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="/libjs-pz2/pz2api.1.js">/libjs-pz2/pz2api.1.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/index-full.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/index-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/index-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         <a href="http://example.indexdata.com/index-mobile.html"
  84            >A version suitable for mobile devices</a>,
  85         with a responsive design that moves components around
  86         depending on the screen size.
  87       </li>
  88       <li>
  89         <a href="http://example.indexdata.com/index-popup.html"
  90            >A version that uses a jQuery popup</a>.
  91       </li>
  92       <li>
  93         An existing web-site,
  94         <a href="http://sagp.miketaylor.org.uk/"
  95            >The Self-Appointed Grammar Police</a>,
  96         which has been fitted with an MKWS searching widget.
  97         (See also the MKWS-widget customisations in
  98         <a href="http://sagp.miketaylor.org.uk/style.css"
  99            >that site's stylesheet</a>.)
 100       </li>
 101       <li>
 102         Another existing web-site,
 103         <a href="http://zthes.z3950.org/"
 104            >The Zthes specifications</a>,
 105         which has been fitted with a popup MKWS search-box.
 106       </li>
 107     </ul>
 108     <p>
 109       The set of targets can be maintained:
 110     </p>
 111     <ul>
 112       <li>
 113         Use the main
 114         <a href="http://mk2.indexdata.com/console/"
 115            >MasterKey Admin Console</a>,
 116         and act as the "MK Demo" library administrator.
 117       </li>
 118     </ul>
 119     <p>
 120       Documentation is as yet in short supply:
 121     </p>
 122     <ul>
 123       <li>
 124         The <a href="README.html"
 125                >README.html</a> (which may not be fully up to
 126         date).
 127       </li>
 128       <li>
 129         The <a href="html-structure.txt"
 130                >structure of the HTML generated by the MKWS widgets</a>,
 131         which can be used to guide the customisation of its CSS styles.
 132       </li>
 133     </ul>
 134   </body>
 135 </html>