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       p { font-weight: bold }
  11     </style>
  12   </head>
  13   <body>
  14     <h1>MKWS: the MasterKey Widget Set</h1>
  15     <p>
  16       This site contains tools, not content:
  17     </p>
  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     <!--
  44         <p style="color:darkred">
  45           Note. This is not yet quite true: the stylesheet needs tweaking
  46           to make it more specific to only the MKWS components. At present
  47           it spills over into styling parts of the containing site, too.
  48         </p>
  49     -->
  50       </li>
  51     </ul>
  52     <p>
  53       For examples of how to use the widget-set, see:
  54     </p>
  55     <ul>
  56       <li>
  57         A very simple application at
  58         <a href="http://example.indexdata.com/"
  59                 >http://example.indexdata.com/</a>.
  60         It's worth viewing the source to see how small it is.
  61       </li>
  62       <li>
  63         <a href="http://example.indexdata.com/language.html"
  64            >A more detailed version</a>
  65         that contains a configuration structure instead of accepting
  66         the defaults. Includes a custom translation option to present
  67         the application in Arabic.
  68       </li>
  69       <li>
  70         The
  71         <a href="http://example.indexdata.com/jquery.html"
  72            >jQuery plugin</a>
  73         version, consisting of a single line of JavaScript code.
  74       </li>
  75       <li>
  76         An application that
  77         <a href="http://example.indexdata.com/lowlevel.html"
  78            >uses lower-level MKWS components</a>
  79         rather than the all-in-one <tt>#mkwsResults</tt> division,
  80         allowing it to use a rather different layout.
  81       </li>
  82       <li>
  83         An application that specifies how to display brief and full records
  84         <a href="http://example.indexdata.com/templates.html"
  85            >using Handlebar templates</a>.
  86         (Read about
  87         <a href="http://handlebarsjs.com/"
  88            >the templating language</a>.)
  89       </li>
  90       <li>
  91         <a href="http://example.indexdata.com/mobile.html"
  92            >A version suitable for mobile devices</a>,
  93         with a responsive design that moves components around
  94         depending on the screen size.
  95       </li>
  96       <li>
  97         <a href="http://example.indexdata.com/popup.html"
  98            >A version that uses a jQuery popup</a>.
  99       </li>
 100       <li>
 101         <a href="http://example.indexdata.com/dict.html"
 102            >An application that uses MKWS to find dictionary
 103            definitions of words when you highlight them</a>.
 104       </li>
 105       <li>
 106         <a href="http://example.indexdata.com/auto.html"
 107            >An application that runs an automatic search on load</a>.
 108       </li>
 109       <li>
 110         <a href="http://example.indexdata.com/localauth.html"
 111            >An application that uses a local authentication regime</a>,
 112         and the corresponding
 113         <a href="http://example.indexdata.com/apache-config.txt"
 114            >Apache2 configuration stanza</a>.
 115       </li>
 116       <li>
 117         An existing web-site,
 118         <a href="http://sagp.miketaylor.org.uk/"
 119            >The Self-Appointed Grammar Police</a>,
 120         which has been fitted with an MKWS searching widget.
 121         (See also the MKWS-widget customisations in
 122         <a href="http://sagp.miketaylor.org.uk/style.css"
 123            >that site's stylesheet</a>.)
 124       </li>
 125       <li>
 126         Another existing web-site,
 127         <a href="http://zthes.z3950.org/"
 128            >The Zthes specifications</a>,
 129         which has been fitted with a popup MKWS search-box.
 130       </li>
 131     </ul>
 132     <p>
 133       The set of targets can be maintained:
 134     </p>
 135     <ul>
 136       <li>
 137         Use the main
 138         <a href="http://mk2.indexdata.com/console/"
 139            >MasterKey Admin Console</a>,
 140         and act as the "MK Demo" library administrator.
 141       </li>
 142     </ul>
 143     <p>
 144       Documentation:
 145     </p>
 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   </body>
 160 </html>