X-Git-Url: http://git.indexdata.com/?p=mkws-moved-to-github.git;a=blobdiff_plain;f=tools%2Fhtdocs%2Findex.html;h=82bdc2fa7972c864067fc2f39c8956c0e3a241d6;hp=2a67a4b74fb8b57090455cf530b3d3f2e8725840;hb=ef845d2595045ecf11ce99ec73ded148af69121f;hpb=10963c36b208e35c7430ab32307df4b73fca49a1 diff --git a/tools/htdocs/index.html b/tools/htdocs/index.html index 2a67a4b..82bdc2f 100644 --- a/tools/htdocs/index.html +++ b/tools/htdocs/index.html @@ -1,3 +1,4 @@ + @@ -6,10 +7,17 @@ body { font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif; } - h1 { font-weight: normal; color: #606060 } - h2 { font-size: 100% } - .pane { background: #eee; border-radius: 1em; - padding: 0.25em 1em; margin: 0.75em; } + h1, h3 { font-weight: normal; color: #606060 } + h2 { margin-top: 0.5em } + .pane { padding: 0em 1em; margin: 0.75em; + border: 0.5em solid #eee; + border-radius: 1em; + background-image: url('images/mkws-logo-48x48-light.png'); + background-repeat: no-repeat; + background-position: right top; + background-color: #eee; + } + .nologo { background-image: none } pre { background: #ddd; padding: 0.5em; } @@ -18,7 +26,7 @@ style="float:right; margin: 1.5em"/>

MKWS: the MasterKey Widget Set

-
+
-

Example

+

A minimal example

Here is a completely functional (though ugly) MKWS-based searching application: @@ -58,7 +66,7 @@ The README -- mostly technical details.

  • - The whitepaper, including a + The MKWS manual, including a reference section. This is a much better introduction.
    • @@ -67,6 +75,9 @@

    Tools

    +

    + Here are the files that this web-site provides: +

    • mkws.js @@ -74,18 +85,26 @@ JavaScript code that powers the MasterKey Widget Set
    • - /pazpar2/js/pz2.js + pazpar2/js/pz2.js -- Low-level JavaScript library for access to the MasterKey web service.
    • + handlebars-v1.1.2.js + -- + A local copy of + the Handlebars templating library, + since it doesn't like to be hotlinked. +
      • +
    • mkws-complete.js -- A single large JavaScript file containing everything needed for - MKWS to work: the widget-set itself, the API library, and any - additional prerequisites such as jQuery. + MKWS to work: the widget-set itself, the API library, and + the prerequisites jQuery and Handlebars.
    • mkws.css @@ -94,72 +113,135 @@ otherwise interfere with application-site's styles.
    +

    + Minified versions of the MKWS JavaScript files are also available: +

    +

    +

    + (This domain also hosts two web-service endpoints that are used by + running MKWS-based applications: + /service-proxy-auth + is used to authenticate new sessions and + /service-proxy/ + is the main endpoint for searching and retrieval. But there is + no need to use these directly: the widgets take care of that.) + +

    -

    For examples of how to use the widget-set, see:

    +

    Versions

    +

    + The links above to the various forms of the widget-set JavaScript + (mkws.js, + mkws-complete.js, + mkws.min.js + and + mkws-complete.min.js) + are always to the current versions of those + files. Applications that rely on a particular version can + instead use the specific numbered versions in + the releases area, + for example + releases/mkws-0.9.1.js. +

    +

    + The current version number is always in + the VERSION file. +

    +

    + Version history is in + the NEWS file. +

    +
    + +
    +

    Examples using the widget-set

    +

    + It's worth viewing the source of these to see how small they + are and how various things are done. +

    +

    Simple examples

    + +

    Advanced examples

    + + +

    Non-standard interfaces

    +
    -

    The set of targets can be maintained:

    - +

    Target selection

    +

    + MKWS comes pre-configured to search in a set of a dozen or so + open-access targets, as a proof of concept. But you'll want + to use it to search your own selection of targets -- some open + access, some subscription. +

    +

    + We can set that up for you: email us on + info@indexdata.com. +

    + +

    + Copyright (©) 2013-2014 Index Data ApS. + http://indexdata.com +