Merge branch 'master' of ssh://git.indexdata.com/home/git/pub/mkws
[mkws-moved-to-github.git] / doc / mkws-manual.markdown
index 8f3cf42..2060dda 100644 (file)
@@ -65,8 +65,10 @@ The following is
         <link rel="stylesheet" href="//mkws.indexdata.com/mkws.css" />
       </head>
       <body>
-        <div class="mkwsSearch"></div>
-        <div class="mkwsResults"></div>
+        <div class="mkws-progress"></div>
+        <div class="mkws-search"></div>
+        <div class="mkws-results"></div>
+        <div class="mkws-stat"></div>
       </body>
     </html>
 
@@ -212,7 +214,7 @@ the system. For details of Handlebars template syntax, see [the online
 documentation](http://handlebarsjs.com/).
 
 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;).
+repository](http://git.indexdata.com/?p=mkws.git;a=tree;f=src/templates;).
 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
@@ -222,24 +224,24 @@ Overriding templates
 --------------------
 
 To override the template for a widget, include it inline in the document
-as a `<script>` tag marked with a class of `mkwsTemplate_Foo` where Foo is the
+as a `<script>` tag marked with a class of `mkws-template-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
-Pager template you would include this in your document:
+pager template you would include this in your document:
 
-    <script class="mkwsTemplate_Pager" type="text/x-handlebars-template">
+    <script class="mkws-template-pager" type="text/x-handlebars-template">
       ...new Pager template
     </script>
 
 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`. (So `class="mkwsTemplate_Facet-Subjects"`)
+`facet-subjects` rather than `facet`. (So `class="mkws-template-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:
-for example, `<div class="mkwsPager" template="specialPager"/>`.
+for example, `<div class="mkws-pager" template="special-pager"/>`.
 
 Templates for MKWS can also be
 [precompiled](http://handlebarsjs.com/precompilation.html). If a precompiled
@@ -278,7 +280,7 @@ Rather than use the included AJAX helpers to render record details inline,
 here's a Records template that will link directly to the source via the address
 provided in the metadata as the first element of `md-electronic-url`:
 
-    <script class="mkwsTemplate_Records" type="text/x-handlebars-template">
+    <script class="mkws-template-records" type="text/x-handlebars-template">
       {{#each hits}}
         <div class="{{containerClass}}">
           <a href="{{md-electronic-url.[0]}}">