New document: Dyalog Configuration Guide

[FionaDyalog]

STEP ONE

Create a new document: Dyalog Configuration Guide

In the “project ToC”, this will go into the “Cross-platform Environment” category (not yet created, still determining the exact name, but will follow the “Core Reference” category.

This will comprise information about configuration files and configuration parameters

Top-level ToC:
Dyalog Configuration Guide (this should contain the standard "About" front matter – see other documents in the project for examples)

• Introduction
• How to set configuration parameters
  • Order of Precedence
  • Command Line
  • Application Configuration Files (split information!)
  • Environment Variables
  • User Configuration Files
  • Registry (Microsoft Windows only)
  • Built-in Defaults
• Configuration Parameters (main page should explain that there can be differences across platforms but that each configuration parameter mentions these, units used (could also be done as a “template” on each relevant parameter, case, etc). Maybe a “categorisation listing” – cf System Functions (by Category).

Order of Precedence of configuration parameter settings – source materials:

• Dyalog for macOS Installation and Configuration Guide – Appendix B: Configuration Files
• Dyalog for Microsoft Windows Installation and Configuration Guide – Configuration Files
• Dyalog for Unix Installation and Configuration Guide – Configuration Parameters > Introduction

Configuration files – source material:

• Dyalog for macOS Installation and Configuration Guide – Appendix B: Configuration Files
• Dyalog for Microsoft Windows Installation and Configuration Guide – Configuration Files
• Dyalog for Unix Installation and Configuration Guide – Configuration Parameters > Configuration Files

Configuration parameters – source materials:

• Dyalog for macOS Installation and Configuration Guide – Appendix C: Configuration Parameters
• Dyalog for Microsoft Windows Installation and Configuration Guide – Configuration Parameters (and all its child pages)
• Dyalog for Unix Installation and Configuration Guide – Configuration Parameters > Environment Variables

NOTE: Each configuration parameter should have its own page and must include any differences between operating systems.

STEP TWO

Once the new document has been created, the three Dyalog for operatingsystem Installation and Configuration Guides will need to be updated (remove the material that has been taken into the cross-platform document and replace with brief summaries and references as appropriate).

The entire document set will need to be searched for broken links to configuration parameters, and any such links corrected.

STEP THREE

Rework all the configuration parameters to use a standard template, taking account of operating system differences and limitations. It can be done in multiple tranches to pick off the low-hanging fruit before getting into the trickier aspects. Might require significant developer input to review for accuracy across the different operating systems…

This could be merged with step one, but might delay the completion of that step significantly.

RESOURCES

Template for each configuration parameter page: ConfigParamTemplate.docx

HTML source file for Dyalog for macOS Installation and Configuration Guide.pdf > Appendix B: Configuration Files: configuration_files.htm

HTML source file for Dyalog for macOS Installation and Configuration Guide.pdf > Appendix C: Configuration Parameters: configuration_parameters.htm