For more documentation:
-doc/README.markdown -- overview
+doc/index.markdown -- overview
doc/mkws-manual.markdown -- how to use the widget set
doc/mkws-developer.markdown -- how to develop and customise widgets
# texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
DOCS = index.html index.pdf \
- README.html README.pdf \
mkws-manual.html mkws-manual.pdf \
mkws-developer.html mkws-developer.pdf
rm -f *.drupal.html
push:
- pandoc --toc README.markdown > README.drupal.html
+ pandoc --toc index.markdown > index.drupal.html
pandoc --toc mkws-manual.markdown > mkws-manual.drupal.html
- cat README.drupal.html | ./drupaljson.pl | curl --upload-file - http://www.indexdata.com/script/node/332?services_token=cda1e26e5733ce3f604773e94f0721df5c31a948 -v --header "Content-Type:application/json"
+ cat index.drupal.html | ./drupaljson.pl | curl --upload-file - http://www.indexdata.com/script/node/332?services_token=cda1e26e5733ce3f604773e94f0721df5c31a948 -v --header "Content-Type:application/json"
cat mkws-manual.drupal.html | ./drupaljson.pl | curl --upload-file - http://www.indexdata.com/script/node/323?services_token=cda1e26e5733ce3f604773e94f0721df5c31a948 -v --header "Content-Type:application/json"
help:
+++ /dev/null
-% The MasterKey Widget Set
-% Mike Taylor; Wolfram Schneider
-% 28 July 2014
-
-
-Introduction
-------------
-
-As much of the searching functionality as possible is hosted on
- <http://mkws.indexdata.com/>
-so that very simple applications such as
- <http://example.indexdata.com/simple.html>
-can have MasterKey searching with minimal effort.
-
-
-Supported Browsers
-------------------
-
-Any modern browser will work fine. JavaScript must be enabled.
-
-* IE8 or later
-* Firefox 17 or later
-* Google Chrome 27 or later
-* Safari 6 or later
-* Opera 12 or later
-* iOS 6.x (iPhone, iPad)
-* Android 4.x
-
-Not supported: IE6, IE7
-
-
-Configuring a client (short version)
-------------------------------------
-
-The application's HTML must contains the following elements as well as
-whatever makes up the application itself:
-
-Prerequisites:
-
-~~~
- <link rel="stylesheet" href="http://mkws.indexdata.com/mkws.css" />
- <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
-~~~
-
-Then the following special `<div>`s can be added (with no content), and
-will be filled in by MKWS:
-
-* `<div id="mkwsSwitch"></div>` -- switch between record and target views
-* `<div id="mkwsLang"></div> ` -- switch between English, Danish and German
-* `<div id="mkwsSearch"></div>` -- search box and button
-* `<div id="mkwsResults"></div>` -- result list, including pager/sorting
-* `<div id="mkwsTargets"></div>` -- target list, including status
-* `<div id="mkwsStat"></div>` -- summary statistics
-
-You can configure and control the client by creating an `mkws_config`
-object before loading the widget-set. Here is an example showing how
-to use options to offer a choice between English and German UI
-languages, and to default to sorting by title ascending:
-
-~~~
- <script type="text/javascript">
- var mkws_config = {
- lang_options: ["en", "de" ],
- sort_default: "title:1"
- };
- </script>
-~~~
-
-For much more detail, see:
-[Embedded metasearching with the MasterKey Widget Set](mkws-manual.html)
-
-
-- - -
-
-Copyright 2014 Index Data ApS. <http://indexdata.com>
an existing web-site with customised searching across multiple
sources, ranking and merging the results.
-All you need to do is pull in our JavaScript and optional stylesheet,
-then add `<div>`s to your page that have special `class` attributes. We
-do the rest.
+As much of the searching functionality as possible is hosted on
+<http://mkws.indexdata.com/> so that very simple applications such as
+<http://example.indexdata.com/simple.html> can have MasterKey
+searching with minimal effort. All you need to do is pull in our
+JavaScript and optional stylesheet, then add `<div>`s to your page
+that have special `class` attributes. We do the rest.
+
+Supported Browsers
+------------------
+
+Any modern browser will work fine. JavaScript must be enabled.
+
+* IE8 or later
+* Firefox 17 or later
+* Google Chrome 27 or later
+* Safari 6 or later
+* Opera 12 or later
+* iOS 6.x (iPhone, iPad)
+* Android 4.x
+
+Not supported: IE6, IE7
A minimal example
-----------------
That's it. A complete metasearching application. Everything
else is refinement.
+Configuring a client (short version)
+------------------------------------
+
+The application's HTML must contains the following elements as well as
+whatever makes up the application itself:
+
+Prerequisites:
+
+~~~
+ <link rel="stylesheet" href="http://mkws.indexdata.com/mkws.css" />
+ <script type="text/javascript" src="http://mkws.indexdata.com/mkws-complete.js"></script>
+~~~
+
+Then the following special `<div>`s can be added (with no content), and
+will be filled in by MKWS:
+
+* `<div id="mkwsSwitch"></div>` -- switch between record and target views
+* `<div id="mkwsLang"></div> ` -- switch between English, Danish and German
+* `<div id="mkwsSearch"></div>` -- search box and button
+* `<div id="mkwsResults"></div>` -- result list, including pager/sorting
+* `<div id="mkwsTargets"></div>` -- target list, including status
+* `<div id="mkwsStat"></div>` -- summary statistics
+
+You can configure and control the client by creating an `mkws_config`
+object before loading the widget-set. Here is an example showing how
+to use options to offer a choice between English and German UI
+languages, and to default to sorting by title ascending:
+
+~~~
+ <script type="text/javascript">
+ var mkws_config = {
+ lang_options: ["en", "de" ],
+ sort_default: "title:1"
+ };
+ </script>
+~~~
+
+For much more detail, see:
+[Embedded metasearching with the MasterKey Widget Set](mkws-manual.html)
+
Documentation
-------------
* This file.
[<a href="index.pdf">PDF version</a>]
-* The <a href="README.html">README</a> -- mostly technical details.
- [<a href="README.pdf">PDF version</a>]
* The <a href="mkws-manual.html">MKWS manual, including a reference section.</a>
[<a href="mkws-manual.pdf">PDF version</a>]
* The <a href="mkws-developer.html">MKWS developers' guide.</a>
* <a href="mkws.min.js">mkws.min.js</a>
* <a href="mkws-complete.min.js">mkws-complete.min.js</a>
-Versions
---------
+### Specific versions
The links above to the various forms of the widget-set JavaScript
(<a href="mkws.js">mkws.js</a>,
body {
font-family: Gill Sans, "Gillius ADF", Gillius, GilliusADF, Sans-Serif;
}
-h1, div#header h2, h3 { font-weight: normal; color: #606060 }
+h1, h2, h3 { font-weight: normal; color: #606060 }
h2 { margin-top: 0.5em }
div#header h2 { font-size: 120% }
.pane {
The templates used by the core widgets can be viewed in [our git
repository](http://git.indexdata.com/?p=mkws.git;a=tree;f=src/mkws.templates;).
-Replacement values are documented in a comment at the top of each template so
+Parameters are documented in a comment at the top of each template so
you can see what's going where. If all you want to do is add a CSS class to
something or change a `span` to a `div` it's easy to just copy the existing
template and make your edits.
as a `<script>` tag marked with a class of `mkwsTemplate_Foo` where Foo is the
name of the template you want to override (typically the name of the widget).
Inline Handlebars templates are distinguished from Javascript via a
-`type="text/x-handlebars-template` attribute. For example, to override the
+`type="text/x-handlebars-template"` attribute. For example, to override the
Pager template you would include this in your document:
<script class="mkwsTemplate_Pager" type="text/x-handlebars-template">
The Facet template has a special feature where you can override it on a
per-facet basis by adding a dash and the facet name as a suffix eg.
-`Facet-Subjects` rather than `Facet`.
+`Facet-Subjects` rather than `Facet`. (So `class="mkwsTemplate_Facet-Subjects"`)
You can also explicitly specify a different template for a particular instance
of a widget by providing the name of your alternative (eg. SpecialPager) as the
-value of the `template` key in the MKWS config object for that widget
-(usually via the `data-mkws-config` attribute).
+value of the `template` key in the MKWS config object for that widget:
+for example, `<div class="mkwsPager" template="specialPager"/>`.
Templates for MKWS can also be
[precompiled](http://handlebarsjs.com/precompilation.html). If a precompiled
template of the same name is found in the `Handlebars.templates` object, it
will be used instead of the default.
-Templating metadata
--------------------
+Inspecting metadata for templating
+----------------------------------
MKWS makes requests to Service Proxy or Pazpar2 that perform the actual
searching. Depending on how these are configured and what is available from the
targets you are searching there may be more data available than what is
-presented by the default templates.
+presented by the default templates. In this case, you can redefine the
+`Record` template to include more fields in the full-record popup.
Handlebars offers a convenient log helper that will output the contents of a
variable for you to inspect. This lets you look at exactly what is being
index.html
-README.html
mkws-manual.html
mkws-developer.html
index.pdf
-README.pdf
mkws-manual.pdf
mkws-developer.pdf
NEWS
projects / mkws-moved-to-github.git / commitdiff