experiments/spclient/index-mkws.html

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