-

Example

+

A minimal example

Here is a completely functional (though ugly) MKWS-based searching application: @@ -64,7 +66,7 @@ The README -- mostly technical details.

- The whitepaper, including a + The MKWS manual, including a reference section. This is a much better introduction.

@@ -112,6 +114,17 @@

+ Minified versions of the MKWS JavaScript files are also available: +

+

+ mkws.min.js +
+ mkws-complete.min.js +

+

(This domain also hosts two web-service endpoints that are used by running MKWS-based applications: /service-proxy-auth @@ -119,8 +132,33 @@ /service-proxy/ is the main endpoint for searching and retrieval. But there is no need to use these directly: the widgets take care of that.) - - +

+

Versions

+

+ The links above to the various forms of the widget-set JavaScript + (mkws.js, + mkws-complete.js, + mkws.min.js + and + mkws-complete.min.js) + are always to the current versions of those + files. Applications that rely on a particular version can + instead use the specific numbered versions in + the releases area, + for example + releases/mkws-0.9.1.js. +

+

+ The current version number is always in + the VERSION file. +

+

+ Version history is in + the NEWS file. +

@@ -133,73 +171,76 @@

A very simple application at - http://example.indexdata.com/. + //example.indexdata.com/simple.html.
- The absolutely minimal application listed above.
- A more detailed version that contains a configuration structure instead of accepting the defaults. Includes a custom translation option to present the application in Arabic.
- A version suitable for mobile devices, with a responsive design that moves components around depending on the screen size.

-

Intermediate examples

+

Advanced examples

- The - jQuery plugin - version, consisting of a single JavaScript statement. -
An application that - uses lower-level MKWS components rather than the all-in-one #mkwsResults division, allowing it to use a rather different layout.
An application that specifies how to display brief and full records - using Handlebar templates. (Read about the templating language.)
- displays thumbnail images. +
+ An application that uses a local authentication regime, + and the corresponding + Apache2 configuration stanza. +
+ A version that uses a jQuery popup.

+ +

Non-standard interfaces

+