Remove outdated comment.
[mkws-moved-to-github.git] / tools / htdocs / whitepaper.markdown
index 9345cba..6f9e0c7 100644 (file)
@@ -289,10 +289,10 @@ lang                     string  en        Code of the default language to displ
                                            English, `de` = German, `da` = Danish, and whatever additional languages are configured
                                            using `language_*` entries (see below).
 
-lang_display             array   []        A list of the languages to offer as options. If empty (the default), then all
+lang_options             array   []        A list of the languages to offer as options. If empty (the default), then all
                                            configured languages are listed.
 
-lang_menu                bool    true      Indicates whether or not to display the language menu. ### We should get rid of this
+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
@@ -303,14 +303,12 @@ pazpar2_url              string  *Note 2*  The URL used to access the metasearch
                                            It's silly that you have to provide a different setting depending on whether
                                            `use_service_proxy` is set. Should just use pazpar2_url in all cases.
 
-perpage                  array   *Note 3*  A list of candidate page sizes. Users can choose between these to determine how many
+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. ### The `perpage` and
-                                           `perpage_default` entries should be renamed `perpage_display` and `perpage`
-                                           respectively for consistency with the language-related settings.
+perpage_default          string  20        The initial value for the number of records to show on each page.
 
-perpage_menu             bool    true      Indicates whether or not to display the perpage menu. ### We should get rid of this
+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.
 
 query_width              int     50        The width of the query box, in characters.
@@ -329,14 +327,14 @@ service_proxy_auth       url     *Note 4*  A URL which, when `use_service_proxy`
 service_proxy_url        string  *Note 5*  The URL on which the service proxy is accessed if `use_service_proxy` is true. This
                                            service must be configured to provide search results, facets, etc.
 
-sort                     array   *Note 6*  List of supported sort criteria. Each element of the list is itself a two-element list:
+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`.
 
 sort_default             string  relevance The label of the default sort criterion to use. Must be one of those in the `sort`
                                            array.
 
-sort_menu                bool    true      Indicates whether or not to display the sort menu. ### We should get rid of this
+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.
 
 use_service_proxy        bool    true      If true, then a Service Proxy is used to deliver searching services rather than raw