X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;ds=sidebyside;f=tools%2Fhtdocs%2FREADME.markdown;h=1994dc88c2c0f0331a3cbfc37897f6bfe14fa698;hb=3bab15c51acc37f065bcf7b14daa10287247b118;hp=b349bf5b54f39c9067a1539ac434974a7ad40a72;hpb=1e449acba57c1146e146225f7f47e5cd412e07e2;p=mkws-moved-to-github.git diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown index b349bf5..1994dc8 100644 --- a/tools/htdocs/README.markdown +++ b/tools/htdocs/README.markdown @@ -3,6 +3,9 @@ % 10 July 2013 +Introduction +------------ + This directory contains an embryonic MasterKey Widget Set. The initial version was based on the "jsdemo" application distributed with pazpar2, but it is now far removed from those beginnnings. @@ -19,7 +22,7 @@ can have MasterKey searching with minimal effort. The following files are hosted on `mkws.indexdata.com`: -* `mkwsStyle.css` +* `mkws.css` * `mkws.js` * `/libjs-pz2/pz2api.1.js` * `mkws-complete.js` -- a single file consisting of `mkws.js`, @@ -35,7 +38,7 @@ whatever makes up the application itself: Prerequisites: ~~~ - + ~~~ @@ -64,20 +67,19 @@ possible options: show_lang: true, /* true, false: show/hide language menu */ show_sort: true, /* true, false: show/hide sort menu */ show_perpage: true, /* true, false: show/hide perpage menu */ - lang_display: ["en", "de", "da"], /* display languages links for given + lang_options: ["en", "de", "da"], /* display languages links for given languages, [] for all */ facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */ sort_default: "relevance", /* "relevance", "title:1", "date:0", "date:1" */ query_width: 50, /* 5..50 */ perpage_default: 20, /* 10, 20, 30, 50 */ lang: "en", /* "en", "de", "da" */ - debug: 0, /* debug level for development: 0..2 */ + debug_level: 0, /* debug level for development: 0..2 */ - responsive_design: false /* true, false: resize for smaller mobile devices */ - pazpar2_url: "/pazpar2/search.pz2", /* URL */ - service_proxy_url: "/service-proxy/", /* URL */ + responsive_design_wodth: 600, /* page reflows for devices < 600 pixels wide */ + pazpar2_url: "/service-proxy/", /* URL */ service_proxy_auth: "/service-proxy-auth", /* URL */ - // TODO: language_*, perpage, responsive_design_width, sort + // TODO: language_*, perpage_options, sort_options }; ~~~