experiments/spclient/index-mkws.html

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