From e87e41ac4d90e6a4dcd979676b11dd9d04c98c27 Mon Sep 17 00:00:00 2001
From: Mike Taylor <mike@indexdata.com>
Date: Wed, 9 Oct 2013 11:09:15 +0100
Subject: [PATCH] Rename more options for consistency: 	lang_display ->
 lang_options 	perpage -> perpage_options 	sort ->
 sort_options

---
 examples/htdocs/index-mobile.html |    2 +-
 tools/htdocs/README.markdown      |    4 ++--
 tools/htdocs/mkws.js              |   26 +++++++++++++-------------
 tools/htdocs/whitepaper.markdown  |    6 +++---
 4 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/examples/htdocs/index-mobile.html b/examples/htdocs/index-mobile.html
index 79a6b39..e6c300e 100644
--- a/examples/htdocs/index-mobile.html
+++ b/examples/htdocs/index-mobile.html
@@ -12,7 +12,7 @@
 		debug: 1,
 		use_service_proxy: true,
 		show_lang: true,
-		lang_display: ["da", "en"],
+		lang_options: ["da", "en"],
 		sort_default: "relevance",
 		query_width: 50,
 		responsive_design: true,
diff --git a/tools/htdocs/README.markdown b/tools/htdocs/README.markdown
index b349bf5..882592b 100644
--- a/tools/htdocs/README.markdown
+++ b/tools/htdocs/README.markdown
@@ -64,7 +64,7 @@ possible options:
 		show_lang: true, 	    /* true, false: show/hide language menu */
 		show_sort: true, 	    /* true, false: show/hide sort menu */
 		show_perpage: true, 	    /* true, false: show/hide perpage menu */
-		lang_display: ["en", "de", "da"], /* display languages links for given
+		lang_options: ["en", "de", "da"], /* display languages links for given
 						     languages, [] for all */
 		facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
 		sort_default: "relevance",  /* "relevance", "title:1", "date:0", "date:1" */
@@ -77,7 +77,7 @@ possible options:
 		pazpar2_url: "/pazpar2/search.pz2",   	   /* URL */
 		service_proxy_url: "/service-proxy/", 	   /* URL */
 		service_proxy_auth: "/service-proxy-auth", /* URL */
-		// TODO: language_*, perpage, responsive_design_width, sort
+		// TODO: language_*, perpage_options, responsive_design_width, sort_options
 	    };
 	</script>
 ~~~
diff --git a/tools/htdocs/mkws.js b/tools/htdocs/mkws.js
index 0e0dfa1..71daa52 100644
--- a/tools/htdocs/mkws.js
+++ b/tools/htdocs/mkws.js
@@ -563,15 +563,15 @@ function mkws_html_all(config) {
      * and of course the optional language_* entries.
      */
     var mkws_config_default = {
-	sort: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
-	perpage: [10, 20, 30, 50],
+	sort_options: [["relevance"], ["title:1", "title"], ["date:0", "newest"], ["date:1", "oldest"]],
+	perpage_options: [10, 20, 30, 50],
 	sort_default: "relevance",
 	perpage_default: 20,
 	query_width: 50,
 	show_lang: true, 	/* show/hide language menu */
 	show_sort: true, 	/* show/hide sort menu */
 	show_perpage: true, 	/* show/hide perpage menu */
-	lang_display: [], 	/* display languages links for given languages, [] for all */
+	lang_options: [], 	/* display languages links for given languages, [] for all */
 	facets: ["sources", "subjects", "authors"], /* display facets, in this order, [] for none */
 	responsive_design_width: 980, /* a page with less pixel width considered as narrow */
 	debug: 1,     /* debug level for development: 0..2 */
@@ -713,9 +713,9 @@ function mkws_html_sort(config) {
     debug("HTML sort");
     var sort_html = '<select name="mkwsSort" id="mkwsSort">';
 
-    for(var i = 0; i < config.sort.length; i++) {
-	var key = config.sort[i][0];
-	var val = config.sort[i].length == 1 ? config.sort[i][0] : config.sort[i][1];
+    for(var i = 0; i < config.sort_options.length; i++) {
+	var key = config.sort_options[i][0];
+	var val = config.sort_options[i].length == 1 ? config.sort_options[i][0] : config.sort_options[i][1];
 
 	sort_html += '<option value="' + key + '"';
 	if (key == config.sort_default) {
@@ -732,8 +732,8 @@ function mkws_html_perpage(config) {
     debug("HTML perpage");
     var perpage_html = '<select name="mkwsPerpage" id="mkwsPerpage">';
 
-    for(var i = 0; i < config.perpage.length; i++) {
-	var key = config.perpage[i];
+    for(var i = 0; i < config.perpage_options.length; i++) {
+	var key = config.perpage_options[i];
 
 	perpage_html += '<option value="' + key + '"';
 	if (key == config.perpage_default) {
@@ -785,19 +785,19 @@ function mkws_html_lang(mkws_config) {
     var list = [];
 
     /* display a list of configured languages, or all */
-    var lang_display = mkws_config.lang_display || [];
+    var lang_options = mkws_config.lang_options || [];
     var hash = {};
-    for (var i = 0; i < lang_display.length; i++) {
-	hash[lang_display[i]] = 1;
+    for (var i = 0; i < lang_options.length; i++) {
+	hash[lang_options[i]] = 1;
     }
 
     for (var k in mkws.locale_lang) {
-	if (hash[k] == 1 || lang_display.length == 0)
+	if (hash[k] == 1 || lang_options.length == 0)
 	    list.push(k);
     }
 
     // add english link
-    if (lang_display.length == 0 || hash[lang_default] == 1)
+    if (lang_options.length == 0 || hash[lang_default] == 1)
         list.push(lang_default);
 
     debug("Language menu for: " + list.join(", "));
diff --git a/tools/htdocs/whitepaper.markdown b/tools/htdocs/whitepaper.markdown
index 7185310..8cf15fc 100644
--- a/tools/htdocs/whitepaper.markdown
+++ b/tools/htdocs/whitepaper.markdown
@@ -289,7 +289,7 @@ 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.
 
 show_lang                bool    true      Indicates whether or not to display the language menu. ### We should get rid of this
@@ -303,7 +303,7 @@ 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
@@ -329,7 +329,7 @@ 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`.
 
-- 
1.7.10.4