projects / mkws-moved-to-github.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Reorder partial widget list in more sensible order.
[mkws-moved-to-github.git] / doc / mkws-manual.markdown
diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown
index d3087e1..a0415b8 100644 (file)
--- a/doc/mkws-manual.markdown
+++ b/doc/mkws-manual.markdown
@@ -1,6 +1,6 @@
-% Embedded metasearching with the MasterKey Widget Set
+% The MKWS manual: embedded metasearching with the MasterKey Widget Set
 % Mike Taylor
 % Mike Taylor
-% 30 July 2014
+% October 2014
 
 
 Introduction
 
 
 Introduction
@@ -19,10 +19,14 @@ Index Data provides several different toolkits for communicating with
 its metasearching middleware, trading off varying degrees of
 flexibility against convenience:
 
 its metasearching middleware, trading off varying degrees of
 flexibility against convenience:
 
-* pz2.js -- a low-level JavaScript library for interrogating the
-  Service Proxy and Pazpar2. It allows the HTML/JavaScript programmer
-  to create JavaScript applications display facets, records, etc. that
-  are fetched from the metasearching middleware.
+* [pz2.js](http://www.indexdata.com/pazpar2/doc/ajaxdev.html) --
+  a low-level JavaScript library for interrogating the
+  [Service Proxy](http://www.indexdata.com/service-proxy/)
+  and
+  [Pazpar2](http://www.indexdata.com/pazpar2/).
+  It allows the HTML/JavaScript programmer
+  to create JavaScript applications to display facets, records,
+  etc. that are fetched from the metasearching middleware.
 
 * masterkey-ui-core -- a higher-level, complex JavaScript library that
   uses pz2.js to provide the pieces needed for building a
 
 * masterkey-ui-core -- a higher-level, complex JavaScript library that
   uses pz2.js to provide the pieces needed for building a
@@ -30,14 +34,17 @@ flexibility against convenience:
 
 * MasterKey Demo UI -- an example of a searching application built on
   top of masterkey-ui-core. Available as a public demo at
 
 * MasterKey Demo UI -- an example of a searching application built on
   top of masterkey-ui-core. Available as a public demo at
-  http://mk2.indexdata.com/
+  <http://mk2.indexdata.com/>
 
 
-* MKDru -- a toolkit for embedding MasterKey-like searching into
-  Drupal sites.
+* [MKDru](http://www.indexdata.com/masterkey-drupal) --
+  a toolkit for embedding MasterKey-like searching into
+  [Drupal](https://www.drupal.org/)
+  sites.
 
 All of these approaches require programming to a greater or lesser
 
 All of these approaches require programming to a greater or lesser
-extent. Against this backdrop, we introduced MKWS (the MasterKey
-Widget Set) -- a set of simple, very high-level HTML+CSS+JavaScript
+extent. Against this backdrop, we introduced
+[MKWS (the MasterKey Widget Set)](http://mkws.indexdata.com/)
+-- a set of simple, very high-level HTML+CSS+JavaScript
 components that can be incorporated into any web-site to provide
 MasterKey searching facilities. By placing `<div>`s with well-known
 MKWS classes in any HTML page, the various components of an application
 components that can be incorporated into any web-site to provide
 MasterKey searching facilities. By placing `<div>`s with well-known
 MKWS classes in any HTML page, the various components of an application
@@ -47,14 +54,15 @@ can be embedded: search-boxes, results areas, target information, etc.
 Simple Example
 ==============
 
 Simple Example
 ==============
 
-The following is a complete MKWS-based searching application:
+The following is
+[a complete MKWS-based searching application](//example.indexdata.com/simple.html):
 
     <html>
       <head>
         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
         <title>MKWS demo client</title>
 
     <html>
       <head>
         <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
         <title>MKWS demo client</title>
-        <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
-        <link rel="stylesheet" href="http://mkws.indexdata.com/mkws.css" />
+        <script type="text/javascript" src="//mkws.indexdata.com/mkws-complete.js"></script>
+        <link rel="stylesheet" href="//mkws.indexdata.com/mkws.css" />
       </head>
       <body>
         <div class="mkwsSearch"></div>
       </head>
       <body>
         <div class="mkwsSearch"></div>
@@ -63,10 +71,9 @@ The following is a complete MKWS-based searching application:
     </html>
 
 Go ahead, try it! Simply put the above in a file (e.g index.html),
     </html>
 
 Go ahead, try it! Simply put the above in a file (e.g index.html),
-drop it into a folder accessible with an ordinary web-server (e.g Apache)
-and load it in your web browser (and no, usually, you can't just load the file
-directly from disk as some browsers, e.g Chrome, won't allow storing cookies).
-Just like that, you have working metasearching.
+drop it into a folder accessible with an ordinary web-server (e.g
+Apache) and load it in your web browser. Just like that, you have
+working metasearching.
 
 How the example works
 ---------------------
 
 How the example works
 ---------------------
@@ -77,7 +84,7 @@ you: the `<html>` element at the top level contains a `<head>` and a
 page, you can add MKWS elements.
 
 These fall into two categories. First, the prerequisites in the HTML
 page, you can add MKWS elements.
 
 These fall into two categories. First, the prerequisites in the HTML
-header, which are loaded from the tool site mkws.indexdata.com:
+header, which are loaded from the tool site `mkws.indexdata.com`:
 
 * `mkws-complete.js`
   contains all the JavaScript needed by the widget-set.
 
 * `mkws-complete.js`
   contains all the JavaScript needed by the widget-set.
@@ -98,9 +105,8 @@ results area. But more are supported. The main `<div>`s are:
    paging for large results sets, facets for refining a search,
    sorting facilities, etc.
 
    paging for large results sets, facets for refining a search,
    sorting facilities, etc.
 
-* `mkwsLang` -- provides links to switch between one of several
-   different UI languages. By default, English, Danish and German are
-   provided.
+* `mkwsStat` --provides a status line summarising the statistics of
+   the various targets.
 
 * `mkwsSwitch` -- provides links to switch between a view of the
    result records and of the targets that provide them. Only
 
 * `mkwsSwitch` -- provides links to switch between a view of the
    result records and of the targets that provide them. Only
@@ -110,8 +116,9 @@ results area. But more are supported. The main `<div>`s are:
    when selected by the link in the `mkwsSwitch` area. Of interest
    mostly for fault diagnosis rather than for end-users.
 
    when selected by the link in the `mkwsSwitch` area. Of interest
    mostly for fault diagnosis rather than for end-users.
 
-* `mkwsStat` --provides a status line summarising the statistics of
-   the various targets.
+* `mkwsLang` -- provides links to switch between one of several
+   different UI languages. By default, English, Danish and German are
+   provided.
 
 To see all of these working together, just put them all into the HTML
 `<body>` like so:
 
 To see all of these working together, just put them all into the HTML
 `<body>` like so:
@@ -855,4 +862,4 @@ and .CLASS indicates an instance of a class.
 
 - - -
 
 
 - - -
 
-Copyright (C) 2013-2014 by Index Data ApS, <http://www.indexdata.com>
+Copyright (C) 2013-2014 Index Data ApS. <http://indexdata.com>
MasterKey Widget Set