body {
font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif;
}
- h1 { font-weight: normal; color: #606060 }
- h2 { font-size: 100% }
+ h1, h3 { font-weight: normal; color: #606060 }
+ h2 { margin-top: 0.5em }
.pane { padding: 0em 1em; margin: 0.75em;
border: 0.5em solid #eee;
border-radius: 1em;
</div>
<div class="pane">
- <h2>Example</h2>
+ <h2>A minimal example</h2>
<p>
Here is a completely functional (though ugly) MKWS-based
searching application:
The <a href="README.html">README</a> -- mostly technical details.
</li>
<li>
- The <a href="whitepaper.html">whitepaper, including a
+ The <a href="mkws-manual.html">MKWS manual, including a
reference section.</a>
This is a much better introduction.
</li>
</li>
</ul>
<p>
+ Minified versions of the MKWS JavaScript files are also available:
+ <p>
+ <ul>
+ <li>
+ <a href="mkws.min.js">mkws.min.js</a>
+ </li>
+ <li>
+ <a href="mkws-complete.min.js">mkws-complete.min.js</a>
+ </li>
+ </ul>
+ <p>
(This domain also hosts two web-service endpoints that are used by
running MKWS-based applications:
<tt>/service-proxy-auth</tt>
</div>
<div class="pane">
+ <h2>Versions</h2>
+ <p>
+ The links above to the various forms of the widget-set JavaScript
+ (<a href="mkws.js">mkws.js</a>,
+ <a href="mkws-complete.js">mkws-complete.js</a>,
+ <a href="mkws.min.js">mkws.min.js</a>
+ and
+ <a href="mkws-complete.min.js">mkws-complete.min.js</a>)
+ are always to the current versions of those
+ files. Applications that rely on a particular version can
+ instead use the specific numbered versions in
+ <a href="releases/">the releases area</a>,
+ for example
+ <a href="releases/mkws-0.9.1.js">releases/mkws-0.9.1.js</a>.
+ </p>
+ <p>
+ The current version number is always in
+ <a href="VERSION">the VERSION file</a>.
+ </p>
+ <p>
+ Version history is in
+ <a href="NEWS">the NEWS file</a>.
+ </p>
+ </div>
+
+ <div class="pane">
<h2>Examples using the widget-set</h2>
<p>
It's worth viewing the source of these to see how small they
are and how various things are done.
</p>
+ <h3>Simple examples</h3>
<ul>
<li>
A very simple application at
- <a href="http://example.indexdata.com/"
- >http://example.indexdata.com/</a>.
+ <a href="//example.indexdata.com/simple.html"
+ >//example.indexdata.com/simple.html</a>.
</li>
<li>
- <a href="http://example.indexdata.com/minimal.html"
+ <a href="//example.indexdata.com/minimal.html"
>The absolutely minimal application</a>
listed above.
</li>
<li>
- <a href="http://example.indexdata.com/language.html"
+ <a href="//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 JavaScript statement.
+ <a href="//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>
+ </ul>
+
+ <h3>Advanced examples</h3>
+ <ul>
<li>
An application that
- <a href="http://example.indexdata.com/lowlevel.html"
+ <a href="//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"
+ <a href="//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.
+ An application that
+ <a href="http://example.indexdata.com/images.html?q=portrait"
+ >displays thumbnail images</a>.
+ </li>
+ <li>
+ <a href="//example.indexdata.com/localauth.html"
+ >An application that uses a local authentication regime</a>,
+ and the corresponding
+ <a href="//example.indexdata.com/apache-config.txt"
+ >Apache2 configuration stanza</a>.
</li>
<li>
- <a href="http://example.indexdata.com/popup.html"
+ <a href="//example.indexdata.com/popup.html"
>A version that uses a jQuery popup</a>.
</li>
+ </ul>
+
+ <h3>Non-standard interfaces</h3>
+ <ul>
<li>
- <a href="http://example.indexdata.com/dict.html"
+ <a href="//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"
+ <a href="//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>,
<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>
<p style="text-align: right; font-size: small">
- Copyright © 2013 IndexData ApS.
+ Copyright (©) 2013-2014 Index Data ApS.
<a href="http://indexdata.com"><code>http://indexdata.com</code></a>
</p>
</body>
projects / mkws-moved-to-github.git / blobdiff