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