experiments/spclient/index-mkws.html

   1 <html>
   2   <head>
   3     <title>MKWS: the MasterKey Widget Set</title>
   4     <style type="text/css">
   5       body {
   6       font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif;
   7       }
   8       h1 { color: #606060 }
   9       p { font-weight: bold }
  10     </style>
  11   </head>
  12   <body>
  13     <h1>MKWS: the MasterKey Widget Set</h1>
  14     <p>
  15       This site contains tools, not content:
  16     </p>
  17     <ul>
  18       <li>
  19         <a href="mkws.js">mkws.js</a>
  20         --
  21         JavaScript code that powers the MasterKey Widget Set
  22       </li>
  23       <li>
  24         <a href="/libjs-pz2/pz2api.1.js">/libjs-pz2/pz2api.1.js</a>
  25         --
  26         Low-level JavaScript library for access to the MasterKey web
  27         service.
  28       </li>
  29       <li>
  30         <a href="mkws-complete.js"
  31                 >mkws-complete.js</a>
  32         --
  33         A single large JavaScript file containing everything needed for
  34         MKWS to work: the widget-set itself, the API library, and any
  35         additional prerequisites such as jQuery.
  36       </li>
  37       <li>
  38         <a href="mkwsStyle.css">mkwsStyle.css</a>
  39         --
  40         A stylesheet which styles only MasterKey widgets, and does not
  41         otherwise interfere with application-site's styles.
  42     <!--
  43         <p style="color:darkred">
  44           Note. This is not yet quite true: the stylesheet needs tweaking
  45           to make it more specific to only the MKWS components. At present
  46           it spills over into styling parts of the containing site, too.
  47         </p>
  48     -->
  49       </li>
  50     </ul>
  51     <p>
  52       For examples of how to use the widget-set, see:
  53     </p>
  54     <ul>
  55       <li>
  56         A very simple application at
  57         <a href="http://somesite.indexdata.com/"
  58                 >http://somesite.indexdata.com/</a>.
  59         It's worth viewing the source to see how small it is.
  60       </li>
  61       <li>
  62         The
  63         <a href="http://somesite.indexdata.com/jquery.html"
  64            >jQuery plugin</a>
  65         version, consisting of a single line of JavaScript code.
  66       </li>
  67       <li>
  68         An existing web-site,
  69         <a href="http://sagp.miketaylor.org.uk/"
  70            >The Self-Appointed Grammar Police</a>,
  71         which has been fitted with an MKWS searching widget.
  72         (See also the MKWS-widget customisations in
  73         <a href="http://sagp.miketaylor.org.uk/style.css"
  74            >that site's stylesheet</a>.)
  75       </li>
  76     </ul>
  77     <p>
  78       Documentation is as yet in short supply:
  79     </p>
  80     <ul>
  81       <li>
  82         The <a href="README"
  83                >README</a> (which may not be fully up to
  84         date).
  85       </li>
  86       <li>
  87         The <a href="html-structure.txt"
  88                >structure of the HTML generated by the MKWS widgets</a>,
  89         which can be used to guide the customisation of its CSS styles.
  90       </li>
  91     </ul>
  92   </body>
  93 </html>