Changes

Jump to: navigation, search

Umlaut partial html API javascript helper

725 bytes added, 16:22, 19 June 2012
no edit summary
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!!!!=
'''THIS IS OUTDATED DOCUMENTATION''' See new Umlaut documentation at http://digggithub.com/peopleteam-umlaut/Miley_Cyrus_Parades_Into_Paris miley cyrushttp://digg.com/peopleumlaut/Miley_Cyrus_Parades_Into_Paris miley cyrus nudewiki---------http://digg.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus nakedhttp://diggTHE CODE DOCUMENTED HERE IS DEPRECATED.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus photoshttpPLEASE SEE INSTEAD://digg.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus lyrics[[JQuery HTML Updater]] http://diggIf 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]], 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.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus picshttp://digg== Overview == Your page needs to include the JS Prototype library.com/people/Miley_Cyrus_Parades_Into_Paris pictures Currently, automatic inclusion of miley cyrushttp://diggthe Prototype library isn't working, so you'll need to include a <script> line to do so.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus pictureshttp://diggYou can link to the prototype library in Umlaut, see example below.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus toplesshttp://diggYou will then include an Umlaut javascript file, and then call the embedUmlaut() js function it supplies.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus showerhttp You'll need to pass some arguments to embedUmlaut://digg.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus vanity fairhttp://digg=== Umlaut base URL === The first argument is your Umlaut base URL.comThis is not your link resolver base url which for Umlaut ends in /peopleresolve, but the actual Umlaut application base URL, which should be the same, without the /Miley_Cyrus_Parades_Into_Paris miley cyrus bikinihttp://diggresolve.com (Link to JHU example removed, because i think it was attracting malicious bot/people/Miley_Cyrus_Parades_Into_Paris miley cyrus 7 thingsspider traffic)http://digg=== Context object === The second argument is a URL-formatted (KEV) [[OpenURL]] context object.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus tour dateshttp://digg=== Display section mappings === The third argument is a javascript hash providing mappings from Umlaut html sections to HTML divs on your page.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus pornhttpUmlaut 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 ://diggdivs key.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus biographyhttpTo see the sections in a default Umlaut installation, see://diggAppConfig::Base.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus phone numberbg_update_map [http://diggumlaut.comrubyforge.org/peoplesvn/Miley_Cyrus_Parades_Into_Paris miley cyrus nude picshttp:trunk/config/digg.cominitializers/peopleumlaut/Miley_Cyrus_Parades_Into_Paris miley cyrus cell phonehttp://diggresolve_views.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus sexyhttprb in resolve_views in svn]. The ://diggdivs key of the hash there is an array of hashes, each individual hash has a :div_id key that corresponds to the html_sections id in this api response.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus songshttpFor Umlaut developers, the ://diggpartial key tells you what [[Rails]] partial is used to generate this section.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus boobshttp://diggThis mapping hash can also optionally use some javascript callbacks to perform behavior after or during loading of a particular section.com/people/Miley_Cyrus_Parades_Into_Paris lyrics In the following example, we'll demo using a javascript callback to miley cyrushttp://diggonly show a div for search_inside functionality if there are search_inside tools provided.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus scandalhttp://digg.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus hothttp://digg.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus sex tape=== General options ===http://digg.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus sexhttp://diggThe fourth argument is a hash of additional options to embedUmlaut.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus underwearhttp://digg.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus mp3http://digg.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus email address=== Other Details === http://diggThe 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.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus musichttp://diggThe html loaded will sometimes include a "spinner" with a message "loading more", if the content is not yet loaded.com/people/Miley_Cyrus_Parades_Into_Paris miley cyrus videohttpAn example is best://digg.com/people/Miley_Cyrus_Parades_Into_Paris nude miley cyrus
== 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> 

Navigation menu