X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=tools%2Fhtdocs%2Fwhitepaper.markdown;h=ea4b6c7c25bcbb3c469d6395865611bfff65f52d;hb=5148298147f8d0a13b1d1ba56595c0dc3c3671fc;hp=7487a2da48932cab2393c6af3f1f51356882418c;hpb=287904816476333f1b699d3ce612418059cf51d3;p=mkws-moved-to-github.git diff --git a/tools/htdocs/whitepaper.markdown b/tools/htdocs/whitepaper.markdown index 7487a2d..ea4b6c7 100644 --- a/tools/htdocs/whitepaper.markdown +++ b/tools/htdocs/whitepaper.markdown @@ -290,9 +290,6 @@ lang string en Code of the default language to displ lang_options array [] A list of the languages to offer as options. If empty (the default), then all configured languages are listed. -show_lang bool true Indicates whether or not to display the language menu. ### We should get rid of this - setting, and simply display the menu if there's an `mkwsLang` element. - language_* hash Support for any number of languages can be added by providing entries whose name is `language_` followed by the code of the language. See the separate section below for details. @@ -302,13 +299,10 @@ pazpar2_url string *Note 2* The URL used to access the metasearch MasterKey Service Proxy, which mediates access to an underlying Pazpar2 instance. In the latter case, `service_proxy_auth` must be provided. -perpage_options array *Note 3* A list of candidate page sizes. Users can choose between these to determine how many - records are displayed on each page of results. - perpage_default string 20 The initial value for the number of records to show on each page. -show_perpage bool true Indicates whether or not to display the perpage menu. ### We should get rid of this - setting, and simply display the menu if an appropriate container is provided. +perpage_options array *Note 3* A list of candidate page sizes. Users can choose between these to determine how many + records are displayed on each page of results. query_width int 50 The width of the query box, in characters. @@ -320,22 +314,30 @@ service_proxy_auth url *Note 4* A URL which, when `use_service_proxy` session to authenticate the user and establish a session that encompasses a defined set of targets to search in. -sort_options array *Note 6* List of supported sort criteria. Each element of the list is itself a two-element list: - the first element of each sublist is a pazpar2 sort-expression such as `data:0` and - the second is a human-readable label such as `newest`. +show_lang bool true Indicates whether or not to display the language menu. + +show_perpage bool true Indicates whether or not to display the perpage menu. + +show_sort bool true Indicates whether or not to display the sort menu. sort_default string relevance The label of the default sort criterion to use. Must be one of those in the `sort` array. -show_sort bool true Indicates whether or not to display the sort menu. ### We should get rid of this - setting, and simply display the menu if an appropriate container is provided. +sort_options array *Note 6* List of supported sort criteria. Each element of the list is itself a two-element list: + the first element of each sublist is a pazpar2 sort-expression such as `data:0` and + the second is a human-readable label such as `newest`. use_service_proxy bool true If true, then a Service Proxy is used to deliver searching services rather than raw - Pazpar2. ### Do we even need this? Can't we just assume that the Service Proxy is in - use when and only when `service_proxy_auth` is defined? Alternatively, retain this, but - use the same entry to specify the URL in either case. + Pazpar2. --- +Perhaps we should get rid of the `show_lang`, `show_perpage` and +`show_sort` configuration items, and simply display the relevant menus +only when their containers are provided -- e.g. an `mkwsLang` element +for the language menu. But for now we retain these, as an easier route +to lightly customise the display than my changing providing a full HTML +structure. + #### Notes 1. ["sources", "subjects", "authors"]