X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-manual.markdown;h=ac8ea6fc5535105c1d56f4afd3ccd69a69c8be33;hb=7307cbb1eb60bd08e24190251c9f4b5750782abc;hp=f9571bf0db23686bca753c6f8f5f761d9fdc8e1c;hpb=010d12ab52135232c38d3d0ee8a25aa772cc2449;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index f9571bf..ac8ea6f 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -40,7 +40,7 @@ extent. Against this backdrop, we introduced MKWS (the MasterKey Widget Set) -- 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 `
`s with well-known -identifiers in any HTML page, the various components of an application +MKWS classes in any HTML page, the various components of an application can be embedded: search-boxes, results areas, target information, etc. @@ -57,8 +57,8 @@ The following is a complete MKWS-based searching application: -
-
+
+
@@ -431,7 +431,7 @@ this is very simple: "//sp-mkws.indexdata.com/service-proxy/?command=auth&action=perconfig" }; -> TODO This should be the default setting: see MKWS-251. +> TODO This should be the default setting: see **MKWS-251**. And ensure that access to the MWKS application is from the correct Referrer URL or IP-range. @@ -446,10 +446,10 @@ URL containing that hostname, such as > TODO It should be possible to change just the hostname without > needing to repeat the rest of the URL (protocol, path, query): see -> MKWS-252. +> **MKWS-252**. > TODO When changing the SP authentication URL, the Pazpar2 URL should -> in general change along with it: see MKWS-253. +> in general change along with it: see **MKWS-253**. ### (Optional): embed credentials for access to the library @@ -460,7 +460,8 @@ 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. +> configuration without needing to repeat the rest of the URL: see +> **MKWS-254**. ### (Optional): conceal credentials from HTML source @@ -481,7 +482,7 @@ yourname.com: Step 1: 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] + RewriteRule /spauth/ http://sp-mkws.indexdata.com/service-proxy/?command=auth&action=check,login&username=U&password=PW [P] Step 2: set the MKWS configuration item `service_proxy_auth` to @@ -619,9 +620,9 @@ structure. 3. [10, 20, 30, 50] -4. http://mkws.indexdata.com/service-proxy-auth +4. http://sp-mkws.indexdata.com/service-proxy-auth -5. http://mkws.indexdata.com/service-proxy/ +5. http://sp-mkws.indexdata.com/service-proxy/ 6. [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]] @@ -700,19 +701,19 @@ from that toolkit. The relevant lines are:
---- -Element Type Default Description --------- ----- --------- ------------ -popup_width string 880 Width of the popup window (if used), in - pixels. +Element Type Default Description +-------- ----- ------- ------------ +popup_width string 880 Width of the popup window (if used), in + pixels. -popup_height string 760 Height of the popup window (if used), in - pixels. +popup_height string 760 Height of the popup window (if used), in + pixels. -popup_button string input.mkwsButton (Never change this.) +popup_button string `input.mkwsButton` (Never change this.) -popup_modal string 0 Modal confirmation mode. Valid values are 0 or 1 +popup_modal string 0 Modal confirmation mode. Valid values are 0 or 1 -popup_autoOpen string 1 Open popup window on load. Valid values are 0 or 1 +popup_autoOpen string 1 Open popup window on load. Valid values are 0 or 1 ---- @@ -789,4 +790,4 @@ and .CLASS indicates an instance of a class. - - - -Copyright (C) 2013-2014 by IndexData ApS, +Copyright (C) 2013-2014 by Index Data ApS,