SettingsInterface

Author: peter-lyons-kehl

InstallFramework.md

@@ -26,21 +26,13 @@ There are two methods for this. The simpler one manages it through text file(s),
 
 An alternative method is Firefox profile-based configuration set(s), controlled through GUI. It can also override any {{valuesManifest}}s. It's done through {{navAssociationsManifests}}. However, using GUI (for any part of configuration) usually requires the whole configuration to be in two stages.
 
-## Configure SeLite to load the framework ##
+## Configure loading the framework ##
 
 ### Through _values_ manifests ###
 This is already done for [scripts][script] that come with SeLite frameworks. If you're using one of those frameworks, you can copy its {{ valuesManifest }} `SeLiteSettingsValues.txt`. Otherwise create it as a plain text file. Either way, you then need to adjust/enter value of field `extensions.selite-settings.common.bootstrappedCoreExtensions`, so it points to location of the framework Javascript file. See also {{navValuesManifests}} and {{navLiteralsForSpecialValues}}.
 
-### Through GUI ###
-<!-- @TODO eliminate or Move to SettingsInterface? -->
-You can configure that via GUI as per [SettingsInterface](SettingsInterface):
-
-  1. Visit {{chromeUrl}} _chrome://selite-settings/content/tree.xul?module=extensions.selite-settings.common_
-  2. create a new [set]
-  3. if you're using just one script configuration, make the set default (click at Default next to its name)
-  4. select 'Add a new value' next to `bootstrapCoreExtensions`. Point it to where you downloaded the framework JS file.
-
-However, if you're going to use several script configurations, then create a [set] for each, but don't make any of those sets default. Then connect the sets with folders of your [suite(s)][suite] through {{associationsManifest}} as per {{navAssociationsManifests}}.
+### Through GUI
+See [SettingsInterface](SettingsInterface) > [Managing mode](SettingsInterface#managing-mode). Select 'Add a new value' next to `bootstrapCoreExtensions`. Point it to where you downloaded the framework JS file.
 
 ## Edit or review configuration of the framework ##
 

JavascriptEssential.md

@@ -14,7 +14,7 @@ layout: default
     * Reflecting on what you intend to implement can save you unnecessary work (immediately or later).
     * Complexity makes coding often slow and frustrating. By documenting first, you will be free to relax with no paperwork duty once implemented.
     * If you can't finish implementation or you need assistance, it's easier for someone else to pick it up if there's some documentation.
-  * Create [scripts][script] to be run from Selenium IDE - see [PackagedScripts](PackagedScripts).<!-- TODO move this elsewhere: it's Selense scripts, not JS.-->
+  * Create [scripts][script] to be run from Selenium IDE - see [PackagedScripts](PackagedScripts).<!-- TODO move this elsewhere: it's Selenese scripts, not JS.-->
   * Don't use fixed line length - see [DocumentationStandard](DocumentationStandard). However, split complex expressions on multiple lines.
   * Use ESLint. [Install it](http://eslint.org/docs/user-guide/command-line-interface) and run it as `eslint .` in both `SeLite` and `SelBlocksGlobal` folders.
   * Apply [Mozilla WebExtensions code style](https://wiki.mozilla.org/WebExtensions/Hacking#Code_Style).

SettingsInterface.md

@@ -10,9 +10,11 @@ Two most frequent use cases are available in Selenium IDE menu > Options. They l
 
 SeLiteSettings' configuration interface is within Firefox at {{chromeUrl}}s. The URLs are
 
+| For [**Managing mode**](#managing-mode): | |
 | _chrome://selite-settings/content/tree.xul_                                   | to manage Firefox profile-based set(s) for all registered modules |
 | _chrome://selite-settings/content/tree.xul?module=full-module-name_           | to manage set(s) for a given module |
 | _chrome://selite-settings/content/tree.xul?prefix=prefix-of-full-module-name_ | to manage set(s) of all modules whose name starts with given prefix |
+| For [**Reviewing mode**](#reviewing-mode): | |
 | _chrome://selite-settings/content/tree.xul?selectFolder_                      | to select a folder for which to review any fields |
 | _chrome://selite-settings/content/tree.xul?folder=/full/path/to/folder_       | to review effective configuration for [suites][suite] in that folder, based on any applicable sets or manifests as per [SettingsScope](SettingsScope) |
 | _chrome://selite-settings/content/tree.xul?register_ | to register a module manually (from its javascript file). You need this only if you design or import a custom configuration module that is not packaged as an [extension of Selenium IDE]. Alternatively you may use your own [Core extension] and [SettingsAPI](SettingsAPI) to register your module automatically. |
@@ -24,6 +26,27 @@ Per-folder view colours fields based on where the value(s) come from:
  * Firefox profile-based configuration set
  * {{valuesManifest}}
 
+# Navigation
+Hover the mouse over a field row for a  mouseover tip with a field description.
+
+## Managing mode
+In managing mode (e.g. at {{chromeUrl}} _chrome://selite-settings/content/tree.xul_), clicking at a cell in column
+
+   * 'Default', at set level, toggles the set default.
+   * 'True', 'Value' at a field/field entry level toggles the boolean value, or edits the value, respectively.
+   * 'Null/Undefine' at a field/field entry level toggles the value first to `null`, then to `undefined`.
+   * 'Value' or 'Add/Delete' at a field/field entry level, for a file-based field (e.g. `testDB` or `bootstrappedCoreExtensions`) opens a file picker dialogue.
+
+E.g. to create a new [set]:
+
+  1. Visit {{chromeUrl}} _chrome://selite-settings/content/tree.xul_.
+  2. Press 'Add a new set' (for `extensions.selite-settings.common`, or for a custom module).
+  3. Make the set default (click at 'Default' column next to its name). However, if you're going to use several script configurations, then create a [set] for each, but don't make any set default. Then connect the sets to your [suite] folders as per {{navAssociationsManifests}}.
+  4. Enter values.
+
+## Reviewing mode
+In per-folder reviewing mode (e.g. at {{chromeUrl}} _chrome://selite-settings/content/tree.xul?folder=/full/path/to/folder_), clicking at 'Manifest/Definition' opens a definition of the module for that field, or a {{valuesManifest}} where the value comes from (if any). 'Set' column indicates the [set] where the value came from (if from a set).
+
 # Reloading databases
 SeLiteSettings adds three buttons to Selenium IDE. They re-load one or two of [script DB], [app DB] or [vanilla DB] (as per the table below). These buttons do the full job on their own only if your web app uses SQLite as its DB. Otherwise apply [DataImport](DataImport).
 
@@ -38,7 +61,7 @@ You should pause [scripts][script] while using these buttons, otherwise the [scr
 ## Permissions
 Reloading databases requires your local account (which runs Firefox) to have access to delete the web [app DB] file and to create new files in the web app DB folder. That works when the app runs in  locally and you started it yourself, or when it is under your home folder. Otherwise your account needs to have the access granted (e.g. via Linux/Mac OS groups or SeLinux `setfacl` - see [DrupalFramework](DrupalFramework)).
 
-# Typing strings `'null'` or `'undefined'`
+# Entering `'null'` or `'undefined'`
 This is unlikely, but possible. If a freetype field has a non-null defined value (possibly empty string), then you can type in string literals `'null'` or `'undefined'` (within apostrophes or quotes) and they will be accepted as those strings. They won't get converted to Javascript null or undefined. Use a special column 'Null/Undefine' for that.
 
 If a freetype field is Javascript `null` or `undefined`, you can click at its cell and change it. If you you don't change it and you hit Enter, that leaves the field as Javascript `null` or `undefined`, rather than a string literal `'null'` or `'undefined'`. So, if  you'd like to enter a string literal `'null'` or `'undefined'`, enter something else first and then change it to `'null'` or `'undefined'` again.