X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fmkws-manual.markdown;h=6cd4cb845f0e479b40e476240dced73495539646;hb=6e1097342651674ed21366e39e4c05dfa9b3180c;hp=99513df2250ecc1884728180e57b693ea9b0cf78;hpb=4428c73bfc09fb75a81daab4711268f58657c80b;p=mkws-moved-to-github.git diff --git a/doc/mkws-manual.markdown b/doc/mkws-manual.markdown index 99513df..6cd4cb8 100644 --- a/doc/mkws-manual.markdown +++ b/doc/mkws-manual.markdown @@ -41,7 +41,7 @@ flexibility against convenience: [Drupal](https://www.drupal.org/) sites. -All of these approaches require programming to a greater or lesser +All but the last of these approaches require programming to a greater or lesser 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 @@ -171,22 +171,6 @@ is part of the `aux` team. Widgets that do not have a team specified (as in the examples above) are placed in the team called `AUTO`. -Old and new-style class-names ------------------------------ - -**NOTE.** Versions of MKWS before v1.0 used camel-case class-names: -without hyphens and with second and subsequent words capitalised. So -instead of `mkws-search`, it used to be `mkwsSearch`. And the classes -used to specify team names used an `mkwsTeam_` prefix (with an -underscore). So instead of `mkws-team-foo`, it used to be -`mkwsTeam_foo`. - -The 1.x series of MKWS releases recognise these old-style class-names -as well as the canonical ones, as a facility for backwards -compatibility. However, **these old class-names are deprecated, and -support will be removed in v2.0**. Existing applications that use them -should be upgraded to the new-style class names as soon as convenient. - Configuring widgets =================== @@ -943,11 +927,6 @@ pp2_path _global_ string *Note 4* Unless overridden by the ` Proxy). Set this to connect to a service on a different host from the default. -responsive_design_width _global_ int If defined, then the facets display moves between two locations as the - screen-width varies. The specified number is the threshhold width, in - pixels, at which the facets move between their two locations. The `switch` - and `lang` widgets also disappear entirely below this threshhold. - scan_all_nodes _global_ bool false An internal setting that changes how MKWS scans the HTML documen to discover widgets. If set to true, a different approach is used which may be faster under some circumstances. @@ -1037,8 +1016,6 @@ template details, string Numerous widgets use Handl switch, targets - - text builder string "Build!" Specifies what text to use for the Builder button. use_service_proxy _global_ bool true If true, then a Service Proxy is used to deliver searching services rather @@ -1057,25 +1034,49 @@ customise the display than by providing a full HTML structure. 3. The default for `pp2_hostname` is `"sp-mkws.indexdata.com"` -4. The default for `pp2_path` is `"service-proxy"` +4. The default for `pp2_path` is `"service-proxy/"` 5. The default for `sort_options` is `[["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]]` -6. The default for `sp_auth_path` is `"service-proxy/"`. +6. The default for `sp_auth_path` is `"service-proxy/"` -7. The default for `sp_auth_query` is `"command=auth&action=perconfig"`. +7. The default for `sp_auth_query` is `"command=auth&action=perconfig"` ### Indirect settings The values of any setting are generally interpreted literally. However, it is possible to specify a value indirectly -- for -example, by reference to a query parameter -- and this is often useful in contexts such as specifying an autosearch query. FIXME -say more. +example, by reference to a query parameter -- and this is often useful in contexts such as specifying an autosearch +query. Settings of this kind have values beginning with an exclamation mark, and take the form `!`_type_`!`_value_. + +The currently supported types are: + +* `param` -- uses the value of the specified query parameter for the URL. For example +`