Better formatting for final bullet list, though I can't really do this

[mkws-moved-to-github.git] / doc / library-configuration.markdown

diff --git a/doc/library-configuration.markdown b/doc/library-configuration.markdown
index 7375caa..9b863d0 100644 (file)
--- a/doc/library-configuration.markdown
+++ b/doc/library-configuration.markdown
@@ -114,7 +114,7 @@ authentication is used, this is very simple:
        <script type="text/javascript">
          var mkws_config = { service_proxy_auth:
          "//sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig" };
-        </script>
+       </script>
 
 > TODO This should be the default setting
 
@@ -125,9 +125,9 @@ Referrer URL or IP-range.
 
 When hostname-based authentication is in use, it's necessary to access
 the Service Proxy as the correctly named virtual host. This can be
-done by setting the service_proxy_auth configuration item to a
+done by setting the `service_proxy_auth` configuration item to a
 URL containing that hostname, such as
-       //yourname.sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig
+`//yourname.sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig`
 
 > TODO It should be possible to change just the hostname without
 > needing to repeat the rest of the URL (protocol, path, query)
@@ -140,8 +140,8 @@ URL containing that hostname, such as
 When credential-based authentication is in use (username and
 password), it's necessary to pass these credentials into the Service
 Proxy when establishing the session. This can most simply be done just
-by setting the service_proxy_auth configuration item to a URL such as
-       //sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig&username=mike&password=swordfish
+by setting the `service_proxy_auth` configuration item to a URL such as
+`//sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig&username=mike&password=swordfish`
 
 > TODO It should be possible to add the username and password to the
 > configuration without needing to repeat the rest of the URL.
@@ -162,13 +162,15 @@ to that local authentication URL. Here is one way to do it when
 Apache2 is the application's web-server, which we will call
 yourname.com:
 
-       - Add a rewriting authentication alias to the configuration:
-               RewriteEngine on
-               RewriteRule /spauth/ http://mkws.indexdata.com/service-proxy/?command=auth&action=check,login&username=U&password=PW [P]
-       - Set thwe MKWS configuration item "service_proxy_auth" to:
-               http://yourname.com/spauth/
-       - Protect access to the local path http://yourname.com/spauth/
-               (e.g. using a .htaccess file).
+- Add a rewriting authentication alias to the configuration:
+
+       RewriteEngine on
+       RewriteRule /spauth/ http://mkws.indexdata.com/service-proxy/?command=auth&action=check,login&username=U&password=PW [P]
+
+- Set the MKWS configuration item `service_proxy_auth` to
+  `http://yourname.com/spauth/`
+- Protect access to the local path `http://yourname.com/spauth/`
+  (e.g. using a .htaccess file).
 
 
 3. Choosing targets from the library
@@ -176,29 +178,40 @@ yourname.com:
 
 MKWS applications can choose what subset of the library's targets to
 use, by means of several alternative settings on individual widgets or
-in the mkws_config structure:
+in the `mkws_config` structure:
 
-* targets -- contains a Pazpar2 targets string, typically of the form
+* `targets` -- contains a Pazpar2 targets string, typically of the form
   "pz:id=" or "pz:id~" followed by a pipe-separated list of low-level
   target IDs.
 
   At present, these IDs can take one of two forms, depending on the
   configuration of the Service Proxy being used: they may be based on
   ZURLs, so a typical value would be something like:
+
        pz:id=josiah.brown.edu:210/innopac|lui.indexdata.com:8080/solr4/select?fq=database:4902
+
   Or they may be UDBs, so a typical value would be something like:
+
        pz:id=brown|artstor
 
-* targetfilter -- contains a CQL query which is used to find relevant
+* `targetfilter` -- contains a CQL query which is used to find relevant
   targets from the relvant library. For example,
+
        udb==Google_Images
+
   Or
+
        categories=news
 
-* target -- contains a single UDB, that of the sole target to be
+* `target` -- contains a single UDB, that of the sole target to be
   used. For example
+
        Google_Images
+
   This is merely syntactic sugar for "targetfilter" with the query
-       udb==NAME
+  `udb==NAME`
+
 
+- - -
 
+Copyright 2014 IndexData ApS. <http://indexdata.com>