Expand widget clauses: "phrase" -> "clause"

Co-authored-by: Eric Pierce <[email protected]>

Author: dseguin

data/json/ui/bodypart_status.json

@@ -2,8 +2,8 @@
   {
     "id": "bodypart_status_indicator_template",
     "type": "widget",
-    "style": "phrase",
-    "phrases": [
+    "style": "clause",
+    "clauses": [
       { "id": "bitten", "text": "bitten", "sym": "B", "color": "yellow", "condition": { "u_has_effect": "bite" } },
       {
         "id": "infected",
@@ -78,7 +78,7 @@
     "//": "Base widget for showing body part status; needs bodypart field defined in derived widget.",
     "type": "widget",
     "style": "text",
-    "default_phrase": { "text": "--" },
+    "default_clause": { "text": "--" },
     "copy-from": "bodypart_status_indicator_template"
   },
   {

data/mods/TEST_DATA/widgets.json

@@ -2,8 +2,8 @@
   {
     "id": "test_bp_status_indicator_template",
     "type": "widget",
-    "style": "phrase",
-    "phrases": [
+    "style": "clause",
+    "clauses": [
       { "id": "bitten", "text": "bitten", "sym": "B", "color": "yellow", "condition": { "u_has_effect": "bite" } },
       {
         "id": "infected",
@@ -410,7 +410,7 @@
     "label": "TORSO STATUS",
     "bodypart": "torso",
     "style": "text",
-    "default_phrase": { "text": "--" },
+    "default_clause": { "text": "--" },
     "copy-from": "test_bp_status_indicator_template"
   },
   {
@@ -419,7 +419,7 @@
     "label": "LEFT ARM STATUS",
     "bodypart": "arm_l",
     "style": "text",
-    "default_phrase": { "text": "--" },
+    "default_clause": { "text": "--" },
     "copy-from": "test_bp_status_indicator_template"
   },
   {
@@ -467,12 +467,12 @@
     "height": 3
   },
   {
-    "id": "test_phrase_number",
+    "id": "test_clause_number",
     "type": "widget",
     "style": "number",
     "label": "Num Values",
-    "default_phrase": { "value": 1, "color": "dark_gray" },
-    "phrases": [
+    "default_clause": { "value": 1, "color": "dark_gray" },
+    "clauses": [
       { "value": -20, "color": "red_red", "condition": { "not": "u_can_see" } },
       { "value": -10, "color": "i_yellow", "condition": "u_is_deaf" },
       { "value": 0, "color": "yellow", "condition": "is_day" },
@@ -481,12 +481,12 @@
     ]
   },
   {
-    "id": "test_phrase_text",
+    "id": "test_clause_text",
     "type": "widget",
     "style": "text",
     "label": "Text Values",
-    "default_phrase": { "text": "None", "color": "dark_gray" },
-    "phrases": [
+    "default_clause": { "text": "None", "color": "dark_gray" },
+    "clauses": [
       { "text": "blind", "color": "red_red", "condition": { "not": "u_can_see" } },
       { "text": "deaf", "color": "i_yellow", "condition": "u_is_deaf" },
       { "text": "daylight", "color": "yellow", "condition": "is_day" },
@@ -495,12 +495,12 @@
     ]
   },
   {
-    "id": "test_phrase_sym",
+    "id": "test_clause_sym",
     "type": "widget",
     "style": "symbol",
     "label": "Symbol Values",
-    "default_phrase": { "sym": ".", "color": "dark_gray" },
-    "phrases": [
+    "default_clause": { "sym": ".", "color": "dark_gray" },
+    "clauses": [
       { "sym": "<", "color": "red_red", "condition": { "not": "u_can_see" } },
       { "sym": "-", "color": "i_yellow", "condition": "u_is_deaf" },
       { "sym": "=", "color": "yellow", "condition": "is_day" },
@@ -509,14 +509,14 @@
     ]
   },
   {
-    "id": "test_phrase_legend",
+    "id": "test_clause_legend",
     "type": "widget",
     "style": "legend",
     "label": "Legend Values",
     "height": 5,
     "width": 0,
-    "default_phrase": { "text": "None", "sym": ".", "color": "dark_gray" },
-    "phrases": [
+    "default_clause": { "text": "None", "sym": ".", "color": "dark_gray" },
+    "clauses": [
       { "text": "blind", "sym": "<", "color": "red_red", "condition": { "not": "u_can_see" } },
       { "text": "deaf", "sym": "-", "color": "i_yellow", "condition": "u_is_deaf" },
       { "text": "daylight", "sym": "=", "color": "yellow", "condition": "is_day" },
@@ -556,7 +556,7 @@
   {
     "id": "test_text_widget",
     "type": "widget",
-    "label": "PHRASE",
+    "label": "CLAUSE",
     "style": "text",
     "strings": [ "Zero", "One", "Two", "Three", "Four", "Five", "Six", "Seven", "Eight", "Nine", "Ten" ]
   },

doc/SIDEBAR_MOD.md

@@ -14,9 +14,9 @@
   - [alignment](#text_align--label_align)
   - [colors](#colors)
   - [flags](#flags)
-- [Phrases and conditions](#phrases-and-conditions)
+- [Clauses and conditions](#clauses-and-conditions)
   - [Conditions](#conditions)
-  - [Default phrase](#default-phrase)
+  - [Default clause](#default-clause)
 - [Variable ranges](#variable-ranges)
 - [Variables](#variables)
   - [Numeric variables](#numeric-variables)
@@ -77,7 +77,7 @@ Each widget has a "style" field that may be:
 - `layout`: Layout container for arranging other widgets in rows or columns
 - `sidebar`: Special top-level widget for defining custom sidebars
 
-"style" can also be `symbol` or `legend`, which are specific to [phrases](#phrases-and-conditions).
+"style" can also be `symbol` or `legend`, which are specific to [clauses](#clauses-and-conditions).
 
 Let's start at the top, with the "sidebar" widget, composed of several "layout" widgets.
 
@@ -511,26 +511,20 @@ Here are some flags that can be included:
 | `W_DYNAMIC_HEIGHT` | Allows certain multi-line widgets to dynamically adjust their height
 
 
-# Phrases and conditions
+# Clauses and conditions
 
-Widgets can take advantage of "phrases" - definitions for what text/values to display and
+Widgets can take advantage of "clauses" - definitions for what text/values to display and
 how to display them. These take the form of a nested object containing several optional fields:
 
 ```json
 {
   "id": "bp_status_indicator_template",
   "type": "widget",
   "style": "text",
-  "phrases": [
-    { "id": "bitten", "text": "bitten", "sym": "B", "color": "yellow", "condition": { ... } },
-    { "id": "infected", "text": "infected", "sym": "I", "color": "pink", "condition": { ... } },
-    { "id": "broken", "text": "broken", "sym": "%", "color": "magenta", "condition": { ... } },
-    { "id": "splinted", "text": "splinted", "sym": "=", "color": "light_gray", "condition": { ... } },
-    { "id": "bandaged", "text": "bandaged", "sym": "+", "color": "white", "condition": { ... } },
-    { "id": "disinfected", "text": "disinfected", "sym": "$", "color": "light_green", "condition": { ... } },
-    { "id": "bleeding", "text": "bleeding", "value": 0, "sym": "b", "color": "light_red", "condition": { ... } },
-    { "id": "bleeding", "text": "bleeding", "value": 11, "sym": "b", "color": "red", "condition": { ... } },
-    { "id": "bleeding", "text": "bleeding", "value": 21, "sym": "b", "color": "red_red", "condition": { ... } }
+  "clauses": [
+    { "id": "bitten", "text": "bitten", "sym": "B", "color": "yellow", "condition": "..." },
+    { "id": "infected", "text": "infected", "sym": "I", "color": "pink", "condition": "..." },
+    { "id": "bandaged", "text": "bandaged", "sym": "+", "color": "white", "condition": "..." }
   ]
 }
 ```
@@ -540,36 +534,36 @@ which provides text and color definitions for different bodypart status conditio
 
 | JSON Field  | Description
 |---          |---
-| `id`        | An optional identifier for this phrase
+| `id`        | An optional identifier for this clause
 | `text`      | Translated text that may be interpreted and displayed in the widget.
 | `sym`       | A shortened symbol representing the text.
-| `color`     | Defines the color for the text derived from this "phrase".
-| `value`     | A numeric value for this "phrase", which may be interpreted differently based on the context of the parent widget.
-| `condition` | A dialogue condition (see [Dialogue conditions](NPCs.md#dialogue-conditions)) that dictates whether this phrase will be used or not. If the condition is true (or when no condition is defined), the phrase can be used to its text/symbol/color in the widget's value.
+| `color`     | Defines the color for the text derived from this "clause".
+| `value`     | A numeric value for this "clause", which may be interpreted differently based on the context of the parent widget.
+| `condition` | A dialogue condition (see [Dialogue conditions](NPCs.md#dialogue-conditions)) that dictates whether this clause will be used or not. If the condition is true (or when no condition is defined), the clause can be used to its text/symbol/color in the widget's value.
 
 
 ## Conditions
 
-Widget phrases and conditions can be used to define new widgets completely from JSON, using
+Widget clauses and conditions can be used to define new widgets completely from JSON, using
 [dialogue conditions](NPCs.md#dialogue-conditions). By omitting the widget's `var` field, the
 widget is interpreted as either a "text", "number", "symbol", or "legend" depending on the given
-`style`. The widget will evaluate each of its phrases to determine which ones to draw values from:
+`style`. The widget will evaluate each of its clauses to determine which ones to draw values from:
 
-| Widget style | Phrase field used    | Details | Example
+| Widget style | Clause field used    | Details | Example
 |---           |---                   |---      |---
-| `"number"`   | `"value"`            | Lists values as comma-separated-values from all phrases that have true conditions. | `Next threshold: 30, 40, 55`
-| `"text"`     | `"text"`             | Lists text as comma-separated-values from all phrases that have true conditions. | `TORSO: bleeding, broken, infected`
-| `"symbol"`   | `"sym"`              | Lists syms sequentially from all phrases that have true conditions. | `TORSO: b%I`
-| `"legend"`   | `"sym"` and `"text"` | Lists syms and text in a paragraph format, with spaces between pairs, from all phrases that have true conditions. | `b bleeding  % broken  I infected`
+| `"number"`   | `"value"`            | Lists values as comma-separated-values from all clauses that have true conditions. | `Next threshold: 30, 40, 55`
+| `"text"`     | `"text"`             | Lists text as comma-separated-values from all clauses that have true conditions. | `TORSO: bleeding, broken, infected`
+| `"symbol"`   | `"sym"`              | Lists syms sequentially from all clauses that have true conditions. | `TORSO: b%I`
+| `"legend"`   | `"sym"` and `"text"` | Lists syms and text in a paragraph format, with spaces between pairs, from all clauses that have true conditions. | `b bleeding  % broken  I infected`
 
 Widgets using the `legend` style can be multiple lines high using a `height` > 1 (and optionally, the `W_DYNAMIC_HEIGHT` flag), so that the generated list can span the given vertical space.
 
-Some conditions can be specific to certain bodyparts. In order to simplify phrases, these conditions can pull from the parent widget's `bodypart` field (or `bodyparts` field if defining multiple). This allows the same phrases to be `copy-from`'d to multiple widgets, and each widget can display the phrases depending on whether its bodypart(s) passes the condition (assuming the condition relies on a bodypart).
+Some conditions can be specific to certain bodyparts. In order to simplify clauses, these conditions can pull from the parent widget's `bodypart` field (or `bodyparts` field if defining multiple). This allows the same clauses to be `copy-from`'d to multiple widgets, and each widget can display the clauses depending on whether its bodypart(s) passes the condition (assuming the condition relies on a bodypart).
 
 
-## Default phrase
+## Default clause
 
-Widgets can define a default phrase that will be used if none of the phrases in the `phrases`
+Widgets can define a default clause that will be used if none of the clauses in the `clauses`
 array pass their conditions:
 
 ```json
@@ -578,7 +572,7 @@ array pass their conditions:
   "type": "widget",
   "style": "text",
   "label": "Observation",
-  "phrases": [
+  "clauses": [
     {
       "text": "Good!",
       "color": "light_green",
@@ -590,7 +584,7 @@ array pass their conditions:
       "condition": { "u_has_trait": "UNOBSERVANT" }
     }
   ],
-  "default_phrase": {
+  "default_clause": {
     "text": "Neutral!",
     "color": "white"
   }