From e289391360ca8d3232b2d5b7920697cffe2baf85 Mon Sep 17 00:00:00 2001
From: Arild Matsson <arild.matsson@gu.se>
Date: Thu, 15 Feb 2024 17:48:10 +0100
Subject: [PATCH] Invert "in order" to "in free order"

---
 CHANGELOG.md                                  |  6 ++++
 app/scripts/components/advanced_search.js     | 10 +++----
 .../components/extended/standard_extended.js  | 30 +++++++++----------
 app/scripts/components/simple_search.js       | 25 ++++++++--------
 app/translations/locale-eng.json              |  8 ++---
 app/translations/locale-swe.json              |  8 ++---
 doc/user_manual_eng.md                        |  4 +--
 doc/user_manual_swe.md                        |  4 +--
 8 files changed, 51 insertions(+), 44 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d9565bb00..0a1a3a413 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## [9.5.2-dev]
+
+### Changed
+
+- The "in order" option is inverted, so it is now "in free order" and unchecked by default (but still `in_order` in the URL query param and in the API)
+
 ## [9.5.1] - 2024-02-12
 
 ### Changed
diff --git a/app/scripts/components/advanced_search.js b/app/scripts/components/advanced_search.js
index f818c54ad..ba451c4a2 100644
--- a/app/scripts/components/advanced_search.js
+++ b/app/scripts/components/advanced_search.js
@@ -34,9 +34,9 @@ export const advancedSearchComponent = {
             on-search="$ctrl.onSearch()"
             on-search-save="$ctrl.onSearchSave(name)"
         ></search-submit>
-        <input id="inOrderChkAdv" type="checkbox" ng-model="$ctrl.inOrder" />
-        <label for="inOrderChkAdv">
-            {{'in_order_chk' | loc:$root.lang}}
+        <input id="freeOrderChkAdv" type="checkbox" ng-model="$ctrl.freeOrder" />
+        <label for="freeOrderChkAdv">
+            {{'free_order_chk' | loc:$root.lang}}
             <i
                 class="fa fa-info-circle text-gray-400"
                 uib-tooltip="{{'order_help' | loc:$root.lang}}"
@@ -52,7 +52,7 @@ export const advancedSearchComponent = {
         function (compareSearches, $location, $timeout) {
             const $ctrl = this
 
-            $ctrl.inOrder = $location.search().in_order == null
+            $ctrl.freeOrder = $location.search().in_order == null
 
             if ($location.search().search && $location.search().search.split("|")) {
                 var [type, ...expr] = $location.search().search.split("|")
@@ -69,7 +69,7 @@ export const advancedSearchComponent = {
                 $location.search("search", null)
                 $location.search("page", null)
                 $location.search("within", null)
-                $location.search("in_order", !$ctrl.inOrder ? false : null)
+                $location.search("in_order", $ctrl.freeOrder ? false : null)
                 $timeout(() => $location.search("search", `cqp|${$ctrl.cqp}`), 0)
             }
 
diff --git a/app/scripts/components/extended/standard_extended.js b/app/scripts/components/extended/standard_extended.js
index 03d367f0d..a7a3721c1 100644
--- a/app/scripts/components/extended/standard_extended.js
+++ b/app/scripts/components/extended/standard_extended.js
@@ -27,8 +27,8 @@ export const extendedStandardComponent = {
                 on-search-save="$ctrl.onSearchSave(name)"
                 disabled="$ctrl.repeatError || $ctrl.orderError"
             ></search-submit>
-            <input id="inOrderChkExt" type="checkbox" ng-model="inOrder" ng-disabled="!$ctrl.inOrderEnabled" />
-            <label for="inOrderChkExt"> {{'in_order_chk' | loc:$root.lang}}</label>
+            <input id="freeOrderChkExt" type="checkbox" ng-model="freeOrder" ng-disabled="!$ctrl.freeOrderEnabled" />
+            <label for="freeOrderChkExt"> {{'free_order_chk' | loc:$root.lang}}</label>
             <span> {{'and' | loc:$root.lang}} </span>
             <span>{{'within' | loc:$root.lang}}</span>
             <select
@@ -48,16 +48,16 @@ export const extendedStandardComponent = {
             const ctrl = this
 
             ctrl.lang = $rootScope.lang
-            $scope.inOrder = $location.search().in_order == null
-            /** Whether the "in order" option is applicable. */
-            ctrl.inOrderEnabled = true
+            $scope.freeOrder = $location.search().in_order != null
+            /** Whether the "free order" option is applicable. */
+            ctrl.freeOrderEnabled = true
             ctrl.orderError = false
 
             // TODO this is *too* weird
             function triggerSearch() {
                 $location.search("search", null)
                 $location.search("page", null)
-                $location.search("in_order", !$scope.inOrder && ctrl.inOrderEnabled ? false : null)
+                $location.search("in_order", $scope.freeOrder && ctrl.freeOrderEnabled ? false : null)
                 $timeout(function () {
                     $location.search("search", "cqp")
                     if (!_.keys(settings["default_within"]).includes(ctrl.within)) {
@@ -95,26 +95,26 @@ export const extendedStandardComponent = {
                     c.log("Error", e)
                 }
 
-                ctrl.validateInOrder()
+                ctrl.validateFreeOrder()
 
                 $location.search("cqp", cqp)
             }
 
-            $scope.$watch("inOrder", () => {
-                ctrl.validateInOrder()
+            $scope.$watch("freeOrder", () => {
+                ctrl.validateFreeOrder()
             })
 
-            /** Trigger error if the "in order" option is incompatible with the query */
-            ctrl.validateInOrder = () => {
+            /** Trigger error if the "free order" option is incompatible with the query */
+            ctrl.validateFreeOrder = () => {
                 const cqpObjs = CQP.parse(ctrl.cqp)
                 if (!CQP.supportsInOrder(cqpObjs)) {
-                    // If query doesn't support free word order, and the "in order" checkbox has been unchecked,
+                    // If query doesn't support free word order, and the "free order" checkbox is checked,
                     // then disable search, show explanation and let user resolve the conflict
-                    ctrl.orderError = !$scope.inOrder
-                    ctrl.inOrderEnabled = !$scope.inOrder
+                    ctrl.orderError = $scope.freeOrder
+                    ctrl.freeOrderEnabled = $scope.freeOrder
                 } else {
                     ctrl.orderError = false
-                    ctrl.inOrderEnabled = true
+                    ctrl.freeOrderEnabled = true
                 }
             }
 
diff --git a/app/scripts/components/simple_search.js b/app/scripts/components/simple_search.js
index 25c1fb74c..104a6ab58 100644
--- a/app/scripts/components/simple_search.js
+++ b/app/scripts/components/simple_search.js
@@ -22,12 +22,12 @@ export const simpleSearchComponent = {
                     ></search-submit>
                     <div class="opts">
                         <input
-                            id="inOrderChk"
+                            id="freeOrderChk"
                             type="checkbox"
-                            ng-model="$ctrl.inOrder"
-                            ng-disabled="!$ctrl.inOrderEnabled"
+                            ng-model="$ctrl.freeOrder"
+                            ng-disabled="!$ctrl.freeOrderEnabled"
                         />
-                        <label for="inOrderChk"> {{'in_order_chk' | loc:$root.lang}}</label>
+                        <label for="freeOrderChk"> {{'free_order_chk' | loc:$root.lang}}</label>
                         <span> {{'and' | loc:$root.lang}} </span>
                         <span> {{'and_include' | loc:$root.lang}} </span>
                         <input id="prefixChk" type="checkbox" ng-model="$ctrl.prefix" />
@@ -89,9 +89,10 @@ export const simpleSearchComponent = {
                 ctrl.onChange(event.value, false)
             })
 
-            ctrl.inOrder = $location.search().in_order == null
-            /** Whether the "in order" option is applicable. */
-            ctrl.inOrderEnabled = false
+            /** Whether tokens should be matched in arbitrary order. */
+            ctrl.freeOrder = $location.search().in_order != null
+            /** Whether the "free order" option is applicable. */
+            ctrl.freeOrderEnabled = false
             ctrl.prefix = $location.search().prefix != null
             ctrl.mid_comp = $location.search().mid_comp != null
             ctrl.suffix = $location.search().suffix != null
@@ -104,7 +105,7 @@ export const simpleSearchComponent = {
 
             // triggers watch on searches.activeSearch
             ctrl.updateSearch = function () {
-                $location.search("in_order", !ctrl.inOrder && ctrl.inOrderEnabled ? false : null)
+                $location.search("in_order", ctrl.freeOrder && ctrl.freeOrderEnabled ? false : null)
                 $location.search("prefix", ctrl.prefix ? true : null)
                 $location.search("mid_comp", ctrl.mid_comp ? true : null)
                 $location.search("suffix", ctrl.suffix ? true : null)
@@ -233,7 +234,7 @@ export const simpleSearchComponent = {
                         ctrl.lemgram = search.val
                     }
                     $rootScope.simpleCQP = CQP.expandOperators(ctrl.getCQP())
-                    ctrl.updateInOrderEnabled()
+                    ctrl.updateFreeOrderEnabled()
                     ctrl.doSearch()
                 }
             })
@@ -247,12 +248,12 @@ export const simpleSearchComponent = {
                     ctrl.currentText = null
                 }
 
-                ctrl.updateInOrderEnabled()
+                ctrl.updateFreeOrderEnabled()
             }
 
-            ctrl.updateInOrderEnabled = () => {
+            ctrl.updateFreeOrderEnabled = () => {
                 const cqpObjs = CQP.parse(ctrl.getCQP() || "[]")
-                ctrl.inOrderEnabled = CQP.supportsInOrder(cqpObjs)
+                ctrl.freeOrderEnabled = CQP.supportsInOrder(cqpObjs)
             }
 
             ctrl.doSearch = function () {
diff --git a/app/translations/locale-eng.json b/app/translations/locale-eng.json
index 8cf591b46..4ba0594eb 100644
--- a/app/translations/locale-eng.json
+++ b/app/translations/locale-eng.json
@@ -346,8 +346,8 @@
     "add_filter_value": "Add",
 
     "repeat_error": "Error: Not possible to repeat from 0 for all tokens.",
-    "order_error": "Error: Disabling \"in order\" requires multiple tokens, no repetition, no boundaries and no wildcards.",
-    "order_help": "Disabling the \"in order\" option is compatible with queries that have multiple tokens, no repetition, no boundaries and no wildcards.",
+    "order_error": "Error: The \"in free order\" option requires multiple tokens, no repetition, no boundaries and no wildcards.",
+    "order_help": "The \"in free order\" option is compatible with queries that have multiple tokens, no repetition, no boundaries and no wildcards.",
 
     "choose_value": "Choose a value",
     "login_needed_for_corpora": "Login needed for access to",
@@ -358,13 +358,13 @@
     "go_to_start": "Go to start page",
 
     "stats_warn": "Statistics is disabled",
-    "stats_not_in_order_warn": "Statistics is currently not supported when \"in order\" is disabled.",
+    "stats_not_in_order_warn": "Statistics currently do not support the \"in free order\" search option.",
 
     "read_in_strix": "Read this text in Strix",
     "read_in_korp": "Read this text in Korp",
     "add_token": "Add token",
 
-    "in_order_chk": "in order",
+    "free_order_chk": "in free order",
     "prefix_chk": "initial part",
     "compound_middle": "medial part",
     "suffix_chk": "final part",
diff --git a/app/translations/locale-swe.json b/app/translations/locale-swe.json
index 47efddf31..0f350c485 100644
--- a/app/translations/locale-swe.json
+++ b/app/translations/locale-swe.json
@@ -344,8 +344,8 @@
     "add_filter_value": "Lägg till",
 
     "repeat_error": "Fel: Det går inte att upprepa från 0 på alla token.",
-    "order_error": "Fel: Det går bara att välja bort \"i följd\" om sökfrågan har flera tokens samt inga repetitioner, gränser eller tomma token.",
-    "order_help": "Att välja bort \"i följd\" är kompatibelt med sökfrågor som har flera tokens samt inga repetitioner, gränser eller tomma token.",
+    "order_error": "Fel: Alternativet \"i fri följd\" fungerar bara om sökfrågan har flera tokens samt inga repetitioner, gränser eller tomma token.",
+    "order_help": "Alternativet \"i fri följd\" är kompatibelt med sökfrågor som har flera tokens samt inga repetitioner, gränser eller tomma token.",
 
     "choose_value": "Välj ett värde",
     "login_needed_for_corpora": "Inloggning behövs för åtkomst till",
@@ -356,13 +356,13 @@
     "go_to_start": "Gå till startsidan",
 
     "stats_warn": "Statistiken är avaktiverad",
-    "stats_not_in_order_warn": "Statistiken stödjs för nuvarande inte när \"i följd\" är avaktiverad.",
+    "stats_not_in_order_warn": "Statistiken stödjer för närvarande inte sökalternativet \"i fri följd\".",
 
     "read_in_strix": "Läs texten i Strix",
     "read_in_korp": "Läs i Korp",
     "add_token": "Lägg till token",
 
-    "in_order_chk": "i följd",
+    "free_order_chk": "i fri följd",
     "prefix_chk": "förled",
     "compound_middle": "mellanled",
     "suffix_chk": "efterled",
diff --git a/doc/user_manual_eng.md b/doc/user_manual_eng.md
index bd824379d..f3b561d76 100644
--- a/doc/user_manual_eng.md
+++ b/doc/user_manual_eng.md
@@ -55,9 +55,9 @@ the search button or hitting Enter.
 
 Below the search field are a selection of check boxes, giving you a few options for your search.
 
-**In order**
+**In free order**
 When searching for more than one word, the default search requires all words to occur in exactly the given order next to each
-other. By unchecking the *in order* box, the search will instead find all sentences containing the search words, but the
+other. By checking the *in free order* box, the search will instead find all sentences containing the search words, but the
 order does not matter, and they do not need to be next to each other.
 
 **Initial part and final part**
diff --git a/doc/user_manual_swe.md b/doc/user_manual_swe.md
index 87a5dcdba..91e2bf4f5 100644
--- a/doc/user_manual_swe.md
+++ b/doc/user_manual_swe.md
@@ -59,10 +59,10 @@ För att göra en lemgramsökning väljer man ett av dessa med piltangenterna sa
 
 Under sökfältet finns ett antal kryssrutor med inställningsmöjligheter för ens sökning.
 
-**I följd**  
+**I fri följd**
 Vid sökning på fler än ett ord görs som standard en frassökning, vilket innebär att man enbart får träffar där sökorden
 förekommer i exakt den ordning man angivit, och direkt efter varandra.
-Genom att kryssa ur rutan *i följd* söks det i stället efter meningar som innehåller samtliga
+Genom att kryssa i rutan *i fri följd* söks det i stället efter meningar som innehåller samtliga
 sökord, i valfri ordning och inte nödvändigtvis intill varandra.
 
 **Förled och efterled**