tools/htdocs/index.html

   1 <html>
   2   <head>
   3     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   4     <title>MKWS: the MasterKey Widget Set</title>
   5     <style type="text/css">
   6       body {
   7       font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif;
   8       }
   9       h1 { color: #606060 }
  10       h2 { font-size: 100% }
  11     </style>
  12   </head>
  13   <body>
  14     <img src="images/mkws-logo-300px.jpeg" alt="MKWS logo" =
  15          style="float:right; margin: 1.5em"/>
  16     <h1>MKWS: the MasterKey Widget Set</h1>
  17     <h2>This site contains tools, not content:</h2>
  18     <ul>
  19       <li>
  20         <a href="mkws.js">mkws.js</a>
  21         --
  22         JavaScript code that powers the MasterKey Widget Set
  23       </li>
  24       <li>
  25         <a href="/pazpar2/js/pz2.js">/pazpar2/js/pz2.js</a>
  26         --
  27         Low-level JavaScript library for access to the MasterKey web
  28         service.
  29       </li>
  30       <li>
  31         <a href="mkws-complete.js"
  32                 >mkws-complete.js</a>
  33         --
  34         A single large JavaScript file containing everything needed for
  35         MKWS to work: the widget-set itself, the API library, and any
  36         additional prerequisites such as jQuery.
  37       </li>
  38       <li>
  39         <a href="mkws.css">mkws.css</a>
  40         --
  41         A stylesheet which styles only MasterKey widgets, and does not
  42         otherwise interfere with application-site's styles.
  43       </li>
  44     </ul>
  45     <h2>For examples of how to use the widget-set, see:</h2>
  46     <ul>
  47       <li>
  48         A very simple application at
  49         <a href="http://example.indexdata.com/"
  50                 >http://example.indexdata.com/</a>.
  51         It's worth viewing the source to see how small it is.
  52       </li>
  53       <li>
  54         <a href="http://example.indexdata.com/language.html"
  55            >A more detailed version</a>
  56         that contains a configuration structure instead of accepting
  57         the defaults. Includes a custom translation option to present
  58         the application in Arabic.
  59       </li>
  60       <li>
  61         The
  62         <a href="http://example.indexdata.com/jquery.html"
  63            >jQuery plugin</a>
  64         version, consisting of a single line of JavaScript code.
  65       </li>
  66       <li>
  67         An application that
  68         <a href="http://example.indexdata.com/lowlevel.html"
  69            >uses lower-level MKWS components</a>
  70         rather than the all-in-one <tt>#mkwsResults</tt> division,
  71         allowing it to use a rather different layout.
  72       </li>
  73       <li>
  74         An application that specifies how to display brief and full records
  75         <a href="http://example.indexdata.com/templates.html"
  76            >using Handlebar templates</a>.
  77         (Read about
  78         <a href="http://handlebarsjs.com/"
  79            >the templating language</a>.)
  80       </li>
  81       <li>
  82         <a href="http://example.indexdata.com/mobile.html"
  83            >A version suitable for mobile devices</a>,
  84         with a responsive design that moves components around
  85         depending on the screen size.
  86       </li>
  87       <li>
  88         <a href="http://example.indexdata.com/popup.html"
  89            >A version that uses a jQuery popup</a>.
  90       </li>
  91       <li>
  92         <a href="http://example.indexdata.com/dict.html"
  93            >An application that uses MKWS to find dictionary
  94            definitions of words when you highlight them</a>.
  95       </li>
  96       <li>
  97         <a href="http://example.indexdata.com/auto.html"
  98            >An application that runs an automatic search on load</a>.
  99       </li>
 100       <li>
 101         <a href="http://example.indexdata.com/localauth.html"
 102            >An application that uses a local authentication regime</a>,
 103         and the corresponding
 104         <a href="http://example.indexdata.com/apache-config.txt"
 105            >Apache2 configuration stanza</a>.
 106       </li>
 107       <li>
 108         An existing web-site,
 109         <a href="http://sagp.miketaylor.org.uk/"
 110            >The Self-Appointed Grammar Police</a>,
 111         which has been fitted with an MKWS searching widget.
 112         (See also the MKWS-widget customisations in
 113         <a href="http://sagp.miketaylor.org.uk/style.css"
 114            >that site's stylesheet</a>.)
 115       </li>
 116       <li>
 117         Another existing web-site,
 118         <a href="http://zthes.z3950.org/"
 119            >The Zthes specifications</a>,
 120         which has been fitted with a popup MKWS search-box.
 121       </li>
 122     </ul>
 123     <h2>The set of targets can be maintained:</h2>
 124     <ul>
 125       <li>
 126         Use the main
 127         <a href="http://mk2.indexdata.com/console/"
 128            >MasterKey Admin Console</a>,
 129         and act as the "MK Demo" library administrator.
 130       </li>
 131     </ul>
 132     <h2>Documentation:</h2>
 133     <ul>
 134       <li>
 135         The <a href="whitepaper.html">The whitepaper, including a reference section.</a>
 136       </li>
 137       <li>
 138         The <a href="README.html">README.html</a>
 139       </li>
 140       <li>
 141         The <a href="html-structure.txt"
 142                >structure of the HTML generated by the MKWS widgets</a>,
 143         which can be used to guide the customisation of its CSS styles.
 144       </li>
 145     </ul>
 146   </body>
 147 </html>