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