<h1>MKWS: the MasterKey Widget Set</h1>
<div class="pane">
- <h2>This site contains tools, not content:</h2>
- <ul>
- <li>
- <a href="mkws.js">mkws.js</a>
- --
- JavaScript code that powers the MasterKey Widget Set
- </li>
- <li>
- <a href="/pazpar2/js/pz2.js">/pazpar2/js/pz2.js</a>
- --
- Low-level JavaScript library for access to the MasterKey web
- service.
- </li>
- <li>
- <a href="mkws-complete.js"
- >mkws-complete.js</a>
- --
- A single large JavaScript file containing everything needed for
- MKWS to work: the widget-set itself, the API library, and any
- additional prerequisites such as jQuery.
- </li>
- <li>
- <a href="mkws.css">mkws.css</a>
- --
- A stylesheet which styles only MasterKey widgets, and does not
- otherwise interfere with application-site's styles.
- </li>
- </ul>
+ <h2>This site contains tools, not content:</h2>
+ <ul>
+ <li>
+ <a href="mkws.js">mkws.js</a>
+ --
+ JavaScript code that powers the MasterKey Widget Set
+ </li>
+ <li>
+ <a href="/pazpar2/js/pz2.js">/pazpar2/js/pz2.js</a>
+ --
+ Low-level JavaScript library for access to the MasterKey web
+ service.
+ </li>
+ <li>
+ <a href="mkws-complete.js"
+ >mkws-complete.js</a>
+ --
+ A single large JavaScript file containing everything needed for
+ MKWS to work: the widget-set itself, the API library, and any
+ additional prerequisites such as jQuery.
+ </li>
+ <li>
+ <a href="mkws.css">mkws.css</a>
+ --
+ A stylesheet which styles only MasterKey widgets, and does not
+ otherwise interfere with application-site's styles.
+ </li>
+ </ul>
</div>
<div class="pane">
- <h2>For examples of how to use the widget-set, see:</h2>
- <ul>
- <li>
- A very simple application at
- <a href="http://example.indexdata.com/"
- >http://example.indexdata.com/</a>.
- It's worth viewing the source to see how small it is.
- </li>
- <li>
- <a href="http://example.indexdata.com/language.html"
- >A more detailed version</a>
- that contains a configuration structure instead of accepting
- the defaults. Includes a custom translation option to present
- the application in Arabic.
- </li>
- <li>
- The
- <a href="http://example.indexdata.com/jquery.html"
- >jQuery plugin</a>
- version, consisting of a single line of JavaScript code.
- </li>
- <li>
- An application that
- <a href="http://example.indexdata.com/lowlevel.html"
- >uses lower-level MKWS components</a>
- rather than the all-in-one <tt>#mkwsResults</tt> division,
- allowing it to use a rather different layout.
- </li>
- <li>
- An application that specifies how to display brief and full records
- <a href="http://example.indexdata.com/templates.html"
- >using Handlebar templates</a>.
- (Read about
- <a href="http://handlebarsjs.com/"
- >the templating language</a>.)
- </li>
- <li>
- <a href="http://example.indexdata.com/mobile.html"
- >A version suitable for mobile devices</a>,
- with a responsive design that moves components around
- depending on the screen size.
- </li>
- <li>
- <a href="http://example.indexdata.com/popup.html"
- >A version that uses a jQuery popup</a>.
- </li>
- <li>
- <a href="http://example.indexdata.com/dict.html"
- >An application that uses MKWS to find dictionary
- definitions of words when you highlight them</a>.
- </li>
- <li>
- <a href="http://example.indexdata.com/auto.html"
- >An application that runs an automatic search on load</a>.
- </li>
- <li>
- <a href="http://example.indexdata.com/localauth.html"
- >An application that uses a local authentication regime</a>,
- and the corresponding
- <a href="http://example.indexdata.com/apache-config.txt"
- >Apache2 configuration stanza</a>.
- </li>
- <li>
- An existing web-site,
- <a href="http://sagp.miketaylor.org.uk/"
- >The Self-Appointed Grammar Police</a>,
- which has been fitted with an MKWS searching widget.
- (See also the MKWS-widget customisations in
- <a href="http://sagp.miketaylor.org.uk/style.css"
- >that site's stylesheet</a>.)
- </li>
- <li>
- Another existing web-site,
- <a href="http://zthes.z3950.org/"
- >The Zthes specifications</a>,
- which has been fitted with a popup MKWS search-box.
- </li>
- </ul>
+ <h2>For examples of how to use the widget-set, see:</h2>
+ <ul>
+ <li>
+ A very simple application at
+ <a href="http://example.indexdata.com/"
+ >http://example.indexdata.com/</a>.
+ It's worth viewing the source to see how small it is.
+ </li>
+ <li>
+ <a href="http://example.indexdata.com/language.html"
+ >A more detailed version</a>
+ that contains a configuration structure instead of accepting
+ the defaults. Includes a custom translation option to present
+ the application in Arabic.
+ </li>
+ <li>
+ The
+ <a href="http://example.indexdata.com/jquery.html"
+ >jQuery plugin</a>
+ version, consisting of a single line of JavaScript code.
+ </li>
+ <li>
+ An application that
+ <a href="http://example.indexdata.com/lowlevel.html"
+ >uses lower-level MKWS components</a>
+ rather than the all-in-one <tt>#mkwsResults</tt> division,
+ allowing it to use a rather different layout.
+ </li>
+ <li>
+ An application that specifies how to display brief and full records
+ <a href="http://example.indexdata.com/templates.html"
+ >using Handlebar templates</a>.
+ (Read about
+ <a href="http://handlebarsjs.com/"
+ >the templating language</a>.)
+ </li>
+ <li>
+ <a href="http://example.indexdata.com/mobile.html"
+ >A version suitable for mobile devices</a>,
+ with a responsive design that moves components around
+ depending on the screen size.
+ </li>
+ <li>
+ <a href="http://example.indexdata.com/popup.html"
+ >A version that uses a jQuery popup</a>.
+ </li>
+ <li>
+ <a href="http://example.indexdata.com/dict.html"
+ >An application that uses MKWS to find dictionary
+ definitions of words when you highlight them</a>.
+ </li>
+ <li>
+ <a href="http://example.indexdata.com/auto.html"
+ >An application that runs an automatic search on load</a>.
+ </li>
+ <li>
+ <a href="http://example.indexdata.com/localauth.html"
+ >An application that uses a local authentication regime</a>,
+ and the corresponding
+ <a href="http://example.indexdata.com/apache-config.txt"
+ >Apache2 configuration stanza</a>.
+ </li>
+ <li>
+ An existing web-site,
+ <a href="http://sagp.miketaylor.org.uk/"
+ >The Self-Appointed Grammar Police</a>,
+ which has been fitted with an MKWS searching widget.
+ (See also the MKWS-widget customisations in
+ <a href="http://sagp.miketaylor.org.uk/style.css"
+ >that site's stylesheet</a>.)
+ </li>
+ <li>
+ Another existing web-site,
+ <a href="http://zthes.z3950.org/"
+ >The Zthes specifications</a>,
+ which has been fitted with a popup MKWS search-box.
+ </li>
+ </ul>
</div>
<div class="pane">
- <h2>The set of targets can be maintained:</h2>
- <ul>
- <li>
- Use the main
- <a href="http://mk2.indexdata.com/console/"
- >MasterKey Admin Console</a>,
- and act as the "MK Demo" library administrator.
- </li>
- </ul>
+ <h2>The set of targets can be maintained:</h2>
+ <ul>
+ <li>
+ Use the main
+ <a href="http://mk2.indexdata.com/console/"
+ >MasterKey Admin Console</a>,
+ and act as the "MK Demo" library administrator.
+ </li>
+ </ul>
</div>
<div class="pane">
- <h2>Documentation:</h2>
- <ul>
- <li>
- The <a href="whitepaper.html">The whitepaper, including a reference section.</a>
- </li>
- <li>
- The <a href="README.html">README.html</a>
- </li>
- <li>
- The <a href="html-structure.txt"
- >structure of the HTML generated by the MKWS widgets</a>,
- which can be used to guide the customisation of its CSS styles.
- </li>
- </ul>
+ <h2>Documentation:</h2>
+ <ul>
+ <li>
+ The <a href="whitepaper.html">The whitepaper, including a reference section.</a>
+ </li>
+ <li>
+ The <a href="README.html">README.html</a>
+ </li>
+ <li>
+ The <a href="html-structure.txt"
+ >structure of the HTML generated by the MKWS widgets</a>,
+ which can be used to guide the customisation of its CSS styles.
+ </li>
+ </ul>
</div>
</body>
</html>
projects / mkws-moved-to-github.git / blobdiff