Browse Source

Make rabbinic the default style; add documentation for option type.

scossu 1 year ago
parent
commit
94635e6f5b
2 changed files with 8 additions and 2 deletions
  1. 7 1
      doc/config.md
  2. 1 1
      scriptshifter/tables/data/hebrew.yml

+ 7 - 1
doc/config.md

@@ -139,7 +139,13 @@ are used in the built-in API:
 - `id`: the option ID used as a HTML tag ID and as a variable name.
 - `label`: human-readable label usable in a UI.
 - `description`: description usable in a UI. Optional.
-- `type`: unused at the moment.
+- `type`: at the moment, if this is set to `list`, a select widget shall be
+  generated in the UI. An additional `options` key (see below) with the
+  individual options will be required. Any other value generates a single-line
+  text field.
+- `options`: list of maps, each representing a selectable option in the drop-
+  down menu when the type is `list`. Each list item has an `id` and a `label`
+  key, used respectively as the input value and human-readable label.
 - `default`: The default value that should be set for the option in a UI. Note
   that this does not set a default value in an API call [TODO].
 

+ 1 - 1
scriptshifter/tables/data/hebrew.yml

@@ -12,7 +12,7 @@ options:
         label: Rabbinic
       - id: modern
         label: Modern
-    default: modern
+    default: rabbinic
 
 script_to_roman:
   hooks: