Generalise configuration-setting substitution across the guides - #993
Generalise configuration-setting substitution across the guides#993abrudz wants to merge 4 commits into
Conversation
Substitution parameters apply to all configuration settings, not only those defined in configuration files. In the Unix guide, move the References to other Configuration Parameters section up from the configuration files page to the general configuration parameters page. In the Windows guide, note the pre-defined [=DOCUMENTS] substitution. Part of Dyalog#988.
|
|
||
| ## References to other Configuration Parameters | ||
|
|
||
| Configuration parameters that are string values can include references to other configuration parameters (irrespective of where they are defined) using square bracket delimiters. For example, `MySetting: "[DYALOG]/MyFile"` will replace `[DYALOG]` with the value of the **DYALOG** configuration parameter. |
There was a problem hiding this comment.
All configuration parameters are string values - strike "that are string values"
(When this text was describing only configuration files, this was alluding to the JSON format, which allows both numeric and string values - obviously, [XXX] cannot appear in a JSON numeric value, only in JSON strings. But both forms ultimately created config settings with string values.)
|
|
||
| For more information on configuration files, see [Configuration Files](configuration-files.md). For more information on environment variables, see [Environment Variables](environment-variables.md). | ||
|
|
||
| ## References to other Configuration Parameters |
There was a problem hiding this comment.
This is pertinent to Windows too.
All configuration parameters are string values, so the qualifier is redundant; strike it in both the Unix and Windows guides, per review.
Per review, the relocation of References to other Configuration Parameters is pertinent to Windows too: move it from the configuration files page up to the general configuration parameters page, matching the Unix guide, since substitution applies to all configuration settings regardless of how they are defined.
|
I'm afraid it is getting very hard in GitHub to see what is what now. However, I have noticed one important error in the move of the description of [XXX] substitution from config files to configuration settings in general: the [.] substitution (which expands to the config file directory) is still relevant to config files only - it would be meaningless anywhere else. So that bit needs moving back. Perhaps when this is done, a rendered copy of the changed documents could be supplied? |
|
@DyalogRichard you can see the clean state passably rendered by GitHub on the PR branch. |
3 participants
Substitution parameters apply to all configuration settings, not only those defined in configuration files. In the Unix guide, move the References to other Configuration Parameters section up from the configuration files page to the general configuration parameters page. In the Windows guide, note the pre-defined [=DOCUMENTS] substitution.
Fixes #988.