If you want to include Umlaut-generated HTML directly on a third party page via javascript, there is a javascript helper script to make that very easy. =WARNING: This helper uses the [[Umlaut partial html API]], but does everything for you. The helper will update your divs, and keep polling Umlaut for new results, continuing to re-update your divs until Umlaut is finished. How often it polls is configured by application config 'poll_wait_seconds', which defaults to 4 seconds. Outdated Documentation!!!!=
Hey! Great Site!, '''THIS IS OUTDATED DOCUMENTATION''' See new Umlaut documentation at http://www.njgithub.com/forumsteam-umlaut/profileumlaut/wiki--------- THE CODE DOCUMENTED HERE IS DEPRECATED.ssf?nickname=newyorksex4 new york sextape, PLEASE SEE INSTEAD:[[JQuery HTML Updater]] If you want to include [[Umlaut]]-generated HTML directly on a third party page via javascript, there is a javascript helper script to make that very easy. This helper uses the [[Umlaut partial html API]], http://wwwbut does everything for you.nj The helper will update your divs, and keep polling Umlaut for new results, continuing to re-update your divs until Umlaut is finished.com/forums/profile How often it polls is configured by application config 'poll_wait_seconds', which defaults to 4 seconds.ssf?nickname =oliviamoji0 olivia mojica sextape, = Overview == Your page needs to include the JS Prototype library. yjbycCurrently, http://wwwautomatic inclusion of the Prototype library isn't working, so you'll need to include a <script> line to do so.njYou can link to the prototype library in Umlaut, see example below.com/forums/profile.ssf?nickname=kardashian16 kardashian sextape You will then include an Umlaut javascript file, and then call the embedUmlaut() js function it supplies. kied, httpYou'll need to pass some arguments to embedUmlaut://www === Umlaut base URL === The first argument is your Umlaut base URL.nj.comThis is not your link resolver base url which for Umlaut ends in /forums/profile.ssf?nickname=lindseyloh6 lindsey lohan sextaperesolve, =-[[[but the actual Umlaut application base URL, http:which should be the same, without the //wwwresolve.nj.com/forums/profile.ssf?nickname=kimkardash61 kim kardashian and ray j sextape, 256(Link to JHU example removed, http://www.nj.combecause i think it was attracting malicious bot/forums/profile.ssf?nicknamespider traffic) =adrianalim0 adriana lima sextape, 8== Context object === The second argument is a URL-formatted (KEV) [[, http://wwwOpenURL]] context object.nj.com/forums/profile.ssf?nickname =dustindiam3 dustin diamond sextape== Display section mappings === The third argument is a javascript hash providing mappings from Umlaut html sections to HTML divs on your page. Umlaut html sections are configured in Umlaut in the "partial_html_map" configuration param, which by default is set to the "bg_update_map" config params :]divs key. To see the sections in a default Umlaut installation, see: AppConfig::Base.bg_update_map [http://wwwumlaut.njrubyforge.comorg/forumssvn/profile.ssf?nickname=avrillavig33 avril lavigne sextape, rdav, http:trunk/config/www.nj.cominitializers/forumsumlaut/profileresolve_views.ssf?nickname=shayjohnso9 shay johnson sextaperb in resolve_views in svn]. The :divs key of the hash there is an array of hashes, >each individual hash has a :-PPPdiv_id key that corresponds to the html_sections id in this api response. For Umlaut developers, httpthe ://wwwpartial key tells you what [[Rails]] partial is used to generate this section.nj This mapping hash can also optionally use some javascript callbacks to perform behavior after or during loading of a particular section.com/forums/profile.ssf?nickname=buffietheb6 buffie In the body sextapefollowing example, sus, http://wwwwe'll demo using a javascript callback to only show a div for search_inside functionality if there are search_inside tools provided.nj === General options === The fourth argument is a hash of additional options to embedUmlaut.com/forums/profile.ssf?nickname =freebritne6 free britney spears sextape, =]]]= Other Details === The umlaut_embed.js script will check if the javascript Prototype library is loaded into the host page,and load it if not. Among other things, this means you can use Prototype in your callbacks. The html loaded will sometimes include a "spinner" with a message "loading more", if the content is not yet loaded. An example is best:
== Example ==
<script type="text/javascript">
// You have to generate an OpenURL context object somehow, and set it in a js global var.
// Normally this would be generated dynamically, not static HTML like this, of course.
// You may want to include a rfr_id to identify your application as a source, demo below.
umlaut_openurl_kev_co = 'url_ver=Z39.88-2004&rft_val_fmt=info:ofi/fmt:kev:mtx:journal&rft_id=info:doi/10.1002/jez.1401770202&rfr_id=info:sid/university.edu:myapplication&rft.genre=article&rft.jtitle=J.%20Exp.%20Zool&rft.date=1971&rft.atitle=Cytoplasmic%20control%20of%20nuclear%20behavior&rft.aulast=Masui';
// set global js var to tell script where to find umlaut
umlaut_base = 'http://umlaut.university.edu';
umlaut_section_map = {
'fulltext_wrapperfulltext': 'my_fulltext',
'highlighted_links': 'my_see_also',
'excerpts_wrapperexcerpts': 'my_excerpts',
'cover_image': 'my_cover',
'search_inside_wrappersearch_inside': {'host_div_id': 'my_search_inside',
'after_update':
function(count) {
}
}
};
//global embedUmlaut options
//demonstrate putting up an alert when Umlaut is done loading all content, which you
//wouldn't want to do, but anyway.
umlaut_options = {
'all-complete-callback': function() { alert('All done!'); }
};
</script>
<!-- include the prototype library -->
<script type="text/javascript" src="http://umlaut.university.edu/javascripts/prototype.js"></script>
<!-- now actually load the umlaut js helper, which will do the magic for you -->
<script type="text/javascript" src="http://umlaut.university.edu/javascripts/embed/umlaut-embed-func.js"></script> <!-- and call embedUmlaut --> <script type="text/javascript"> embedUmlaut(umlaut_base, umlaut_openurl_kev_co, umlaut_section_map, umlaut_options); </script>
