diff --git a/dyalog-configuration-guide/docs/configuration-parameters/addclassheaders.md b/dyalog-configuration-guide/docs/configuration-parameters/addclassheaders.md new file mode 100644 index 00000000000..32ff5662b2a --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/addclassheaders.md @@ -0,0 +1,12 @@ +# AddClassHeaders + +What the Tracer displays when tracing the execution of a function defined in a script. + +Valid values are: + +- `0` : the entire script is shown in the Trace window +- `1` : only the first line of the script and the function being traced are shown + + + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/apl-code-e-magnitude.md b/dyalog-configuration-guide/docs/configuration-parameters/apl-code-e-magnitude.md new file mode 100644 index 00000000000..0bd1f01a1d7 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/apl-code-e-magnitude.md @@ -0,0 +1,11 @@ +# APL_CODE_E_MAGNITUDE + +The magnitude at or above which numbers in function bodies are descanned (written out as their character representation, for example by `⎕CR`) in exponential format. This controls whether large integers appear as, for example, `1E21` or `1000000000000000000000`, which affects the readability of code and the stability of its character representation across versions. + +Valid values are: + +- `0` : numbers are descanned and displayed normally (the default) +- `¯1` : numbers greater than or equal to 1017 use exponential format, as in Version 12.1 +- an integer from `2` to `34` : numbers greater than or equal to 10value use exponential format + +Default is `0`. The effect of any other value is undefined. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/apl-complex-as-v12.md b/dyalog-configuration-guide/docs/configuration-parameters/apl-complex-as-v12.md new file mode 100644 index 00000000000..2260fcfde9b --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/apl-complex-as-v12.md @@ -0,0 +1,13 @@ +# APL_COMPLEX_AS_V12 + +!!! Legacy "Legacy" + This configuration parameter eases the transition of older code to currently supported versions of Dyalog. It is intended to be removed in a future release. + +Whether code developed with Version 12.1 or earlier keeps its original behaviour with respect to complex numbers. + +Valid values are: + +- `1` : Version 12.1 behaviour is retained. Power (`*`) and logarithm (`⍟`) do not produce complex results from non-complex arguments; `⎕VFI` does not honour `J`/`j`; and `¯4○Y` is evaluated as `(¯1+Y*2)*0.5`. In addition, objects containing complex numbers cannot be transferred to or from component files, TCP/IP (Conga), or auxiliary processors, nor used as an argument to Serialise/Deserialise Array (`220⌶`); a `DOMAIN ERROR` is issued instead. +- any other value, or unset : code developed with Version 12.1 or earlier may now generate complex numbers + +This does not prevent the generation and use of complex numbers through newer features, such as complex-number literals. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/apl-fast-fchk.md b/dyalog-configuration-guide/docs/configuration-parameters/apl-fast-fchk.md new file mode 100644 index 00000000000..01003d61794 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/apl-fast-fchk.md @@ -0,0 +1,10 @@ +# APL_FAST_FCHK + +Whether `⎕FCHK` is optimised so that it can reliably determine that a component file was properly untied and so need not be checked (this can be overridden with the `⎕FCHK` `force` option). The optimisation has a performance cost on `⎕FUNTIE`, so it is best switched off in applications that frequently tie and untie files. It affects only component files with journaling enabled. + +Valid values are: + +- `0` : do not optimise `⎕FCHK` (optimise `⎕FUNTIE` instead) +- `1` : optimise `⎕FCHK` + +Default is `0` on all platforms. On Microsoft Windows, setting the value `1` has no effect. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/apl-fcreate-props-c.md b/dyalog-configuration-guide/docs/configuration-parameters/apl-fcreate-props-c.md new file mode 100644 index 00000000000..77eb5e55459 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/apl-fcreate-props-c.md @@ -0,0 +1,12 @@ +# APL_FCREATE_PROPS_C + +The default checksum level for newly-created component files. + +Valid values are a checksum level. + +Default is `1`. + +!!! Info "Information" + Component files that have both journalling and checksum properties set to `0` have been deprecated, and it is no longer possible to create files with this combination of properties. + +Related parameters: [APL_FCREATE_PROPS_J](apl-fcreate-props-j.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/apl-fcreate-props-j.md b/dyalog-configuration-guide/docs/configuration-parameters/apl-fcreate-props-j.md new file mode 100644 index 00000000000..950e70fa2c6 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/apl-fcreate-props-j.md @@ -0,0 +1,12 @@ +# APL_FCREATE_PROPS_J + +The default journaling level for newly-created component files. + +Valid values are a journaling level. + +Default is `1`. + +!!! Info "Information" + Component files that have both journalling and checksum properties set to `0` have been deprecated, and it is no longer possible to create files with this combination of properties. + +Related parameters: [APL_FCREATE_PROPS_C](apl-fcreate-props-c.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/apl-max-threads.md b/dyalog-configuration-guide/docs/configuration-parameters/apl-max-threads.md new file mode 100644 index 00000000000..717cc52a0af --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/apl-max-threads.md @@ -0,0 +1,7 @@ +# APL_MAX_THREADS + +The maximum number of system threads used for parallel execution. + +Valid values are an integer from `1` to `64`. + +Default is `1`. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/apl-textinaplcore.md b/dyalog-configuration-guide/docs/configuration-parameters/apl-textinaplcore.md new file mode 100644 index 00000000000..b4e9fbb3987 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/apl-textinaplcore.md @@ -0,0 +1,12 @@ +# APL_TextInAplCore + +Whether certain information is written to an *aplcore* file when a [system error](../../../programming-reference-guide/error-messages/system-errors) occurs. + +Valid values are: + +- `0` : the information is omitted +- `1` : the information is included + +Default is `1` (the interpreter's own default is `0`, but on UNIX and macOS the supplied startup script sets it to `1`). + +Related parameters: [AplCoreName](aplcorename.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/aplan-for-editor.md b/dyalog-configuration-guide/docs/configuration-parameters/aplan-for-editor.md new file mode 100644 index 00000000000..2efce9f27bc --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/aplan-for-editor.md @@ -0,0 +1,14 @@ +# APLAN_FOR_EDITOR + +Whether new **Edit** windows containing arrays open using [array notation](../../../programming-reference-guide/introduction/arrays/array-notation/) when possible. + +Valid values are: + +- `0` : arrays open in the usual display form +- `1` : arrays open using array notation; [`⎕PP`](../../../language-reference-guide/system-functions/pp) does not then apply to numbers shown in the editor + +Default is `0`. + +The setting can be toggled with the `]APLAN.Editor` user command. In Ride and the Microsoft Windows IDE, an open **Edit** window's mode can be toggled with the ![array notation](../img/object_arraynotation.png){width=20 height=20 vertical-align:text-bottom} icon in the editor's toolbar. + +Related parameters: [APLAN_FOR_OUTPUT](aplan-for-output.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/aplan-for-output.md b/dyalog-configuration-guide/docs/configuration-parameters/aplan-for-output.md new file mode 100644 index 00000000000..ab40aeed87c --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/aplan-for-output.md @@ -0,0 +1,14 @@ +# APLAN_FOR_OUTPUT + +Whether Session output uses [array notation](../../../programming-reference-guide/introduction/arrays/array-notation/) when possible. + +Valid values are: + +- `0` : Session output uses the usual display form +- `1` : Session output uses array notation; [`⎕PP`](../../../language-reference-guide/system-functions/pp) does not then apply to numeric Session output + +Default is `0`. + +The setting can be toggled with the `]APLAN.Output` user command. In the Microsoft Windows IDE it can also be toggled with the ![array notation](../img/session_arraynotation.png){width=20 height=20 vertical-align:text-bottom} icon in the Session toolbar. + +Related parameters: [APLAN_FOR_EDITOR](aplan-for-editor.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/aplcorename.md b/dyalog-configuration-guide/docs/configuration-parameters/aplcorename.md new file mode 100644 index 00000000000..6da9e425956 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/aplcorename.md @@ -0,0 +1,11 @@ +# AplCoreName + +The directory and name of the file in which an *aplcore* is saved. An optional wild-card character (`*`) is replaced by a number when the file is written; only one `*` can be used. If there is more than one `*`, the setting is ignored and the aplcore is named `aplcore`. Dyalog terminates with an exit code of `3` when an aplcore is generated. + +Valid values are a file path, optionally containing a single `*`. + + + +Related parameters: [MaxAplCores](maxaplcores.md) (including how to prevent aplcore files being generated). + +See also [aplcore Parameters](../../../language-reference-guide/primitive-operators/i-beam/aplcore-parameters). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/aplk.md b/dyalog-configuration-guide/docs/configuration-parameters/aplk.md new file mode 100644 index 00000000000..06d86ed939a --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/aplk.md @@ -0,0 +1,14 @@ +# APLK + +!!! Info "Information" + This configuration parameter is only relevant when using the Classic edition of Dyalog. + +The name of the Input Translate Table, which defines the keyboard layout. The keyboard list in the Configuration dialog shows every `.DIN` file in the directory given by [`APLKeys`](aplkeys.md); any of the supplied tables can be chosen, and you can add your own. The `FILE.DIN` table is intended for input from file and should not normally be chosen as a keyboard table. + +Valid values are the name of a `.DIN` input translate table. + + + +Related parameters: [APLKeys](aplkeys.md). + +See also the [Input tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-input-tab-classic-edition-only) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/aplk0.md b/dyalog-configuration-guide/docs/configuration-parameters/aplk0.md new file mode 100644 index 00000000000..be60e8e1256 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/aplk0.md @@ -0,0 +1,11 @@ +# APLK0 + +!!! Info "Information" + This configuration parameter is only relevant when using the Classic edition of Dyalog on the UNIX and macOS operating systems. + +An input translate table that overrides [`APLK`](aplk.md), if set. It takes precedence over the table implied by the terminal type. + +Valid values are the name of a `.din` input translate table. + + +Related parameters: [APLK](aplk.md), [APLKeys](aplkeys.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/aplkeys.md b/dyalog-configuration-guide/docs/configuration-parameters/aplkeys.md new file mode 100644 index 00000000000..f0014a23b34 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/aplkeys.md @@ -0,0 +1,17 @@ +# APLKeys + +!!! Info "Information" + This configuration parameter is only relevant when using the Classic edition of Dyalog. + +A search path for the Input Translate Table, useful when configuring a run-time application. Directory paths use the operating system's conventions and are separated by `;` (Windows) or `:` (UNIX and macOS). + +Valid values are a list of directory paths. + +Default is the `aplkeys` sub-directory of the Dyalog installation directory (given by [`Dyalog`](dyalog.md)). + +On UNIX and macOS, if this parameter is unset the search path defaults to the directory given by [`Dyalog`](dyalog.md); if that is also unset, it defaults to `/usr/dyalog`. + + +Related parameters: [APLK](aplk.md), [Dyalog](dyalog.md). + +See also the [Input tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-input-tab-classic-edition-only) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/aplnid.md b/dyalog-configuration-guide/docs/configuration-parameters/aplnid.md new file mode 100644 index 00000000000..fcce58d8430 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/aplnid.md @@ -0,0 +1,10 @@ +# aplnid + +The *user number* used by the component file system to control file sharing and security. When a user creates a component file, their user number is recorded in the file to identify them as its owner. + +Valid values, and how the user number is obtained, depend on the operating system: + +- Microsoft Windows: **aplnid** is an integer from `0` to `65535`. To share component files or external variables across a network, each user must have a unique **aplnid**. A value of `0` causes the user to bypass APL's access-control-matrix mechanism. +- UNIX and macOS: the user number is obtained from the operating system (UID) and **aplnid** is not used. If the user is `root`, APL's access-control mechanism is ignored. + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/aplstatusfd.md b/dyalog-configuration-guide/docs/configuration-parameters/aplstatusfd.md new file mode 100644 index 00000000000..7bb90462ce5 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/aplstatusfd.md @@ -0,0 +1,10 @@ +# APLSTATUSFD + +!!! Info "Information" + This configuration parameter is only relevant on the UNIX and macOS operating systems. + +The number of the output stream (file descriptor) on which messages for the Status window are written. Setting it allows this output to be redirected when Dyalog is started. + +Valid values are a file descriptor number. + +Default is unset, in which case the output appears in the same terminal window as the Session (although it is not part of the Session, and can be cleared with the Screen Redraw command key, often `Ctrl+L`). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/aplt.md b/dyalog-configuration-guide/docs/configuration-parameters/aplt.md new file mode 100644 index 00000000000..0be147e6c7e --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/aplt.md @@ -0,0 +1,15 @@ +# APLT + +!!! Info "Information" + This configuration parameter is only relevant when using the Classic edition of Dyalog. + +The name of the Output Translate Table. + +Valid values are the name of an output translate table. + +Default is `WIN.DOT` on Microsoft Windows, where there is rarely a need to alter it. + + +Related parameters: [APLTrans](apltrans.md). + +See also the [Output tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-output-tab-classic-edition-only) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/apltn.md b/dyalog-configuration-guide/docs/configuration-parameters/apltn.md new file mode 100644 index 00000000000..d325f737e21 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/apltn.md @@ -0,0 +1,11 @@ +# APLTn + +!!! Info "Information" + This configuration parameter is only relevant when using the Classic edition of Dyalog on the UNIX and macOS operating systems. + +An output translate table that overrides [`APLT`](aplt.md), if set. The name ends with a digit (for example `APLT0`), so that more than one can be defined. It takes precedence over the table implied by the terminal type. + +Valid values are the name of an output translate table. + + +Related parameters: [APLT](aplt.md), [APLTrans](apltrans.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/apltrans.md b/dyalog-configuration-guide/docs/configuration-parameters/apltrans.md new file mode 100644 index 00000000000..08d2c36657b --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/apltrans.md @@ -0,0 +1,17 @@ +# APLTrans + +!!! Info "Information" + This configuration parameter is only relevant when using the Classic edition of Dyalog. + +A search path for the Output Translate Table, useful when configuring a run-time application. Directory paths use the operating system's conventions and are separated by `;` (Windows) or `:` (UNIX and macOS). + +Valid values are a list of directory paths. + +Default is the `apltrans` sub-directory of the Dyalog installation directory (given by [`Dyalog`](dyalog.md)). + +On UNIX and macOS, if this parameter is unset the search path defaults to the directory given by [`Dyalog`](dyalog.md); if that is also unset, it defaults to `/usr/dyalog`. + + +Related parameters: [APLT](aplt.md), [Dyalog](dyalog.md). + +See also the [Output tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-output-tab-classic-edition-only) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/auto-pw.md b/dyalog-configuration-guide/docs/configuration-parameters/auto-pw.md new file mode 100644 index 00000000000..c7879410f54 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/auto-pw.md @@ -0,0 +1,17 @@ +# Auto_PW + +Whether the value of [`⎕PW`](../../../language-reference-guide/system-functions/pw) is derived automatically from the current width of the Session (Windows) or terminal (UNIX and macOS) window. + +Valid values are: + +- `0` : `⎕PW` is independent of the window width +- `1` : `⎕PW` changes whenever the window is resized, reflecting the number of characters that fit on one line + +Default depends on operating system: + +- Microsoft Windows: `0` +- UNIX and macOS: when unset, behaves as `1` (`⎕PW` tracks the terminal width, updated when the interpreter next checks for input) + +Related parameters: [Default_PW](default-pw.md). + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey1.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey1.md new file mode 100644 index 00000000000..0cab4980f03 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey1.md @@ -0,0 +1,11 @@ +# AutoComplete/CancelKey1 + +The first of two possible keys that cancel (hide) the AutoComplete suggestion box. + +Valid values are a key code. + + + +Related parameters: [AutoComplete/CancelKey2](cancelkey2.md). + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey2.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey2.md new file mode 100644 index 00000000000..3a02bcb58d7 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey2.md @@ -0,0 +1,11 @@ +# AutoComplete/CancelKey2 + +The second of two possible keys that cancel (hide) the AutoComplete suggestion box. + +Valid values are a key code. + + + +Related parameters: [AutoComplete/CancelKey1](cancelkey1.md). + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/cols.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/cols.md new file mode 100644 index 00000000000..0b6152899b2 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/cols.md @@ -0,0 +1,11 @@ +# AutoComplete/Cols + +The maximum number of columns (width) in the AutoComplete pop-up suggestion box. + +Valid values are a positive integer. + + + +Related parameters: [AutoComplete/Rows](rows.md). + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/commonkey1.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/commonkey1.md new file mode 100644 index 00000000000..8f457c359b3 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/commonkey1.md @@ -0,0 +1,9 @@ +# AutoComplete/CommonKey1 + +The key that auto-completes the *common prefix*: the longest string of leading characters of the currently selected name that is shared by at least one other name in the AutoComplete suggestion box. + +Valid values are a key code. + + + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/completekey1.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/completekey1.md new file mode 100644 index 00000000000..15e05d38592 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/completekey1.md @@ -0,0 +1,11 @@ +# AutoComplete/CompleteKey1 + +The first of two possible keys that select the current option from the AutoComplete suggestion box. + +Valid values are a key code. + + + +Related parameters: [AutoComplete/CompleteKey2](completekey2.md). + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/completekey2.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/completekey2.md new file mode 100644 index 00000000000..543859cb56c --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/completekey2.md @@ -0,0 +1,11 @@ +# AutoComplete/CompleteKey2 + +The second of two possible keys that select the current option from the AutoComplete suggestion box. + +Valid values are a key code. + + + +Related parameters: [AutoComplete/CompleteKey1](completekey1.md). + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/enabled.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/enabled.md new file mode 100644 index 00000000000..494abc819f4 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/enabled.md @@ -0,0 +1,12 @@ +# AutoComplete/Enabled + +Whether AutoComplete is enabled. + +Valid values are: + +- `0` : AutoComplete is disabled +- `1` : AutoComplete is enabled + + + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/history.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/history.md new file mode 100644 index 00000000000..84cc08ea2fe --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/history.md @@ -0,0 +1,14 @@ +# AutoComplete/History + +Whether AutoComplete maintains a list of previous auto-completions. + +Valid values are: + +- `0` : no history is kept +- `1` : a history of previous auto-completions is kept + + + +Related parameters: [AutoComplete/HistorySize](historysize.md). + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/historysize.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/historysize.md new file mode 100644 index 00000000000..13a98777de4 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/historysize.md @@ -0,0 +1,11 @@ +# AutoComplete/HistorySize + +The number of previous auto-completions kept when [`AutoComplete/History`](history.md) is `1`. + +Valid values are a positive integer. + + + +Related parameters: [AutoComplete/History](history.md). + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/prefixsize.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/prefixsize.md new file mode 100644 index 00000000000..99ebd55e9a9 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/prefixsize.md @@ -0,0 +1,9 @@ +# AutoComplete/PrefixSize + +The threshold, in number of characters entered, before AutoComplete begins to display suggestions. + +Valid values are a non-negative integer. + + + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/rows.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/rows.md new file mode 100644 index 00000000000..fc309a12d26 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/rows.md @@ -0,0 +1,11 @@ +# AutoComplete/Rows + +The maximum number of rows (height) in the AutoComplete pop-up suggestion box. + +Valid values are a positive integer. + + + +Related parameters: [AutoComplete/Cols](cols.md). + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/showfiles.md b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/showfiles.md new file mode 100644 index 00000000000..ff69af763ff --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autocomplete/showfiles.md @@ -0,0 +1,12 @@ +# AutoComplete/ShowFiles + +Whether AutoComplete suggests directory and file names for the `)LOAD`, `)COPY`, and `)DROP` system commands. + +Valid values are: + +- `0` : file and directory names are not suggested +- `1` : file and directory names are suggested + + + +See also the [Auto Complete tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autodpi.md b/dyalog-configuration-guide/docs/configuration-parameters/autodpi.md new file mode 100644 index 00000000000..994ce165d02 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autodpi.md @@ -0,0 +1,15 @@ +# AutoDPI + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +Whether Dyalog registers the application as DPI-aware when it initialises, and so performs auto-scaling itself. + +Valid values are: + +- `0` : scaling is the responsibility of the programmer or the operating system +- `1` : Dyalog performs the auto-scaling + +Default is `1`. + +See also the [General tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autoformat.md b/dyalog-configuration-guide/docs/configuration-parameters/autoformat.md new file mode 100644 index 00000000000..5656d3e0deb --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autoformat.md @@ -0,0 +1,14 @@ +# AutoFormat + +Whether Control Structures are formatted automatically when a function is opened for editing or converted to text by `⎕CR`, `⎕NR`, or `⎕VR`. Automatic formatting discards leading spaces in the function body, prefixes each line with a single space except those beginning with a label or comment symbol (so that labels and comments stand out), and indents Control Structures by the width given in [`TabStops`](tabstops.md). + +Valid values are: + +- `0` : no automatic formatting +- `1` : Control Structures are formatted automatically + +Default is `1`. + +Related parameters: [TabStops](tabstops.md), [AutoIndent](autoindent.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/autoindent.md b/dyalog-configuration-guide/docs/configuration-parameters/autoindent.md new file mode 100644 index 00000000000..687efa65870 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/autoindent.md @@ -0,0 +1,14 @@ +# AutoIndent + +Whether semi-automatic indentation is applied during editing, so that a new line in a function is indented by the same amount as the previous line. This simplifies the entry of indented Control Structures. + +Valid values are: + +- `0` : no automatic indentation +- `1` : a new line is indented to match the previous line + +Default is `1`. + +Related parameters: [AutoFormat](autoformat.md), [TabStops](tabstops.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/cfext.md b/dyalog-configuration-guide/docs/configuration-parameters/cfext.md new file mode 100644 index 00000000000..7e2ca6bc04b --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/cfext.md @@ -0,0 +1,14 @@ +# CFEXT + +Component file filename extensions, determining the file search order when a component file is tied. + +Valid values are a colon-separated list of one or more extensions, each including the leading period (`.`) that separates it from the basename. + +Default depends on operating system: + +- Microsoft Windows and macOS: `.dcf:` +- other platforms: `.dcf:.DCF:` + +For example, on Windows `'myfile'⎕FTIE 0` searches first for `myfile.dcf`, then for `myfile` with no extension (and, as Windows file names are not case-sensitive, finds `myfile.DCF`, `MyFile.Dcf`, and so on). On other platforms it searches for `myfile`, then `myfile.dcf`, then `myfile.DCF`. + +Related parameters: [WSEXT](wsext.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/cmd-prefix-and-cmd-postfix.md b/dyalog-configuration-guide/docs/configuration-parameters/cmd-prefix-and-cmd-postfix.md new file mode 100644 index 00000000000..67b378fec1b --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/cmd-prefix-and-cmd-postfix.md @@ -0,0 +1,10 @@ +# CMD_PREFIX and CMD_POSTFIX + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +Strings within which operating-system commands given as the arguments to `⎕CMD`, `⎕SH`, `)CMD`, and `)SH` are wrapped, so that the command arguments run under a non-standard command shell. + +Valid values are a string. + +For implementation details, see [Windows Command (`⎕CMD`)](../../../language-reference-guide/system-functions/cmd). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/configfile.md b/dyalog-configuration-guide/docs/configuration-parameters/configfile.md new file mode 100644 index 00000000000..4dae9501acc --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/configfile.md @@ -0,0 +1,7 @@ +# ConfigFile + +The name of the [application configuration file](../how-to-set/application-configuration-files.md). + +Valid values are a file name. + +Related parameters: [UserConfigFile](userconfigfile.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/configuration-parameters-by-category.md b/dyalog-configuration-guide/docs/configuration-parameters/configuration-parameters-by-category.md new file mode 100644 index 00000000000..f59e2357d61 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/configuration-parameters-by-category.md @@ -0,0 +1,290 @@ +--- +search: + exclude: true +--- +# Configuration Parameters (by Category) + +The following tables list the configuration parameters grouped by subject. Each parameter is described in full on its own page; the parameters are also listed alphabetically in the navigation pane. + +## Session log and input buffers + +These control the Session log and the buffers that hold input and function-key definitions. + +|Name|Description| +|----|-----------| +|[`Log_File`](log-file.md)|The path (absolute, or relative to the working directory) and name of the Session log file| +|[`Log_File_InUse`](log-file-inuse.md)|Whether the Session log is saved to the Session log file and reloaded the next time a Session is started| +|[`Log_Size`](log-size.md)|The size of the Session log buffer| +|[`Session_File`](session-file.md)|The name of the file from which the Session (`⎕SE`) is loaded when Dyalog starts| +|[`LAYOUT_FILE`](layout-file.md)|The Session layout file, recording the docking layout of the Session| +|[`History_Size`](history-size.md)|The size of the buffer used to store previously entered (input) lines in the Session| +|[`Input_Size`](input-size.md)|The size of the buffer used to store marked lines (lines awaiting execution) in the Session| +|[`PFKey_Size`](pfkey-size.md)|The size of the buffer used to store programmable function key definitions (see Program Function Key (`⎕PFKEY`))| +|[`Confirm_Session_Delete`](confirm-session-delete.md)|Whether you are prompted for confirmation when you delete lines from the Session log| + +## Session appearance and behaviour + +These control how the Session window looks and behaves. + +|Name|Description| +|----|-----------| +|[`APLAN_FOR_OUTPUT`](aplan-for-output.md)|Whether Session output uses array notation when possible| +|[`DYALOG_GUTTER_ENABLE`](dyalog-gutter-enable.md)|Whether a gutter is displayed in the left-most column of the Session window| +|[`URLHighlight`](urlhighlight.md)|Whether URLs and links are highlighted in Session and Edit windows| +|[`StatusOnEdit`](statusonedit.md)|Whether a status bar is displayed along the bottom of individual Edit windows| +|[`ToolBarsOnEdit`](toolbarsonedit.md)|Whether tool bars are displayed along the top of individual Edit windows| +|[`AutoDPI`](autodpi.md)|Whether Dyalog registers the application as DPI-aware when it initialises, and so performs auto-scaling itself| +|[`Dyalog_Pixel_Type`](dyalog-pixel-type.md)|How the value `'Pixel'` of the `Coord` property is interpreted| +|[`Dyalog_LineEditor_Mode`](dyalog-lineeditor-mode.md)|Whether multi-line input is enabled in the Session| +|[`DYALOG_NOPOPUPS`](dyalog-nopopups.md)|Whether a message box appears when Dyalog terminates unexpectedly| +|[`XPLookAndFeel`](xplookandfeel.md)|Whether *Native Look and Feel* is used, affecting the appearance of user-interface controls such as buttons| +|[`ShowStatusOnError`](showstatusonerror.md)|Whether the Status window is displayed automatically, when required, when Dyalog attempts to write output to it| + +## Workspace defaults + +These set the values that system variables and related flags take in a clear workspace. + +|Name|Description| +|----|-----------| +|[`Default_DIV`](default-div.md)|The value of `⎕DIV` in a clear workspace| +|[`Default_IO`](default-io.md)|The value of `⎕IO` in a clear workspace| +|[`Default_ML`](default-ml.md)|The value of `⎕ML` (migration level) in a clear workspace| +|[`Default_PP`](default-pp.md)|The value of `⎕PP` (print precision) in a clear workspace| +|[`Default_PW`](default-pw.md)|The value of `⎕PW` in a clear workspace| +|[`Default_RTL`](default-rtl.md)|The value of `⎕RTL` (response time limit) in a clear workspace| +|[`Default_WX`](default-wx.md)|The value of `⎕WX` in a clear workspace| +|[`Auto_PW`](auto-pw.md)|Whether the value of `⎕PW` is derived automatically from the current width of the Session (Windows) or terminal (UNIX and macOS) window| +|[`PropertyExposeRoot`](propertyexposeroot.md)|The default value, in a clear workspace, of the flag that specifies whether the names of the properties, methods, and events of the Root object are exposed| +|[`PropertyExposeSE`](propertyexposese.md)|The default value, in a clear workspace, of the flag that specifies whether the names of the properties, methods, and events of the Session object (`⎕SE`) are exposed| + +## Editor + +These control the behaviour of the Editor. + +|Name|Description| +|----|-----------| +|[`Confirm_Abort`](confirm-abort.md)|Whether you are prompted for confirmation when you abort an edit session after making changes to the object being edited| +|[`Confirm_Close`](confirm-close.md)|Whether you are prompted for confirmation when you close an edit window after making changes to the object being edited| +|[`Confirm_Fix`](confirm-fix.md)|Whether you are prompted for confirmation when you fix an object in the workspace after making changes in the editor| +|[`AutoFormat`](autoformat.md)|Whether Control Structures are formatted automatically when a function is opened for editing or converted to text by `⎕CR`, `⎕NR`, or `⎕VR`| +|[`AutoIndent`](autoindent.md)|Whether semi-automatic indentation is applied during editing, so that a new line in a function is indented by the same amount as the previous line| +|[`TabStops`](tabstops.md)|The number of spaces inserted by pressing the Tab key in the editor| +|[`DockableEditWindows`](dockableeditwindows.md)|Whether individual edit windows can be undocked from (and docked back into) the MDI Editor window| +|[`DoubleClickEdit`](doubleclickedit.md)|Whether double-clicking over a name invokes the editor| +|[`WrapSearch`](wrapsearch.md)|Whether Search/Replace in the editor stops at the top or bottom of the text (according to the direction of the search), or continues from the other end| +|[`WrapSearchMsgBox`](wrapsearchmsgbox.md)|Whether a message box is displayed to inform you when a wrapped search passes the start or end of the text| +|[`DYALOG_DISCARD_FN_SOURCE`](dyalog-discard-fn-source.md)|Whether source code is discarded when a function or operator is fixed by the editor or by `⎕FIX`| +|[`APLAN_FOR_EDITOR`](aplan-for-editor.md)|Whether new **Edit** windows containing arrays open using array notation when possible| +|[`InitFullScriptNormal`](initfullscriptnormal.md)|When the Editor is used to edit a script (such as a Class or Namespace) that is **not suspended**, this controls whether fixing the script and exiting the Editor re-fixes just the functions in the script, or re-executes the whole script (re-initialising any fields or variables defined within it)| +|[`InitFullScriptSusp`](initfullscriptsusp.md)|When the Editor is used to edit a script (such as a Class or Namespace) that is **suspended**, this controls whether fixing the script and exiting the Editor re-fixes just the functions in the script, or re-executes the whole script (re-initialising any fields or variables defined within it)| +|[`EditorState`](editorstate.md)|An internal parameter that records the state (normal or maximised) of the last edit window, so that the next edit window is created in the same state| + +## Tracer + +These control the behaviour of the Tracer. + +|Name|Description| +|----|-----------| +|[`AddClassHeaders`](addclassheaders.md)|What the Tracer displays when tracing the execution of a function defined in a script| +|[`Trace_On_Error`](trace-on-error.md)|Whether the Tracer is deployed automatically when execution of a defined function halts with an untrapped error| +|[`Trace_Level_Warn`](trace-level-warn.md)|The maximum number of Trace windows displayed when an error occurs and `Trace_On_Error` is `1`| +|[`SkipLines`](skiplines.md)|Causes the Tracer to skip lines that contain no executable statement, with the exception of the first line of the function and, in a traditional function (not a dfn), the last line if it is a comment| +|[`TraceStopMonitor`](tracestopmonitor.md)|Which of the `⎕TRACE`, `⎕STOP`, and `⎕MONITOR` columns are displayed in Trace and Edit windows| + +## Edit, Trace, and SM window geometry + +These set the initial size, position, and staggering of Edit, Trace, and stand-alone `⎕SM` windows in Dyalog Classic mode. + +|Name|Description| +|----|-----------| +|[`Edit_Cols`](edit-cols.md)|The initial width of an edit window, in character units| +|[`Edit_Rows`](edit-rows.md)|The initial height of an edit window, in character units| +|[`Edit_First_X`](edit-first-x.md)|The initial horizontal position, in character units, of the first edit window; subsequent edit windows are staggered from it| +|[`Edit_First_Y`](edit-first-y.md)|The initial vertical position, in character units, of the first edit window; subsequent edit windows are staggered from it| +|[`Edit_Offset_X`](edit-offset-x.md)|The number of characters by which an edit window is staggered horizontally from the previous one| +|[`Edit_Offset_Y`](edit-offset-y.md)|The number of characters by which an edit window is staggered vertically from the previous one| +|[`Trace_First_X`](trace-first-x.md)|The initial horizontal position, in character units, of the first Trace window; subsequent Trace windows are staggered from it| +|[`Trace_First_Y`](trace-first-y.md)|The initial vertical position, in character units, of the first Trace window; subsequent Trace windows are staggered from it| +|[`Trace_Offset_X`](trace-offset-x.md)|The number of characters by which a Trace window is staggered horizontally from the previous one| +|[`Trace_Offset_Y`](trace-offset-y.md)|The number of characters by which a Trace window is staggered vertically from the previous one| +|[`SM_Cols`](sm-cols.md)|The width, in characters, of the window used to display `⎕SM` when it is used stand-alone| +|[`SM_Rows`](sm-rows.md)|The height, in characters, of the window used to display `⎕SM` when it is used stand-alone| + +## AutoComplete + +These control the AutoComplete suggestion box. + +|Name|Description| +|----|-----------| +|[`AutoComplete/Enabled`](autocomplete/enabled.md)|Whether AutoComplete is enabled| +|[`AutoComplete/PrefixSize`](autocomplete/prefixsize.md)|The threshold, in number of characters entered, before AutoComplete begins to display suggestions| +|[`AutoComplete/History`](autocomplete/history.md)|Whether AutoComplete maintains a list of previous auto-completions| +|[`AutoComplete/HistorySize`](autocomplete/historysize.md)|The number of previous auto-completions kept when `AutoComplete/History` is `1`| +|[`AutoComplete/ShowFiles`](autocomplete/showfiles.md)|Whether AutoComplete suggests directory and file names for the `)LOAD`, `)COPY`, and `)DROP` system commands| +|[`AutoComplete/Cols`](autocomplete/cols.md)|The maximum number of columns (width) in the AutoComplete pop-up suggestion box| +|[`AutoComplete/Rows`](autocomplete/rows.md)|The maximum number of rows (height) in the AutoComplete pop-up suggestion box| +|[`AutoComplete/CancelKey1`](autocomplete/cancelkey1.md)|The first of two possible keys that cancel (hide) the AutoComplete suggestion box| +|[`AutoComplete/CancelKey2`](autocomplete/cancelkey2.md)|The second of two possible keys that cancel (hide) the AutoComplete suggestion box| +|[`AutoComplete/CommonKey1`](autocomplete/commonkey1.md)|The key that auto-completes the *common prefix*: the longest string of leading characters of the currently selected name that is shared by at least one other name in the AutoComplete suggestion box| +|[`AutoComplete/CompleteKey1`](autocomplete/completekey1.md)|The first of two possible keys that select the current option from the AutoComplete suggestion box| +|[`AutoComplete/CompleteKey2`](autocomplete/completekey2.md)|The second of two possible keys that select the current option from the AutoComplete suggestion box| + +## Value Tips + +These control the Value Tips shown when the mouse hovers over a name. + +|Name|Description| +|----|-----------| +|[`ValueTips/Enabled`](valuetips/enabled.md)|Whether Value Tips are enabled| +|[`ValueTips/Delay`](valuetips/delay.md)|The delay, in milliseconds, before a Value Tip is displayed when the mouse hovers over a name| +|[`ValueTips/ColourScheme`](valuetips/colourscheme.md)|The colour scheme used to display a Value Tip when the mouse hovers over a name| + +## Keyboard and input + +These control keyboard layouts, translate tables, and how keystrokes are interpreted. + +|Name|Description| +|----|-----------| +|[`APLK`](aplk.md)|The name of the Input Translate Table, which defines the keyboard layout| +|[`APLKeys`](aplkeys.md)|A search path for the Input Translate Table, useful when configuring a run-time application| +|[`APLT`](aplt.md)|The name of the Output Translate Table| +|[`APLTrans`](apltrans.md)|A search path for the Output Translate Table, useful when configuring a run-time application| +|[`InitialKeyboardLayout`](initialkeyboardlayout.md)|The name of the keyboard to be selected on start-up| +|[`InitialKeyboardLayoutInUse`](initialkeyboardlayoutinuse.md)|Whether the keyboard given by `InitialKeyboardLayout` is selected as the current keyboard layout when an APL Session starts| +|[`InitialKeyboardLayoutShowAll`](initialkeyboardlayoutshowall.md)|Whether all installed keyboards are listed in the choice of keyboards on the Unicode Input tab of the Configuration dialog| +|[`OverstrikesPopup`](overstrikespopup.md)|Whether the Overstrikes popup is enabled| +|[`ResolveOverstrikes`](resolveoverstrikes.md)|Whether an APL composite symbol can be entered using overstrikes| +|[`UseXCV`](usexcv.md)|How the common copy (Ctrl+C), cut (Ctrl+X), and paste (Ctrl+V) keystrokes are processed| +|[`UnicodeToClipboard`](unicodetoclipboard.md)|Whether text transferred to and from the Windows clipboard is treated as Unicode text| +|[`KeyboardInputDelay`](keyboardinputdelay.md)|The delay, in milliseconds, before the system reacts to a keystroke by updating the name of the Current Object in the Session status bar (see The Current Object) and offering a list of names for auto-completion (see the Auto Complete tab)| +|[`WantsSpecialKeys`](wantsspecialkeys.md)|A list of applications (for example, `putty.exe`) that use the command strings in the Input Translate Tables| +|[`mapchars`](mapchars.md)|The mapping between `⎕AV` and the font must be strictly one-to-one| + +## Start-up and workspace loading + +These control what is loaded and run when Dyalog starts, and where workspaces are found. + +|Name|Description| +|----|-----------| +|[`Load`](load.md)|The name of a workspace, or of a directory or text file containing APL source code, to be loaded when Dyalog starts| +|[`LX`](lx.md)|An expression to be executed after Dyalog has started and loaded a workspace or a text file of APL source code (see `Load`)| +|[`MaxWS`](maxws.md)|The amount of memory allocated to the workspace at start-up| +|[`WSPath`](wspath.md)|The workspace search path: a list of directories searched, in order, when you `)LOAD` or `)COPY` a workspace, or start an Auxiliary Processor, without giving an explicit path| +|[`WSEXT`](wsext.md)|Workspace filename extensions| +|[`ConfigFile`](configfile.md)|The name of the application configuration file| +|[`UserConfigFile`](userconfigfile.md)|The name of the user configuration file| +|[`IniFile`](inifile.md)|The name of the Windows Registry folder that holds the configuration parameters| +|[`DyalogStartup`](dyalogstartup.md)|The name of a file containing APL code to be run each time Dyalog starts| +|[`DyalogStartupSE`](dyalogstartupse.md)|One or more *Session initialisation* directories containing APL code to be installed in `⎕SE`| +|[`DyalogStartup_X`](dyalogstartup-x.md)|During Session initialisation, code is loaded from the directories given by `DyalogStartupSE` into a corresponding namespace tree in `⎕SE`, and is then optionally executed| +|[`DYALOG_INITSESSION`](dyalog-initsession.md)|Whether Dyalog performs Session Initialisation on start-up| + +## Interpreter and runtime + +These control aspects of the running interpreter. + +|Name|Description| +|----|-----------| +|[`qcmd_timeout`](qcmd-timeout.md)|The length of time, in milliseconds, that Dyalog waits for the execution of a Windows command to start| +|[`Dyalog_NETCore`](dyalog-netcore.md)|Whether the .NET interface is used in preference to the .NET Framework interface| +|[`Enable_CEF`](enable-cef.md)|Whether the Chromium Embedded Framework (CEF) is enabled| +|[`APL_MAX_THREADS`](apl-max-threads.md)|The maximum number of system threads used for parallel execution| +|[`CMD_PREFIX and CMD_POSTFIX`](cmd-prefix-and-cmd-postfix.md)|Strings within which operating-system commands given as the arguments to `⎕CMD`, `⎕SH`, `)CMD`, and `)SH` are wrapped, so that the command arguments run under a non-standard command shell| +|[`Serial`](serial.md)|Your Dyalog serial number| +|[`DYALOG_SERIAL`](dyalog-serial.md)|Your Dyalog serial number| + +## Shutting down + +These control what is saved when Dyalog terminates, and running as a service. + +|Name|Description| +|----|-----------| +|[`SaveContinueOnExit`](savecontinueonexit.md)|Whether the current workspace is saved as `CONTINUE.DWS` before Dyalog terminates| +|[`SaveSessionOnExit`](savesessiononexit.md)|Whether the current Session is saved in the Session file before Dyalog terminates| +|[`SaveLogOnExit`](savelogonexit.md)|Whether the Session log is saved before Dyalog terminates| +|[`RunAsService`](runasservice.md)|Whether Dyalog runs as a service: it does not prompt for confirmation when the user logs off, and the interpreter continues to run across the logoff/logon process| + +## Installation locations, help, and URLs + +These give the locations of Dyalog components and of help and web resources. + +|Name|Description| +|----|-----------| +|[`Dyalog`](dyalog.md)|The directory in which Dyalog is installed| +|[`localdyalogdir`](localdyalogdir.md)|The directory in which Dyalog is installed on the client, in a client/server installation| +|[`DyalogInstallDir`](dyaloginstalldir.md)|The full pathname of the directory in which Dyalog is installed| +|[`ProgramFolder`](programfolder.md)|The folder in which the Dyalog program icons are installed| +|[`DyalogLink`](dyaloglink.md)|The directory containing the code for Link| +|[`DyalogHelpDir`](dyaloghelpdir.md)|The location of the HTML-based help used when help is requested from the Session (from the Help menu or by pressing `F1`)| +|[`DyalogWebSite`](dyalogwebsite.md)|The URL of the Dyalog web site| +|[`DyalogEmailAddress`](dyalogemailaddress.md)|The contact email address for Dyalog Ltd| +|[`ExternalHelpURL`](externalhelpurl.md)|The URL used when `UseExternalHelpURL` is `1` and Dyalog displays help for external objects (such as .NET types) through the Microsoft Document Explorer and online help (for example from Visual Studio)| +|[`UseExternalHelpURL`](useexternalhelpurl.md)|Whether Dyalog uses the Microsoft Document Explorer and online help to display help for external objects, such as .NET types| + +## Component files and interoperability + +These control component-file defaults and the interoperability of code and data across versions. + +|Name|Description| +|----|-----------| +|[`APL_FCREATE_PROPS_C`](apl-fcreate-props-c.md)|The default checksum level for newly-created component files| +|[`APL_FCREATE_PROPS_J`](apl-fcreate-props-j.md)|The default journaling level for newly-created component files| +|[`APL_FAST_FCHK`](apl-fast-fchk.md)|Whether `⎕FCHK` is optimised so that it can reliably determine that a component file was properly untied and so need not be checked (this can be overridden with the `⎕FCHK` `force` option)| +|[`CFEXT`](cfext.md)|Component file filename extensions, determining the file search order when a component file is tied| +|[`DYALOG_EXTVAR_SUPPORTED`](dyalog-extvar-supported.md)|Whether support for external variables is enabled| +|[`APL_CODE_E_MAGNITUDE`](apl-code-e-magnitude.md)|The magnitude at or above which numbers in function bodies are descanned (written out as their character representation, for example by `⎕CR`) in exponential format| +|[`APL_COMPLEX_AS_V12`](apl-complex-as-v12.md)|Whether code developed with Version 12.1 or earlier keeps its original behaviour with respect to complex numbers| +|[`File_Stack_Size`](file-stack-size.md)|The number of most-recently-used workspaces displayed in the Session File menu| +|[`aplnid`](aplnid.md)|The *user number* used by the component file system to control file sharing and security| + +## Errors and diagnostics + +These control aplcore files, error reporting, and event logging. + +|Name|Description| +|----|-----------| +|[`AplCoreName`](aplcorename.md)|The directory and name of the file in which an *aplcore* is saved| +|[`MaxAplCores`](maxaplcores.md)|The maximum number of *aplcore* files retained| +|[`APL_TextInAplCore`](apl-textinaplcore.md)|Whether certain information is written to an *aplcore* file when a system error occurs| +|[`DMXOutputOnError`](dmxoutputonerror.md)|Which windows `⎕DMX` error messages are displayed in| +|[`PassExceptionsToOpSys`](passexceptionstoopsys.md)|The default state of the *Pass Exception* check box in the System Error dialog box| +|[`ErrorOnExternalException`](erroronexternalexception.md)|The behaviour when a system exception occurs in a call on an external DLL or shared library| +|[`DYALOG_EVENTLOGGINGLEVEL`](dyalog-eventlogginglevel.md)|Whether a log entry is written to the Windows Event Log when Dyalog would otherwise pop up a message box because of an unexpected termination| +|[`DYALOG_EVENTLOGNAME`](dyalog-eventlogname.md)|The name of the Windows Event Log to which an event message is written (or the source of the event message, depending on the Registry entries defined) when Dyalog would otherwise pop up a message box because of an unexpected termination| + +## Ride + +These control the interpreter's use of the Ride protocol. + +|Name|Description| +|----|-----------| +|[`RIDE_Init`](ride-init.md)|This parameter determines how the interpreter should behave with respect to the Ride protocol| +|[`Ride_Spawned`](ride-spawned.md)|Whether `⎕SR` and `)SH` are disabled| + +## User commands + +These control the user-command framework. + +|Name|Description| +|----|-----------| +|[`UCMDCacheFile`](ucmdcachefile.md)|The name of the User Command cache file| + +## UNIX and macOS specific + +These parameters are only relevant on the UNIX and macOS operating systems. + +|Name|Description| +|----|-----------| +|[`APLSTATUSFD`](aplstatusfd.md)|The output stream on which Status window messages are written| +|[`APLK0`](aplk0.md)|An input translate table that overrides `APLK` (Classic edition)| +|[`APLTn`](apltn.md)|An output translate table that overrides `APLT` (Classic edition)| +|[`DYALOG_SERIALFILE`](dyalog-serialfile.md)|The path to the file containing your Dyalog serial number| +|[`DYALOG_SHELL_SUBPROCESS`](dyalog-shell-subprocess.md)|Whether a child process handles `⎕SHELL` calls (AIX)| +|[`EDITOR_COLUMNS`](editor-columns.md)|The columns shown in the Editor for each type of object| + +## Miscellaneous + +|Name|Description| +|----|-----------| +|[`Greet_Bitmap`](greet-bitmap.md)|The filename of a bitmap displayed during initialisation of the Dyalog application, typically to show a product logo from a run-time application| +|[`yy_window`](yy-window.md)|How Dyalog interprets a 2-digit year number (for `⎕SM` and GUI edit fields that use a 2-digit year format such as `MM/DD/YY`)| diff --git a/dyalog-configuration-guide/docs/configuration-parameters/configuration-parameters.md b/dyalog-configuration-guide/docs/configuration-parameters/configuration-parameters.md new file mode 100644 index 00000000000..11cdc28a476 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/configuration-parameters.md @@ -0,0 +1,26 @@ +# Configuration Parameters + +This section documents each Dyalog configuration parameter on its own page. A parameter page states what the parameter does, its valid values, its default (noting any difference between operating systems), and related parameters. + +The parameters are listed alphabetically in the navigation pane. For a subject-based overview, see [Configuration Parameters by Category](configuration-parameters-by-category.md). + +For how to give a parameter a value – on the command line, in a configuration file, as an environment variable, or in the Windows Registry – and for the order of precedence when a parameter is set in more than one place, see [How to Set Configuration Parameters](../how-to-set/overview.md). + +You are not limited to the parameters used by Dyalog itself; you can also define parameters of your own. + +## Specifying size-related parameters + +Several configuration parameters define a size, such as [maxws](maxws.md) or [log_size](log-size.md). + +The value of such a parameter is an integer, optionally followed immediately by a single character that denotes the units: + +| Character | Units | +|-----------|-------| +| `K` | KiB | +| `M` | MiB | +| `G` | GiB | +| `T` | TiB | +| `P` | PiB | +| `E` | EiB | + +If no character is given, the units are assumed to be KiB. Specifying an invalid value prevents Dyalog from starting. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/confirm-abort.md b/dyalog-configuration-guide/docs/configuration-parameters/confirm-abort.md new file mode 100644 index 00000000000..5b51fa3abc6 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/confirm-abort.md @@ -0,0 +1,12 @@ +# Confirm_Abort + +Whether you are prompted for confirmation when you abort an edit session after making changes to the object being edited. + +Valid values are: + +- `0` : no confirmation +- `1` : confirmation is required + +Default is `0`. + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/confirm-close.md b/dyalog-configuration-guide/docs/configuration-parameters/confirm-close.md new file mode 100644 index 00000000000..311b42ddb87 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/confirm-close.md @@ -0,0 +1,12 @@ +# Confirm_Close + +Whether you are prompted for confirmation when you close an edit window after making changes to the object being edited. + +Valid values are: + +- `0` : no confirmation +- `1` : confirmation is required + +Default is `0`. + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/confirm-fix.md b/dyalog-configuration-guide/docs/configuration-parameters/confirm-fix.md new file mode 100644 index 00000000000..233c6119e1f --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/confirm-fix.md @@ -0,0 +1,12 @@ +# Confirm_Fix + +Whether you are prompted for confirmation when you fix an object in the workspace after making changes in the editor. + +Valid values are: + +- `0` : no confirmation +- `1` : confirmation is required + +Default is `0`. + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/confirm-session-delete.md b/dyalog-configuration-guide/docs/configuration-parameters/confirm-session-delete.md new file mode 100644 index 00000000000..45e4aa68d51 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/confirm-session-delete.md @@ -0,0 +1,12 @@ +# Confirm_Session_Delete + +Whether you are prompted for confirmation when you delete lines from the Session log. + +Valid values are: + +- `0` : no confirmation +- `1` : confirmation is required + +Default is `1`. + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/default-div.md b/dyalog-configuration-guide/docs/configuration-parameters/default-div.md new file mode 100644 index 00000000000..909b4914ba4 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/default-div.md @@ -0,0 +1,9 @@ +# Default_DIV + +The value of [`⎕DIV`](../../../language-reference-guide/system-functions/div) in a clear workspace. + +Valid values are those of `⎕DIV`: `0` or `1`. + +Default is `0`. + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/default-io.md b/dyalog-configuration-guide/docs/configuration-parameters/default-io.md new file mode 100644 index 00000000000..461e686c8db --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/default-io.md @@ -0,0 +1,9 @@ +# Default_IO + +The value of [`⎕IO`](../../../language-reference-guide/system-functions/io) in a clear workspace. + +Valid values are those of `⎕IO`: `0` or `1`. + +Default is `1`. + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/default-ml.md b/dyalog-configuration-guide/docs/configuration-parameters/default-ml.md new file mode 100644 index 00000000000..7b7ca1b50b3 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/default-ml.md @@ -0,0 +1,9 @@ +# Default_ML + +The value of [`⎕ML`](../../../language-reference-guide/system-functions/ml) (migration level) in a clear workspace. + +Valid values are those of `⎕ML`: `0`, `1`, `2`, or `3`. + +Default is `1`. + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/default-pp.md b/dyalog-configuration-guide/docs/configuration-parameters/default-pp.md new file mode 100644 index 00000000000..96b4ffc465a --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/default-pp.md @@ -0,0 +1,9 @@ +# Default_PP + +The value of [`⎕PP`](../../../language-reference-guide/system-functions/pp) (print precision) in a clear workspace. + +Valid values are those of `⎕PP`: an integer from `1` to `34`. + +Default is `10`. + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/default-pw.md b/dyalog-configuration-guide/docs/configuration-parameters/default-pw.md new file mode 100644 index 00000000000..b93d3a1a0ef --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/default-pw.md @@ -0,0 +1,9 @@ +# Default_PW + +The value of [`⎕PW`](../../../language-reference-guide/system-functions/pw) in a clear workspace. `⎕PW` is a property of the Session, so this value is overridden when a Session file is loaded, and when [`Auto_PW`](auto-pw.md) causes `⎕PW` to track the width of the Session (Windows) or terminal (UNIX and macOS) window. + +Valid values are those of `⎕PW`: an integer from `42` to `32767`. + + + +Related parameters: [Auto_PW](auto-pw.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/default-rtl.md b/dyalog-configuration-guide/docs/configuration-parameters/default-rtl.md new file mode 100644 index 00000000000..f9566b77673 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/default-rtl.md @@ -0,0 +1,9 @@ +# Default_RTL + +The value of [`⎕RTL`](../../../language-reference-guide/system-functions/rtl) (response time limit) in a clear workspace. + +Valid values are those of `⎕RTL`: `0` or a positive integer. + +Default is `0`. + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/default-wx.md b/dyalog-configuration-guide/docs/configuration-parameters/default-wx.md new file mode 100644 index 00000000000..080e03fd483 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/default-wx.md @@ -0,0 +1,13 @@ +# Default_WX + +The value of [`⎕WX`](../../../language-reference-guide/system-functions/wx) in a clear workspace. This determines whether the names of the properties, methods, and events of GUI objects are exposed: when they are (`⎕WX` is `1`), properties can be queried and set, and methods invoked, as if they were variables and functions, so those names cannot also be used for global variables in GUI objects. + +Valid values are those of `⎕WX`: `0`, `1`, or `3`. + +Default is `3`. + + +!!! Info "Information" + UNIX and macOS versions of Dyalog have no GUI objects, but `⎕SE` is present, so `⎕WX` still affects expressions such as `⎕SE.PropList`. + +See also [Expose properties of GUI Namespaces](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-object-syntax-tab) in the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dmxoutputonerror.md b/dyalog-configuration-guide/docs/configuration-parameters/dmxoutputonerror.md new file mode 100644 index 00000000000..7b94633f9a2 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dmxoutputonerror.md @@ -0,0 +1,12 @@ +# DMXOutputOnError + +Which windows `⎕DMX` error messages are displayed in. The value is the sum of the codes for the chosen windows. + +The value is the sum of the following: + +- `1` : Status window +- `2` : Session window + + + +See also the [Help/DMX tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-help-dmx-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dockableeditwindows.md b/dyalog-configuration-guide/docs/configuration-parameters/dockableeditwindows.md new file mode 100644 index 00000000000..e182fa7be70 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dockableeditwindows.md @@ -0,0 +1,13 @@ +# DockableEditWindows + +Whether individual edit windows can be undocked from (and docked back into) the MDI Editor window. This applies only in Classic Dyalog mode. + +Valid values are: + +- `0` : edit windows cannot be undocked +- `1` : edit windows can be undocked and re-docked + +Default is `0`. + + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/doubleclickedit.md b/dyalog-configuration-guide/docs/configuration-parameters/doubleclickedit.md new file mode 100644 index 00000000000..ed6fd6e52dd --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/doubleclickedit.md @@ -0,0 +1,12 @@ +# DoubleClickEdit + +Whether double-clicking over a name invokes the editor. + +Valid values are: + +- `0` : double-clicking selects a word, and triple-clicking selects the entire line +- `1` : double-clicking over a name invokes the editor + +Default is `1`. + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-discard-fn-source.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-discard-fn-source.md new file mode 100644 index 00000000000..8b37294ee95 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-discard-fn-source.md @@ -0,0 +1,12 @@ +# DYALOG_DISCARD_FN_SOURCE + +Whether source code is discarded when a function or operator is fixed by the editor or by `⎕FIX`. + +Valid values are: + +- `0` : source code is retained in the workspace, and is presented for editing as it was previously saved +- `1` : source code is discarded when an object is fixed (source code already retained in the workspace is not deleted) + +Default is `0`. + +For more information, see [Discard Source Information](../../../language-reference-guide/primitive-operators/i-beam/discard-source-information) and [Source as Typed](../../../earlier-release-notes/release-notes-v19-0/introduction/source-as-typed). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-eventlogginglevel.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-eventlogginglevel.md new file mode 100644 index 00000000000..5a9cfc80ba3 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-eventlogginglevel.md @@ -0,0 +1,17 @@ +# DYALOG_EVENTLOGGINGLEVEL + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +Whether a log entry is written to the Windows Event Log when Dyalog would otherwise pop up a message box because of an unexpected termination. + +Valid values are: + +- `0` : no entry is written to the Windows Event Log +- `1` : an entry is written to the Windows Event Log + + + +Related parameters: [DYALOG_EVENTLOGNAME](dyalog-eventlogname.md). + +For more information, see [Handling Unexpected Application Errors in Windows](../../../programming-reference-guide/error-trapping/handling-unexpected-errors). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-eventlogname.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-eventlogname.md new file mode 100644 index 00000000000..774a193aa9e --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-eventlogname.md @@ -0,0 +1,14 @@ +# DYALOG_EVENTLOGNAME + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +The name of the Windows Event Log to which an event message is written (or the source of the event message, depending on the Registry entries defined) when Dyalog would otherwise pop up a message box because of an unexpected termination. + +Valid values are an event log name or event source name. + + + +Related parameters: [DYALOG_EVENTLOGGINGLEVEL](dyalog-eventlogginglevel.md). + +For more information, see [Handling Unexpected Application Errors in Windows](../../../programming-reference-guide/error-trapping/handling-unexpected-errors). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-extvar-supported.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-extvar-supported.md new file mode 100644 index 00000000000..bb372f896d7 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-extvar-supported.md @@ -0,0 +1,13 @@ +# DYALOG_EXTVAR_SUPPORTED + +Whether support for external variables is enabled. Support for external variables has been deprecated and is scheduled for removal in a future release; they are not supported by default, and enabling this parameter reinstates them for the time being. + +Valid values are: + +- `0` : support for external variables is disabled +- `1` : support for external variables is enabled + +Default is `0`. + + +See also [Set External Variable](../../../language-reference-guide/system-functions/set-external-variable) and [Query External Variable](../../../language-reference-guide/system-functions/query-external-variable). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-gutter-enable.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-gutter-enable.md new file mode 100644 index 00000000000..46d6ae874f6 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-gutter-enable.md @@ -0,0 +1,13 @@ +# DYALOG_GUTTER_ENABLE + +Whether a gutter is displayed in the left-most column of the Session window. The gutter shows: + +- a small red circle on every line that has been modified in the Session (including older lines moved to and edited without pressing ``), indicating which lines will be re-executed when `` is next pressed; +- a left bracket `[` identifying groups of [implicit output](../../../programming-reference-guide/introduction/output). Other forms of output are not marked in this way. + +Valid values are: + +- `0` : no gutter is displayed +- `1` : the gutter is displayed + +Default depends on the interface: `0` for the TTY interface, `1` otherwise. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-initsession.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-initsession.md new file mode 100644 index 00000000000..2bd227eb9c1 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-initsession.md @@ -0,0 +1,10 @@ +# DYALOG_INITSESSION + +Whether Dyalog performs [Session Initialisation](../../../windows-ui-guide/the-session-object/session-initialisation) on start-up. Session initialisation makes Link, SALT, and other features available. + +Valid values are: + +- `0` : the Session is not initialised +- `1` : the Session is initialised + +Default is `1` for interactive sessions, and `0` for executable scripts and run-time versions. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-lineeditor-mode.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-lineeditor-mode.md new file mode 100644 index 00000000000..a673af46590 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-lineeditor-mode.md @@ -0,0 +1,12 @@ +# Dyalog_LineEditor_Mode + +Whether multi-line input is enabled in the Session. + +Valid values are: + +- `0` : multi-line input is disabled +- `1` : multi-line input is enabled + + + +See also [Multi-line Session Input](../../../windows-ui-guide/multiline-session-input) and the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-netcore.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-netcore.md new file mode 100644 index 00000000000..d25ac1539d7 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-netcore.md @@ -0,0 +1,16 @@ +# Dyalog_NETCore + +!!! Info "Information" + This configuration parameter is only relevant when using .NET or .NET Framework. + +Whether the .NET interface is used in preference to the .NET Framework interface. + +Valid values are: + +- `0` : the .NET Framework interface is used +- `1` : the .NET interface is used + +Default depends on operating system: + +- Microsoft Windows: `0` +- other platforms that support .NET: `1` diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-nopopups.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-nopopups.md new file mode 100644 index 00000000000..227d5c8b487 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-nopopups.md @@ -0,0 +1,15 @@ +# DYALOG_NOPOPUPS + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +Whether a message box appears when Dyalog terminates unexpectedly. + +Valid values are: + +- `0` : a message box appears +- `1` : no message box appears + +Default is `0`. + +For more information, see [Handling Unexpected Application Errors in Windows](../../../programming-reference-guide/error-trapping/handling-unexpected-errors). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-pixel-type.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-pixel-type.md new file mode 100644 index 00000000000..4f58dfaf343 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-pixel-type.md @@ -0,0 +1,15 @@ +# Dyalog_Pixel_Type + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +How the value `'Pixel'` of the [`Coord`](../../../object-reference/properties/coord) property is interpreted. + +Valid values are: + +- `RealPixel` : the object behaves as if `Coord` were `'RealPixel'` (also the behaviour when the parameter is undefined) +- `ScaledPixel` : the object behaves as if `Coord` were `'ScaledPixel'` + +Default is `RealPixel`. + +See also the [General tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab) of the Windows Configuration Dialog. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-serial.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-serial.md similarity index 53% rename from windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-serial.md rename to dyalog-configuration-guide/docs/configuration-parameters/dyalog-serial.md index 19ec7e5cca7..7127a5921de 100644 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-serial.md +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-serial.md @@ -1,5 +1,7 @@ # DYALOG_SERIAL -This parameter contains your Dyalog serial number. This must be set to the serial number issued to you. If not set, then the software is unregistered. +Your Dyalog serial number. This must be set to the serial number issued to you; if it is not set, the software is unregistered. + +Valid values are your issued serial number. For the full licence terms and conditions, see [https://www.dyalog.com/uploads/documents/Terms_and_Conditions.pdf](https://www.dyalog.com/uploads/documents/Terms_and_Conditions.pdf). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-serialfile.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-serialfile.md new file mode 100644 index 00000000000..6b3978f014e --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-serialfile.md @@ -0,0 +1,12 @@ +# DYALOG_SERIALFILE + +!!! Info "Information" + This configuration parameter is only relevant on the UNIX and macOS operating systems. + +The full path to the text file that contains your Dyalog serial number. If it is not set, the default location `$HOME/.dyalog/serial` is used. When Dyalog starts, if [`DYALOG_SERIAL`](dyalog-serial.md) is not already set it is set to the contents of this file. Setting this parameter is useful in a multi-user environment: a system administrator can maintain a single serial number file for all users. + +Valid values are a file path. + +Default is unset. + +Related parameters: [DYALOG_SERIAL](dyalog-serial.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog-shell-subprocess.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-shell-subprocess.md new file mode 100644 index 00000000000..96e1f5b6336 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog-shell-subprocess.md @@ -0,0 +1,13 @@ +# DYALOG_SHELL_SUBPROCESS + +!!! Info "Information" + This configuration parameter is only relevant on the AIX operating system. + +Whether the interpreter starts a small child process to handle calls to [`⎕SHELL`](../../../language-reference-guide/system-functions/shell). This improves the performance of `⎕SHELL` on AIX. + +Valid values are: + +- `0` : calls to `⎕SHELL` are handled without a child process +- `1` : the interpreter starts a child process to handle calls to `⎕SHELL` + +Default is `1`. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalog.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalog.md new file mode 100644 index 00000000000..d31ff36ebeb --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalog.md @@ -0,0 +1,12 @@ +# Dyalog + +The directory in which Dyalog is installed. It is used to form the default values of parameters such as [`APLKeys`](aplkeys.md), [`APLTrans`](apltrans.md), and [`WSPath`](wspath.md). + +Valid values are a directory path. + +Default is the directory from which the Dyalog program was loaded. + +!!! Info "Information" + On UNIX and macOS this parameter is set by the supplied startup script (`mapl`). To find the location of the Dyalog executable itself, read it from the process information (for example `/proc//` on Linux, or the output of `ps`) rather than from this parameter. + +Related parameters: [DyalogInstallDir](dyaloginstalldir.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalogemailaddress.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalogemailaddress.md new file mode 100644 index 00000000000..a3dbb49f238 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalogemailaddress.md @@ -0,0 +1,7 @@ +# DyalogEmailAddress + +The contact email address for Dyalog Ltd. + +Valid values are an email address. + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyaloghelpdir.md b/dyalog-configuration-guide/docs/configuration-parameters/dyaloghelpdir.md new file mode 100644 index 00000000000..a892a0eaee1 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyaloghelpdir.md @@ -0,0 +1,10 @@ +# DyalogHelpDir + +The location of the HTML-based help used when help is requested from the Session (from the Help menu or by pressing `F1`). + +Valid values are: + +- the full pathname of the directory that contains the Dyalog help file (`dyalog.chm`) +- the index page of the online HTML-based help on `help.dyalog.com`, for example `https://help.dyalog.com/21.0` + +Default is the full pathname of the directory containing `dyalog.chm`. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyaloginstalldir.md b/dyalog-configuration-guide/docs/configuration-parameters/dyaloginstalldir.md new file mode 100644 index 00000000000..42dfcfe208b --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyaloginstalldir.md @@ -0,0 +1,9 @@ +# DyalogInstallDir + +The full pathname of the directory in which Dyalog is installed. + +Valid values are a directory path. + + + +Related parameters: [Dyalog](dyalog.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyaloglink.md b/dyalog-configuration-guide/docs/configuration-parameters/dyaloglink.md new file mode 100644 index 00000000000..9de5195a02f --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyaloglink.md @@ -0,0 +1,9 @@ +# DyalogLink + +The directory containing the code for Link. Link is required for Session initialisation. + +Valid values are a directory path. + +Default is `[DYALOG]/StartupSession/Link`. + +For more information, see the [Link installation instructions](https://dyalog.github.io/link/4.0/Usage/Installation). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalogstartup-x.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalogstartup-x.md new file mode 100644 index 00000000000..bebbd9da1f5 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalogstartup-x.md @@ -0,0 +1,14 @@ +# DyalogStartup_X + +During Session initialisation, code is loaded from the directories given by [`DyalogStartupSE`](dyalogstartupse.md) into a corresponding namespace tree in `⎕SE`, and is then optionally executed. This parameter controls that execution. + +Valid values are: + +- `0` : the `Run` function (if it exists) in each top-level namespace loaded during Session start-up is executed, in alphabetical order of namespace +- `1` : the `Run` function is not executed + +Other values are reserved for future extension. + +Default is `0`. + +Related parameters: [DyalogStartupSE](dyalogstartupse.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalogstartup.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalogstartup.md new file mode 100644 index 00000000000..074a25a338e --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalogstartup.md @@ -0,0 +1,9 @@ +# DyalogStartup + +The name of a file containing APL code to be run each time Dyalog starts. + +Valid values are a file name. + +Default is a file named `SessionStartup`, with the extension `.aplf`, `.apln`, or `.aplc`, in the Dyalog directory. + +For more information, see [Session Initialisation](../../../windows-ui-guide/the-session-object/session-initialisation). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalogstartupse.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalogstartupse.md new file mode 100644 index 00000000000..77c2c5bbd5c --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalogstartupse.md @@ -0,0 +1,19 @@ +# DyalogStartupSE + +One or more *Session initialisation* directories containing APL code to be installed in `⎕SE`. + +Valid values are a list of directory names, separated by `;` (Windows) or `:` (UNIX and macOS). If the value begins with the separator, the default list is *extended* rather than *replaced*. + +Default is a directory named `StartupSession` in the standard locations. On Windows these might be: + +1. `C:\Program Files\Dyalog\Dyalog APL-64 21.0 Unicode` +2. `C:\Users\Bob\Documents\Dyalog APL Files` +3. `C:\Users\Bob\Documents\Dyalog APL-64 21.0 Unicode Files` + +where the version-specific name has the form `Dyalog APL{bit} {version} {edition}` (`{bit}` is `-64` for a 64-bit version, otherwise nothing; `{version}` is the major and secondary version numbers separated by a period; `{edition}` is `Unicode` for the Unicode edition, otherwise nothing). + +The effective sequence of directories is stored as a vector of character vectors in `⎕SE.Dyalog.StartupSession.AllPaths`. When the parameter is unset or extended, the `StartupSession` directory in the installation directory, the version-agnostic directory, and the version-specific directory are available as `⎕SE.Dyalog.StartupSession.Dyalog`, `.VerAgno`, and `.VerSpec` respectively. + +Related parameters: [DyalogStartup_X](dyalogstartup-x.md). + +For more information, see [Session Initialisation](../../../windows-ui-guide/the-session-object/session-initialisation). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/dyalogwebsite.md b/dyalog-configuration-guide/docs/configuration-parameters/dyalogwebsite.md new file mode 100644 index 00000000000..fe74e51e78e --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/dyalogwebsite.md @@ -0,0 +1,7 @@ +# DyalogWebSite + +The URL of the Dyalog web site. + +Valid values are a URL. + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/edit-cols.md b/dyalog-configuration-guide/docs/configuration-parameters/edit-cols.md new file mode 100644 index 00000000000..d7ad9853d02 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/edit-cols.md @@ -0,0 +1,11 @@ +# Edit_Cols + +The initial width of an edit window, in character units. + +Valid values are a positive integer number of character units. + + + +Related parameters: [Edit_Rows](edit-rows.md). + +See also the [Windows tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/edit-first-x.md b/dyalog-configuration-guide/docs/configuration-parameters/edit-first-x.md new file mode 100644 index 00000000000..eef916ca420 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/edit-first-x.md @@ -0,0 +1,11 @@ +# Edit_First_X + +The initial horizontal position, in character units, of the first edit window; subsequent edit windows are staggered from it. Applies only in Classic Dyalog mode. + +Valid values are an integer number of character units. + + + +Related parameters: [Edit_First_Y](edit-first-y.md), [Edit_Offset_X](edit-offset-x.md). + +See also the [Windows tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/edit-first-y.md b/dyalog-configuration-guide/docs/configuration-parameters/edit-first-y.md new file mode 100644 index 00000000000..85080705f70 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/edit-first-y.md @@ -0,0 +1,11 @@ +# Edit_First_Y + +The initial vertical position, in character units, of the first edit window; subsequent edit windows are staggered from it. Applies only in Classic Dyalog mode. + +Valid values are an integer number of character units. + + + +Related parameters: [Edit_First_X](edit-first-x.md), [Edit_Offset_Y](edit-offset-y.md). + +See also the [Windows tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/edit-offset-x.md b/dyalog-configuration-guide/docs/configuration-parameters/edit-offset-x.md new file mode 100644 index 00000000000..d5fe278781d --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/edit-offset-x.md @@ -0,0 +1,11 @@ +# Edit_Offset_X + +The number of characters by which an edit window is staggered horizontally from the previous one. + +Valid values are an integer number of character units. + + + +Related parameters: [Edit_Offset_Y](edit-offset-y.md), [Edit_First_X](edit-first-x.md). + +See also the [Windows tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/edit-offset-y.md b/dyalog-configuration-guide/docs/configuration-parameters/edit-offset-y.md new file mode 100644 index 00000000000..68164eb81e4 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/edit-offset-y.md @@ -0,0 +1,11 @@ +# Edit_Offset_Y + +The number of characters by which an edit window is staggered vertically from the previous one. + +Valid values are an integer number of character units. + + + +Related parameters: [Edit_Offset_X](edit-offset-x.md), [Edit_First_Y](edit-first-y.md). + +See also the [Windows tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/edit-rows.md b/dyalog-configuration-guide/docs/configuration-parameters/edit-rows.md new file mode 100644 index 00000000000..7697e1e05d7 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/edit-rows.md @@ -0,0 +1,11 @@ +# Edit_Rows + +The initial height of an edit window, in character units. + +Valid values are a positive integer number of character units. + + + +Related parameters: [Edit_Cols](edit-cols.md). + +See also the [Windows tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/editor-columns.md b/dyalog-configuration-guide/docs/configuration-parameters/editor-columns.md new file mode 100644 index 00000000000..bba28878d7d --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/editor-columns.md @@ -0,0 +1,16 @@ +# EDITOR_COLUMNS + +!!! Info "Information" + This configuration parameter is only relevant on the UNIX and macOS operating systems. + +The columns shown in the Editor, set separately for each type of object. There is one parameter per object type: + +- `EDITOR_COLUMNS_CHARACTER_ARRAY` +- `EDITOR_COLUMNS_CLASS` +- `EDITOR_COLUMNS_FUNCTION` +- `EDITOR_COLUMNS_NAMESPACE` +- `EDITOR_COLUMNS_NUMERIC_ARRAY` + +Valid values are a list of column names. + +See also [Configuring the Editor](../../../unix-installation-and-configuration-guide/configuring-the-editor). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/editorstate.md b/dyalog-configuration-guide/docs/configuration-parameters/editorstate.md new file mode 100644 index 00000000000..668aca7e93e --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/editorstate.md @@ -0,0 +1,5 @@ +# EditorState + +An internal parameter that records the state (normal or maximised) of the last edit window, so that the next edit window is created in the same state. It is not intended to be set by the user. + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/enable-cef.md b/dyalog-configuration-guide/docs/configuration-parameters/enable-cef.md new file mode 100644 index 00000000000..78fb002c3dd --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/enable-cef.md @@ -0,0 +1,13 @@ +# Enable_CEF + +Whether the [Chromium Embedded Framework (CEF)](https://en.wikipedia.org/wiki/Chromium_Embedded_Framework) is enabled. When disabled, an attempt to create an [HTMLRenderer](../../../object-reference/objects/htmlrenderer) object fails with an error message. + +Valid values are: + +- `0` : CEF is disabled +- `1` : CEF is enabled + +Default is `1`, except when Dyalog is not running under a desktop (for example, in a PuTTY session), where the default is `0`. + +!!! Info "Information" + The value of **Enable_CEF** in the Windows Registry or a configuration file is currently ignored; only a value set on the command line or as an environment variable is honoured, otherwise the default is used. Under UNIX and macOS, Auxiliary Processors cannot be used while CEF is enabled. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/erroronexternalexception.md b/dyalog-configuration-guide/docs/configuration-parameters/erroronexternalexception.md new file mode 100644 index 00000000000..d9e0c69c515 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/erroronexternalexception.md @@ -0,0 +1,10 @@ +# ErrorOnExternalException + +The behaviour when a system exception occurs in a call on an external DLL or shared library. + +Valid values are: + +- `0` : Dyalog terminates with a system error +- `1` : Dyalog generates a trappable `EXTERNAL DLL EXCEPTION` error (91) instead of terminating + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/externalhelpurl.md b/dyalog-configuration-guide/docs/configuration-parameters/externalhelpurl.md new file mode 100644 index 00000000000..94d1984c8b6 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/externalhelpurl.md @@ -0,0 +1,14 @@ +# ExternalHelpURL + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +The URL used when [`UseExternalHelpURL`](useexternalhelpurl.md) is `1` and Dyalog displays help for external objects (such as .NET types) through the Microsoft Document Explorer and online help (for example from Visual Studio). The default is usually sufficient, but some configurations require it to be changed. + +Valid values are a URL. + + + +Related parameters: [UseExternalHelpURL](useexternalhelpurl.md). + +See also the [Help/DMX tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-help-dmx-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/file-stack-size.md b/dyalog-configuration-guide/docs/configuration-parameters/file-stack-size.md new file mode 100644 index 00000000000..a79927a1fe7 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/file-stack-size.md @@ -0,0 +1,9 @@ +# File_Stack_Size + +The number of most-recently-used workspaces displayed in the Session File menu. + +Valid values are a non-negative integer. + + + +See also the [General tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/greet-bitmap.md b/dyalog-configuration-guide/docs/configuration-parameters/greet-bitmap.md new file mode 100644 index 00000000000..e43ddaf3a9c --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/greet-bitmap.md @@ -0,0 +1,7 @@ +# Greet_Bitmap + +The filename of a bitmap displayed during initialisation of the Dyalog application, typically to show a product logo from a run-time application. The bitmap remains until an error occurs or it is removed using the [GreetBitmap](../../../object-reference/methodorevents/greetbitmap) method of the Root object. For example, `Greet_Bitmap=c:\myapp\logo.bmp`. + +Valid values are a file path. + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/history-size.md b/dyalog-configuration-guide/docs/configuration-parameters/history-size.md new file mode 100644 index 00000000000..fcb20f8f280 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/history-size.md @@ -0,0 +1,9 @@ +# History_Size + +The size of the buffer used to store previously entered (input) lines in the Session. See [Specifying Size-related Parameters](configuration-parameters.md) for how to give a valid size. The maximum is 2 GB. + + + +Related parameters: [Input_Size](input-size.md). + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/inifile.md b/dyalog-configuration-guide/docs/configuration-parameters/inifile.md new file mode 100644 index 00000000000..7b8e45400d3 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/inifile.md @@ -0,0 +1,23 @@ +# IniFile + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +The name of the Windows Registry folder that holds the configuration parameters. For example, `INIFILE=Software\Dyalog\mysettings`. + +Valid values are a Registry folder path. + +Default depends on edition (64-bit and 32-bit versions respectively): + +- Unicode edition: + ``` + Software\Dyalog\Dyalog APL/W-64 {{ version_majmin }} Unicode + Software\Dyalog\Dyalog APL/W {{ version_majmin }} Unicode + ``` +- Classic edition: + ``` + Software\Dyalog\Dyalog APL/W-64 {{ version_majmin }} + Software\Dyalog\Dyalog APL/W {{ version_majmin }} + ``` + +See also the [General tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/initfullscriptnormal.md b/dyalog-configuration-guide/docs/configuration-parameters/initfullscriptnormal.md new file mode 100644 index 00000000000..e4f9cc0f9b8 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/initfullscriptnormal.md @@ -0,0 +1,14 @@ +# InitFullScriptNormal + +When the Editor is used to edit a script (such as a Class or Namespace) that is **not suspended**, this controls whether fixing the script and exiting the Editor re-fixes just the functions in the script, or re-executes the whole script (re-initialising any fields or variables defined within it). It determines the action associated with the `` (Esc) key; the other action remains available on the Editor File menu (and can be assigned to `` in the Keyboard Shortcuts tab). + +Valid values are: + +- `Only Functions` : only the functions in the script are re-fixed +- `Everything` : the whole script is re-executed + + + +Related parameters: [InitFullScriptSusp](initfullscriptsusp.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/initfullscriptsusp.md b/dyalog-configuration-guide/docs/configuration-parameters/initfullscriptsusp.md new file mode 100644 index 00000000000..3933b7f98fd --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/initfullscriptsusp.md @@ -0,0 +1,14 @@ +# InitFullScriptSusp + +When the Editor is used to edit a script (such as a Class or Namespace) that is **suspended**, this controls whether fixing the script and exiting the Editor re-fixes just the functions in the script, or re-executes the whole script (re-initialising any fields or variables defined within it). It determines the action associated with the `` (Esc) key; the other action remains available on the Editor File menu (and can be assigned to `` in the Keyboard Shortcuts tab). + +Valid values are: + +- `Only Functions` : only the functions in the script are re-fixed +- `Everything` : the whole script is re-executed + + + +Related parameters: [InitFullScriptNormal](initfullscriptnormal.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/initialkeyboardlayout.md b/dyalog-configuration-guide/docs/configuration-parameters/initialkeyboardlayout.md new file mode 100644 index 00000000000..b58d322d9d3 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/initialkeyboardlayout.md @@ -0,0 +1,14 @@ +# InitialKeyboardLayout + +!!! Info "Information" + This configuration parameter is only relevant when using the Unicode edition of Dyalog. + +The name of the keyboard to be selected on start-up. When an APL Session starts, this layout becomes the current keyboard layout if [`InitialKeyboardLayoutInUse`](initialkeyboardlayoutinuse.md) is `1`. + +Valid values are the name of an installed keyboard layout. + + + +Related parameters: [InitialKeyboardLayoutInUse](initialkeyboardlayoutinuse.md), [InitialKeyboardLayoutShowAll](initialkeyboardlayoutshowall.md). + +See also the [Unicode Input tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutinuse.md b/dyalog-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutinuse.md new file mode 100644 index 00000000000..940cda54120 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutinuse.md @@ -0,0 +1,17 @@ +# InitialKeyboardLayoutInUse + +!!! Info "Information" + This configuration parameter is only relevant when using the Unicode edition of Dyalog. + +Whether the keyboard given by [`InitialKeyboardLayout`](initialkeyboardlayout.md) is selected as the current keyboard layout when an APL Session starts. + +Valid values are: + +- `0` : the initial keyboard layout is not selected automatically +- `1` : the initial keyboard layout is selected on start-up + + + +Related parameters: [InitialKeyboardLayout](initialkeyboardlayout.md). + +See also the [Unicode Input tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutshowall.md b/dyalog-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutshowall.md new file mode 100644 index 00000000000..f1d041a21fd --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutshowall.md @@ -0,0 +1,17 @@ +# InitialKeyboardLayoutShowAll + +!!! Info "Information" + This configuration parameter is only relevant when using the Unicode edition of Dyalog. + +Whether all installed keyboards are listed in the choice of keyboards on the Unicode Input tab of the Configuration dialog. + +Valid values are: + +- `0` : only Dyalog keyboards are listed +- `1` : all installed keyboards are listed + + + +Related parameters: [InitialKeyboardLayout](initialkeyboardlayout.md). + +See also the [Unicode Input tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/input-size.md b/dyalog-configuration-guide/docs/configuration-parameters/input-size.md new file mode 100644 index 00000000000..2876f02c189 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/input-size.md @@ -0,0 +1,9 @@ +# Input_Size + +The size of the buffer used to store marked lines (lines awaiting execution) in the Session. See [Specifying Size-related Parameters](configuration-parameters.md) for how to give a valid size. + + + +Related parameters: [History_Size](history-size.md). + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/keyboardinputdelay.md b/dyalog-configuration-guide/docs/configuration-parameters/keyboardinputdelay.md new file mode 100644 index 00000000000..c92037e6aaf --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/keyboardinputdelay.md @@ -0,0 +1,7 @@ +# KeyboardInputDelay + +The delay, in milliseconds, before the system reacts to a keystroke by updating the name of the Current Object in the Session status bar (see [The Current Object](../../../windows-ui-guide/session-manager)) and offering a list of names for auto-completion (see the [Auto Complete tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab)). + +Valid values are a number of milliseconds. + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/layout-file.md b/dyalog-configuration-guide/docs/configuration-parameters/layout-file.md new file mode 100644 index 00000000000..696eabdb6a5 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/layout-file.md @@ -0,0 +1,19 @@ +# LAYOUT_FILE + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +The path (absolute, or relative to the working directory) and name of the Session layout file. The Session layout file records the docking layout of the Session, that is, the position of the Editor, the Debugger, and the other tools that can be docked in the Session window. + +The file is read when Dyalog starts, and the current layout is written back to it when Dyalog exits, so a layout chosen from the [Layout menu](../../../windows-ui-guide/session-menubar#the-layout-menu) is still in effect the next time Dyalog starts, without the session file having to be saved. A layout file contains no APL code. + +Valid values are a file path including the `.layout` extension, which is not assumed. + +Default is `default.layout` in the Dyalog folder of your Documents directory, for example `C:\Users\Bob\Documents\Dyalog APL-64 21.0 Unicode Files\default.layout`. The folder name identifies the interpreter: `-64` is included for the 64-bit interpreter and `Unicode` for the Unicode edition, so the 32-bit Classic edition of Dyalog 19.0 uses `Dyalog APL 19.0 Files`. + +The layout files supplied with Dyalog, such as `classic.layout` and `Bottom.layout`, are installed in the directory given by [`Dyalog`](dyalog.md), for example `C:\Program Files\Dyalog\Dyalog APL-64 21.0 Unicode`. + +!!! Info "Information" + The docking state of a user-defined Form docked in the Session cannot be recorded in the layout file; the session file must be saved to preserve it. + +Related parameters: [Session_File](session-file.md), [Log_File](log-file.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/load.md b/dyalog-configuration-guide/docs/configuration-parameters/load.md new file mode 100644 index 00000000000..8d8a2e655e5 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/load.md @@ -0,0 +1,22 @@ +# Load + +The name of a workspace, or of a directory or text file containing APL source code, to be loaded when Dyalog starts. It is normally given on the command line or in a configuration file, and overrides a workspace name given as the last item on the command line. + +- If **Load** names a text file, `2 ⎕FIX` imports its contents and associates the file with each fixed object. +- If **Load** names a directory, Link associates the directory with the active workspace and imports the code (see [Link](https://dyalog.github.io/link)). + +Having loaded the workspace or fixed the code, Dyalog executes the expression given by [`LX`](lx.md) if it is set. If `LX` is not set and the `-x` command-line option was given, no further action is taken. Otherwise Dyalog derives an expression to execute: + +- if **Load** is a directory, `Run ,⊂`; +- if **Load** is a workspace (determined by its internal signature), the expression given by its [`⎕LX`](../../../language-reference-guide/system-functions/lx); +- otherwise, for a source file, according to its extension: + +|File Extension|Type|Expression| +|---|---|---| +|`.aplf`|Function source code|`filename 0⍴⊂''`| +|`.aplc`|Class source code|`filename.Run 0⍴⊂''`| +|`.apln`|Namespace source code|`filename.Run 0⍴⊂''`| + +where `filename` is the **Load** value without its extension. Nothing is executed for operator (`.aplo`) or interface (`.apli`) source files. (The argument `0⍴⊂''` may change in a future version.) + +Related parameters: [LX](lx.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/localdyalogdir.md b/dyalog-configuration-guide/docs/configuration-parameters/localdyalogdir.md new file mode 100644 index 00000000000..2baed60d964 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/localdyalogdir.md @@ -0,0 +1,9 @@ +# localdyalogdir + +The directory in which Dyalog is installed on the client, in a client/server installation. + +Valid values are a directory path. + + + +Related parameters: [Dyalog](dyalog.md), [DyalogInstallDir](dyaloginstalldir.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/log-file-inuse.md b/dyalog-configuration-guide/docs/configuration-parameters/log-file-inuse.md new file mode 100644 index 00000000000..10f1d6a79c1 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/log-file-inuse.md @@ -0,0 +1,14 @@ +# Log_File_InUse + +Whether the Session log is saved to the [Session log file](log-file.md) and reloaded the next time a Session is started. + +Valid values are: + +- `0` : the Session log is not saved +- `1` : the Session log is saved and reloaded the next time a Session is started + +Default is `1`. + +Related parameters: [Log_File](log-file.md), [Log_Size](log-size.md). + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/log-file.md b/dyalog-configuration-guide/docs/configuration-parameters/log-file.md new file mode 100644 index 00000000000..28e2aec7865 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/log-file.md @@ -0,0 +1,16 @@ +# Log_File + +The path (absolute, or relative to the working directory) and name of the Session log file. + +Session log files are not interchangeable between different versions, editions, or widths of Dyalog. Starting a second instance of the same interpreter with the same log file name would normally fail to create a log for that instance, so the default name includes a `*` character: at start-up Dyalog replaces the `*` with an increasing integer, beginning at `000`, and opens and locks the first name it can (for example `log*.dlfx` yields `log000.dlfx`, `log001.dlfx`, and so on). Closing an instance frees its number for reuse. The process fails, and no log is used, if the number would exceed `999`. + +The `LogFile` property of `⎕SE` reports the name of the log file in use. + +Default depends on operating system: + +- Microsoft Windows: `\Dyalog APL[-64] . [Unicode ]Files\default_*.dlfx`, for example `C:\Users\Bob\Documents\Dyalog APL-64 21.0 Unicode Files\default_*.dlfx` +- UNIX and macOS: `$HOME/.dyalog/session_log__*.dlf`, for example `$HOME/.dyalog/session_log_210U64_*.dlf` + +Related parameters: [Log_File_InUse](log-file-inuse.md), [Log_Size](log-size.md). + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/log-size.md b/dyalog-configuration-guide/docs/configuration-parameters/log-size.md new file mode 100644 index 00000000000..ef350558177 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/log-size.md @@ -0,0 +1,9 @@ +# Log_Size + +The size of the Session log buffer. See [Specifying Size-related Parameters](configuration-parameters.md) for how to give a valid size. The maximum is 2 GB. + + + +Related parameters: [Log_File](log-file.md), [Log_File_InUse](log-file-inuse.md). + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/lx.md b/dyalog-configuration-guide/docs/configuration-parameters/lx.md new file mode 100644 index 00000000000..fb6855f783a --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/lx.md @@ -0,0 +1,10 @@ +# LX + +!!! Info "Information" + This configuration parameter is only relevant when using the Unicode edition of Dyalog, and only in the development interpreter (it is ignored in run-time applications). + +An expression to be executed after Dyalog has started and loaded a workspace or a text file of APL source code (see [`Load`](load.md)). It is run only at start-up and overrides the workspace latent expression `⎕LX`; it is ignored when a workspace is loaded other than at start-up. + +Valid values are an APL expression. + +Related parameters: [Load](load.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/mapchars.md b/dyalog-configuration-guide/docs/configuration-parameters/mapchars.md new file mode 100644 index 00000000000..f73c8bbc5dd --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/mapchars.md @@ -0,0 +1,19 @@ +# mapchars + +!!! Info "Information" + This configuration parameter is only relevant when using the Classic edition of Dyalog. + +The mapping between `⎕AV` and the font must be strictly one-to-one. Historically a few pairs of `⎕AV` characters were mapped to a single font glyph (for example the ASCII pipe `¦` and the APL style `|`); **mapchars** defines any such mappings. + +**mapchars** is a string of pairs of hexadecimal values, each an origin-`0` index into `⎕AV`. The first character of each pair is mapped to the second on output. + +The default is `DB0DEBA7EEC00BE0`, which defines the following mappings: + +| From (hex) | From (decimal) | From | To (hex) | To (decimal) | To | +|---|---|---|---|---|---| +| DB | 219 | `‘` | 0D | 13 | `'` | +| EB | 235 | `^` | A7 | 167 | `^` | +| EE | 238 | `⌷` | C0 | 192 | `\|` | +| 0B | 11 | `.` | E0 | 224 | `.` | + +To clear all mappings, set `mapchars=0000`. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/maxaplcores.md b/dyalog-configuration-guide/docs/configuration-parameters/maxaplcores.md new file mode 100644 index 00000000000..c25d18d37cb --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/maxaplcores.md @@ -0,0 +1,11 @@ +# MaxAplCores + +The maximum number of *aplcore* files retained. It applies, in conjunction with [`AplCoreName`](aplcorename.md), when the string given by `AplCoreName` ends with an asterisk (`*`). When saving an aplcore, Dyalog finds the highest-numbered matching file (or `0` if none), increments it, saves the new aplcore with that number, and deletes lower-numbered files so that at most this many are kept. + +Valid values are a positive integer. + + + +Related parameters: [AplCoreName](aplcorename.md). + +See also [aplcore Parameters](../../../language-reference-guide/primitive-operators/i-beam/aplcore-parameters). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/maxws.md b/dyalog-configuration-guide/docs/configuration-parameters/maxws.md new file mode 100644 index 00000000000..0e09b320c5b --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/maxws.md @@ -0,0 +1,12 @@ +# MaxWS + +The amount of memory allocated to the workspace at start-up. See [Specifying Size-related Parameters](configuration-parameters.md) for how to give a valid size; for example `MAXWS=4G` requests a 4 GiB workspace. Values less than `4M` are ignored, and the maximum is `15E`. + +Default depends on platform: + +- Raspberry Pi: `64M` +- all other platforms: `256M` + +The memory used for the workspace must be contiguous. Dyalog places no implicit restriction on workspace size, and virtual memory allows more than the physically installed memory to be addressed; however, a workspace that greatly exceeds physical memory causes excessive paging. 32-bit versions are typically limited to 1.3-1.9 GiB (a limitation of the operating system on 32-bit processes, not of Dyalog); 64-bit versions have no such limit. + +See also the [Workspace tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-workspace-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/overstrikespopup.md b/dyalog-configuration-guide/docs/configuration-parameters/overstrikespopup.md new file mode 100644 index 00000000000..4708c0618cd --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/overstrikespopup.md @@ -0,0 +1,17 @@ +# OverstrikesPopup + +!!! Info "Information" + This configuration parameter is only relevant when using the Unicode edition of Dyalog. + +Whether the Overstrikes popup is enabled. + +Valid values are: + +- `0` : the Overstrikes popup is disabled +- `1` : the Overstrikes popup is enabled + + + +Related parameters: [ResolveOverstrikes](resolveoverstrikes.md). + +See also the [Unicode Input tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/passexceptionstoopsys.md b/dyalog-configuration-guide/docs/configuration-parameters/passexceptionstoopsys.md new file mode 100644 index 00000000000..c7660bad875 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/passexceptionstoopsys.md @@ -0,0 +1,15 @@ +# PassExceptionsToOpSys + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +The default state of the *Pass Exception* check box in the System Error dialog box. + +Valid values are: + +- `0` : *Pass Exception* is cleared by default +- `1` : *Pass Exception* is checked by default + + + +For more information, see [Handling Unexpected Application Errors in Windows](../../../programming-reference-guide/error-trapping/handling-unexpected-errors). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/pfkey-size.md b/dyalog-configuration-guide/docs/configuration-parameters/pfkey-size.md new file mode 100644 index 00000000000..35847d356fc --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/pfkey-size.md @@ -0,0 +1,7 @@ +# PFKey_Size + +The size of the buffer used to store programmable function key definitions (see [Program Function Key (`⎕PFKEY`)](../../../language-reference-guide/system-functions/pfkey)). If the buffer is too small, adding a new definition signals a `LIMIT ERROR`. See [Specifying Size-related Parameters](configuration-parameters.md) for how to give a valid size. + + + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/programfolder.md b/dyalog-configuration-guide/docs/configuration-parameters/programfolder.md new file mode 100644 index 00000000000..d1db2f8fc23 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/programfolder.md @@ -0,0 +1,10 @@ +# ProgramFolder + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +The folder in which the Dyalog program icons are installed. + +Valid values are a folder name. + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/propertyexposeroot.md b/dyalog-configuration-guide/docs/configuration-parameters/propertyexposeroot.md new file mode 100644 index 00000000000..600f11d0d00 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/propertyexposeroot.md @@ -0,0 +1,14 @@ +# PropertyExposeRoot + +The default value, in a clear workspace, of the flag that specifies whether the names of the properties, methods, and events of the Root object are exposed. When set, the properties of Root can be queried and set, and its methods invoked, as if they were variables and functions, so those names cannot also be used for global variables in the workspace. + +Valid values are: + +- `0` : the names are not exposed +- `1` : the names are exposed + + + +Related parameters: [PropertyExposeSE](propertyexposese.md), [Default_WX](default-wx.md). + +See also the [Object Syntax tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-object-syntax-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/propertyexposese.md b/dyalog-configuration-guide/docs/configuration-parameters/propertyexposese.md new file mode 100644 index 00000000000..660abb8c138 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/propertyexposese.md @@ -0,0 +1,14 @@ +# PropertyExposeSE + +The default value, in a clear workspace, of the flag that specifies whether the names of the properties, methods, and events of the Session object (`⎕SE`) are exposed. When set, the properties of `⎕SE` can be queried and set, and its methods invoked, as if they were variables and functions, so those names cannot also be used for global variables in the `⎕SE` namespace. + +Valid values are: + +- `0` : the names are not exposed +- `1` : the names are exposed + + + +Related parameters: [PropertyExposeRoot](propertyexposeroot.md). + +See also the [Object Syntax tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-object-syntax-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/qcmd-timeout.md b/dyalog-configuration-guide/docs/configuration-parameters/qcmd-timeout.md new file mode 100644 index 00000000000..b9fc06387e0 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/qcmd-timeout.md @@ -0,0 +1,10 @@ +# qcmd_timeout + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +The length of time, in milliseconds, that Dyalog waits for the execution of a Windows command to start. + +Valid values are a number of milliseconds. + +Default is `5000`. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/resolveoverstrikes.md b/dyalog-configuration-guide/docs/configuration-parameters/resolveoverstrikes.md new file mode 100644 index 00000000000..9c8dd390b0a --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/resolveoverstrikes.md @@ -0,0 +1,17 @@ +# ResolveOverstrikes + +!!! Info "Information" + This configuration parameter is only relevant when using the Unicode edition of Dyalog. + +Whether an APL composite symbol can be entered using overstrikes. + +Valid values are: + +- `0` : overstrikes are disabled +- `1` : overstrikes are enabled + + + +Related parameters: [OverstrikesPopup](overstrikespopup.md). + +See also the [Unicode Input tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only) of the Windows Configuration Dialog. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/ride-init.md b/dyalog-configuration-guide/docs/configuration-parameters/ride-init.md similarity index 92% rename from windows-installation-and-configuration-guide/docs/configuration-parameters/ride-init.md rename to dyalog-configuration-guide/docs/configuration-parameters/ride-init.md index 3cd3eab473f..eb5f17a796f 100644 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/ride-init.md +++ b/dyalog-configuration-guide/docs/configuration-parameters/ride-init.md @@ -2,7 +2,10 @@ This parameter determines how the interpreter should behave with respect to the Ride protocol. Setting this configuration parameter on the machine that hosts the interpreter enables the interpreter-Ride connection. -RIDE_Init can only be used to specify a limited number of Ride configuration options; the rest must be specified in a Ride ini file. Full details describing how to configure Ride, including using certificates to authenticate connections can be found in the [Ride User Guide](https://dyalog.github.io/ride). +RIDE_Init can only be used to specify a limited number of Ride configuration options; the rest must be specified in a Ride ini file. + +!!! Info "Information" + This configuration parameter is only relevant when using Ride. Full details describing how to configure Ride, including using certificates to authenticate connections can be found in the [Ride User Guide](https://dyalog.github.io/ride). The format of the value is: ``` diff --git a/dyalog-configuration-guide/docs/configuration-parameters/ride-spawned.md b/dyalog-configuration-guide/docs/configuration-parameters/ride-spawned.md new file mode 100644 index 00000000000..0d0f3930c04 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/ride-spawned.md @@ -0,0 +1,15 @@ +# Ride_Spawned + +!!! Info "Information" + This configuration parameter is only relevant when using Ride. + +Whether `⎕SR` and `)SH` are disabled. It is used to prevent user interfaces that a Ride session does not support (and which would otherwise make the session unresponsive) from being executed. + +Valid values are: + +- `0` : `⎕SR` and `)SH` behave normally +- non-zero : `⎕SR` and `)SH` are disabled and instead generate a `DOMAIN ERROR` + + + +For more information, see the [Ride User Guide](https://dyalog.github.io/ride). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/runasservice.md b/dyalog-configuration-guide/docs/configuration-parameters/runasservice.md new file mode 100644 index 00000000000..660e2da0242 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/runasservice.md @@ -0,0 +1,14 @@ +# RunAsService + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +Whether Dyalog runs as a service: it does not prompt for confirmation when the user logs off, and the interpreter continues to run across the logoff/logon process. + +Valid values are: + +- `0` : Dyalog does not run as a service +- `1` : Dyalog runs as a service +- `2` : as `1`, but graphical user-interface features are disabled to reduce resource use; `⎕WC` then fails with a `LIMIT ERROR` for every object except Timer + +Default is `0`. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/savecontinueonexit.md b/dyalog-configuration-guide/docs/configuration-parameters/savecontinueonexit.md new file mode 100644 index 00000000000..a9482ace828 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/savecontinueonexit.md @@ -0,0 +1,12 @@ +# SaveContinueOnExit + +Whether the current workspace is saved as `CONTINUE.DWS` before Dyalog terminates. + +Valid values are: + +- `0` : the workspace is not saved on exit +- `1` : the workspace is saved as `CONTINUE.DWS` on exit + + + +Related parameters: [SaveSessionOnExit](savesessiononexit.md), [SaveLogOnExit](savelogonexit.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/savelogonexit.md b/dyalog-configuration-guide/docs/configuration-parameters/savelogonexit.md new file mode 100644 index 00000000000..104752b72a6 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/savelogonexit.md @@ -0,0 +1,12 @@ +# SaveLogOnExit + +Whether the Session log is saved before Dyalog terminates. + +Valid values are: + +- `0` : the Session log is not saved on exit +- `1` : the Session log is saved on exit + + + +Related parameters: [SaveSessionOnExit](savesessiononexit.md), [SaveContinueOnExit](savecontinueonexit.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/savesessiononexit.md b/dyalog-configuration-guide/docs/configuration-parameters/savesessiononexit.md new file mode 100644 index 00000000000..3a48e35df7e --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/savesessiononexit.md @@ -0,0 +1,12 @@ +# SaveSessionOnExit + +Whether the current Session is saved in the Session file before Dyalog terminates. + +Valid values are: + +- `0` : the Session is not saved on exit +- `1` : the Session is saved on exit + + + +Related parameters: [SaveContinueOnExit](savecontinueonexit.md), [SaveLogOnExit](savelogonexit.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/serial.md b/dyalog-configuration-guide/docs/configuration-parameters/serial.md new file mode 100644 index 00000000000..f9bbd7ddef5 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/serial.md @@ -0,0 +1,10 @@ +# Serial + +!!! Legacy "Legacy" + This configuration parameter is superseded by [`DYALOG_SERIAL`](dyalog-serial.md). + +Your Dyalog serial number. + +Valid values are your issued serial number. + +Related parameters: [DYALOG_SERIAL](dyalog-serial.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/session-file.md b/dyalog-configuration-guide/docs/configuration-parameters/session-file.md new file mode 100644 index 00000000000..808881ac5f1 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/session-file.md @@ -0,0 +1,9 @@ +# Session_File + +The name of the file from which the Session (`⎕SE`) is loaded when Dyalog starts. If no extension is given, `.dse` is assumed. The session file holds the `⎕SE` object last saved in it, which defines the appearance and behaviour of the Session menu bar, tool bars, and status bar, together with any functions and variables held in the `⎕SE` namespace. + +Default is `[DYALOG]/default.dse` (the `default.dse` file in the Dyalog installation directory). + + + +See also the [Session tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/showstatusonerror.md b/dyalog-configuration-guide/docs/configuration-parameters/showstatusonerror.md new file mode 100644 index 00000000000..60123f8a0f9 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/showstatusonerror.md @@ -0,0 +1,10 @@ +# ShowStatusOnError + +Whether the Status window is displayed automatically, when required, when Dyalog attempts to write output to it. + +Valid values are: + +- `0` : the Status window is not displayed automatically +- `1` : the Status window is displayed automatically when output is written to it + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/skiplines.md b/dyalog-configuration-guide/docs/configuration-parameters/skiplines.md new file mode 100644 index 00000000000..bb30ecc16f6 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/skiplines.md @@ -0,0 +1,13 @@ +# SkipLines + +Causes the Tracer to skip lines that contain no executable statement, with the exception of the first line of the function and, in a traditional function (not a dfn), the last line if it is a comment. + +The value is the sum of the following: + +- `1` : skip blank lines +- `2` : skip comment lines +- `4` : skip locals lines + + + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/sm-cols.md b/dyalog-configuration-guide/docs/configuration-parameters/sm-cols.md new file mode 100644 index 00000000000..928fd671889 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/sm-cols.md @@ -0,0 +1,9 @@ +# SM_Cols + +The width, in characters, of the window used to display [`⎕SM`](../../../language-reference-guide/system-functions/sm) when it is used stand-alone. It is not used when the window is specified through the SM object. + +Valid values are a positive integer number of characters. + + + +Related parameters: [SM_Rows](sm-rows.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/sm-rows.md b/dyalog-configuration-guide/docs/configuration-parameters/sm-rows.md new file mode 100644 index 00000000000..b12f12bfc69 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/sm-rows.md @@ -0,0 +1,9 @@ +# SM_Rows + +The height, in characters, of the window used to display [`⎕SM`](../../../language-reference-guide/system-functions/sm) when it is used stand-alone. It is not used when the window is specified through the SM object. + +Valid values are a positive integer number of characters. + + + +Related parameters: [SM_Cols](sm-cols.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/statusonedit.md b/dyalog-configuration-guide/docs/configuration-parameters/statusonedit.md new file mode 100644 index 00000000000..fd1856266f0 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/statusonedit.md @@ -0,0 +1,14 @@ +# StatusOnEdit + +Whether a status bar is displayed along the bottom of individual Edit windows. + +Valid values are: + +- `0` : no status bar is displayed +- `1` : a status bar is displayed + + + +Related parameters: [ToolBarsOnEdit](toolbarsonedit.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/tabstops.md b/dyalog-configuration-guide/docs/configuration-parameters/tabstops.md new file mode 100644 index 00000000000..220e7f2bd06 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/tabstops.md @@ -0,0 +1,11 @@ +# TabStops + +The number of spaces inserted by pressing the Tab key in the editor. This width is also used to indent Control Structures when [`AutoFormat`](autoformat.md) is enabled. + +Valid values are a positive integer number of spaces. + +Default is `4`. + +Related parameters: [AutoFormat](autoformat.md), [AutoIndent](autoindent.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/toolbarsonedit.md b/dyalog-configuration-guide/docs/configuration-parameters/toolbarsonedit.md new file mode 100644 index 00000000000..fd78d235263 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/toolbarsonedit.md @@ -0,0 +1,14 @@ +# ToolBarsOnEdit + +Whether tool bars are displayed along the top of individual Edit windows. + +Valid values are: + +- `0` : no tool bars are displayed +- `1` : tool bars are displayed + + + +Related parameters: [StatusOnEdit](statusonedit.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/trace-first-x.md b/dyalog-configuration-guide/docs/configuration-parameters/trace-first-x.md new file mode 100644 index 00000000000..cb5470722a3 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/trace-first-x.md @@ -0,0 +1,11 @@ +# Trace_First_X + +The initial horizontal position, in character units, of the first Trace window; subsequent Trace windows are staggered from it. Applies only in Classic Dyalog mode. + +Valid values are an integer number of character units. + + + +Related parameters: [Trace_First_Y](trace-first-y.md), [Trace_Offset_X](trace-offset-x.md). + +See also the [Windows tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/trace-first-y.md b/dyalog-configuration-guide/docs/configuration-parameters/trace-first-y.md new file mode 100644 index 00000000000..0ca7813eb41 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/trace-first-y.md @@ -0,0 +1,11 @@ +# Trace_First_Y + +The initial vertical position, in character units, of the first Trace window; subsequent Trace windows are staggered from it. Applies only in Classic Dyalog mode. + +Valid values are an integer number of character units. + + + +Related parameters: [Trace_First_X](trace-first-x.md), [Trace_Offset_Y](trace-offset-y.md). + +See also the [Windows tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/trace-level-warn.md b/dyalog-configuration-guide/docs/configuration-parameters/trace-level-warn.md new file mode 100644 index 00000000000..5bdcba9a30b --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/trace-level-warn.md @@ -0,0 +1,11 @@ +# Trace_Level_Warn + +The maximum number of Trace windows displayed when an error occurs and [`Trace_On_Error`](trace-on-error.md) is `1`. If the state indicator holds more functions than this, a warning message box is displayed instead of the stack of Trace windows, avoiding a lengthy delay. This parameter is ignored when the Tracer is invoked explicitly, and applies only in Classic Dyalog mode. + +Valid values are a positive integer. + +Default is `16`. + +Related parameters: [Trace_On_Error](trace-on-error.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/trace-offset-x.md b/dyalog-configuration-guide/docs/configuration-parameters/trace-offset-x.md new file mode 100644 index 00000000000..e72228e3511 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/trace-offset-x.md @@ -0,0 +1,11 @@ +# Trace_Offset_X + +The number of characters by which a Trace window is staggered horizontally from the previous one. Applies only in Classic Dyalog mode. + +Valid values are an integer number of character units. + + + +Related parameters: [Trace_Offset_Y](trace-offset-y.md), [Trace_First_X](trace-first-x.md). + +See also the [Windows tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/trace-offset-y.md b/dyalog-configuration-guide/docs/configuration-parameters/trace-offset-y.md new file mode 100644 index 00000000000..203779817a6 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/trace-offset-y.md @@ -0,0 +1,11 @@ +# Trace_Offset_Y + +The number of characters by which a Trace window is staggered vertically from the previous one. Applies only in Classic Dyalog mode. + +Valid values are an integer number of character units. + + + +Related parameters: [Trace_Offset_X](trace-offset-x.md), [Trace_First_Y](trace-first-y.md). + +See also the [Windows tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/trace-on-error.md b/dyalog-configuration-guide/docs/configuration-parameters/trace-on-error.md new file mode 100644 index 00000000000..dc3090f5e90 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/trace-on-error.md @@ -0,0 +1,17 @@ +# Trace_On_Error + +Whether the Tracer is deployed automatically when execution of a defined function halts with an untrapped error. When enabled, a stack of Trace windows is displayed immediately, with the top window receiving the input focus. + +Valid values are: + +- `0` : the Tracer is not deployed automatically +- `1` : the Tracer is deployed automatically on an untrapped error + +Default depends on operating system: + +- Microsoft Windows: `0` +- UNIX and macOS: `1` + +Related parameters: [Trace_Level_Warn](trace-level-warn.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/tracestopmonitor.md b/dyalog-configuration-guide/docs/configuration-parameters/tracestopmonitor.md new file mode 100644 index 00000000000..0660e03f97a --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/tracestopmonitor.md @@ -0,0 +1,11 @@ +# TraceStopMonitor + +Which of the `⎕TRACE`, `⎕STOP`, and `⎕MONITOR` columns are displayed in Trace and Edit windows. The value is the sum of the codes for the chosen columns. + +The value is the sum of the following: + +- `1` : the `⎕TRACE` column +- `2` : the `⎕STOP` column +- `4` : the `⎕MONITOR` column + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/ucmdcachefile.md b/dyalog-configuration-guide/docs/configuration-parameters/ucmdcachefile.md new file mode 100644 index 00000000000..53270edeaad --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/ucmdcachefile.md @@ -0,0 +1,7 @@ +# UCMDCacheFile + +The name of the User Command cache file. + +Valid values are a file name. + +Default is `UserCommand{UcmdMajor}{UcmdMinor}.{DyalogMajor}{DyalogMinor}{U|C}{bits}.cache`, for example `UserCommand25.182U64.cache`. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/unicodetoclipboard.md b/dyalog-configuration-guide/docs/configuration-parameters/unicodetoclipboard.md new file mode 100644 index 00000000000..71474209231 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/unicodetoclipboard.md @@ -0,0 +1,15 @@ +# UnicodeToClipboard + +!!! Info "Information" + This configuration parameter is only relevant when using the Classic edition of Dyalog. + +Whether text transferred to and from the Windows clipboard is treated as Unicode text. + +Valid values are: + +- `0` : the symbols in `⎕AV` are mapped to ASCII text (0-255); APL symbols are mapped to ASCII symbols by their position in the Dyalog APL font +- `1` : the symbols in `⎕AV` are mapped to Unicode text; APL symbols are mapped to their genuine Unicode equivalents + +Default is `0`. + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/urlhighlight.md b/dyalog-configuration-guide/docs/configuration-parameters/urlhighlight.md new file mode 100644 index 00000000000..616ebe1892c --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/urlhighlight.md @@ -0,0 +1,12 @@ +# URLHighlight + +Whether URLs and links are highlighted in Session and Edit windows. When enabled, a valid URL under the mouse pointer is underscored, the relevant Session pop-up menu items (open the link, copy it to the clipboard) are activated, and the link can be opened with Ctrl+Click. A URL is recognised as a string beginning with `http://`, `https://`, `www.`, or `mailto:`. + +Valid values are: + +- `0` : URLs and links are not highlighted +- `1` : URLs and links are highlighted + +Default is `0`. + +See also the [General tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/useexternalhelpurl.md b/dyalog-configuration-guide/docs/configuration-parameters/useexternalhelpurl.md new file mode 100644 index 00000000000..2e104a5c450 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/useexternalhelpurl.md @@ -0,0 +1,17 @@ +# UseExternalHelpURL + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +Whether Dyalog uses the Microsoft Document Explorer and online help to display help for external objects, such as .NET types. + +Valid values are: + +- `0` : the Microsoft Document Explorer is not used +- `1` : the Microsoft Document Explorer and online help are used, at the URL given by [`ExternalHelpURL`](externalhelpurl.md) + + + +Related parameters: [ExternalHelpURL](externalhelpurl.md). + +See also the [Help/DMX tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-help-dmx-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/userconfigfile.md b/dyalog-configuration-guide/docs/configuration-parameters/userconfigfile.md new file mode 100644 index 00000000000..2a68bef37cc --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/userconfigfile.md @@ -0,0 +1,7 @@ +# UserConfigFile + +The name of the [user configuration file](../how-to-set/user-configuration-files.md). On Microsoft Windows this parameter is not set by default, but can be defined by the user. + +Valid values are a file name. + +Related parameters: [ConfigFile](configfile.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/usexcv.md b/dyalog-configuration-guide/docs/configuration-parameters/usexcv.md new file mode 100644 index 00000000000..1de8812c686 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/usexcv.md @@ -0,0 +1,15 @@ +# UseXCV + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. It is defined for the Unicode IME in the Registry section `HKEY_CURRENT_USER\Software\Dyalog\UnicodeIME\`. + +How the common copy (Ctrl+C), cut (Ctrl+X), and paste (Ctrl+V) keystrokes are processed. + +Valid values are: + +- `0` : processed normally, through the appropriate `.DIN` file +- `1` : passed untranslated to the host application (`dyalog.exe` treats Ctrl+X, Ctrl+C, and Ctrl+V as CT, CP, and PT respectively) + + + +The standard Dyalog keyboard (`*.din`) files map Shift+Del to CT, Ctrl+Ins to CP, and Shift+Ins to PT, so these work regardless of this setting. Those files also map both Ctrl+X and Ctrl+Shift+X to `⊃`, so when this parameter is `1` you must use Ctrl+Shift+X to obtain `⊃` (and likewise for C and V). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/valuetips/colourscheme.md b/dyalog-configuration-guide/docs/configuration-parameters/valuetips/colourscheme.md new file mode 100644 index 00000000000..52048f84580 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/valuetips/colourscheme.md @@ -0,0 +1,11 @@ +# ValueTips/ColourScheme + +The colour scheme used to display a Value Tip when the mouse hovers over a name. + +Valid values are the name of a colour scheme. + + + +Related parameters: [ValueTips/Enabled](enabled.md), [ValueTips/Delay](delay.md). + +See also the [General tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/valuetips/delay.md b/dyalog-configuration-guide/docs/configuration-parameters/valuetips/delay.md new file mode 100644 index 00000000000..f81fad03aed --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/valuetips/delay.md @@ -0,0 +1,11 @@ +# ValueTips/Delay + +The delay, in milliseconds, before a Value Tip is displayed when the mouse hovers over a name. + +Valid values are a number of milliseconds. + + + +Related parameters: [ValueTips/Enabled](enabled.md), [ValueTips/ColourScheme](colourscheme.md). + +See also the [General tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/valuetips/enabled.md b/dyalog-configuration-guide/docs/configuration-parameters/valuetips/enabled.md new file mode 100644 index 00000000000..0bc2f76168c --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/valuetips/enabled.md @@ -0,0 +1,14 @@ +# ValueTips/Enabled + +Whether Value Tips are enabled. When enabled, Dyalog displays the value of a variable, or the code of a function, when the mouse hovers over its name. + +Valid values are: + +- `0` : Value Tips are disabled +- `1` : Value Tips are enabled + + + +Related parameters: [ValueTips/Delay](delay.md), [ValueTips/ColourScheme](colourscheme.md). + +See also the [General tab](../../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/wantsspecialkeys.md b/dyalog-configuration-guide/docs/configuration-parameters/wantsspecialkeys.md new file mode 100644 index 00000000000..493f27d3606 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/wantsspecialkeys.md @@ -0,0 +1,10 @@ +# WantsSpecialKeys + +!!! Info "Information" + This configuration parameter is only relevant when using the Unicode edition of Dyalog. + +A list of applications (for example, `putty.exe`) that use the command strings in the Input Translate Tables. + +Valid values are a list of application names. + + diff --git a/dyalog-configuration-guide/docs/configuration-parameters/wrapsearch.md b/dyalog-configuration-guide/docs/configuration-parameters/wrapsearch.md new file mode 100644 index 00000000000..1d88be60ece --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/wrapsearch.md @@ -0,0 +1,14 @@ +# WrapSearch + +Whether Search/Replace in the editor stops at the top or bottom of the text (according to the direction of the search), or continues from the other end. + +Valid values are: + +- `0` : the search stops at the top or bottom of the text +- `1` : the search continues from the start or end as appropriate + + + +Related parameters: [WrapSearchMsgBox](wrapsearchmsgbox.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/wrapsearchmsgbox.md b/dyalog-configuration-guide/docs/configuration-parameters/wrapsearchmsgbox.md new file mode 100644 index 00000000000..1f6c0f547ad --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/wrapsearchmsgbox.md @@ -0,0 +1,14 @@ +# WrapSearchMsgBox + +Whether a message box is displayed to inform you when a [wrapped search](wrapsearch.md) passes the start or end of the text. + +Valid values are: + +- `0` : no message box is displayed +- `1` : a message box is displayed when the search wraps + + + +Related parameters: [WrapSearch](wrapsearch.md). + +See also the [Trace/Edit tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/wsext.md b/dyalog-configuration-guide/docs/configuration-parameters/wsext.md new file mode 100644 index 00000000000..276f8317e38 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/wsext.md @@ -0,0 +1,14 @@ +# WSEXT + +Workspace filename extensions. Together with [`WSPath`](wspath.md) this determines the file search order for `)LOAD` and `)COPY`, and it specifies the extension added by `)SAVE` or `)CONTINUE` when none is given. + +Valid values are a colon-separated list of one or more extensions, each including the leading period (`.`) that separates it from the basename. When `)SAVE` or `⎕SAVE` is used without an extension, the first extension in the list is applied. + +Default depends on operating system: + +- Microsoft Windows and macOS: `.dws:` +- other platforms: `:.dws:.DWS` + +For example, on Windows `)LOAD myws` searches first for `myws.dws`, then for `myws` with no extension (and, as Windows file names are not case-sensitive, finds `myws.DWS`, `MyWs.Dws`, and so on). On other platforms `)LOAD myws` searches for `myws`, then `myws.dws`, then `myws.DWS`. + +Related parameters: [WSPath](wspath.md), [CFEXT](cfext.md). diff --git a/dyalog-configuration-guide/docs/configuration-parameters/wspath.md b/dyalog-configuration-guide/docs/configuration-parameters/wspath.md new file mode 100644 index 00000000000..6a731208011 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/wspath.md @@ -0,0 +1,11 @@ +# WSPath + +The workspace search path: a list of directories searched, in order, when you `)LOAD` or `)COPY` a workspace, or start an Auxiliary Processor, without giving an explicit path. To load workspaces from the current directory, include `.` in the list. + +Valid values are a list of directory paths, separated by `;` (Windows) or `:` (UNIX and macOS). + +For example, on Windows `WSPath=.;D:\MYWS` causes `)COPY`, `)LOAD`, and `)LIB` to look first in the current directory, then in `D:\MYWS`. + +Related parameters: [WSEXT](wsext.md). + +See also the [Workspace tab](../../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-workspace-tab) of the Windows Configuration Dialog. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/xplookandfeel.md b/dyalog-configuration-guide/docs/configuration-parameters/xplookandfeel.md new file mode 100644 index 00000000000..f9b50380d3c --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/xplookandfeel.md @@ -0,0 +1,13 @@ +# XPLookAndFeel + +!!! Info "Information" + This configuration parameter is only relevant on the Microsoft Windows operating system. + +Whether *Native Look and Feel* is used, affecting the appearance of user-interface controls such as buttons. + +Valid values are: + +- `0` : Native Look and Feel is not used +- `1` : Native Look and Feel is used + +Default is `1`. diff --git a/dyalog-configuration-guide/docs/configuration-parameters/yy-window.md b/dyalog-configuration-guide/docs/configuration-parameters/yy-window.md new file mode 100644 index 00000000000..6f310e47d23 --- /dev/null +++ b/dyalog-configuration-guide/docs/configuration-parameters/yy-window.md @@ -0,0 +1,13 @@ +# yy_window + +How Dyalog interprets a 2-digit year number (for `⎕SM` and GUI edit fields that use a 2-digit year format such as `MM/DD/YY`). It has no effect on applications that use a 4-digit year format. The value defines a *date window*, either fixed or sliding. + +Valid values are: + +- a 4-digit year : a **fixed** window whose earliest acceptable year is that value (for example `1970` maps 2-digit input to `1970`-`2069`) +- a 1- or 2-digit year, typically negative : a **sliding** window whose oldest acceptable year is that many years before the current year (for example `-30` in 1999 maps input to `1969`-`2068`) +- two values separated by a comma : the lower and upper limits of the window (each independently fixed (4-digit) or sliding (1- or 2-digit)); a 2-digit year that does not convert into the range signals a `DOMAIN ERROR`. If only the first is given, the second defaults to the first plus 99. + +Default is unset: on Microsoft Windows, Dyalog then follows the Region and Language 2-digit year settings. + +The number of digits in each value determines whether it is a fixed (4-digit) or sliding (1- or 2-digit) limit, so a window can mix the two, for example `YY_WINDOW=1990,10` allows dates from `1990` to at most 10 years hence. diff --git a/dyalog-configuration-guide/docs/how-to-set/application-configuration-files.md b/dyalog-configuration-guide/docs/how-to-set/application-configuration-files.md new file mode 100644 index 00000000000..f3833475db3 --- /dev/null +++ b/dyalog-configuration-guide/docs/how-to-set/application-configuration-files.md @@ -0,0 +1,16 @@ +# Application Configuration Files + +An *application configuration file* holds the configuration values associated with a specific application. It is created by the user and is normally stored alongside the application. + +When Dyalog starts, it derives the name of the application configuration file as follows: + +- the name given in the **ConfigFile** parameter, if it is set; otherwise +- the name of the workspace or script loaded at start-up (through the **Load** parameter) with its extension replaced by `.dcfg`, if that file exists; otherwise +- no application configuration file is used. + +An application configuration file setting overrides an environment variable, a user configuration file, the Registry, and the built-in default (see [Order of Precedence](order-of-precedence.md)). + +Configuration files use JSON5 (a superset of JSON) syntax and are portable across all platforms that Dyalog supports. Both application and user configuration files can *cascade*: a file can extend another with the `Extend` key, inheriting its settings and optionally overriding them. For the file format, cascading, arrays, and references between parameters, see [Configuration File Structure](configuration-file-structure.md). + +!!! Warning "Warning" + Although user credentials such as login details or passwords can be placed in a configuration file, Dyalog strongly recommends against this, even when the credentials are encrypted, as it is a significant security risk. diff --git a/dyalog-configuration-guide/docs/how-to-set/built-in-defaults.md b/dyalog-configuration-guide/docs/how-to-set/built-in-defaults.md new file mode 100644 index 00000000000..714b7da3cc4 --- /dev/null +++ b/dyalog-configuration-guide/docs/how-to-set/built-in-defaults.md @@ -0,0 +1,5 @@ +# Built-in Defaults + +Every configuration parameter has a built-in default that the interpreter uses when the parameter is not set by any other source. The built-in default therefore has the lowest precedence (see [Order of Precedence](order-of-precedence.md)). + +A parameter's default can differ between operating systems. Each parameter's own page states its default, and notes any per-platform differences. diff --git a/dyalog-configuration-guide/docs/how-to-set/command-line.md b/dyalog-configuration-guide/docs/how-to-set/command-line.md new file mode 100644 index 00000000000..9bf9edf4a06 --- /dev/null +++ b/dyalog-configuration-guide/docs/how-to-set/command-line.md @@ -0,0 +1,7 @@ +# Command Line + +A configuration parameter can be set on the command line that starts Dyalog, by giving the parameter name and its value. A command line setting takes precedence over every other source (see [Order of Precedence](order-of-precedence.md)), which makes it convenient for temporarily overriding a value defined elsewhere. + +For example, a usual workspace size can be defined in a [user configuration file](user-configuration-files.md) through the **MAXWS** parameter and then superseded for a single Session by giving a different **MAXWS** on the command line. + +Parameter names given on the command line are not case-sensitive. diff --git a/dyalog-configuration-guide/docs/how-to-set/configuration-file-structure.md b/dyalog-configuration-guide/docs/how-to-set/configuration-file-structure.md new file mode 100644 index 00000000000..a99d1501ca2 --- /dev/null +++ b/dyalog-configuration-guide/docs/how-to-set/configuration-file-structure.md @@ -0,0 +1,56 @@ +# Configuration File Structure + +Both [application](application-configuration-files.md) and [user](user-configuration-files.md) configuration files use JSON5 (a superset of standard JSON) syntax, and are portable across all platforms that Dyalog supports. A file can be written directly or produced by `⎕JSON` (which supports JSON5). + +A JSON object holds data as key/value pairs and other JSON objects. A key and its value are separated by a colon (`:`); entries are separated by commas (`,`). + +The top-level object defines an optional key `Extend` and an optional object `Settings`: + +- `Extend` is a string naming another configuration file to import. The imported file can itself extend a further file. Imported values can be overridden by redefining them. The file name is relative to the file that imports it, and any extension must be given explicitly. +- `Settings` is an object holding configuration parameter names and their values. A value can be a string, a number, or an array of strings. Names are not case-sensitive. + +If the same name is defined more than once within a file, the first definition is used and a warning is generated. + +

Example

+```apl +{ + Extend: "my_default_configuration.dcfg", + Settings: { + // maximum workspace + MAXWS: "2GB", + WSPATH: ["/dir1", "/dir2", ""], + UserOption: 123, + ROOTDIR: "/my/root/directory", + // reference to another configuration parameter + FNAME: "[rootdir]/filename", + } +} +``` + +## Arrays + +A value can be an array of strings, used mainly for file paths, for example `WSPATH: ["/dir1", "/dir2"]`. The only parameters that can be defined as arrays are **WSPATH**, **WSEXT**, and **CFEXT**. + +## File Names + +Path names in configuration files should use portable forward slashes (`/`) rather than back-slashes (`\`), because JSON uses the back-slash as an escape character. For example, `WSPATH: ["c:/Dyalog21.0"]` (or `["c:\\Dyalog21.0"]`) specifies `c:\Dyalog21.0`. + +An unescaped back-slash is not reported as an error. The file is accepted, and the resulting value silently differs from the path intended: + +- `["c:\Dyalog21.0"]` gives `c:Dyalog21.0`. Because `\D` is not a recognised escape sequence, the back-slash is discarded, and an absolute path becomes a drive-relative one. +- `["c:\temp"]` gives `c:`, followed by a tab character, followed by `emp`, because `\t` is the escape sequence for a tab. + +## Nested Structures + +A configuration file represents a nested parameter structure (for example, a Windows Registry sub-folder) as a nested object: +```apl +Captions: { + Session: "My Dyalog Session", + Status: "My Status window", +} +``` +The value is then queried with a back-slash separator: +```apl + +2 ⎕NQ '.' 'GetEnvironment' 'Captions\Session' +My Dyalog Session +``` diff --git a/dyalog-configuration-guide/docs/how-to-set/environment-variables.md b/dyalog-configuration-guide/docs/how-to-set/environment-variables.md new file mode 100644 index 00000000000..373ccddd081 --- /dev/null +++ b/dyalog-configuration-guide/docs/how-to-set/environment-variables.md @@ -0,0 +1,10 @@ +# Environment Variables + +A configuration parameter can be set as an environment variable in the environment from which Dyalog is started. An environment variable setting overrides a user configuration file, the Registry, and the built-in default, but is itself overridden by an application configuration file and by the command line (see [Order of Precedence](order-of-precedence.md)). + +On UNIX and macOS, environment variable names are given in upper case, for example `MAXWS`. On Microsoft Windows, parameter names are not case-sensitive. + +If a parameter's name contains a back-slash (that is, the parameter lives in a sub-key, such as `SALT\CommandFolder`), replace the back-slash with an underscore when setting it as an environment variable, for example `SALT_CommandFolder`. + +!!! Hint "Hints and Recommendations" + Dyalog Ltd recommends that [configuration files](application-configuration-files.md) are used for all run-time applications, and that the use of environment variables for this purpose is eliminated. Configuration files are text-based, portable across platforms, and easily managed alongside application source code. diff --git a/dyalog-configuration-guide/docs/how-to-set/order-of-precedence.md b/dyalog-configuration-guide/docs/how-to-set/order-of-precedence.md new file mode 100644 index 00000000000..a9e35fac0cf --- /dev/null +++ b/dyalog-configuration-guide/docs/how-to-set/order-of-precedence.md @@ -0,0 +1,15 @@ +# Order of Precedence + +When a configuration parameter is set in more than one place, Dyalog applies the following order of precedence. Each source overrides those below it: + +1. [Command line](command-line.md) +2. [Application configuration file](application-configuration-files.md) +3. [Environment variable](environment-variables.md) +4. [User configuration file](user-configuration-files.md) +5. [Windows Registry](registry.md) (Microsoft Windows only) +6. [Built-in defaults](built-in-defaults.md) + +!!! Info "Information" + The Registry step applies to Microsoft Windows only. On UNIX and macOS there is no Registry, so a user configuration file setting is overridden only by the sources above it. + +The value actually in force for a given parameter, after the precedence rules have been applied, can be queried from within Dyalog with `2 ⎕NQ '.' 'GetEnvironment' name` or with the `]Config` user command. diff --git a/dyalog-configuration-guide/docs/how-to-set/overview.md b/dyalog-configuration-guide/docs/how-to-set/overview.md new file mode 100644 index 00000000000..d3ff87fb9c4 --- /dev/null +++ b/dyalog-configuration-guide/docs/how-to-set/overview.md @@ -0,0 +1,22 @@ +# How to Set Configuration Parameters + +A configuration parameter can be set from any of the following sources: + +- the [command line](command-line.md) used to start Dyalog +- an [application configuration file](application-configuration-files.md) +- an [environment variable](environment-variables.md) +- a [user configuration file](user-configuration-files.md) +- the [Windows Registry](registry.md) (Microsoft Windows only) +- the interpreter's [built-in defaults](built-in-defaults.md) + +When the same parameter is set in more than one source, the [order of precedence](order-of-precedence.md) determines which value is used. This gives a great deal of flexibility: a usual value can be defined in a configuration file and then temporarily overridden from the command line. + +Dyalog Ltd recommends configuration files for all run-time applications, in preference to environment variables. + +## References to Other Configuration Parameters + +A string value can refer to another configuration parameter, wherever it is defined, using square-bracket delimiters. For example, `MySetting: "[DYALOG]/MyFile"` replaces `[DYALOG]` with the value of the **DYALOG** parameter. If the string inside the brackets is `.`, it is replaced with the path of the directory containing the configuration file itself. + +If the referenced parameter is not defined, no substitution takes place and the reference, including its brackets, remains in place. To include a literal square bracket in a string, prefix it with a `\` character. + +On Microsoft Windows, `[=DOCUMENTS]` is a pre-defined substitution parameter that is replaced with the location of the user's Documents folder (for example, `C:\Users\Bob\Documents`). diff --git a/dyalog-configuration-guide/docs/how-to-set/registry.md b/dyalog-configuration-guide/docs/how-to-set/registry.md new file mode 100644 index 00000000000..8529afa163d --- /dev/null +++ b/dyalog-configuration-guide/docs/how-to-set/registry.md @@ -0,0 +1,10 @@ +# Registry + +!!! Info "Information" + The Windows Registry applies to Microsoft Windows only. On UNIX and macOS there is no Registry. + +On Microsoft Windows, configuration parameters can be stored in the Registry. A Registry setting overrides only the built-in default; every other source overrides it (see [Order of Precedence](order-of-precedence.md)). + +The Configuration Dialog reflects the values stored in the Registry and ignores any overriding values defined on the command line, in configuration files, or in environment variables. When a parameter is changed through the Configuration Dialog, the new value is recorded in the Registry, but it remains overridden by any source that takes precedence over the Registry. + +Some parameters are stored in Registry sub-folders. A [configuration file](application-configuration-files.md) represents such a parameter as a nested object; see [Configuration File Structure](configuration-file-structure.md). diff --git a/dyalog-configuration-guide/docs/how-to-set/user-configuration-files.md b/dyalog-configuration-guide/docs/how-to-set/user-configuration-files.md new file mode 100644 index 00000000000..7df06d056dd --- /dev/null +++ b/dyalog-configuration-guide/docs/how-to-set/user-configuration-files.md @@ -0,0 +1,18 @@ +# User Configuration Files + +A *user configuration file* defines configuration values for the current (and possibly only) user of the system. It typically configures the development environment, providing settings that are the same for all of that user's applications. + +A user configuration file setting overrides the Registry and the built-in default, but is overridden by an environment variable, an application configuration file, and the command line (see [Order of Precedence](order-of-precedence.md)). + +## UNIX and macOS + +The first time a new version of Dyalog is launched it creates and initialises a version-specific user configuration file `$HOME/.dyalog/dyalog..dcfg`, where the version-specific part comprises the version number, edition, and width. For example, a 64-bit Unicode edition of Dyalog 21.0 is identified as `210U64`. The name of this file should not be changed. + +The first time any version of Dyalog is run, an additional file `$HOME/.dyalog/dyalog.dcfg` is created. Settings placed here apply irrespective of Dyalog version, so they need not be repeated in each version-specific file. + +!!! Legacy "Legacy" + Before Dyalog 18.0, configuration parameters could be set as environment variables in a `$HOME/.dyalog/dyalog.config` script. That script is no longer referenced; any settings to be retained must be moved into the appropriate `$HOME/.dyalog/dyalog..dcfg` file. + +## Microsoft Windows + +The name of the user configuration file is given by the **UserConfigFile** parameter. On Windows this parameter is not set by default, but can be defined by the user. diff --git a/dyalog-configuration-guide/docs/img/object_arraynotation.png b/dyalog-configuration-guide/docs/img/object_arraynotation.png new file mode 100644 index 00000000000..6ab90aed2a8 Binary files /dev/null and b/dyalog-configuration-guide/docs/img/object_arraynotation.png differ diff --git a/dyalog-configuration-guide/docs/img/session_arraynotation.png b/dyalog-configuration-guide/docs/img/session_arraynotation.png new file mode 100644 index 00000000000..710f039a825 Binary files /dev/null and b/dyalog-configuration-guide/docs/img/session_arraynotation.png differ diff --git a/dyalog-configuration-guide/docs/index.md b/dyalog-configuration-guide/docs/index.md new file mode 100644 index 00000000000..fb180ca12d9 --- /dev/null +++ b/dyalog-configuration-guide/docs/index.md @@ -0,0 +1,10 @@ +--- +search: + exclude: true +--- + +# About + +The _Dyalog Configuration Guide_ describes how Dyalog is configured across operating systems. It explains how configuration parameters are set and the order of precedence between the different sources, the configuration files that Dyalog reads, and it provides a reference page for each configuration parameter, noting any differences between operating systems. + +Assumed knowledge: A basic understanding of Dyalog APL and of the operating system in use. diff --git a/dyalog-configuration-guide/docs/introduction.md b/dyalog-configuration-guide/docs/introduction.md new file mode 100644 index 00000000000..79760fa54a1 --- /dev/null +++ b/dyalog-configuration-guide/docs/introduction.md @@ -0,0 +1,9 @@ +# Introduction + +Dyalog is customised through *configuration parameters*. A configuration parameter controls some aspect of the interpreter or the development environment, from the maximum workspace size to the location of the Session log. + +The same parameters apply across all supported operating systems, but a few are specific to one platform, and some take different default values on different platforms. Each parameter's own page states any such differences. + +A configuration parameter can be set in several ways: on the command line, in an application configuration file, as an environment variable, in a user configuration file, in the Windows Registry (Microsoft Windows only), or left at its built-in default. When a parameter is set in more than one of these, a fixed [order of precedence](how-to-set/order-of-precedence.md) determines which setting wins. [How to Set Configuration Parameters](how-to-set/overview.md) describes each source in turn. + +Parameter names are not case-sensitive when given on the command line, in configuration files, or in the Windows Registry. When a parameter is set as an environment variable on UNIX or macOS, its name is given in upper case. diff --git a/dyalog-configuration-guide/mkdocs.yml b/dyalog-configuration-guide/mkdocs.yml new file mode 100644 index 00000000000..0b4264f7efd --- /dev/null +++ b/dyalog-configuration-guide/mkdocs.yml @@ -0,0 +1,223 @@ +site_name: Dyalog Configuration Guide +theme: + favicon: documentation-assets/images/favicon-32.png + logo: documentation-assets/images/dyalog-logo_white.svg + features: + - navigation.instant + - navigation.tracking + - navigation.path + - navigation.indexes + - navigation.footer + name: material + font: + text: Be Vietnam Pro +extra_css: + - documentation-assets/css/main.css + - documentation-assets/css/extra.css +extra_javascript: + - javascripts/mathjax.js + - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js +plugins: + - privacy + - search + - macros + - site-urls + - caption: + table: + enable: true + start_index: 1 + increment_index: 1 + position: top + reference_text: 'Table {index}' + caption_prefix: 'Table {index}:' +extra: + version_maj: 21 + version_majmin: "21.0" +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.keys + - pymdownx.superfences + - pymdownx.highlight: + pygments_lang_class: true + - pymdownx.arithmatex: + generic: true + - pymdownx.highlight: + use_pygments: false + - attr_list + - abbr + - footnotes + - md_in_html + - markdown_tables_extended + - toc: + title: On this page +nav: + - index.md + - Introduction: introduction.md + - How to Set Configuration Parameters: + - Overview: how-to-set/overview.md + - Order of Precedence: how-to-set/order-of-precedence.md + - Command Line: how-to-set/command-line.md + - Application Configuration Files: how-to-set/application-configuration-files.md + - Environment Variables: how-to-set/environment-variables.md + - User Configuration Files: how-to-set/user-configuration-files.md + - Windows Registry: how-to-set/registry.md + - Built-in Defaults: how-to-set/built-in-defaults.md + - Configuration File Structure: how-to-set/configuration-file-structure.md + - Configuration Parameters: + - Introduction: configuration-parameters/configuration-parameters.md + - By Category: configuration-parameters/configuration-parameters-by-category.md + - AddClassHeaders: configuration-parameters/addclassheaders.md + - APLAN_FOR_EDITOR: configuration-parameters/aplan-for-editor.md + - APLAN_FOR_OUTPUT: configuration-parameters/aplan-for-output.md + - AplCoreName: configuration-parameters/aplcorename.md + - aplk: configuration-parameters/aplk.md + - APLK0: configuration-parameters/aplk0.md + - aplkeys: configuration-parameters/aplkeys.md + - aplnid: configuration-parameters/aplnid.md + - APLSTATUSFD: configuration-parameters/aplstatusfd.md + - aplt: configuration-parameters/aplt.md + - APLTn: configuration-parameters/apltn.md + - apltrans: configuration-parameters/apltrans.md + - APL_CODE_E_MAGNITUDE: configuration-parameters/apl-code-e-magnitude.md + - APL_COMPLEX_AS_V12: configuration-parameters/apl-complex-as-v12.md + - APL_FCREATE_PROPS_C: configuration-parameters/apl-fcreate-props-c.md + - APL_FCREATE_PROPS_J: configuration-parameters/apl-fcreate-props-j.md + - APL_FAST_FCHK: configuration-parameters/apl-fast-fchk.md + - APL_MAX_THREADS: configuration-parameters/apl-max-threads.md + - APL_TextInAplCore: configuration-parameters/apl-textinaplcore.md + - AutoDPI: configuration-parameters/autodpi.md + - AutoComplete: + - CancelKey1: configuration-parameters/autocomplete/cancelkey1.md + - CancelKey2: configuration-parameters/autocomplete/cancelkey2.md + - Cols: configuration-parameters/autocomplete/cols.md + - CommonKey1: configuration-parameters/autocomplete/commonkey1.md + - CompleteKey1: configuration-parameters/autocomplete/completekey1.md + - CompleteKey2: configuration-parameters/autocomplete/completekey2.md + - Enabled: configuration-parameters/autocomplete/enabled.md + - History: configuration-parameters/autocomplete/history.md + - HistorySize: configuration-parameters/autocomplete/historysize.md + - PrefixSize: configuration-parameters/autocomplete/prefixsize.md + - Rows: configuration-parameters/autocomplete/rows.md + - ShowFiles: configuration-parameters/autocomplete/showfiles.md + - AutoFormat: configuration-parameters/autoformat.md + - AutoIndent: configuration-parameters/autoindent.md + - auto_pw: configuration-parameters/auto-pw.md + - CFEXT: configuration-parameters/cfext.md + - CMD_PREFIX and CMD_POSTFIX: configuration-parameters/cmd-prefix-and-cmd-postfix.md + - ConfigFile: configuration-parameters/configfile.md + - confirm_abort: configuration-parameters/confirm-abort.md + - confirm_close: configuration-parameters/confirm-close.md + - confirm_fix: configuration-parameters/confirm-fix.md + - confirm_session_delete: configuration-parameters/confirm-session-delete.md + - default_div: configuration-parameters/default-div.md + - default_io: configuration-parameters/default-io.md + - default_ml: configuration-parameters/default-ml.md + - default_pp: configuration-parameters/default-pp.md + - default_pw: configuration-parameters/default-pw.md + - default_rtl: configuration-parameters/default-rtl.md + - default_wx: configuration-parameters/default-wx.md + - DMXOUTPUTONERROR: configuration-parameters/dmxoutputonerror.md + - DockableEditWindows: configuration-parameters/dockableeditwindows.md + - DoubleClickEdit: configuration-parameters/doubleclickedit.md + - dyalog: configuration-parameters/dyalog.md + - DyalogEmailAddress: configuration-parameters/dyalogemailaddress.md + - DyalogHelpDir: configuration-parameters/dyaloghelpdir.md + - DyalogInstallDir: configuration-parameters/dyaloginstalldir.md + - DyalogLink: configuration-parameters/dyaloglink.md + - DyalogStartup: configuration-parameters/dyalogstartup.md + - DyalogStartupSE: configuration-parameters/dyalogstartupse.md + - DyalogStartup_X: configuration-parameters/dyalogstartup-x.md + - DyalogWebSite: configuration-parameters/dyalogwebsite.md + - DYALOG_DISCARD_FN_SOURCE: configuration-parameters/dyalog-discard-fn-source.md + - DYALOG_EVENTLOGGINGLEVEL: configuration-parameters/dyalog-eventlogginglevel.md + - DYALOG_EVENTLOGNAME: configuration-parameters/dyalog-eventlogname.md + - DYALOG_EXTVAR_SUPPORTED: configuration-parameters/dyalog-extvar-supported.md + - DYALOG_GUTTER_ENABLE: configuration-parameters/dyalog-gutter-enable.md + - DYALOG_INITSESSION: configuration-parameters/dyalog-initsession.md + - Dyalog_LineEditor_Mode: configuration-parameters/dyalog-lineeditor-mode.md + - Dyalog_NETCore: configuration-parameters/dyalog-netcore.md + - DYALOG_NOPOPUPS: configuration-parameters/dyalog-nopopups.md + - DYALOG_PIXEL_TYPE: configuration-parameters/dyalog-pixel-type.md + - DYALOG_SERIAL: configuration-parameters/dyalog-serial.md + - DYALOG_SERIALFILE: configuration-parameters/dyalog-serialfile.md + - DYALOG_SHELL_SUBPROCESS: configuration-parameters/dyalog-shell-subprocess.md + - EDITOR_COLUMNS: configuration-parameters/editor-columns.md + - EditorState: configuration-parameters/editorstate.md + - Edit_Cols: configuration-parameters/edit-cols.md + - Edit_First_X: configuration-parameters/edit-first-x.md + - Edit_First_Y: configuration-parameters/edit-first-y.md + - Edit_Offset_X: configuration-parameters/edit-offset-x.md + - Edit_Offset_Y: configuration-parameters/edit-offset-y.md + - Edit_Rows: configuration-parameters/edit-rows.md + - ENABLE_CEF: configuration-parameters/enable-cef.md + - ErrorOnExternalException: configuration-parameters/erroronexternalexception.md + - ExternalHelpURL: configuration-parameters/externalhelpurl.md + - File_Stack_Size: configuration-parameters/file-stack-size.md + - greet_bitmap: configuration-parameters/greet-bitmap.md + - history_size: configuration-parameters/history-size.md + - inifile: configuration-parameters/inifile.md + - InitFullScriptNormal: configuration-parameters/initfullscriptnormal.md + - InitFullScriptSusp: configuration-parameters/initfullscriptsusp.md + - InitialKeyboardLayout: configuration-parameters/initialkeyboardlayout.md + - InitialKeyboardLayoutInUse: configuration-parameters/initialkeyboardlayoutinuse.md + - InitialKeyboardLayoutShowAll: configuration-parameters/initialkeyboardlayoutshowall.md + - input_size: configuration-parameters/input-size.md + - KeyboardInputDelay: configuration-parameters/keyboardinputdelay.md + - LAYOUT_FILE: configuration-parameters/layout-file.md + - Load: configuration-parameters/load.md + - localdyalogdir: configuration-parameters/localdyalogdir.md + - log_file: configuration-parameters/log-file.md + - log_file_inuse: configuration-parameters/log-file-inuse.md + - log_size: configuration-parameters/log-size.md + - LX: configuration-parameters/lx.md + - mapchars: configuration-parameters/mapchars.md + - MaxAplCores: configuration-parameters/maxaplcores.md + - maxws: configuration-parameters/maxws.md + - OverstrikesPopup: configuration-parameters/overstrikespopup.md + - PassExceptionsToOpSys: configuration-parameters/passexceptionstoopsys.md + - pfkey_size: configuration-parameters/pfkey-size.md + - ProgramFolder: configuration-parameters/programfolder.md + - PropertyExposeRoot: configuration-parameters/propertyexposeroot.md + - PropertyExposeSE: configuration-parameters/propertyexposese.md + - qcmd_timeout: configuration-parameters/qcmd-timeout.md + - ResolveOverstrikes: configuration-parameters/resolveoverstrikes.md + - RIDE_Init: configuration-parameters/ride-init.md + - RIDE_Spawned: configuration-parameters/ride-spawned.md + - RunAsService: configuration-parameters/runasservice.md + - SaveContinueOnExit: configuration-parameters/savecontinueonexit.md + - SaveLogOnExit: configuration-parameters/savelogonexit.md + - SaveSessionOnExit: configuration-parameters/savesessiononexit.md + - Serial: configuration-parameters/serial.md + - session_file: configuration-parameters/session-file.md + - ShowStatusOnError: configuration-parameters/showstatusonerror.md + - SkipLines: configuration-parameters/skiplines.md + - SM_Cols: configuration-parameters/sm-cols.md + - SM_Rows: configuration-parameters/sm-rows.md + - StatusOnEdit: configuration-parameters/statusonedit.md + - TabStops: configuration-parameters/tabstops.md + - ToolBarsOnEdit: configuration-parameters/toolbarsonedit.md + - TraceStopMonitor: configuration-parameters/tracestopmonitor.md + - Trace_First_X: configuration-parameters/trace-first-x.md + - Trace_First_Y: configuration-parameters/trace-first-y.md + - Trace_level_warn: configuration-parameters/trace-level-warn.md + - Trace_Offset_X: configuration-parameters/trace-offset-x.md + - Trace_Offset_Y: configuration-parameters/trace-offset-y.md + - Trace_On_Error: configuration-parameters/trace-on-error.md + - UCMDCacheFile: configuration-parameters/ucmdcachefile.md + - UnicodeToClipboard: configuration-parameters/unicodetoclipboard.md + - URLHighlight: configuration-parameters/urlhighlight.md + - UseExternalHelpURL: configuration-parameters/useexternalhelpurl.md + - UserConfigFile: configuration-parameters/userconfigfile.md + - UseXCV: configuration-parameters/usexcv.md + - ValueTips: + - ValueTips/ColourScheme: configuration-parameters/valuetips/colourscheme.md + - ValueTips/Delay: configuration-parameters/valuetips/delay.md + - ValueTips/Enabled: configuration-parameters/valuetips/enabled.md + - WantsSpecialKeys: configuration-parameters/wantsspecialkeys.md + - WrapSearch: configuration-parameters/wrapsearch.md + - WrapSearchMsgBox: configuration-parameters/wrapsearchmsgbox.md + - WSEXT: configuration-parameters/wsext.md + - WSPATH: configuration-parameters/wspath.md + - XPLookAndFeel: configuration-parameters/xplookandfeel.md + - yy_window: configuration-parameters/yy-window.md diff --git a/earlier-release-notes/docs/release-notes-v19-0/configuration-parameters/log-file.md b/earlier-release-notes/docs/release-notes-v19-0/configuration-parameters/log-file.md index 1dc10f4ac12..778cbff1ddc 100644 --- a/earlier-release-notes/docs/release-notes-v19-0/configuration-parameters/log-file.md +++ b/earlier-release-notes/docs/release-notes-v19-0/configuration-parameters/log-file.md @@ -4,7 +4,7 @@ This parameter specifies the pathname to the Session log file; it can be absolut The Session log file is not interchangeable between different versions/editions/widths of Dyalog – this means that opening a new instance of Dyalog will overwrite any contents of the Session log file populated by an already‑running instance. However, if the LOG_FILE parameter contains a '`*`' (for example, `JD.*.dlf` ) then at start-up Dyalog will attempt to open, and then **lock**, a file where the '`*`' has been replaced with an increasing integer value (starting with 000, so `JD.000.dlf`, `JD.001.dlf` etc). If said file cannot be opened and locked, the value will be incremented. The process will fail, and no log will be used if the extension number would exceed 999. -The default is `Users\\Documents\Dyalog APL- . Files\default_*.dlf`, for example, `Users\Bob\Documents\Dyalog APL-64 19.0 Unicode Files\default_*.dlf` +The default is `Users\\Documents\Dyalog APL[-64] . [Unicode ]Files\default_*.dlf`, for example, `Users\Bob\Documents\Dyalog APL-64 19.0 Unicode Files\default_*.dlf` Note that the LogFile property of `⎕SE` reports the name of the log file that is being used. diff --git a/language-reference-guide/docs/primitive-operators/i-beam/aplcore-parameters.md b/language-reference-guide/docs/primitive-operators/i-beam/aplcore-parameters.md index 8afaeaace21..0e1a4c26b73 100644 --- a/language-reference-guide/docs/primitive-operators/i-beam/aplcore-parameters.md +++ b/language-reference-guide/docs/primitive-operators/i-beam/aplcore-parameters.md @@ -19,7 +19,7 @@ Sets the aplcore parameters **AplCoreName** and/or **MaxAplCores** for the curre If `Y` is empty, the function simply returns the values of these parameters without changing them. -See also: [AplCoreName](../../../../windows-installation-and-configuration-guide/configuration-parameters/aplcorename) and [MaxAplCores.](../../../../windows-installation-and-configuration-guide/configuration-parameters/maxaplcores) +See also: [AplCoreName](../../../../dyalog-configuration-guide/configuration-parameters/aplcorename) and [MaxAplCores.](../../../../dyalog-configuration-guide/configuration-parameters/maxaplcores)
diff --git a/language-reference-guide/docs/primitive-operators/i-beam/number-of-threads.md b/language-reference-guide/docs/primitive-operators/i-beam/number-of-threads.md index bd51597e4a4..f67bb240a7e 100644 --- a/language-reference-guide/docs/primitive-operators/i-beam/number-of-threads.md +++ b/language-reference-guide/docs/primitive-operators/i-beam/number-of-threads.md @@ -10,7 +10,7 @@ Specifies how many threads are to be used for parallel execution. If `Y` has the value `⍬`, `R` is the number of virtual processors in the machine. -Otherwise, `Y` is an integer that specifies the number of threads that are to be used henceforth for parallel execution. Prior to this call, the default number of threads is specified by the parameter `APL_MAX_THREADS`. See [ APL_MAX_THREADS](../../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters). +Otherwise, `Y` is an integer that specifies the number of threads that are to be used henceforth for parallel execution. Prior to this call, the default number of threads is specified by the parameter `APL_MAX_THREADS`. See [ APL_MAX_THREADS](../../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters). Note that whatever the value of `Y`, Dyalog limits the number of threads to 64. So the effective number of threads is `Y⌊64`. diff --git a/language-reference-guide/docs/system-commands/continue.md b/language-reference-guide/docs/system-commands/continue.md index c7097f29cae..3d4d22bc3b9 100644 --- a/language-reference-guide/docs/system-commands/continue.md +++ b/language-reference-guide/docs/system-commands/continue.md @@ -2,7 +2,7 @@ # Save Continuation `)CONTINUE` -This command saves the active workspace in the current working directory and ends the Dyalog session. The name of the workspace file is CONTINUE in upper-case with the extension defined by the [`WSEXT` parameter](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters). +This command saves the active workspace in the current working directory and ends the Dyalog session. The name of the workspace file is CONTINUE in upper-case with the extension defined by the [`WSEXT` parameter](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters). Note that the values of all system variables (including [`⎕SM`](../system-functions/sm.md)) and GUI objects are also saved in `CONTINUE`. diff --git a/language-reference-guide/docs/system-commands/load.md b/language-reference-guide/docs/system-commands/load.md index b6c67f860d8..939cda4768f 100644 --- a/language-reference-guide/docs/system-commands/load.md +++ b/language-reference-guide/docs/system-commands/load.md @@ -4,7 +4,7 @@ This command causes the named stored workspace to be loaded.  The current active workspace is lost. -`ws` specifies a file name. If no file extension is given, it is implied. See [WSEXT](../../../windows-installation-and-configuration-guide/configuration-parameters/wsext). +`ws` specifies a file name. If no file extension is given, it is implied. See [WSEXT](../../../dyalog-configuration-guide/configuration-parameters/wsext). If `ws` is a full or relative pathname, only the specified directory is examined.  If not, the APL workspace path (`WSPATH`) is traversed in search of the named workspace.  A stored workspace is one which has previously been saved with the system command [`)SAVE`](save.md) or the system function [`⎕SAVE`](../system-functions/save.md).  Under Windows, if `ws` is omitted, the File Open dialog box is displayed. diff --git a/language-reference-guide/docs/system-commands/save.md b/language-reference-guide/docs/system-commands/save.md index 1d96ddf88a8..d14b8193e6b 100644 --- a/language-reference-guide/docs/system-commands/save.md +++ b/language-reference-guide/docs/system-commands/save.md @@ -10,7 +10,7 @@ If `ws` specifies a file name other than that implied by `⎕WSID`, the specif See [Programmer's Guide: "Workspaces"](../../../programming-reference-guide/introduction/workspaces) for the rules for specifying a workspace name. -If an extension is not specified, an extension is added according to the [**WSEXT** parameter](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters).. +If an extension is not specified, an extension is added according to the [**WSEXT** parameter](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters).. A workspace may not be saved if any threads (other than the root thread 0) are running or if there are any Edit or Trace windows open. Otherwise, the workspace is saved with its state of execution intact, however certain operations may be performed before it is saved. For further information, see [Set Workspace Save Options](../primitive-operators/i-beam/set-workspace-save-options.md). diff --git a/language-reference-guide/docs/system-functions/dt.md b/language-reference-guide/docs/system-functions/dt.md index f49af5a42cc..cb26e6138e7 100644 --- a/language-reference-guide/docs/system-functions/dt.md +++ b/language-reference-guide/docs/system-functions/dt.md @@ -249,7 +249,7 @@ When XY is a pattern, the corresponding character vector ### Two-digit Years -Two digit years (that is, those corresponding to the formatting pattern elements `YY` and `WW`) are, by default, interpreted according to the same rules used for `⎕SM` and GUI edit fields, which are configurable using the [`YY_WINDOW`](../../windows-installation-and-configuration-guide/configuration-parameters/yy-window/) configuration parameter. +Two digit years (that is, those corresponding to the formatting pattern elements `YY` and `WW`) are, by default, interpreted according to the same rules used for `⎕SM` and GUI edit fields, which are configurable using the [`YY_WINDOW`](../../../dyalog-configuration-guide/configuration-parameters/yy-window/) configuration parameter. ### Ambiguities and Precision diff --git a/language-reference-guide/docs/system-functions/fappend.md b/language-reference-guide/docs/system-functions/fappend.md index 52e9b8f0588..0438e8221f2 100644 --- a/language-reference-guide/docs/system-functions/fappend.md +++ b/language-reference-guide/docs/system-functions/fappend.md @@ -28,7 +28,7 @@ Dump←{ ``` !!! Info "Information" - Component files that have both journalling and checksum properties set to `0` have been deprecated; from Dyalog v21.0, component files with this combination of properties will be read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/). + Component files that have both journalling and checksum properties set to `0` have been deprecated, and component files with this combination of properties are read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/).
diff --git a/language-reference-guide/docs/system-functions/fchk.md b/language-reference-guide/docs/system-functions/fchk.md index 247cfb28df9..309f9a0229e 100644 --- a/language-reference-guide/docs/system-functions/fchk.md +++ b/language-reference-guide/docs/system-functions/fchk.md @@ -7,7 +7,7 @@ search: `⎕FCHK` validates and repairs component files, and validates files associated with external variables, following an abnormal termination of the APL process or operating system. -`Y` must be a simple character scalar or vector which specifies the name of the file to be exclusively checked or repaired. For component files, the file must be named in accordance with the operating system's conventions, and may be a relative or absolute pathname. The file must exist and must not be tied. If no file extension is supplied, the set of extensions specified by the  **CFEXT** parameter are tried one after another until the file is found or the set of extensions is exhausted. See [CFEXT](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters). +`Y` must be a simple character scalar or vector which specifies the name of the file to be exclusively checked or repaired. For component files, the file must be named in accordance with the operating system's conventions, and may be a relative or absolute pathname. The file must exist and must not be tied. If no file extension is supplied, the set of extensions specified by the  **CFEXT** parameter are tried one after another until the file is found or the set of extensions is exhausted. See [CFEXT](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters). For files associated with external variables, any filename extension must be specified even if `⎕XT` would not require it. The file must exist and must not currently be associated with an external variable. diff --git a/language-reference-guide/docs/system-functions/fcopy.md b/language-reference-guide/docs/system-functions/fcopy.md index 4200cadd3f7..299b5e79d64 100644 --- a/language-reference-guide/docs/system-functions/fcopy.md +++ b/language-reference-guide/docs/system-functions/fcopy.md @@ -9,7 +9,7 @@ search: `Y` must be a simple integer scalar or 1 or 2-element vector containing the file tie number and optional passnumber. The file need not be tied exclusively. -`X` is a character vector containing the name of a new file to be copied to. If no file extension is supplied, the first extension specified by the   **CFEXT** parameter will be added. See [ CFEXT](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters). +`X` is a character vector containing the name of a new file to be copied to. If no file extension is supplied, the first extension specified by the   **CFEXT** parameter will be added. See [ CFEXT](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters). `⎕FCOPY` creates a copy of the tied file specified by `Y`, named `X`. diff --git a/language-reference-guide/docs/system-functions/fcreate.md b/language-reference-guide/docs/system-functions/fcreate.md index 0e3161cf661..5d915e927d0 100644 --- a/language-reference-guide/docs/system-functions/fcreate.md +++ b/language-reference-guide/docs/system-functions/fcreate.md @@ -15,7 +15,7 @@ search: `X` must be either: -1. a simple character scalar or vector which specifies the name of the file to be created. If no file extension is supplied, the first extension specified by the   **CFEXT** parameter will be added. See [ CFEXT](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters). +1. a simple character scalar or vector which specifies the name of the file to be created. If no file extension is supplied, the first extension specified by the   **CFEXT** parameter will be added. See [ CFEXT](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters). 2. a vector of length 1 or 2 whose items are:- a simple character scalar or vector as above. - an integer scalar specifying the file size limit in bytes. @@ -91,7 +91,7 @@ will name a variant of `⎕FCREATE` which will create component file with level ``` !!! Info "Information" - Component files that have both journalling and checksum properties set to `0` have been deprecated; from Dyalog v21.0 it will not be possible to create files with this combination of properties. For information on how to identify code that creates component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/). + Component files that have both journalling and checksum properties set to `0` have been deprecated, and it is no longer possible to create files with this combination of properties. For information on how to identify code that creates component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/).
diff --git a/language-reference-guide/docs/system-functions/fprops.md b/language-reference-guide/docs/system-functions/fprops.md index 2ca494c6c6d..8331cce0bfd 100644 --- a/language-reference-guide/docs/system-functions/fprops.md +++ b/language-reference-guide/docs/system-functions/fprops.md @@ -117,7 +117,7 @@ An exclusive tie is not needed to change the file property. Compression is not supported for files in which both Journalling and Checksum are disabled. !!! Info "Information" - Component files that have both journalling and checksum properties set to `0` have been deprecated; from Dyalog v21.0, component files with this combination of properties will be read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/). Be aware that converting from non-checksummed components to checksummed components can take a significant amount of time. + Component files that have both journalling and checksum properties set to `0` have been deprecated, and it is no longer possible to create files with this combination of properties. Existing files with this combination are read-only, except that their properties can still be changed. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/). Be aware that converting from non-checksummed components to checksummed components can take a significant amount of time.
diff --git a/language-reference-guide/docs/system-functions/frename.md b/language-reference-guide/docs/system-functions/frename.md index aefcac1f24c..f2516882d3f 100644 --- a/language-reference-guide/docs/system-functions/frename.md +++ b/language-reference-guide/docs/system-functions/frename.md @@ -9,7 +9,7 @@ search: `Y` must be a simple 1 or 2 element integer vector containing a file tie number and an optional passnumber.  If the passnumber is omitted it is assumed to be zero. -`X` must be a simple character scalar or vector containing the new name of the file.  This name must be in accordance with the operating system's conventions, and may be specified with a relative or absolute pathname. If no file extension is supplied, the first extension specified by the   **CFEXT** parameter will be added. See [ CFEXT](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters). +`X` must be a simple character scalar or vector containing the new name of the file.  This name must be in accordance with the operating system's conventions, and may be specified with a relative or absolute pathname. If no file extension is supplied, the first extension specified by the   **CFEXT** parameter will be added. See [ CFEXT](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters). The file being renamed must be tied exclusively. diff --git a/language-reference-guide/docs/system-functions/freplace.md b/language-reference-guide/docs/system-functions/freplace.md index 8a1e1fa84b3..2ae1d7e1a95 100644 --- a/language-reference-guide/docs/system-functions/freplace.md +++ b/language-reference-guide/docs/system-functions/freplace.md @@ -32,7 +32,7 @@ Frep←{ ``` !!! Info "Information" - Component files that have both journalling and checksum properties set to `0` have been deprecated; from Dyalog v21.0, component files with this combination of properties will be read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/). + Component files that have both journalling and checksum properties set to `0` have been deprecated, and component files with this combination of properties are read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/).
diff --git a/language-reference-guide/docs/system-functions/fresize.md b/language-reference-guide/docs/system-functions/fresize.md index 32ea255ff71..f67a4787ec2 100644 --- a/language-reference-guide/docs/system-functions/fresize.md +++ b/language-reference-guide/docs/system-functions/fresize.md @@ -35,7 +35,7 @@ FILE FULL ``` !!! Info "Information" - Component files that have both journalling and checksum properties set to `0` have been deprecated; from Dyalog v21.0, component files with this combination of properties will be read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/). + Component files that have both journalling and checksum properties set to `0` have been deprecated, and component files with this combination of properties are read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/).
diff --git a/language-reference-guide/docs/system-functions/fstac.md b/language-reference-guide/docs/system-functions/fstac.md index 6a52ccd2604..65305c1677e 100644 --- a/language-reference-guide/docs/system-functions/fstac.md +++ b/language-reference-guide/docs/system-functions/fstac.md @@ -25,7 +25,7 @@ The shy result of `⎕FSTAC` is the tie number of the file. ``` !!! Info "Information" - Component files that have both journalling and checksum properties set to `0` have been deprecated; from Dyalog v21.0, component files with this combination of properties will be read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/). + Component files that have both journalling and checksum properties set to `0` have been deprecated, and component files with this combination of properties are read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/).
diff --git a/language-reference-guide/docs/system-functions/load.md b/language-reference-guide/docs/system-functions/load.md index 290851d8f04..90219cf7172 100644 --- a/language-reference-guide/docs/system-functions/load.md +++ b/language-reference-guide/docs/system-functions/load.md @@ -5,7 +5,7 @@ search: # Load Workspace `⎕LOAD Y`{{key}} -`Y` must be a simple character scalar or vector containing the name of a file that contains a saved workspace. . If no file extension is given it is implied. See [WSEXT](../../../windows-installation-and-configuration-guide/configuration-parameters/wsext). +`Y` must be a simple character scalar or vector containing the name of a file that contains a saved workspace. . If no file extension is given it is implied. See [WSEXT](../../../dyalog-configuration-guide/configuration-parameters/wsext). If `Y` is ill-formed or does not identify a saved workspace or the user account does not have access permission to the workspace, a `DOMAIN ERROR` is reported. diff --git a/language-reference-guide/docs/system-functions/na.md b/language-reference-guide/docs/system-functions/na.md index 35c98ef9362..29f95ededc2 100644 --- a/language-reference-guide/docs/system-functions/na.md +++ b/language-reference-guide/docs/system-functions/na.md @@ -47,7 +47,7 @@ div 2.5 ``` -It is imperative that care be taken when coding type declarations. A DLL *cannot* check types of data passed from APL. A wrong type declaration will lead to erroneous results or may even cause the workspace to become corrupted and crash. During development, you may wish to prevent this happening. See [ErrorOnExternalException](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters). +It is imperative that care be taken when coding type declarations. A DLL *cannot* check types of data passed from APL. A wrong type declaration will lead to erroneous results or may even cause the workspace to become corrupted and crash. During development, you may wish to prevent this happening. See [ErrorOnExternalException](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters). The full syntax for the right argument of `⎕NA` is: ``` diff --git a/language-reference-guide/docs/system-functions/query-external-variable.md b/language-reference-guide/docs/system-functions/query-external-variable.md index d51c856fc6d..cf0b684b288 100644 --- a/language-reference-guide/docs/system-functions/query-external-variable.md +++ b/language-reference-guide/docs/system-functions/query-external-variable.md @@ -18,7 +18,7 @@ EXT\ARRAY ``` !!! Info "Information" - Support for external variables has been deprecated, and they are scheduled for removal in a future release. For information on how to identify uses of external variables in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/). + Support for external variables has been deprecated: they are not supported by default, and support is scheduled for removal in a future release. Setting the [DYALOG_EXTVAR_SUPPORTED](../../../dyalog-configuration-guide/configuration-parameters/dyalog-extvar-supported) configuration parameter to `1` reinstates support for the time being. For information on how to identify uses of external variables in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/).
diff --git a/language-reference-guide/docs/system-functions/set-external-variable.md b/language-reference-guide/docs/system-functions/set-external-variable.md index d9d08090b0f..c24f516d055 100644 --- a/language-reference-guide/docs/system-functions/set-external-variable.md +++ b/language-reference-guide/docs/system-functions/set-external-variable.md @@ -104,7 +104,7 @@ An external array may be erased using the native file function: `⎕NERASE`. In a multi-user environment (UNIX or a Windows LAN) a new file associated with an external array is created with access permission for owner read/write. An existing file is opened for exclusive use (by the owner) if the permissions remain at this level. If the access permissions allow any other users to read and write to the file, the file is opened for shared use. In UNIX versions, access permissions may be modified using the appropriate Operating System command, or in Windows using the supplied function `XVAR` from the UTIL workspace. !!! Info "Information" - Support for external variables has been deprecated, and they are scheduled for removal in a future release. For information on how to identify uses of external variables in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/). + Support for external variables has been deprecated: they are not supported by default, and support is scheduled for removal in a future release. Setting the [DYALOG_EXTVAR_SUPPORTED](../../../dyalog-configuration-guide/configuration-parameters/dyalog-extvar-supported) configuration parameter to `1` reinstates support for the time being. For information on how to identify uses of external variables in your existing codebase, see the [Release Notes](../../../release-notes/announcements/deprecated-functionality/).
diff --git a/language-reference-guide/docs/system-functions/shell.md b/language-reference-guide/docs/system-functions/shell.md index aa7390af6a3..2b955b327e8 100644 --- a/language-reference-guide/docs/system-functions/shell.md +++ b/language-reference-guide/docs/system-functions/shell.md @@ -306,7 +306,7 @@ The default for the input stream is - `(0 'Null')`: Provide no data on standard input. !!! unix "Dyalog on AIX" - The performance of `⎕SHELL` on AIX can be improved using the [`DYALOG_SHELL_SUBPROCESS`](../../../unix-installation-and-configuration-guide/configuration-parameters/environment-variables/#_table-4) configuration parameter; this configuration parameter is active by default. + The performance of `⎕SHELL` on AIX can be improved using the [`DYALOG_SHELL_SUBPROCESS`](../../../dyalog-configuration-guide/configuration-parameters/dyalog-shell-subprocess) configuration parameter; this configuration parameter is active by default.
diff --git a/language-reference-guide/docs/system-functions/system.md b/language-reference-guide/docs/system-functions/system.md index 75bce0d409f..d2426f041e1 100644 --- a/language-reference-guide/docs/system-functions/system.md +++ b/language-reference-guide/docs/system-functions/system.md @@ -251,7 +251,7 @@ This namespace provides information about the interpreter's operating system pro Non-negative integer [process identifier](https://en.wikipedia.org/wiki/Process_identifier) (PID) of the interpreter. #### Process.LaunchTarget -The fully qualified path of the file or directory loaded at startup. This is set by either a workspace name on the [APL command line](../../windows-installation-and-configuration-guide/apl-command-line) or using the [LOAD configuration parameter](../../windows-installation-and-configuration-guide/configuration-parameters/load/). +The fully qualified path of the file or directory loaded at startup. This is set by either a workspace name on the [APL command line](../../windows-installation-and-configuration-guide/apl-command-line) or using the [LOAD configuration parameter](../../../dyalog-configuration-guide/configuration-parameters/load/). #### Process.ParentId Non-negative integer [process identifier](https://en.wikipedia.org/wiki/Process_identifier) of the process that launched the interpreter. Always `¯1` on Microsoft Windows. diff --git a/language-reference-guide/docs/system-functions/wx.md b/language-reference-guide/docs/system-functions/wx.md index 3f2748793d2..b18f00ce608 100644 --- a/language-reference-guide/docs/system-functions/wx.md +++ b/language-reference-guide/docs/system-functions/wx.md @@ -26,13 +26,13 @@ When you create an object, its `⎕WX` (like any other system variable) is initi If the value of `⎕WX` of a GUI object is initially 0, it will not expose its members. If you subsequently change it from 0 to 1, it will expose them. If you change its `⎕WX` back to 0, it will not expose any yet-unexposed members, although already-exposed members will continue to be exposed. -The value of `⎕WX` in a clear workspace is defined by the default_wx parameter (see [ default_wx](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters)) which itself defaults to 3. +The value of `⎕WX` in a clear workspace is defined by the default_wx parameter (see [ default_wx](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters)) which itself defaults to 3. `⎕WX` has namespace scope and may be localised in a function header. This allows you to create a utility namespace or utility function in which the exposure of objects is known and determined, regardless of its global value in the workspace. ## Notes -- The visibility of the properties and methods of the Root object are not controlled by `⎕WX` but by the **PropertyExposeRoot** parameter. For further information, see [ PropertyExposeRoot](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters). +- The visibility of the properties and methods of the Root object are not controlled by `⎕WX` but by the **PropertyExposeRoot** parameter. For further information, see [ PropertyExposeRoot](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters). - `⎕WX` is retained for backwards compatibility and should be considered as deprecated. Dyalog recommends `⎕WX` be set to 3 and never changed. diff --git a/mkdocs.yml b/mkdocs.yml index 97e1608424a..a9ac4cd3730 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -79,6 +79,8 @@ nav: - 'Core Reference': - 'Dyalog APL Language': "!include ./language-reference-guide/mkdocs.yml" - 'Programming': "!include ./programming-reference-guide/mkdocs.yml" + - 'Cross-platform Environment': + - 'Configuration': "!include ./dyalog-configuration-guide/mkdocs.yml" - 'Code Tooling': - '.NET Interface': "!include ./dotnet-interface-guide/mkdocs.yml" - 'Compiler': "!include ./compiler-user-guide/mkdocs.yml" diff --git a/object-reference/docs/objects/font.md b/object-reference/docs/objects/font.md index a9839a7fd5d..b79beb75a5d 100644 --- a/object-reference/docs/objects/font.md +++ b/object-reference/docs/objects/font.md @@ -20,7 +20,7 @@ The characteristics of the font are specified by its properties as follows : The [Coord](../properties/coord.md) property may be set to `'Pixel'`, `'ScaledPixel'` or `'RealPixel'` when the object is created, but [Coord](../properties/coord.md) may not subsequently be changed. -If Coord is `'Pixel'`, it is interpreted as either `'RealPixel'` or `'ScaledPixel'` according to the value of the **Dyalog_Pixel_Type** parameter, which is either ScaledPixel or RealPixel. See [Dyalog_Pixel_Type](../../../windows-installation-and-configuration-guide/configuration-parameters/dyalog-pixel-type). +If Coord is `'Pixel'`, it is interpreted as either `'RealPixel'` or `'ScaledPixel'` according to the value of the **Dyalog_Pixel_Type** parameter, which is either ScaledPixel or RealPixel. See [Dyalog_Pixel_Type](../../../dyalog-configuration-guide/configuration-parameters/dyalog-pixel-type). **If this parameter is not specified, the default is RealPixel. So by default, when you set Coord to Pixel, it will be treated as RealPixel.** diff --git a/object-reference/docs/objects/root.md b/object-reference/docs/objects/root.md index cf4ca1cdcc5..d7c630a6ff2 100644 --- a/object-reference/docs/objects/root.md +++ b/object-reference/docs/objects/root.md @@ -47,7 +47,7 @@ There are a number of elements that control whether or not Root members are expo 2. This flag may be changed dynamically using the *Options/Object Syntax/Expose Root Properties* menu item on the Session or using `2401⌶`. If the workspace is subsequently saved, the current value of the flag is saved with it. 3. The value of the flag in a `CLEAR WS` is determined by the **PropertyExposeRoot** parameter. Under Windows, this parameter is associated with the *Expose properties of Root* checkbox on the *Object Syntax* Tab of the *Configuration* dialog box. When you change the value of this checkbox and close the *Configuration* dialog by clicking *OK*, the value of the **PropertyExposeRoot** parameter is immediately updated in the user's section of the Registry. However, the value of the flag *in the current workspace* is not changed. The **PropertyExposeRoot** parameter only defines the value of the flag in a `CLEAR WS`, so if you subsequently type `)CLEAR`, the current value of the parameter in the Registry determines whether or not Root members are exposed and sets the flag in the workspace accordingly. -For further information, see [The Options Menu](../../../windows-ui-guide/session-menubar), [ PropertyExposeRoot](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters), and [Expose Root Properties](../../../language-reference-guide/primitive-operators/i-beam/expose-root-properties). +For further information, see [The Options Menu](../../../windows-ui-guide/session-menubar), [ PropertyExposeRoot](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters), and [Expose Root Properties](../../../language-reference-guide/primitive-operators/i-beam/expose-root-properties). ## Notes diff --git a/object-reference/docs/properties/coord.md b/object-reference/docs/properties/coord.md index eff2f88e627..923898ebdfa 100644 --- a/object-reference/docs/properties/coord.md +++ b/object-reference/docs/properties/coord.md @@ -29,7 +29,7 @@ to (Size -1). If Coord is `'ScaledPixel'` the number of pixels specified for [Posn](posn.md), [Size](size.md), and other such properties will be automatically scaled by Dyalog APL according to the user's chosen display scaling factor. So if you specify an Edit object to be 80 pixels wide and 20 pixels high, and the user's scaling factor is 150%, Dyalog will automatically draw it 120 pixels wide and 30 pixels high. Dyalog will also de-scale coordinate values reported by `⎕WG` and event messages. -If Coord is `'Pixel'`, it is interpreted as either `'RealPixel'` or `'ScaledPixel'` according to the value of the **Dyalog_Pixel_Type** parameter, which is either ScaledPixel or RealPixel. See [Dyalog_Pixel_Type](../../../windows-installation-and-configuration-guide/configuration-parameters/dyalog-pixel-type). +If Coord is `'Pixel'`, it is interpreted as either `'RealPixel'` or `'ScaledPixel'` according to the value of the **Dyalog_Pixel_Type** parameter, which is either ScaledPixel or RealPixel. See [Dyalog_Pixel_Type](../../../dyalog-configuration-guide/configuration-parameters/dyalog-pixel-type). **If this parameter is not specified, the default is RealPixel. So by default, when you set Coord to Pixel, it will be treated as RealPixel.** diff --git a/programming-reference-guide/docs/component-files/integrity-and-security.md b/programming-reference-guide/docs/component-files/integrity-and-security.md index aa27aab0e40..32f49ffc442 100644 --- a/programming-reference-guide/docs/component-files/integrity-and-security.md +++ b/programming-reference-guide/docs/component-files/integrity-and-security.md @@ -23,4 +23,4 @@ APL files are treated as normal data files by the operating system, and may be m Do not use operating system commands to copy, erase or move component files that are tied and in use by an APL session. !!! Info "Information" - Component files that have both journalling and checksum properties set to `0` have been deprecated; from Dyalog v21.0, component files with this combination of properties will be read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../release-notes/announcements/deprecated-functionality.md). + Component files that have both journalling and checksum properties set to `0` have been deprecated, and component files with this combination of properties are read-only. Dyalog Ltd recommends using `⎕FPROPS` to convert any such files to have different properties. For information on how to identify component files that have both journalling and checksum properties set to `0` in your existing codebase, see the [Release Notes](../../release-notes/announcements/deprecated-functionality.md). diff --git a/programming-reference-guide/docs/error-messages/system-errors.md b/programming-reference-guide/docs/error-messages/system-errors.md index 6c84720f0c9..1f8211c4fd9 100644 --- a/programming-reference-guide/docs/error-messages/system-errors.md +++ b/programming-reference-guide/docs/error-messages/system-errors.md @@ -11,13 +11,13 @@ On Windows, if the **DYALOG_NOPOPUPS** parameter is 0 (the default), it will di ## aplcore file -When a system error occurs, APL normally saves an *aplcore* file which may be sent to Dyalog for diagnosis. The name and location of the *aplcore* file may be specified by the [**AplCoreName**](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters) parameter. If this parameter is not specified, the *aplcore* file is named `aplcore` and is saved in the current working directory. +When a system error occurs, APL normally saves an *aplcore* file which may be sent to Dyalog for diagnosis. The name and location of the *aplcore* file may be specified by the [**AplCoreName**](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters) parameter. If this parameter is not specified, the *aplcore* file is named `aplcore` and is saved in the current working directory. -Normally a new *aplcore* will replace a file of the same name. However, if [**AplCoreName**](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters) contains an asterisk (*), the system will create a new file, replacing the asterisk with a number incremented from the largest numbered file present. +Normally a new *aplcore* will replace a file of the same name. However, if [**AplCoreName**](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters) contains an asterisk (*), the system will create a new file, replacing the asterisk with a number incremented from the largest numbered file present. -The number of *aplcore* files retained by the system is specified by the [**MaxAplCores**](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters) parameter. If [**MaxAplCores**](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters) is 0, the system will not save an *aplcore*. However, under Windows, if **DYALOG_NOPOPUPS** is 0, and the user checks the *Create an aplcore file* checkbox when the *System Error* dialog box is displayed, an *aplcore* will be saved regardless of the value of [**MaxAplCores**](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters). See **System Error Dialog Box**. +The number of *aplcore* files retained by the system is specified by the [**MaxAplCores**](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters) parameter. If [**MaxAplCores**](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters) is 0, the system will not save an *aplcore*. However, under Windows, if **DYALOG_NOPOPUPS** is 0, and the user checks the *Create an aplcore file* checkbox when the *System Error* dialog box is displayed, an *aplcore* will be saved regardless of the value of [**MaxAplCores**](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters). See **System Error Dialog Box**. -Be aware that if your application contains any secure data, this data may be present in an *aplcore* file, and it may be appropriate to set both [**MaxAplCores**](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters) and **DYALOG_NOPOPUPS** to 0 to prevent such data being saved on disk. +Be aware that if your application contains any secure data, this data may be present in an *aplcore* file, and it may be appropriate to set both [**MaxAplCores**](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters) and **DYALOG_NOPOPUPS** to 0 to prevent such data being saved on disk. Information that may prove useful in debugging the problem, including (where possible) the SI stack at the point where the *aplcore* was generated, is by default written to the end of *aplcore* files; the section begins with the string @@ -27,7 +27,7 @@ Under UNIX, this interesting information section can be extracted from the *aplc `sed -n '/======== Interesting Information/,$p' aplcore` -To prevent this information from being written to the *aplcore* file, the [**APL_TextInAplCore**](../../../windows-installation-and-configuration-guide/configuration-parameters/apl-textinaplcore) parameter should be set to 0. +To prevent this information from being written to the *aplcore* file, the [**APL_TextInAplCore**](../../../dyalog-configuration-guide/configuration-parameters/apl-textinaplcore) parameter should be set to 0. ## Workspace Integrity @@ -120,7 +120,7 @@ After debugging, the System Exception dialog box appears again. Click on *Don't ## ErrorOnExternalException Parameter -This parameter allows you to prevent APL from taking the actions described above when an exception caused by an external DLL occurs. The following example illustrates what happens when the functions above are run, but with the [**ErrorOnExternalException**](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters) parameter set to 1. +This parameter allows you to prevent APL from taking the actions described above when an exception caused by an external DLL occurs. The following example illustrates what happens when the functions above are run, but with the [**ErrorOnExternalException**](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters) parameter set to 1. ```apl    ⎕←2 ⎕NQ'.' 'GetEnvironment' 'ErrorOnExternalException' 1 @@ -137,7 +137,7 @@ goo[1] foo[1] ``` -Note: Dyalog recommends that enabling [**ErrorOnExternalException**](../../../windows-installation-and-configuration-guide/configuration-parameters/configuration-parameters) should only be done while developing or debugging an application; ignoring such errors may result in corruption in the workspace which could result to unexpected errors later in the application. +Note: Dyalog recommends that enabling [**ErrorOnExternalException**](../../../dyalog-configuration-guide/configuration-parameters/configuration-parameters) should only be done while developing or debugging an application; ignoring such errors may result in corruption in the workspace which could result to unexpected errors later in the application. ## What should I do if Dyalog hangs? diff --git a/programming-reference-guide/docs/introduction/arrays/display-of-arrays.md b/programming-reference-guide/docs/introduction/arrays/display-of-arrays.md index c7bfa648d5d..78fc8647d77 100644 --- a/programming-reference-guide/docs/introduction/arrays/display-of-arrays.md +++ b/programming-reference-guide/docs/introduction/arrays/display-of-arrays.md @@ -151,7 +151,7 @@ Arrays (including namespaces) can be displayed in the session using [array notat ``` In the [Microsoft Windows IDE](../../../../windows-ui-guide) it can also be toggled on and off using the ![](../../img/session_arraynotation.png){width=20 height=20 vertical-align:text-bottom} icon on the Session toolbar. -To enable the display of output using array notation when starting a Dyalog session, set the [APLAN_FOR_OUTPUT](../../../../windows-installation-and-configuration-guide/configuration-parameters/aplan-for-output) configuration parameter to `1`. +To enable the display of output using array notation when starting a Dyalog session, set the [APLAN_FOR_OUTPUT](../../../../dyalog-configuration-guide/configuration-parameters/aplan-for-output) configuration parameter to `1`. ## Obtaining Textual Representations diff --git a/programming-reference-guide/docs/introduction/workspaces.md b/programming-reference-guide/docs/introduction/workspaces.md index 5f2fffdd983..46f89162d1d 100644 --- a/programming-reference-guide/docs/introduction/workspaces.md +++ b/programming-reference-guide/docs/introduction/workspaces.md @@ -4,7 +4,7 @@ APL expressions are evaluated within a workspace. The workspace may contain obje Workspaces may be explicitly saved with an identifying name. The workspace may subsequently be loaded, or objects may be selectively copied from a saved workspace into the current workspace. -Workspaces are stored in files whose names must conform to operating system conventions. When a workspace name is specified without a file suffix, these are added or implied. For further information, see [WSEXT](../../../windows-installation-and-configuration-guide/configuration-parameters/wsext). +Workspaces are stored in files whose names must conform to operating system conventions. When a workspace name is specified without a file suffix, these are added or implied. For further information, see [WSEXT](../../../dyalog-configuration-guide/configuration-parameters/wsext). If the name of the file in which the workspace is saved contains spaces, the ws argument for the system functions `)SAVE`, `)COPY`, `)PCOPY`, `)LOAD`, `)XLOAD` and `)DROP` should be surrounded by two double-quote (") characters. To include a " character in the file name, you must specify two adjoining double-quotes (that is, """"). Note however that Windows does not allow double-quotes in file names, so this effectively applies only to non-Windows systems. diff --git a/unix-installation-and-configuration-guide/docs/configuration-parameters/configuration-files.md b/unix-installation-and-configuration-guide/docs/configuration-parameters/configuration-files.md index bf67263ef94..e02349557c3 100644 --- a/unix-installation-and-configuration-guide/docs/configuration-parameters/configuration-files.md +++ b/unix-installation-and-configuration-guide/docs/configuration-parameters/configuration-files.md @@ -1,79 +1,11 @@ # Configuration Files -A configuration file is a text file containing configuration parameters and values. It can cascade, that is, it can extend (inherit) configuration values from other configuration files, and supplement and/or override them. Configuration files use JSON5 (a superset of standard JSON) syntax and are portable across all systems supported by Dyalog. +A configuration file is a text file, in JSON5 syntax, that holds configuration parameters and their values, and is portable across all platforms that Dyalog supports. -The key benefits of defining configuration parameters using configuration files include: +Configuration files and their structure are documented, for all platforms, in the Dyalog Configuration Guide: -- Configuration files are text-based. They are, therefore, easily managed along with the source code for an application, using industry standard tools for source code management and continuous integration. -- Application configuration files can be placed in application folders and define the configuration settings for a specific application. -- User configuration files provide settings that are the same for all applications. Typically, these files are used to configure the development environment. -- Interpreter configuration can be performed in the same way across all supported platforms. -- Dyalog can be launched from a text file that defines a function, namespace or class. If a configuration file exists with the same name as this file (but with a *.dcfg* extension), then Dyalog will detect this on launching and use the configuration parameter settings it defines. -- Configuration files are easy to read, and can be written directly or by using `⎕JSON` (which supports JSON5). -- Both application and user configuration files can cascade, overriding settings defined in a more generic configuration file; this simplifies the configuration of components which share some configuration. +- [Application Configuration Files](../../../dyalog-configuration-guide/how-to-set/application-configuration-files) +- [User Configuration Files](../../../dyalog-configuration-guide/how-to-set/user-configuration-files) +- [Configuration File Structure](../../../dyalog-configuration-guide/how-to-set/configuration-file-structure) -Dyalog Ltd recommends that configuration files are used for all run-time applications, and that the use of environment variables for this purpose is eliminated. - -There are two different types of configuration file: - -- A user configuration file – this defines configuration values for the current (possibly only) user of the system. The first time a new version of Dyalog is launched it creates and initialises a user configuration file called *\$HOME/.dyalog/dyalog.<version-specific>.dcfg*, where the version-specific information comprises the version number, edition and width. For example, a 64‑bit Unicode edition of Dyalog version 18.0 will be identified as *180U64*. The name of this file should not be changed. -- An application configuration file – this contains configuration values associated with a specific application. This is created by the user and should be saved at the same level as the application. It can either be given the same name as the workspace/script that is loaded when the application starts (but with the extension *.dcfg*) or the name should be stored in the CONFIGFILE parameter. - -An additional configuration file called *\$HOME/.dyalog/dyalog.dcfg* is also created the first time any version of Dyalog is run. This can be edited to include configuration parameter values that should always be applied irrespective of Dyalog version so that they do not have to be redefined in multiple version-specific user configuration files. - -Prior to Dyalog version 18.0, configuration parameters could be specified as environment variables and set in the *\$HOME/.dyalog/dyalog.config* script. This is no longer referenced, and any settings that should be retained must be re-entered in the appropriate *\$HOME/.dyalog/dyalog.<version-specific>.dcfg* configuration file. - -## Configuration File Structure - -Configuration files define configuration parameters using JSON5. A JSON object contains data in the form of key/value pairs and other JSON objects. The keys are strings and the values are the JSON types. A key and its value are seperated by a colon (`:`) character. Entries (key/value pairs) are separated by comma (`,`) characters. - -The top-level object defines an optional key called `Extend` and an optional object called `Settings`: - -- `Extend` is a string value containing the name of a configuration file to import. The extended (imported) file can extend another configuration file. Configuration values from the imported file(s) can be overridden by redefining them. The file name is implicitly relative to the name of the file that imports it (any file name extension must be explicitly specified). -- `Settings` is an object containing the names of configuration parameters and their values. The values can be a string, a number or an array of strings. - -The names and values correspond to configuration parameters, and names are not case sensitive. Any named values can be defined; an APL application could query the values using `+2⎕NQ'.' 'GetEnvironment' ` or using the `]Config` user command. - -If the same name is defined multiple times within a configuration file then the first definition will be used and a warning will be generated. - -## Arrays - -An array can be used to define file paths, for example, `WSPATH: ["/dir1", "/dir2"]`. The only parameters which can be defined as arrays are **WSPATH**, **WSEXT** and **CFEXT**. - -## 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. - -If the referenced configuration parameter is not defined then no substitution will take place; the reference, including the square bracket delimiters, will remain in place. - -To include literal square brackets in a string, prefix them with a `\` character. - -## Nested Structures - -Configuration files support nested parameter structures by defining an object that corresponds to the structure. For example: -``` -Captions: { - Session: "My Dyalog Session" - Status: "My Status window" -} -``` -```apl - +2 ⎕NQ '.' 'GetEnvironment' 'Captions\Session' -My Dyalog Session -``` - -## Example Configuration File Content -``` -{ - Extend: "my_default_configuration.dcfg", - Settings: { - // maximum workspace - MAXWS: "2GB", - WSPATH: ["/dir1", "/dir2", ""], - UserOption: 123, - ROOTDIR: "/my/root/directory", - // references to other configuration parameters - FNAME: "[rootdir]/filename", - } -} -``` +On UNIX and macOS, user configuration files are held in `$HOME/.dyalog/`. diff --git a/unix-installation-and-configuration-guide/docs/configuration-parameters/configuration-parameters.md b/unix-installation-and-configuration-guide/docs/configuration-parameters/configuration-parameters.md index 155b53a9e62..59981fb657f 100644 --- a/unix-installation-and-configuration-guide/docs/configuration-parameters/configuration-parameters.md +++ b/unix-installation-and-configuration-guide/docs/configuration-parameters/configuration-parameters.md @@ -1,13 +1,5 @@ # Configuration Parameters -Dyalog can be customised using configuration parameters. These can be set in various ways; if a configuration parameter is set in multiple places the following descending order of precedence applies: +Dyalog is customised using configuration parameters. The parameters, the ways to set them (the command line, application and user configuration files, environment variables, and built-in defaults), and the order of precedence when a parameter is set in more than one place are documented, for all platforms, in the [Dyalog Configuration Guide](../../../dyalog-configuration-guide/introduction). -1. command line settings -2. application configuration file settings -3. environment variable settings -4. user configuration file settings -5. built-in defaults - -This provides a great deal of flexibility, enabling a user to override one setting with another. For example, a "usual" workspace size (**MAXWS**) can be defined in the user configuration file, but be temporarily superseded by entering a different value when starting a Dyalog Session from the command line. - -For more information on configuration files, see [Configuration Files](configuration-files.md). For more information on environment variables, see [Environment Variables](environment-variables.md). +The parameters that apply only to UNIX and macOS, and the platform-specific defaults and behaviour of the shared parameters, are noted on the individual parameter pages there. diff --git a/unix-installation-and-configuration-guide/docs/configuration-parameters/environment-variables.md b/unix-installation-and-configuration-guide/docs/configuration-parameters/environment-variables.md index 4dedf4b26f9..4d3fcb7ccd6 100644 --- a/unix-installation-and-configuration-guide/docs/configuration-parameters/environment-variables.md +++ b/unix-installation-and-configuration-guide/docs/configuration-parameters/environment-variables.md @@ -1,129 +1,5 @@ # Environment Variables -Environment variables are used to configure various aspects of Dyalog APL. The complete list appears in the *Dyalog for Microsoft Windows Installation and Configuration Guide: Configuration Parameters*; this section discusses those variables which are of particular importance to the Non-GUI versions of Dyalog APL, and lists those that have meaning to the UNIX versions. Additionally there some non-GUI-specific variables which are described below and some which either do not apply, or may not work as the user might at first expect. +A configuration parameter can be set as an environment variable. This mechanism, the order of precedence, and the full list of parameters (including those specific to UNIX and macOS) are documented in the [Dyalog Configuration Guide](../../../dyalog-configuration-guide/how-to-set/environment-variables). -Under UNIX, all environment variables should appear in UPPER CASE. For example, to set the default value of `⎕ML` to 3, then -``` -$ export DEFAULT_ML=3 -``` - -If a configuration parameter described in the *Dyalog for Microsoft Windows Installation and Configuration Guide* has a backslash "\" in its name (strictly speaking, appears in a subkey of the Dyalog key in the Windows Registry), this should be replaced with an underscore in the equivalent environment variable. This applies for example to SALT\CommandFolder. - -Many of these environment variables are set in the mapl script; their values are either appropriate for the installation location of Dyalog APL, or are set to define reasonable default values. - -The environment variables are broken down into several tables: - -- [Table 1](#_table-1): The most commonly defined and used for non-GUI versions of Dyalog APL under UNIX. Most of these variables are essential for a usable APL session -- [Table 2](#_table-2): Variables used to control default values in the workspace -- [Table 3](#_table-3): Variables used to configure the Session -- [Table 4](#_table-4): Miscellaneous Variables used by non-GUI Dyalog APL -- [Table 5](#_table-5): Editor-related environment variables -- [Table 6](#_table-6): Tracer-related environment variables -- [Table 7](#_table-7): Ride-related environment variables -- [Table 8](#_table-8): SALT and User Command-related environment variables - -Table: Commonly used Variables - -|Variable|Notes| -|---|---| -|TERM
APLK
APLK0
APLT
APLTn|Define the input and output translate tables used by Dyalog APL. The values of APLK0 and APLTn override the values of APLK and APLT if set, and they in turn override the value of (Unicode) *default*, or (Classic) TERM if set.

APLK is for input translation, APLT for output translation.

These are used in conjunction with ..| -|`APLKEYS` `APLTTRANS`|Define the search path for the input and output translate tables respectively. If unset, the interpreter will default to `$DYALOG`; if `$DYALOG` too is not set, will default to `/usr/dyalog`.| -|`APLNID`|This variable is ignored by the UNIX versions of Dyalog APL: `⎕AI` and `⎕AN` pick up their values from the user's uid and `/etc/passwd`.| -|`APLSTATUSFD`|If set, this defines the stream number on which all messages for the Status Window appear. It is then possible to redirect this output when APL is started.

If unset, the output will appear in the same terminal window as the APL session, although it is not part of the session; such output can be removed by hitting SR (Screen Redraw - often defined to be Ctrl-L).| -|`DYALOG_NETCORE`|This parameter is a Boolean value with a default value of 1. If set to 0, it disables the .NET interface.| -|`DYALOG_SERIAL`|This parameter contains your Dyalog serial number. This must be set to the serial number issued to you. If not set, then the software is unregistered. For the full licence terms and conditions, see [https://www.dyalog.com/uploads/documents/Terms_and_Conditions.pdf](https://www.dyalog.com/uploads/documents/Terms_and_Conditions.pdf) .| -|`DYALOG_SERIALFILE`|This parameter specifies the full path to the text file containing your Dyalog serial number.| -|`ENABLE_CEF`|This parameter is a Boolean value with a default value of 1. If set to 0, it disables the [Chromium Embedded Framework (CEF)](https://en.wikipedia.org/wiki/Chromium_Embedded_Framework) and at attempt to create an HTMLRenderer object (see [HTMLRenderer](../../../object-reference/objects/htmlrenderer)) will fail with an error message. See Note (below).| -|`ERRORONEXTERNALEXCEPTION`|By default, any error when calling `⎕NA` will result in APL terminating; if `ERRORONEXTERNALEXCEPTION` is set to 1, then APL will instead generate an event 91: `EXTERNAL DLL EXCEPTION` . Be aware however that the workspace may become corrupted. This is best used when developing `⎕NA` code rather than in production.| -|`LIBPATH`|A suitable entry for the Conga libraries needs to be added to the `LIBPATH` variable if Conga is to be used. For more information see the *Conga Guide*.| -|`MAXWS`|Defines the size of the workspace that will be presented to the user when Dyalog APL is started. A simple integer value will be treated as being in KB. K, M and G can be appended to the value to indicate KiB, MiB and GiB (binary) respectively. If unset, the default value is 256M.| -|`WSPATH`|Defines the search path for both workspaces and Auxiliary processors.

If unset, there is no default value. Workspaces and APs that are not on the `WSPATH` can be accessed using absolute or relative pathnames.| - -## Note - -Currently the value of the **Enable_CEF** parameter defined in the Windows Registry or in a -Configuration file is ignored. Only the value set in the command line or as an -environment variable is honoured. If not defined in this way, the default value -is used. - -Under macOS and Linux, if the configuration parameter **ENABLE_CEF** is 1, Auxiliary Processors cannot be used (they hang on error). The default value is 1 unless you are not running under a desktop (for example, you are running Dyalog in a PuTTY session when the default is 0). - -Table: Default workspace values - -|Variable|Notes| -|---|---| -|`DEFAULT_DIV`|Default value for `⎕DIV` in a clear workspace.| -|`DEFAULT_IO`|Default value for `⎕IO` in a clear workspace.| -|`DEFAULT_ML`|Default value for `⎕ML` in a clear workspace.| -|`DEFAULT_PP`|Default value for `⎕PP` in a clear workspace.| -|`AUTO_PW` `DEFAULT_PW`|`⎕PW` is set by the interpreter when it starts, or when the session window is resized. Under UNIX if the terminal window is resized, the session will be resized when the interpreter next checks for input.| -|`DEFAULT_RTL`|Default value for `⎕RTL` in a clear workspace.| -|`DEFAULT_WX`|Default value for `⎕WX` in a clear workspace. Note that although the UNIX versions of Dyalog APL do not have GUI objects, `⎕SE` is present, and the value of `⎕WX` will affect the programmer's ability to run expressions such as `⎕SE.PropList`.| - -For numeric values, the interpreter takes the value of the environment variable, and prepends a "0" to that string. It then parses the string, accepting characters until the first non-digit character is reached. - -This string, now of digits only, is converted into an integer. If the resulting value is valid, then that is the value that will be used in the workspace. If the resulting value is invalid, then the default value will be used instead. - -Table: Variables used to configure the Session - -|Variable|Notes| -|---|---| -|`APLAN_FOR_OUTPUT`|Enable or disable use of [array notation](../../../programming-reference-guide/introduction/arrays/array-notation/) for session output| -|`DYALOGLINK`|Specifies the directory for Link| -|`DYALOGSTARTUPSE`|Specifies one or more *Session initialisation* directories that contain APL code to be installed in `⎕SE`| -|`DYALOGSTART_X`|Specifies whether the `Run` function is executed during Session startup| -|`DYALOG_GUTTER_ENABLE`|Enable or disable Session Gutter| -|`HISTORY_SIZE`|The size of the prior line buffer| -|`INPUT_SIZE`|The size of the buffer used to store lines marked for execution| -|`LOG_FILE` `LOG_FILE_INUSE` `LOG_SIZE`|These three variables determine the name of the session log file (default `~/.dyalog/session_log__*.dlf`, for example, `~/.dyalog/session_log_190U64_*.dlf`), whether a log file is created or not, and the size of the log file in KB. Be aware: the session log file is not interchangeable between the different editions and widths of APL; in a mixed environment it is strongly recommended to use a different log file for each version.| -|`PFKEY_SIZE`|The size of the buffer used to hold `PFKEY` definitions: if this is too small, an attempt to add a new definition will result in a `LIMIT ERROR`.| -|`SESSION_FILE`|Defines the location of your session file; session file support was added in Dyalog 13.1. The default value is `$DYALOG/default.dse`| - -To set values, use K to indicate KB. Note that the buffers will contain other information, so the buffer size will not be exact. Note also that multibyte Unicode characters will take up more space than single byte characters, and that 32 and 64 bit versions of Dyalog APL can require different amounts of space for holding the same information. - -Example: -``` -HISTORY_SIZE=4K my_apl_startup_script -``` - -Table: Miscellaneous Variables used by non-GUI Dyalog APL - -|---|---| -|Variable|Notes| -|`APL_TEXTINAPLCORE`|If set with the value 1 the "Interesting Information" section is included in an aplcore file. Otherwise this section is omitted. By default the interpreter has this set to 0; it is the default APL script which sets it to 1.| -|`AUTOFORMAT` `TABSTOPS`|If `AUTOFORMAT` is 1, then control structures will be shown with indents, set at `TABSTOPS` spaces; the changes are reflected in the editor window when the `RD` (ReDraw) command key is hit.| -|`AUTOINDENT`|If `AUTOINDENT` is set to 1, then if a line is added it is indented the same as the previous line.| -|`AUTO_PW`|Introduced in 13.0. With `AUTO_PW=0` `⎕PW` remains fixed at the size of the terminal window when APL was started. When set to 1, or unset, `⎕PW` alters each time the terminal window is resized.| -|`DYALOG`|This variable is defined in the supplied `mapl` startup script, and is used to form the default values for `APLKEYS`, `APLTRANS`, `WSPATH` etc. If it is necessary to identify the location of the Dyalog executable, then a more reliable method is to determine the full path name from the appropriate file in the `/proc//` subdirectory or from the output of `ps`.| -|`DYALOG_SHELL_SUBPROCESS`|On AIX, if `DYALOG_SHELL_SUBPROCESS` is `1` (the default on AIX), the interpreter starts a (small) child process that handles calls to `⎕SHELL`.| - -These are the remaining variables listed in the *Dyalog for Microsoft Windows Installation and Configuration Guide* which are effective in the non-GUI UNIX versions of Dyalog APL - -Table: Editor-related environment variables - -|---|---| -|Variable|Notes| -|`APLAN_FOR_EDITOR`|Enable or disable use of [array notation](../../../programming-reference-guide/introduction/arrays/array-notation/) for editing arrays| -|`EDITOR_COLUMNS_*`|See [Configuring the Editor](../configuring-the-editor.md). Can be one of `EDITOR_COLUMNS_CHARACTER_ARRAY EDITOR_COLUMNS_CLASS EDITOR_COLUMNS_FUNCTION EDITOR_COLUMNS_NAMESPACE EDITOR_COLUMNS_NUMERIC_ARRAY`| -|`DYALOG_DISCARD_FN_SOURCE`|Specifies whether source code is retained in the workspace| - -Table: Tracer-related environment variables - -|--------------|--------------------------------------------------------------------------------------| -|Variable |Notes | -|`TRACE_ON_ERROR`|With this is set to 1 (the default) the tracer is opened if an untrapped error occurs.| - -Table: Ride-related environment variables - -|---------|----------------------------------------------------------------------------| -|Variable |Notes | -|`RIDE_INIT`|Enables and configures Ride; see the [Ride User Guide](https://dyalog.github.io/ride) for more information.| - -Table: SALT and user commands related environment variables - -|---|---| -|Variable|Notes| -|`SESSION_FILE`|Specifies the location of the file containing `⎕SE` . The default value is `$DYALOG/default.dse`| -|`UCMDCACHEFILE`|Specifies the location of the user command cache file. Defaults to `"UserCommand{UcmdMajor}{UcmdMinor}.{DyalogMajor}{DyalogMinor}{U|C}{bits}.cache"` , for example, `UserCommand25.182U64.cache` in the `dyalog` directory.| - -Further information about SALT and user commands appear in the *User Commands User Guide* and the *SALT User Guide*. +On UNIX and macOS, environment variable names are given in upper case, for example `MAXWS`. diff --git a/windows-installation-and-configuration-guide/docs/apl-command-line.md b/windows-installation-and-configuration-guide/docs/apl-command-line.md index 7dce922b8f2..ef5150b847e 100644 --- a/windows-installation-and-configuration-guide/docs/apl-command-line.md +++ b/windows-installation-and-configuration-guide/docs/apl-command-line.md @@ -17,7 +17,7 @@ Is the location of the Dyalog executable. Usually this is the full pathname, sur **[options]** |---|---| -|-x|Disables the execution of the `⎕LX` expression and the derived expression when code is loaded from a source code file or directory. This applies only at start-up and does not apply to workspaces or source files that are loaded subsequently. See [Latent Expression](../../language-reference-guide/system-functions/lx) and [Load](configuration-parameters/load.md)| +|-x|Disables the execution of the `⎕LX` expression and the derived expression when code is loaded from a source code file or directory. This applies only at start-up and does not apply to workspaces or source files that are loaded subsequently. See [Latent Expression](../../language-reference-guide/system-functions/lx) and [Load](../../dyalog-configuration-guide/configuration-parameters/load)| |-a|Start in USER mode.| |-b|Suppress the banner in the Session..| |-s|Disable the Session. This option is ignored in Windows versions.| @@ -41,10 +41,10 @@ The name of a Dyalog APL workspace to be loaded. Unless specified, on Windows th **[param]** -A parameter name followed by an equals sign (`=`) and a value. The parameter name may be one of the standard APL parameters (see [Configuration Parameters](configuration-parameters/configuration-parameters.md) ) or a name and value of your own choosing (see [GetEnvironment](../../object-reference/methodorevents/getenvironment) ) . If the parameter is in a registry sub-folder (see [Registry Sub-Folders](registry-subfolders.md) ), its name must be preceded by the name of the sub-folder, followed by a backslash (`\`) or underscore (`_`). +A parameter name followed by an equals sign (`=`) and a value. The parameter name may be one of the standard APL parameters (see [Configuration Parameters](../../dyalog-configuration-guide/configuration-parameters/configuration-parameters) ) or a name and value of your own choosing (see [GetEnvironment](../../object-reference/methodorevents/getenvironment) ) . If the parameter is in a registry sub-folder (see [Registry Sub-Folders](registry-subfolders.md) ), its name must be preceded by the name of the sub-folder, followed by a backslash (`\`) or underscore (`_`). !!! note - Instead of a loading a workspace specified by the **ws** option, APL can be instructed to load a program from a script file. For further information, see [Load](configuration-parameters/load.md). + Instead of a loading a workspace specified by the **ws** option, APL can be instructed to load a program from a script file. For further information, see [Load](../../dyalog-configuration-guide/configuration-parameters/load).

Examples

diff --git a/windows-installation-and-configuration-guide/docs/configuration-files.md b/windows-installation-and-configuration-guide/docs/configuration-files.md index 2c0103246ba..051d23d5dea 100644 --- a/windows-installation-and-configuration-guide/docs/configuration-files.md +++ b/windows-installation-and-configuration-guide/docs/configuration-files.md @@ -1,151 +1,12 @@ # Configuration Files -## Introduction +A configuration file is an optional text file, in JSON5 syntax, that holds configuration parameters and their values. Configuration files are portable across all platforms that Dyalog supports. -A configuration file is an optional text file containing configuration parameters and their values. It may cascade, that is, it can extend (inherit) configuration values from other configuration files, and supplement and/or override them. +Configuration files, their structure, and how they combine with the other ways of setting configuration parameters are documented, for all platforms, in the Dyalog Configuration Guide: -Configuration files use JSON5 (a superset of standard JSON) syntax, as described below. These files are portable across all systems supported by Dyalog. +- [Application Configuration Files](../../dyalog-configuration-guide/how-to-set/application-configuration-files) +- [User Configuration Files](../../dyalog-configuration-guide/how-to-set/user-configuration-files) +- [Configuration File Structure](../../dyalog-configuration-guide/how-to-set/configuration-file-structure) +- [Order of Precedence](../../dyalog-configuration-guide/how-to-set/order-of-precedence) -Although it is possible to include user credentials such as login details or passwords in configuration files, Dyalog very strongly recommends against doing this even if the credentials are encrypted as this should be considered to be a very significant security risk. - -**Names of configuration parameters defined in Configuration files may be specified in any combination of alphabetic case.** - -Dyalog processes up to two kinds of configuration file (each of which may cascade): - -1. An application configuration file which contains configuration values associated with a specific application -2. A user configuration file which defines configuration values for the current, and possibly only, user of the system. - -## Application Configuration File - -When Dyalog starts, it derives the name of the application configuration file as follows: - -- The name in the configuration parameter **ConfigFile** if it is set, otherwise -- The name of the workspace or script loaded at start-up using the **Load** parameter, with the extension replaced by `.dcfg`, if that file exists, otherwise -- Nothing. - -## User Configuration File - -The name of the user configuration file is specified by the **UserConfigFile** parameter. Under Windows, this parameter is not set by default but may be defined by the user. - -## Precedence - -Configuration files supplement existing methods of defining parameters. The following precedence table shows the order of precedence when a setting is defined in multiple places: - -- Command-line settings override -- Application configuration file settings, which override -- Environment variable settings, which override -- User configuration file settings, which override -- Settings in the registry (Windows only), which override -- Built-in defaults - -## Configuration Files and The Configuration Dialog - -The Configuration Dialog reflects the values of parameters stored in the Windows Registry and ignores overriding values defined on the command-line, in configuration files or in environment variables. If the user changes parameters using the Configuration Dialog, the new values are recorded in the Registry, but remain overridden by those that take precedence. - -## Configuration File Structure - -Configuration files define configuration parameters using JSON5. A JSON object contains data in the form of key/value pairs and other JSON objects. The keys are strings and the values are the JSON types. Keys and values are separated by colon. Each entry (key/value pair) is separated by comma. - -The top-level object defines an optional key named **Extend** and an optional object named **Settings**. - -**Extend** is a string value containing the name of a configuration file to import. The extended (imported) file may in turn extend another configuration file. Configuration values from the imported file(s) may be overridden by redefining them. The file name is implicitly relative to the name of the file which imports it. Any file name extension must be explicitly specified. - -**Settings** is an object containing the names of configuration parameters and their values. The values may be: - -- A string -- A number -- An array of strings - -The names and values correspond to configuration parameters, but names are not case sensitive. Any named values may be defined; an APL application may query the values using `+2⎕NQ'.' 'GetEnvironment' name`, or using the `]Config` user command. Note that `GetEnvironment` returns the value in use as defined by the precedence rules (see **Precedence above**). - -

Example

-```apl - +2 ⎕NQ '.' 'GetEnvironment' ('MaxWS' 'Captions\Session') -┌────┬───────────────────────┐ -│256M│My Dyalog V18.0 Session│ -└────┴───────────────────────┘ - ]Config MaxWS Captions\Session -┌────────────────┬───────────────────────┐ -│MaxWS │256M │ -├────────────────┼───────────────────────┤ -│Captions\Session│My Dyalog V18.0 Session│ -└────────────────┴───────────────────────┘ - -``` - -A warning will be given if names are redefined in the same configuration file; the second and subsequent definitions will be discarded. - -## File Names - -Pathnames specified in configuration files should be specified using portable forward slashes "/" rather than back-slashes "\" as the latter are used as escape characters by JSON. - -`WSPATH: ["c:/Dyalog18.0"]` or `WSPATH: ["c:\\Dyalog18.0"]` specifies the file `c:\Dyalog18.0`. - -whereas, - -`WSPATH: ["c:\Dyalog18.0"]` means `c:Dyalog18.0`. - -

Example

-```apl -{ - Extend: "my_default_configuration.dcfg", - - Settings: { - // maximum workspace - MAXWS: "2GB", - WSPATH: ["/dir1", "/dir2", ""], - UserOption: 123, - ROOTDIR: "/my/root/directory", - // references to other configuration parameters - FNAME: "[rootdir]/filename", - } -} -``` - -## Arrays - -An array may be used to define file paths etc. For example, -```apl -WSPATH: ["/dir1", "/dir2"] -``` - -The only parameters which may be defined as arrays are **WSPATH**, **WSEXT** and **CFEXT**. - -#### References to other Configuration Parameters - -Configuration parameters which are string values may include references to other configuration parameters (regardless of where they are defined) using square bracket delimiters. For example: -```apl -MySetting: "[DYALOG]/MyFile" -``` - -will replace `[DYALOG`] with the value of the **DYALOG** configuration value. - -If the string inside the `[]` delimiters is "`.`", the "`.`" is replaced is replaced with the path of the directory containing the configuration file itself. Therefore, -```apl -FILENAME: "[.]/x.txt" -``` - -will set the parameter **FILENAME** to a value which is a reference to a file called `x.txt` in the same directory as the configuration file defining it. - -Note that: - -- If the referenced configuration parameter is not defined then no substitution will take place; the reference, including square bracket delimiters, will remain in place. -- To include square brackets in a string, prefix the '[' with a '\' character. - -#### Nested Structures - -Some parameters are stored in sub-folders in the Windows Registry. Currently, all such parameters used by Dyalog APL itself relate to the Windows IDE, but you can create your own application-specific structures.. - -The Configuration file supports this structure by defining an object that corresponds to a Registry sub-folder. For example: -```apl -Captions: { - Session: "My Dyalog Session", - Status: "My Status window", -} -``` - -```apl - +2 ⎕NQ '.' 'GetEnvironment' 'Captions\Session' -My Dyalog Session - -``` +On Microsoft Windows, configuration parameters can also be held in the [Windows Registry](../../dyalog-configuration-guide/how-to-set/registry), which the Configuration Dialog reads and writes. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/addclassheaders.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/addclassheaders.md deleted file mode 100644 index e6ae2c21246..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/addclassheaders.md +++ /dev/null @@ -1,5 +0,0 @@ -# AddClassHeaders - -This parameter specifies what the Tracer displays when tracing the execution of a function in a script. If set to 1, the Tracer displays just the first line of the script and the function in question. If set to 0, the entire script is shown in the Tracer window. - -See also [Limit tracer display to current function in script](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md) diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-code-e-magnitude.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-code-e-magnitude.md deleted file mode 100644 index 6387c045c41..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-code-e-magnitude.md +++ /dev/null @@ -1,17 +0,0 @@ -# APL_CODE_E_MAGNITUDE - -The introduction of decimal floating point numbers lead to the maximum allowable print precision being increased from 17 to 34, which resulted in a change in the way numbers in the range `(10*17) to (10*34)` in function bodies are descanned[^1]. For example, the number one sextillion (1021) in a function is descanned by Version 12.1 as `1E21` and by Version 13.0 as `1000000000000000000000`. - -Whilst this change has no other deleterious effect, it means that code that contains such numbers is harder to read, and the result of `⎕CR` (and other character representations) of the same function may have changed between Version 12.1 and later versions of Dyalog causing undesired affects in code management systems. - -The **APL_CODE_E_MAGNITUDE** parameter allows the user to choose between the behaviour seen in Version 12.1 and earlier and in more recent behaviour. It also allows the user to specify the size of numbers above which those numbers are display in exponential format. - -If the **APL_CODE_E_MAGNITUDE** parameter is undefined or set to 0 (the default), numbers are descanned and displayed as normal. - -If **APL_CODE_E_MAGNITUDE** has the value -1, numbers greater than or equal to 1017 will be displayed using exponential format, as in Version 12.1. - -If **APL_CODE_E_MAGNITUDE** has a value between 2 and 34, numbers greater than or equal to 10value will be displayed using exponential format. - -The effect of setting this parameter to any other value is undefined. - -[^1]: Descanning refers to the internal process used to convert the internal representation of APL code into a character array. For numbers in function statements, this process uses the maximum value of Print Precision. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-complex-as-v12.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-complex-as-v12.md deleted file mode 100644 index 3b0b46a77c4..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-complex-as-v12.md +++ /dev/null @@ -1,13 +0,0 @@ -# APL_COMPLEX_AS_V12 - -Support for Complex Numbers means that some functions produce different results from older Versions of Dyalog APL. If **APL_COMPLEX_AS_V12** is set to 1 the behaviour of code developed using Version 12.1 or earlier will be unchanged; in particular: - -- Power (`*` ) and logarithm (`⍟` ) do not produce Complex Numbers as results from non-complex arguments. -- `⎕VFI` will not honour "J" or "j" as part of a number. -- `¯4○Y` will be evaluated as `(¯1+Y*2)*0.5` , which is positive for negative real arguments. - -If **APL_COMPLEX_AS_V12** is set to any other value or is not set at all then code developed using version 12.1 or earlier may now generate Complex Numbers. - -In addition, if **APL_COMPLEX_AS_V12** is set to 1, objects containing complex numbers cannot be transferred to or from component files, TCP/IP (CONGA), or auxiliary processors and may not be used as an argument to Serialise/Deserialise Array (`220⌶` ). Instead, a `DOMAIN ERROR` will be issued. - -Note that this feature is provided to simplify the transition of older code to currently supported Versions of Dyalog APL. It does not prevent the generation and use of Complex Numbers using newer features (such as explicitly specifying a Complex Number literal), and the intention is that it will be removed in a future release of Dyalog APL. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-fast-fchk.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-fast-fchk.md deleted file mode 100644 index 8a75219994c..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-fast-fchk.md +++ /dev/null @@ -1,15 +0,0 @@ -# APL_FAST_FCHK - -This parameter specifies whether Dyalog APL should optimise `⎕FCHK` by allowing it to reliably determine whether a component file had been properly untied and therefore does not need to be checked (this is overridable using the `⎕FCHK` option force). - -Optimising `⎕FCHK` in this way has a performance impact on `⎕FUNTIE` and it is recommended this optimisation is switched off if your application frequently ties and unties files. - -Note: this only affects component files with journaling enabled. - -The values of the parameter are: - -|---|----------------------------------------------------| -|0 |Do not optimise `⎕FCHK` (optimise `⎕FUNTIE` instead)| -|1 |Optimise `⎕FCHK` | - -The default value of the parameter is 0 on all platforms. On Windows, setting the value 1 has no effect. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-fcreate-props-c.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-fcreate-props-c.md deleted file mode 100644 index d9d3882d21e..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-fcreate-props-c.md +++ /dev/null @@ -1,3 +0,0 @@ -# APL_FCREATE_PROPS_C - -This parameter specifies the default checksum level for newly-created component files. If unspecified, the default checksum level is 1. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-fcreate-props-j.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-fcreate-props-j.md deleted file mode 100644 index 9e5fba6ae35..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-fcreate-props-j.md +++ /dev/null @@ -1,3 +0,0 @@ -# APL_FCREATE_PROPS_J - -This parameter specifies the default journaling level for newly-created component files. If unspecified, the default journaling level is 1. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-max-threads.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-max-threads.md deleted file mode 100644 index 6c9aa4a018a..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-max-threads.md +++ /dev/null @@ -1,3 +0,0 @@ -# APL_MAX_THREADS - -Specifies the maximum number of system threads that are to be used for parallel execution. The default is 1 and the maximum value is 64. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-textinaplcore.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-textinaplcore.md deleted file mode 100644 index f42ffa6d104..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/apl-textinaplcore.md +++ /dev/null @@ -1,3 +0,0 @@ -# APL_TextInAplCore - -This Boolean parameter specifies whether or not certain information is written to an *aplcore* file when a [system error](../../../programming-reference-guide/error-messages/system-errors) occurs. The default is 1. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplan-for-editor.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/aplan-for-editor.md deleted file mode 100644 index f09c5b913fb..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplan-for-editor.md +++ /dev/null @@ -1,11 +0,0 @@ -# APLAN_FOR_EDITOR - -This parameter specifies whether (`1`) or not (`0`, the default) new **Edit** windows containing arrays should open using [array notation](../../../programming-reference-guide/introduction/arrays/array-notation/) when possible. - -When this parameter is `1`, [`⎕PP`](../../../language-reference-guide/system-functions/pp) does not apply to numbers shown in the Editor. - -The setting can be toggled with the `]APLAN.Editor` user command. - -In Ride and the Microsoft Windows IDE, once an **Edit** window is open, its mode can be toggled by clicking the ![](../img/object_arraynotation.png){width=20 height=20 vertical-align:text-bottom} icon in the Editor's toolbar. - -See also: [APLAN_FOR_OUTPUT](../aplan-for-output). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplan-for-output.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/aplan-for-output.md deleted file mode 100644 index 7c5c83566af..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplan-for-output.md +++ /dev/null @@ -1,11 +0,0 @@ -# APLAN_FOR_OUTPUT - -This parameter specifies whether (`1`) or not (`0`, the default) to use [array notation](../../../programming-reference-guide/introduction/arrays/array-notation/) for session output when possible. - -When this parameter is `1`, [`⎕PP`](../../../language-reference-guide/system-functions/pp) does not apply to numeric session output. - -The setting can be toggled with the `]APLAN.Output` user command - -In the Microsoft Windows IDE, the setting can also be toggled by clicking the ![](../img/session_arraynotation.png){width=20 height=20 vertical-align:text-bottom} icon in the session toolbar. - -See also: [APLAN_FOR_EDITOR](../aplan-for-editor). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplcorename.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/aplcorename.md deleted file mode 100644 index 4757b359a31..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplcorename.md +++ /dev/null @@ -1,7 +0,0 @@ -# AplCoreName - -This parameter specifies the directory and name of the file in which *aplcore* should be saved. The optional wild-card character (`*`) is replaced by a number when the file is written. If there is more than one `*` in **AplCoreName**, the string is used as is; no substitution is made. For more details, including how to prevent aplcore files from being generated, see [MaxAplCores](maxaplcores.md). - -Note that APL terminates with an exit code of 3 when an aplcore file is generated. - -See also [aplcore Parameters](../../../language-reference-guide/primitive-operators/i-beam/aplcore-parameters). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplk.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/aplk.md deleted file mode 100644 index 867ca693164..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplk.md +++ /dev/null @@ -1,7 +0,0 @@ -# APLK - -**Classic Edition only.** - -This parameter specifies the name of your Input Translate Table, which defines your keyboard layout. The keyboard combo in the *Configure* dialog box displays all the files with the .DIN extension in the directory specified by the **APLKEYS** parameter. You may choose any one of the supplied tables, and you may add your own to the directory. Note that the FILE.DIN table is intended for input from **file** , and should not normally be chosen as a keyboard table. - -See also [Input table file](../configuring-the-ide/configuration-dialog/configuration-dialog-input-tab-classic-edition-only.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplkeys.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/aplkeys.md deleted file mode 100644 index d43a0950c17..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplkeys.md +++ /dev/null @@ -1,7 +0,0 @@ -# APLKeys - -**Classic Edition only.** - -This parameter specifies a search path for the Input Translate Table and is useful for configuring a run-time application. The directory paths are specified using Operating System specific conventions and separated by ";" (Windows) or ":" (UNIX). Its default value is the `aplkeys` sub-directory of the directory in which Dyalog APL/W is installed (defined by **Dyalog** ). - -See also [Input table search path](../configuring-the-ide/configuration-dialog/configuration-dialog-input-tab-classic-edition-only.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplnid.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/aplnid.md deleted file mode 100644 index 5dae14b6e55..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplnid.md +++ /dev/null @@ -1,7 +0,0 @@ -# aplnid - -Under Windows, this parameter specifies the *user number* that is used by the component file system to control file sharing and security. If you wish to share component files and/or external variables in a network it is essential that each user has a unique **aplnid** parameter. It may be any integer in the range 0 to 65535. Note that an **aplnid** value of 0 causes the user to bypass APL's access control matrix mechanism. - -Under UNIX, the *user number* is obtained from the Operating System (UID) and **aplnid** is not used. If the user is "root", APL's access control mechanism is ignored. - -When a user creates a component file, his *user number* is recorded in the file to identify him as its owner. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplt.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/aplt.md deleted file mode 100644 index 8f7654a4199..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/aplt.md +++ /dev/null @@ -1,5 +0,0 @@ -# APLT - -This parameter specifies the name of the Output Translate Table. On Windows the default is WIN.DOT and there is rarely a need to alter it. - -See also [Output table file](../configuring-the-ide/configuration-dialog/configuration-dialog-output-tab-classic-edition-only.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/apltrans.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/apltrans.md deleted file mode 100644 index 06747069f17..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/apltrans.md +++ /dev/null @@ -1,5 +0,0 @@ -# APLTrans - -This parameter specifies a search path for the Output Translate Table and is useful for configuring a run-time application. The directory paths are specified using Operating System specific conventions and separated by ";" (Windows) or ":" (UNIX). Its default value is the sub-directory `apltrans` in the directory in which Dyalog APL/W is installed. - -See also [Output table search path](../configuring-the-ide/configuration-dialog/configuration-dialog-output-tab-classic-edition-only.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/auto-pw.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/auto-pw.md deleted file mode 100644 index 3c155e69573..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/auto-pw.md +++ /dev/null @@ -1,5 +0,0 @@ -# Auto_PW - -This parameter specifies whether or not the value of `⎕PW` is derived automatically from the current width of the Session Window. If **Auto_PW** is 1, the value of `⎕PW` changes whenever the Session Window is resized and reflects the number of characters that can be displayed on a single line. If **Auto_PW** is 0 (the default under Windows) `⎕PW` is independent of the Session Window size. - -See also [Auto PW](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey1.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey1.md deleted file mode 100644 index a10932b3a60..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey1.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/CancelKey1 - -Specifies the first of two possible keys that may be used to cancel (hide) the Auto Cancel suggestion box. - -See also [Cancel Key](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey2.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey2.md deleted file mode 100644 index f5b40b87d13..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/cancelkey2.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/CancelKey2 - -Specifies the second of two possible keys that may be used to cancel (hide) the Auto Cancel suggestion box. - -See also [Cancel Key](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/cols.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/cols.md deleted file mode 100644 index 7fbc1054da8..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/cols.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/Cols - -This parameter specifies the maximum number of columns (width) in the Auto Complete pop-up suggestions box. - -See also [Show up to](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/commonkey1.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/commonkey1.md deleted file mode 100644 index 4247ca75fe2..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/commonkey1.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/CommonKey1 - -Specifies the key that will auto-complete the *common prefix*. This is defined to be the longest string of leading characters in the currently selected name that is shared by at least one other name in the Auto Complete suggestion box. - -See also [Common Key](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/completekey1.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/completekey1.md deleted file mode 100644 index 5dd2b6572c2..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/completekey1.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/CompleteKey1 - -Specifies the first of two possible keys that may be used to select the current option from the Auto Complete suggestion box. - -See also [OK Key](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/completekey2.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/completekey2.md deleted file mode 100644 index fb4c8d2bb07..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/completekey2.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/CompleteKey2 - -Specifies the second of two possible keys that may be used to select the current option from the Auto Complete suggestion box. - -See also [OK Key](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/enabled.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/enabled.md deleted file mode 100644 index 28ed760d65c..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/enabled.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/Enabled - -This parameter specifies whether or not Auto Completion is enabled - -See also [Use Auto Complete](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/history.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/history.md deleted file mode 100644 index ebbfde9408b..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/history.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/History - -Specifies whether or not Auto Complete maintains a list of previous Auto Completions. - -See also [Keep History](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/historysize.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/historysize.md deleted file mode 100644 index 124aef6d2dc..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/historysize.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/HistorySize - -Specifies the number of previous Auto Completions that are maintained when History is 1. See [History](history.md). - -See also [History Length](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/prefixsize.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/prefixsize.md deleted file mode 100644 index d478b046f80..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/prefixsize.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/PrefixSize - -This parameter specifies the threshold (number of characters) before Auto Completeion displays suggestions. - -See also [Make suggestions after](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/rows.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/rows.md deleted file mode 100644 index 9406d47f845..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/rows.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/Rows - -This parameter specifies the maximum number of rows (height) in the Auto Complete pop-up suggestions box. - -See also [Suggest up to](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/showfiles.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/showfiles.md deleted file mode 100644 index 29f36839856..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autocomplete/showfiles.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoComplete/ShowFiles - -Specifies whether or not Auto Completion suggests directory and file names for `)LOAD`, `)COPY` and `)DROP` system commands. - -See also [Include filenames](../../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autodpi.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autodpi.md deleted file mode 100644 index 55bc35bd381..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autodpi.md +++ /dev/null @@ -1,3 +0,0 @@ -# AutoDPI - -This parameter determines whether or not the Dyalog program registers the application as DPI-Aware when it initialises. If 1, (the default), Dyalog performs the auto-scaling; if 0, scaling is the responsibility of the programmer or operating system. See also [Enable DPI Scaling of the interpreter and development environment](../configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autoformat.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autoformat.md deleted file mode 100644 index a0510fac45c..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autoformat.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoFormat - -This parameter specifies whether or not you want automatic formatting of Control Structures in functions. The default value is 1 which means that formatting is done automatically for you when a function is opened for editing or converted to text by `⎕CR`, `⎕NR` and `⎕VR`. Automatic formatting first discards all leading spaces in the function body. It then prefixes all lines with a single space except those beginning with a label or a comment symbol (this has the effect of making labels and comments stand out). The third step is to indent Control Structures. The size of the indent depends upon the **TabStops** parameter. To turn off automatic formatting, set **AutoFormat** to 0. - -See also [Autoformat functions](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/autoindent.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/autoindent.md deleted file mode 100644 index 8e50d07e986..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/autoindent.md +++ /dev/null @@ -1,5 +0,0 @@ -# AutoIndent - -This parameter specifies whether or not you want semi-automatic indenting during editing. The default value is 1. This means that when you enter a new line in a function, it is automatically indented by the same amount as the previous line. This option simplifies the entry of indented Control Structures. - -See also [Autoindent](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/cfext.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/cfext.md deleted file mode 100644 index e702abcbf86..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/cfext.md +++ /dev/null @@ -1,11 +0,0 @@ -# CFEXT - -This parameter specifies component file filename extensions. - -CFEXT is a string that specifies a colon-separated list of one or more extensions, including any period (".") which separates the extension from its basename. - -If undefined, CFEXT defaults to `.dcf:` on Windows and macOS, and `.dcf:.DCF:` on all other platforms. - -In the Windows case, this means that `'myfile'⎕FTIE 0` will search first for a file named `myfile.dcf` , and then for a file named `myfile` (with no extension). As file names are not case-sensitive under Windows, this will find `myfile.DCF` or `MyFile.Dcf` and so forth. If none are found with this extension, it will load `myfile` , `MyFile` , `MYFILE` etc. - -In the second (non-Windows) case note that `'myfile'⎕FTIE 0` will search first for a file named `myfile` , then `myfile.dcf` , then `myfile.DCF` . diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/classicmode.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/classicmode.md deleted file mode 100644 index 1c0e3d080e4..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/classicmode.md +++ /dev/null @@ -1,7 +0,0 @@ -# ClassicMode - -This parameter specifies whether or not the Session operates in *Dyalog Classic mode* . The default is 0. If this parameter is set to 1, the Editor and Tracer behave in a manner that is consistent with earlier versions of Dyalog APL. - -Note that in this mode, a maximum of 50 Trace windows may be displayed. - -See also [Classic Dyalog mode](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/classicmodesaveposition.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/classicmodesaveposition.md deleted file mode 100644 index 9c280156b00..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/classicmodesaveposition.md +++ /dev/null @@ -1,8 +0,0 @@ -# ClassicModeSavePosition - -This parameter specifies whether or not the current size and location of the first of the editor and tracer windows are remembered for next time. - This applies only if **ClassicMode** is 1. See [ ClassicMode](./classicmode.md). - -The size and location of the windows are saved in the registry in the subfolder WindowRects/EditWindow and TraceWindow. - -See also [Remember previous window position](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/cmd-prefix-and-cmd-postfix.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/cmd-prefix-and-cmd-postfix.md deleted file mode 100644 index 4fb67a58c0c..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/cmd-prefix-and-cmd-postfix.md +++ /dev/null @@ -1,5 +0,0 @@ -# CMD_PREFIX and CMD_POSTFIX - -These parameters defines strings within which operating system commands specified as the arguments to `⎕CMD` and `⎕SH` , and `)CMD` and `)SH` , are wrapped. Its purpose is to run the command arguments under a non-standard command shell. This applies to Windows only. - -See [Windows Command](../../../language-reference-guide/system-functions/cmd) for implementation details. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/configfile.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/configfile.md deleted file mode 100644 index b744f192cee..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/configfile.md +++ /dev/null @@ -1,3 +0,0 @@ -# ConfigFile - -This parameter specifies the name of the Application Configuration file. See [Configuration Files](../configuration-files.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/configuration-parameters.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/configuration-parameters.md deleted file mode 100644 index 06fd7dede0f..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/configuration-parameters.md +++ /dev/null @@ -1,41 +0,0 @@ -# Configuration Parameters - -## Introduction - -Dyalog APL is customised using a set of **configuration parameters**. These may be defined in a number of ways, which take precedence as follows: - -- Command-line settings -- Application configuration file settings -- Environment variable settings -- User configuration file settings -- Settings in the registry section defined by the **IniFile** parameter (Windows only) -- Built-in defaults - -This scheme provides a great deal of flexibility, and a system whereby you can override one setting with another. For example, you can define your normal workspace size (*maxws*) in the Registry, but override it with a new value specified on the APL command line. The way this is done is described in the following section. - -Furthermore, you are not limited to the set of parameters employed by APL itself as you may add parameters of your own choosing. - -Although for clarity parameter names are given here in mixed case, they are case-independent under Windows. Under UNIX and Linux, if Dyalog parameters are specified as environment variables they must be named entirely in upper-case. - -Note that the value of a parameter obtained by the GetEnvironment method (see [GetEnvironment](../../../object-reference/methodorevents/getenvironment)) uses exactly the same set of rules. - -The following section details those parameters that are implemented by Registry Values in the top-level folder identified by **IniFile**. Values that are implemented in sub-folders are *mainly* internal and are not described in detail here. However, any Value that is maintained via a configuration dialog box will be named and described in the documentation for that dialog box in The APL Environment. - -## Specifying Size-related Parameters - -Several of the configuration parameters define sizes. - -The value of the parameter must consist of an integer value, optionally followed immediately by a single character which denotes the units to be used. If the value contains no character the units are assumed to be KiB. - -Valid values for units are: - -K(KiB), M(MiB), G(GiB), T(TiB), P(PiB) and E(EiB). - -Specifying an invalid value will prevent Dyalog APL from starting. - -## Changing parameter values in the Registry - -You can change parameters in the Registry in one of two ways: - -- Using the Configuration dialog box that is obtained by selecting *Configure* from the *Options* menu on the Dyalog APL/W session. See ["The Configuration Dialog Box"](../configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md) for details. -- By directly editing the Windows Registry using `REGEDIT.EXE` or `REGEDIT32.EXE`. This is necessary for parameters that are not editable via the Configuration dialog box. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-abort.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-abort.md deleted file mode 100644 index 1d5aa3a0b33..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-abort.md +++ /dev/null @@ -1,5 +0,0 @@ -# Confirm_Abort - -This parameter specifies whether or not you will be prompted for confirmation when you attempt to abort an edit session after making changes to the object being edited. Its value is either 1 (confirmation is required) or 0. The default is 0. - -See also [Confirm edit window close on Abort](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-close.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-close.md deleted file mode 100644 index 45131cec426..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-close.md +++ /dev/null @@ -1,5 +0,0 @@ -# Confirm_Close - -This parameter specifies whether or not you will be prompted for confirmation when you close an edit window after making changes to the object being edited. Its value is either 1 (confirmation is required) or 0. The default is 0. - -See also [Confirm edit window close on Close](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-fix.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-fix.md deleted file mode 100644 index 5ccef4df7f8..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-fix.md +++ /dev/null @@ -1,5 +0,0 @@ -# Confirm_Fix - -This parameter specifies whether or not you will be prompted for confirmation when you attempt to fix an object in the workspace after making changes in the editor. Its value is either 1 (confirmation is required) or 0. The default is 0. - -See also [Confirm edit window close on Edit (and Fix)](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-session-delete.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-session-delete.md deleted file mode 100644 index a0f487337fb..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/confirm-session-delete.md +++ /dev/null @@ -1,5 +0,0 @@ -# Confirm_Session_Delete - -This parameter specifies whether or not you will be prompted for confirmation when you attempt to delete lines from the Session Log. Its value is either 1 (confirmation is required) or 0. The default is 1. - -See also [Confirm on Deletion from Session log](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-div.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/default-div.md deleted file mode 100644 index 8cb87b10f51..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-div.md +++ /dev/null @@ -1,5 +0,0 @@ -# Default_DIV - -This parameter specifies the value of `⎕DIV` in a clear workspace. Its default value is 0. - -See also [⎕DIV](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-io.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/default-io.md deleted file mode 100644 index d41e1a01f8b..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-io.md +++ /dev/null @@ -1,5 +0,0 @@ -# Default_IO - -This parameter specifies the value of `⎕IO` in a clear workspace. Its default value is 1. - -See also [⎕IO](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-ml.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/default-ml.md deleted file mode 100644 index 89b4a7a4a17..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-ml.md +++ /dev/null @@ -1,5 +0,0 @@ -# Default_ML - -This parameter specifies the value of `⎕ML` in a clear workspace. Its default value is 1. - -See also [⎕ML](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-pp.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/default-pp.md deleted file mode 100644 index 9f8efe67e61..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-pp.md +++ /dev/null @@ -1,5 +0,0 @@ -# Default_PP - -This parameter specifies the value of `⎕PP` in a clear workspace. Its default value is 10. - -See also [⎕PP](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-pw.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/default-pw.md deleted file mode 100644 index 645cc4b7840..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-pw.md +++ /dev/null @@ -1,3 +0,0 @@ -# Default_PW - -This parameter specifies the value of `⎕PW` in a clear workspace. Note that `⎕PW` is a property of the Session and the value of **Default_PW** is overridden when a Session file is loaded. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-rtl.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/default-rtl.md deleted file mode 100644 index 2e3331b2fb8..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-rtl.md +++ /dev/null @@ -1,5 +0,0 @@ -# Default_RTL - -This parameter specifies the value of `⎕RTL` in a clear workspace. Its default value is 0. - -See also [⎕RTL](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-wx.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/default-wx.md deleted file mode 100644 index 2a26b812839..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/default-wx.md +++ /dev/null @@ -1,5 +0,0 @@ -# Default_WX - -This parameter specifies the value of `⎕WX` in a clear workspace. This in turn determines whether or not the names of properties, methods and events of GUI objects are exposed. If set (`⎕WX` is 1), you may query/set properties and invoke methods directly as if they were variables and functions respectively. As a consequence, these names may not be used for global variables in GUI objects. - -See also [Expose properties of GUI Namespaces](../configuring-the-ide/configuration-dialog/configuration-dialog-object-syntax-tab.md) and [⎕WX](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dmxoutputonerror.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dmxoutputonerror.md deleted file mode 100644 index 79d39683c1c..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dmxoutputonerror.md +++ /dev/null @@ -1,5 +0,0 @@ -# DMXOutputOnError - -This parameter specifies in which windows DMX error messages are displayed. It is an integer whose value is the sum of the specified windows where 1 = Status Window and 2 = Session Window. - -See also [DMX messages should go to](../configuring-the-ide/configuration-dialog/configuration-dialog-help-dmx-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dockableeditwindows.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dockableeditwindows.md deleted file mode 100644 index f78a101fb04..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dockableeditwindows.md +++ /dev/null @@ -1,6 +0,0 @@ -# DockableEditWindows - -This parameter specifies whether or not individual edit windows can be undocked from (and docked back into) the (MDI) Editor window. Its default value is 0. - This applies only if **ClassicMode** is 1. See [ ClassicMode](./classicmode.md). - -See also [Allow floating edit windows](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/doubleclickedit.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/doubleclickedit.md deleted file mode 100644 index c412185207f..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/doubleclickedit.md +++ /dev/null @@ -1,5 +0,0 @@ -# DoubleClickEdit - -This parameter specifies whether or not double-clicking over a name invokes the editor. Its default is 1. If DoubleClickEdit is set to 0, double-clicking selects a word and triple-clicking selects the entire line. - -See also [Double-click to Edit](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-discard-fn-source.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-discard-fn-source.md deleted file mode 100644 index d473cbea0ba..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-discard-fn-source.md +++ /dev/null @@ -1,5 +0,0 @@ -# DYALOG_DISCARD_FN_SOURCE - -This Boolean parameter specifies whether (1) or not (0) source code is discarded from the workspace when an object is fixed. The default value is 0 which means that source code is retained in the workspace and will subsequently be presented for editing as it had been saved previously. - -For further information, see [Discard Source Information](../../../language-reference-guide/primitive-operators/i-beam/discard-source-information) and [Source as Typed](../../../earlier-release-notes/release-notes-v19-0/introduction/source-as-typed). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-eventlogginglevel.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-eventlogginglevel.md deleted file mode 100644 index ce4a8a9c020..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-eventlogginglevel.md +++ /dev/null @@ -1,4 +0,0 @@ -# DYALOG_EVENTLOGGINGLEVEL - -This parameter applies under Windows only, and specifies whether a log entry is written to the Windows Event Log or not when Dyalog APL would pop up a message box due to an unexpected termination of Dyalog APL. See - [Handling Unexpected Application Errors in Windows](../../../programming-reference-guide/error-trapping/handling-unexpected-errors) for more information. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-eventlogname.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-eventlogname.md deleted file mode 100644 index 3c6c854e606..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-eventlogname.md +++ /dev/null @@ -1,4 +0,0 @@ -# DYALOG_EVENTLOGNAME - -This parameter applies under Windows only, and is either the name of the event log to which an event message will be written, or the source of the event message (depending on the registry entries which may or may not have been defined) when Dyalog APL would pop up a message box due to an unexpected termination of Dyalog APL.See - [Handling Unexpected Application Errors in Windows](../../../programming-reference-guide/error-trapping/handling-unexpected-errors) for more information. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-gutter-enable.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-gutter-enable.md deleted file mode 100644 index a262b85f90b..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-gutter-enable.md +++ /dev/null @@ -1,8 +0,0 @@ -# DYALOG_GUTTER_ENABLE - -This Boolean parameter specifies whether (1) or not (0) a Gutter is displayed in the left-most column of the Session window. This gutter is used to display: - -- A small red circle. This indicator is used on every line that is modified in the session, including old ones (for example, if you move up the session and modify them, without pressing ``) . The indicators show which session lines will be re-executed when you subsequently press ``. -- A left bracket `[` to identify groups of [implicit output](../../../programming-reference-guide/introduction/output). Note that other forms of output are not identified in this way. - -The default value is 0 for the TTY interface, and 1 otherwise. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-lineeditor-mode.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-lineeditor-mode.md deleted file mode 100644 index 98bb7ed47a6..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-lineeditor-mode.md +++ /dev/null @@ -1,5 +0,0 @@ -# Dyalog_LineEditor_Mode - -This Boolean parameter specifies whether or not multi-line input is enabled in the Session. - -See also [Multiline Input](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md) and [Multi-line Session Input](../../../windows-ui-guide/multiline-session-input). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-netcore.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-netcore.md deleted file mode 100644 index e00a2f1e7e6..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-netcore.md +++ /dev/null @@ -1,5 +0,0 @@ -# Dyalog_NETCore - -This Boolean parameter specifies whether the .NET interface is enabled. On Windows the default is 0 which disables the .NET interface in favour of the .NET Framework interface. If it is set to 1, Dyalog uses .NET instead of the .NET Framework. - -On other platforms which support .NET, the default is 1. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-nopopups.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-nopopups.md deleted file mode 100644 index d1255543d96..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-nopopups.md +++ /dev/null @@ -1,4 +0,0 @@ -# DYALOG_NOPOPUPS - -This parameter specifies whether a MsgBox will appear (0, the default) or will not (1) when Dyalog APL terminates unexpectedly. This applies to APL on Windows only. See - [Handling Unexpected Application Errors in Windows](../../../programming-reference-guide/error-trapping/handling-unexpected-errors) for more information. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-pixel-type.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-pixel-type.md deleted file mode 100644 index a60cdad1ce8..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog-pixel-type.md +++ /dev/null @@ -1,5 +0,0 @@ -# Dyalog_Pixel_Type - -When the Coord property is set to `'Pixel'` , this parameter specifies how it is interpreted. If the value of **Dyalog_Pixel_Type** is RealPixel or if Dyalog_Pixel_Type is undefined, the object behaves as if Coord was `'RealPixel'` . If the value of **Dyalog_Pixel_Type** is ScaledPixel, the object behaves as if Coord were `'ScaledPixel'`. See [Coord](../../../object-reference/properties/coord). - -See also [Enable DPI scaling of GUI application](../configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog.md deleted file mode 100644 index 8604c3532c1..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalog.md +++ /dev/null @@ -1,3 +0,0 @@ -# Dyalog - -This parameter specifies the name of the directory in which Dyalog APL is installed. If undefined, the name of the directory from which the Dyalog APL program was loaded is assumed. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogemailaddress.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogemailaddress.md deleted file mode 100644 index 87fed966141..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogemailaddress.md +++ /dev/null @@ -1,3 +0,0 @@ -# DyalogEmailAddress - -This parameter specifies the contact email address for Dyalog Limited. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyaloghelpdir.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyaloghelpdir.md deleted file mode 100644 index da64d42fbdc..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyaloghelpdir.md +++ /dev/null @@ -1,6 +0,0 @@ -# DyalogHelpDir - -This parameter specifies identifies the location of the HTML-based help that is used for a request for help (from the Help menu or pressing `F1`) from the Session. It may be: - -- The full pathname of the directory that contains the Dyalog APL help file (`dyalog.chm`). This is the default. -- The index page of the on-line HTML-based help located on `help.dyalog.com` for example, `https://help.dyalog.com/18.0`. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyaloginstalldir.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyaloginstalldir.md deleted file mode 100644 index 1e06c346606..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyaloginstalldir.md +++ /dev/null @@ -1,3 +0,0 @@ -# DyalogInstallDir - -This parameter specifies the full pathname of the directory in which Dyalog APL is installed. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyaloglink.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyaloglink.md deleted file mode 100644 index c1849bf312c..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyaloglink.md +++ /dev/null @@ -1,7 +0,0 @@ -# DyalogLink - -This parameter specifies the name of the directory containing the code for Link. The default is `[DYALOG]/StartupSession/Link`. - -Note that Link is required for Session initialisation. - -For further information, see [https://dyalog.github.io/link/4.0/Usage/Installation](https://dyalog.github.io/link/4.0/Usage/Installation). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogstartup-x.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogstartup-x.md deleted file mode 100644 index ad7e5ad74b5..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogstartup-x.md +++ /dev/null @@ -1,11 +0,0 @@ -# DyalogStartup_X - -During Session initialisation, code is loaded from the directories specified by the **DyalogStartupSE** parameter into a corresponding namespace tree in the Session namespace `⎕SE`. Optionally, the code is then executed. - -If **DyalogStartup_X** is 0 (the default if not defined), the `Run` function (if it exists) in each *top-level* namespace loaded during Session start-up is executed. The namespaces are processed in alphabetical order. - -If **DyalogStartup_X** is 1, the `Run` function is not executed. - -Other values are reserved for future extension. - -See also: [DyalogStartupSE](dyalogstartupse.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogstartup.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogstartup.md deleted file mode 100644 index 80152a20a3c..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogstartup.md +++ /dev/null @@ -1,5 +0,0 @@ -# DyalogStartup - -This parameter specifies the name of a file that contains APL code to be run each time Dyalog starts. If this is undefined, the default file is named `SessionStartup` with the file extension `.aplf`, .`apln` or `.aplc`, in the `Dyalog` directory. - -See also [Introduction](../../../windows-ui-guide/the-session-object/session-initialisation). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogstartupse.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogstartupse.md deleted file mode 100644 index 3e9ab3dec7c..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogstartupse.md +++ /dev/null @@ -1,36 +0,0 @@ -# DyalogStartupSE - -This parameter specifies one or more *Session initialisation* directories that contain APL code to be installed in `⎕SE`. If this parameter is not specified, the default is a directory named `StartupSession` located in three standard locations. - -Under Windows these might be: - -1. `C:\Program Files\Dyalog\Dyalog APL-64 19.0 Unicode` - -2. `C:\Users\Pete\Documents\Dyalog APL Files` - -3. `C:\Users\Pete\Documents\Dyalog APL-64 19.0 Unicode Files` - -The version-specific name is : -```apl - Dyalog APL{bit} {version} {edition} -``` - -where: - -- {bit} is "`-64`" if 64-bit version, otherwise nothing -- {version} is the main and secondary version numbers of dyalog.exe separated by ".". -- {edition} is "`Unicode`" for the Unicode Edition, otherwise nothing - -The parameter is a string containing the list of directory names separated by ";" on Windows, ":" elsewhere. - -If DyalogStartupSE begins with the specified separator, the default list is *extended* rather than *replaced*. - -Note that the effective sequence of directories specified by this parameter is converted to a vector of character vectors and stored in `⎕SE.Dyalog.StartupSession.AllPaths`. - -If unset or extended (that is, starts with a : separator): - -- the effective StartupSession directory in [DYALOG] is available as `⎕SE.Dyalog.StartupSession.Dyalog`. -- the StartupSession directory in the version-agnostic directory is available as `⎕SE.Dyalog.StartupSession.VerAgno`. -- the StartupSession directory in the version-specific directory is available as `⎕SE.Dyalog.StartupSession.VerSpec`. - -See also [Implementation](../../../windows-ui-guide/the-session-object/session-initialisation). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogwebsite.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogwebsite.md deleted file mode 100644 index d9abbc1b856..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/dyalogwebsite.md +++ /dev/null @@ -1,3 +0,0 @@ -# DyalogWebSite - -This parameter specifies the URL for the Dyalog web site. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-cols.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-cols.md deleted file mode 100644 index 0111b3f2b5e..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-cols.md +++ /dev/null @@ -1,5 +0,0 @@ -# Edit_Cols - -This parameter specifies the initial width of an edit window in character units. - -See also [Width](../configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-first-x.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-first-x.md deleted file mode 100644 index 7f6904a08c2..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-first-x.md +++ /dev/null @@ -1,5 +0,0 @@ -# Edit_First_X - -This parameters specify the initial x-position on the screen of the *first* edit window in character units. Subsequent edit windows will be staggered. This parameter only apply if **ClassicMode** is 1. - -See also [X Pos](../configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-first-y.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-first-y.md deleted file mode 100644 index fbc7262c0d1..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-first-y.md +++ /dev/null @@ -1,5 +0,0 @@ -# Edit_First_Y - -This parameters specify the initial y-position on the screen of the *first* edit window in character units. Subsequent edit windows will be staggered. This parameter only apply if **ClassicMode** is 1. - -See also [Y Pos](../configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-offset-x.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-offset-x.md deleted file mode 100644 index 5a27e1a7c79..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-offset-x.md +++ /dev/null @@ -1,5 +0,0 @@ -# Edit_Offset_X - -This parameter specify the number of characters by which an edit window is staggered horizontally from the previous one. - -See also [X Offset](../configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-offset-y.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-offset-y.md deleted file mode 100644 index d49bbfcd45f..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-offset-y.md +++ /dev/null @@ -1,5 +0,0 @@ -# Edit_Offset_Y - -This parameter specify the number of characters by which an edit window is staggered vertically from the previous one. - -See also [Y Offset](../configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-rows.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-rows.md deleted file mode 100644 index 221826629d7..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/edit-rows.md +++ /dev/null @@ -1,5 +0,0 @@ -# Edit_Rows - -This parameter specifies the initial height of an edit window in character units. - -See also [Height](../configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/editorstate.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/editorstate.md deleted file mode 100644 index 910b4521f78..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/editorstate.md +++ /dev/null @@ -1,3 +0,0 @@ -# EditorState - -This is an internal parameter that remembers the state of the last edit window (normal or maximised). This is used to create the next edit window in the appropriate state. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/enable-cef.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/enable-cef.md deleted file mode 100644 index c106006741b..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/enable-cef.md +++ /dev/null @@ -1,10 +0,0 @@ -# Enable_CEF - -This parameter is a Boolean value with a default value of 1. If set to 0, it disables the [Chromium Embedded Framework (CEF).](https://en.wikipedia.org/wiki/Chromium_Embedded_Framework) and an attempt to create an [HTMLRenderer](../../../object-reference/objects/htmlrenderer) object will fail with an error message. - -## Note - -Currently the value of the **Enable_CEF** parameter defined in the Windows Registry or in a -Configuration file is ignored. Only the value set in the command line or as an -environment variable is honoured. If not defined in this way, the default value -is used. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/erroronexternalexception.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/erroronexternalexception.md deleted file mode 100644 index be5081ddf83..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/erroronexternalexception.md +++ /dev/null @@ -1,3 +0,0 @@ -# ErrorOnExternalException - -This parameter specifies the behaviour when a System Exception occurs in an external DLL. If this parameter is set to 1, and an exception occurs in a call on an external DLL. APL generates an `EXTERNAL DLL EXCEPTION` error (91), instead of terminating with a System Error. This error may be trapped. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/externalhelpurl.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/externalhelpurl.md deleted file mode 100644 index 3f9f5b9fe4c..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/externalhelpurl.md +++ /dev/null @@ -1,5 +0,0 @@ -# ExternalHelpURL - -If **UseExternalHelpURL** is 1, Dyalog attempts to use the Microsoft Document Explorer and online help, for example from Visual Studio (if installed), to display help for external objects, such as .Net Types. This parameter specifies the URL to be used. In most cases the default setting will be sufficient. On some configurations it may be necessary to change this. See [ UseExternalHelpURL](useexternalhelpurl.md). - -See also [URL](../configuring-the-ide/configuration-dialog/configuration-dialog-help-dmx-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/file-stack-size.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/file-stack-size.md deleted file mode 100644 index 6958238898a..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/file-stack-size.md +++ /dev/null @@ -1,3 +0,0 @@ -# File_Stack_Size - -This parameter specifies the number of the most recently used workspaces displayed in the Session File menu. See [Recently used file list size](../configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/greet-bitmap.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/greet-bitmap.md deleted file mode 100644 index 47fb933f034..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/greet-bitmap.md +++ /dev/null @@ -1,6 +0,0 @@ -# Greet_Bitmap - -This parameter specifies the filename of a bitmap to be displayed during initialisation of the Dyalog APL application. It is used typically to display a product logo from a runtime application. The bitmap will remain until either an error occurs, or it is removed using the [GreetBitmap](../../../object-reference/methodorevents/greetbitmap) method of the Root object. -```apl -Greet_Bitmap=c:\myapp\logo.bmp -``` diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/history-size.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/history-size.md deleted file mode 100644 index f267ae8dbee..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/history-size.md +++ /dev/null @@ -1,5 +0,0 @@ -# History_Size - -This parameter specifies the size of the buffer used to store previously entered (input) lines in the Session. See [Specifying Size-related Parameters](./configuration-parameters.md) for further details about defining a valid value for this parameter. The maximum value is 2Gb. - -See also [History size](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/inifile.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/inifile.md deleted file mode 100644 index a8d7566ccfc..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/inifile.md +++ /dev/null @@ -1,22 +0,0 @@ -# IniFile - -This parameter specifies the name of the Windows Registry folder that contains the configuration parameters described in this section. For example, -```apl -INIFILE=Software\Dyalog\mysettings -``` - -The default values for **IniFile**, for the 64-bit and 32-bit versions respectively, are: - -## Unicode Edition -```apl - Software\Dyalog\Dyalog APL/W-64 {{ version_majmin }} Unicode - Software\Dyalog\Dyalog APL/W {{ version_majmin }} Unicode -``` - -## Classic Edition -```apl - Software\Dyalog\Dyalog APL/W-64 {{ version_majmin }} - Software\Dyalog\Dyalog APL/W {{ version_majmin }} -``` - -See also [Configuration saved in](../configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/initfullscriptnormal.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/initfullscriptnormal.md deleted file mode 100644 index 83f17b29d88..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/initfullscriptnormal.md +++ /dev/null @@ -1,14 +0,0 @@ -# InitFullScriptNormal - -When using the Editor to edit a script such as a Class or Namespace you can specify whether, when you Fix the script and Exit the Editor, just the functions in the script are re-fixed, or whether the whole script is re-executed, thereby re-initialising any Fields or variables defined within. - -These two actions always appear in the Editor File menu, but you can specify which is associated with the (Esc) key by selecting the appropriate option in the drop-downs labelled: - -- Exit and save changes (EP) in a suspended class or namespace should fix: -- If not suspended fix: - -In both cases, you may select either *Only Functions* or *Everything*. - -The label for the corresponding items on the Editor File menu (see Editor (The File Menu, editing a script)) will change according to which behaviour applies. Note that if you specify a keystroke for in the *Keyboard Shortcuts* tab, this will be associated with the unselected action. - -See also [If not ...](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/initfullscriptsusp.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/initfullscriptsusp.md deleted file mode 100644 index 1a00249a3cc..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/initfullscriptsusp.md +++ /dev/null @@ -1,14 +0,0 @@ -# InitFullScriptSusp - -When using the Editor to edit a script such as a Class or Namespace you can specify whether, when you Fix the script and Exit the Editor, just the functions in the script are re-fixed, or whether the whole script is re-executed, thereby re-initialising any Fields or variables defined within. - -These two actions always appear in the Editor File menu, but you can specify which is associated with the (Esc) key by selecting the appropriate option in the drop-downs labelled: - -- Exit and save changes (EP) in a suspended class or namespace should fix: -- If not suspended fix: - -In both cases, you may select either *Only Functions* or *Everything*. - -The label for the corresponding items on the Editor File menu (see Editor (The File Menu, editing a script)) will change according to which behaviour applies. Note that if you specify a keystroke for in the *Keyboard Shortcuts* tab, this will be associated with the unselected action. - -See also [Exit and fix ...](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/initialkeyboardlayout.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/initialkeyboardlayout.md deleted file mode 100644 index d12494db146..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/initialkeyboardlayout.md +++ /dev/null @@ -1,7 +0,0 @@ -# InitialKeyboardLayout - -**Unicode Edition only.** - -This parameter specifies the name of the keyboard to be selected on startup. When you start an APL session, this layout will automatically be selected as the current keyboard layout if the value of **InitialKeyboardLayoutInUse** is 1. - -See also [Keyboard](../configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutinuse.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutinuse.md deleted file mode 100644 index 73c6070f65b..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutinuse.md +++ /dev/null @@ -1,7 +0,0 @@ -# InitialKeyboardLayoutInUse - -**Unicode Edition only.** - -This Boolean parameter specifies whether or not the keyboard specified by **InitialKeyboardLayout** is selected as the current keyboard layout when you start an APL session. - -See also [Activate selected keyboard](../configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutshowall.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutshowall.md deleted file mode 100644 index 52facf34430..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/initialkeyboardlayoutshowall.md +++ /dev/null @@ -1,7 +0,0 @@ -# InitialKeyboardLayoutShowAll - -**Unicode Edition only.** - -This Boolean parameter specifies whether or not all installed keyboards are listed in the choice of keyboards in the Configuration dialog box (Unicode Input tab). - -See also [Show keyboards for all Languages](../configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/input-size.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/input-size.md deleted file mode 100644 index 8f35d5ca4ae..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/input-size.md +++ /dev/null @@ -1,5 +0,0 @@ -# Input_Size - -This parameter specifies the size of the buffer used to store marked lines (lines awaiting execution) in the Session. See [Specifying Size-related Parameters](./configuration-parameters.md) for further details about defining a valid value for this parameter. - -See also [Input buffer size](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/keyboardinputdelay.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/keyboardinputdelay.md deleted file mode 100644 index d70471d24a8..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/keyboardinputdelay.md +++ /dev/null @@ -1,6 +0,0 @@ -# KeyboardInputDelay - -This parameter specifies the delay (in milliseconds) before the system reacts to a user keystroke by: - -- updating the name of the Current Object in the Session statusbar. See [The Current Object](../../../windows-ui-guide/session-manager). -- offering a list of names for auto-completion. See [ Auto Complete Tab](../configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md) diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/load.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/load.md deleted file mode 100644 index b68002c6a12..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/load.md +++ /dev/null @@ -1,41 +0,0 @@ -# Load - -This parameter is a character string that specifies the name of a workspace, or a directory or text file containing APL source code, to be loaded when Dyalog starts. - -If Load specifies a text file, `2 ⎕FIX` is used to import the file contents and associate that file with each of the objects that have been fixed in the workspace. - -If Load specifies a directory, Link is used to associate the directory with the active workspace and to import the code. - For more information about Link, see [https://dyalog.github.io/link](https://dyalog.github.io/link). - -The **Load** parameter will normally be specified on the command line or in a Configuration file. - -Having loaded the workspace, or fixed the code from the named file or directory, Dyalog executes the expression specified by the `LX` parameter if it is set. See [LX](lx.md). - -If `LX` is not set, Dyalog checks whether or not the **-x** command line option was specified. If so, no further action is taken. See [-x](../apl-command-line.md#command-line). - -Otherwise, Dyalog executes an expression which is derived as follows. - -If the value of Load is a directory, Dyalog will execute the expression: -```apl - Run ,⊂ -``` - -where `` is the value of the **Load** parameter. - -If the value of Load is the name of a file, Dyalog determines whether or not the file is a workspace by its internal signature. - -If the file is a workspace the expression to be executed is specified by its `⎕LX`. See [Latent Expression](../../../language-reference-guide/system-functions/lx). - -Otherwise, if the file extension is `.aplf` `.aplc` or `.apln` the expression is shown in the table below, where `filename` is the file name specified by the **Load** parameter without its extension. - -|File Extension|Type |Expression | -|--------------|---------------------|--------------------| -|`.aplf` |Function source code |`filename 0⍴⊂''` | -|`.aplc` |Class source code |`filename.Run 0⍴⊂''`| -|`.apln` |Namespace source code|`filename.Run 0⍴⊂''`| - -## Notes - -- The **Load** parameter overrides a workspace name specified as the last item on the command line. -- The argument `0⍴⊂''` may change in a future version of Dyalog. -- Nothing is executed when code is loaded from source files that define operators (`.aplo`) or Interfaces (`.apli`). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/localdyalogdir.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/localdyalogdir.md deleted file mode 100644 index ed465a4325f..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/localdyalogdir.md +++ /dev/null @@ -1,3 +0,0 @@ -# localdyalogdir - -This parameter specifies the name of the directory in which Dyalog APL/W is installed on the client, in a client/server installation diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/log-file-inuse.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/log-file-inuse.md deleted file mode 100644 index 7474d460b5e..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/log-file-inuse.md +++ /dev/null @@ -1,5 +0,0 @@ -# Log_File_InUse - -This Boolean parameter specifies whether or not the Session log is saved. The default is 1 meaning that the Session log is saved in a Session log file and loaded the next time a Session is started. If set to 0, the Session log is not saved - -See also [Use log file](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/log-file.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/log-file.md deleted file mode 100644 index 43209765b71..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/log-file.md +++ /dev/null @@ -1,13 +0,0 @@ -# Log_File - -This parameter specifies the path (absolute or relative to the working directory) and name of the Session log file. - -Session log files are not interchangeable between different versions/editions/widths of Dyalog. In addition, starting multiple instances of a Dyalog interpreter with the same log file name will only create a log file for the first instance started. - -This is mitigated by including a __\*__ character in the default Session log’s filename, for example, __log.\*.dlfx__ or __log\*.dlfx__. In this situation, at start-up, Dyalog attempts to open, and then lock, a file in which the __\*__ is replaced with an increasing integer value starting from __000__, for example, __log\*.dlfx__ results in files called __log000.dlfx__, __log001.dlfx__, and so on. If a file cannot be opened and locked, the value is incremented. This means that starting multiple instances of the same interpreter simultaneously will create and open multiple log files with different values. If one or more instances are then closed, starting a new instance will re-open the closed log file for that interpreter that has the lowest value. The process fails, and no log will be created or used, if the value would exceed __999__. - -NOTE: The LogFile property of `⎕SE` reports the name of the log file that is being used. - -The default is __\Dyalog APL- Files\default_\*.dlfx__, for example, __C:\Users\Bob\Documents\Dyalog APL-64 20.0 Unicode Files\default_\*.dlfx__ - -See also [Use log file](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/log-size.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/log-size.md deleted file mode 100644 index 958d9ae6512..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/log-size.md +++ /dev/null @@ -1,5 +0,0 @@ -# Log_Size - -This parameter specifies the size of the Session log buffer. See [Specifying Size-related Parameters](./configuration-parameters.md) for further details about defining a valid value for this parameter. The maximum value is 2Gb. - -See also [Session log size](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/lx.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/lx.md deleted file mode 100644 index fc822255124..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/lx.md +++ /dev/null @@ -1,9 +0,0 @@ -# LX - -This parameter specifies an expression to be executed after Dyalog has started and loaded a workspace or a text file containing APL source code. Also see [ Load](load.md). This expression is run only on Dyalog start-up and overrides the workspace latent expression `⎕LX`. - -The LX parameter applies only to the development version of Dyalog and is ignored in run-time applications. - -The LX parameter is ignored when a workspace is loaded other than at start-up of the Dyalog program. - -The LX parameter applies only to the Unicode edition of Dyalog and is ignored in Classic edition. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/mapchars.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/mapchars.md deleted file mode 100644 index 734ba80d3e6..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/mapchars.md +++ /dev/null @@ -1,17 +0,0 @@ -# mapchars - -**Classic Edition only.** - -In previous versions of Dyalog APL, certain pairs of characters in `⎕AV` were mapped to a single font glyph through the output translate table. For example, the ASCII pipe ¦ and the APL style `|` were both mapped to the APL style `|` . From Version 7.0 onwards, it has been a requirement that the mapping between `⎕AV` and the font is strictly one-to-one (this is a consequence of the new native file system). Originally, the mapping of the ASCII pipe and the APL style, the APL and ASCII quotes, and the ASCII ^ and the APL ^ were hard-coded. The mapping is defined by the **mapchars** parameter. - -**mapchars** is a string containing pairs of hexadecimal values which refer to 0-origin indices in `⎕AV` . The first character in each pair is mapped to the second on output. The default value of **mapchars** is `DB0DEBA7EEC00BE0` which defines the following mappings. - -|From|||To||| -|---|---|---|---|---|---| -|Hex|Decimal|Symbol|Hex|Decimal|Symbol| -|DB|219|`‘`|0D|13|`'`| -|EB|235|`^`|A7|167|`^`| -|EE|238|`⌷`|C0|192|`|`| -|0B|11|`.`|E0|224|`.`| - -To clear all mappings, set `MAPCHARS=0000` . diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/maxaplcores.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/maxaplcores.md deleted file mode 100644 index 8333c486937..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/maxaplcores.md +++ /dev/null @@ -1,11 +0,0 @@ -# MaxAplCores - -This parameter is used in conjunction with the **AplCoreName** parameter to control the maximum number of*aplcore* files that are saved. It applies when the string specified by **AplCoreName** ends with an asterisk (*). If so, when saving an *aplcore* file, Dyalog performs the following steps: - -1. Identifies the highest number ending of those files that match the directory/name pattern specified by **AplCoreName** . If none, assume 0. -2. Increments that number, then saves the *aplcore* in a new file ending with the new number. -3. If necessary, deletes lower-numbered files to retain only the maximum number of files specified by **MaxAplCores** . - -See also: [AplCoreName](aplcorename.md). - -See also [aplcore Parameters](../../../language-reference-guide/primitive-operators/i-beam/aplcore-parameters). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/maxws.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/maxws.md deleted file mode 100644 index a1b49880531..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/maxws.md +++ /dev/null @@ -1,20 +0,0 @@ -# MaxWS - -This parameter determines your workspace size and is the amount of memory allocated to the workspace at APL start-up. See [Specifying Size-related Parameters](./configuration-parameters.md) for further details about defining a valid value for this parameter. - -The default value is 256M (256MiB), with the exception of the Raspberry Pi where the default is 64M. Values less than 4M are ignored, and the maximum value is 15E. - -For example, to get a 4GiB workspace, set: -```apl - MAXWS=4G -``` - -Dyalog APL places no implicit restriction on workspace size, and the virtual memory capability of the underlying operating system allows you to access more memory than you have physically installed. However if you use a workspace that **greatly** exceeds your physical memory you will encounter excessive *paging* and your APL programs will run slowly. You may also cause the system to crash. - -Note that the memory used for the workspace must be *contiguous* . - -32-bit versions of Dyalog APL are typically limited to between 1.3GiB to 1.9GiB under Windows, and 1.9GiB under UNIX. These are operating system limitations imposed on 32-bit processes rather than ones imposed by Dyalog APL, and are affected by the number and size of DLLs/shared libraries that are loaded into the process space. - -64-bit versions of Dyalog APL have no such limitations; Dyalog has used workspaces of 96GiB on various platforms. - -See also [Maximum workspace size](../configuring-the-ide/configuration-dialog/configuration-dialog-workspace-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/overstrikespopup.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/overstrikespopup.md deleted file mode 100644 index 0a961df732e..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/overstrikespopup.md +++ /dev/null @@ -1,5 +0,0 @@ -# OverstrikesPopup - -**Unicode Edition only.** - -This is a Boolean parameter that specifies whether or not the Overstrikes popup is enabled. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/passexceptionstoopsys.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/passexceptionstoopsys.md deleted file mode 100644 index 12c0703db98..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/passexceptionstoopsys.md +++ /dev/null @@ -1,4 +0,0 @@ -# PassExceptionsToOpSys - -This is a Boolean parameter that specifies the default state of the *Pass Exception* check box in the *System Error* dialog box.See - [Handling Unexpected Application Errors in Windows](../../../programming-reference-guide/error-trapping/handling-unexpected-errors) for more information. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/pfkey-size.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/pfkey-size.md deleted file mode 100644 index dceaef136d3..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/pfkey-size.md +++ /dev/null @@ -1,7 +0,0 @@ -# PFKey_Size - -This parameter specifies the size of the buffer that is used to store programmable function key definitions. See [Program Function Key ](../../../language-reference-guide/system-functions/pfkey). - -For further details about defining a valid value for this parameter, see [Specifying Size-related Parameters](./configuration-parameters.md). - -See also [PFKey buffer size](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/programfolder.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/programfolder.md deleted file mode 100644 index e3b393a007d..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/programfolder.md +++ /dev/null @@ -1,3 +0,0 @@ -# ProgramFolder - -This parameter specifies the name of the folder in which the Dyalog APL program icons are installed. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/propertyexposeroot.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/propertyexposeroot.md deleted file mode 100644 index 5ce778576c0..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/propertyexposeroot.md +++ /dev/null @@ -1,5 +0,0 @@ -# PropertyExposeRoot - -Each workspace contains a flag that specifies whether or not the names of Properties, Methods and Events of the Root object are exposed. If set, you may query/set the Properties of Root and invoke the Root Methods directly as if they were variables and functions respectively. As a consequence, these names may not be used for global variables in your workspace. This parameter determines the default value of the flag in a `CLEAR WS`. - -See also [Expose properties of Root](../configuring-the-ide/configuration-dialog/configuration-dialog-object-syntax-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/propertyexposese.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/propertyexposese.md deleted file mode 100644 index 0be291cb29e..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/propertyexposese.md +++ /dev/null @@ -1,5 +0,0 @@ -# PropertyExposeSE - -Each workspace contains a flag that specifies whether or the names of Properties, Methods and Events of the Session object are exposed. If set, you may query/set the Properties of `⎕SE` and invoke `⎕SE` Methods directly as if they were variables and functions respectively. As a consequence, these names may not be used for global variables in the `⎕SE` namespace. This parameter determines the default value of the flag in a `CLEAR WS`. - -See also [Expose properties of Session Namespace](../configuring-the-ide/configuration-dialog/configuration-dialog-object-syntax-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/qcmd-timeout.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/qcmd-timeout.md deleted file mode 100644 index 230784417e4..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/qcmd-timeout.md +++ /dev/null @@ -1,3 +0,0 @@ -# qcmd_timeout - -This parameter specifies the length of time in milliseconds that APL will wait for the execution of a Windows command to start. Its default value is 5000 milliseconds. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/resolveoverstrikes.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/resolveoverstrikes.md deleted file mode 100644 index 35701094537..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/resolveoverstrikes.md +++ /dev/null @@ -1,5 +0,0 @@ -# ResolveOverstrikes - -**Unicode Edition only.** - -Specifies whether or not the user may enter an APL composite symbol using overstrikes. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/ride-spawned.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/ride-spawned.md deleted file mode 100644 index 09037975249..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/ride-spawned.md +++ /dev/null @@ -1,3 +0,0 @@ -# Ride_Spawned - -If non-zero, this parameter disables `⎕SR` and `)SH` which instead generate `DOMAIN ERROR`. This parameter is used to prevent certain user-interfaces from being executed from a Ride session which does not support them, and which would otherwise cause the Ride session to become unresponsive. See [Ride User Guide](https://dyalog.github.io/ride). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/runasservice.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/runasservice.md deleted file mode 100644 index 01c33fcb51e..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/runasservice.md +++ /dev/null @@ -1,3 +0,0 @@ -# RunAsService - -When RunAsService is set to 1 or 2 (the default is 0) Dyalog APL will not prompt for confirmation when the user logs off, and the interpreter will continue to run across the logoff /logon process. The value 2 reduces the resources used by a Dyalog service by disabling the graphical user-interface features. In this mode, `⎕WC object` will fail with a `LIMIT ERROR` unles the object is Timer, which is the only one that remains enabled. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/savecontinueonexit.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/savecontinueonexit.md deleted file mode 100644 index 4c7279c3249..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/savecontinueonexit.md +++ /dev/null @@ -1,3 +0,0 @@ -# SaveContinueOnExit - -Specifies whether or not your current workspace is saved as `CONTINUE.DWS` before APL terminates. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/savelogonexit.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/savelogonexit.md deleted file mode 100644 index b9263f65286..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/savelogonexit.md +++ /dev/null @@ -1,3 +0,0 @@ -# SaveLogOnExit - -Specifies whether or not your Session log is saved before APL terminates. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/savesessiononexit.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/savesessiononexit.md deleted file mode 100644 index 8aeaaa475cb..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/savesessiononexit.md +++ /dev/null @@ -1,3 +0,0 @@ -# SaveSessionOnExit - -Specifies whether or not your current Session is saved in your Session file before APL terminates. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/serial.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/serial.md deleted file mode 100644 index 92870c67072..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/serial.md +++ /dev/null @@ -1,3 +0,0 @@ -# Serial - -Legacy: Specifies your Dyalog APL/W Serial Number. See[ DYALOG_SERIAL](dyalog-serial.md) which supercedes it.. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/session-file.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/session-file.md deleted file mode 100644 index 3ea7ee7d121..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/session-file.md +++ /dev/null @@ -1,5 +0,0 @@ -# Session_File - -This parameter specifies the name of the file from which the APL session (`⎕SE` ) is to be loaded when APL starts. If not specified, a .dse extension is assumed. This session file contains the `⎕SE` object that was last saved in it. This object defines the appearance and behaviour of the Session menu bar, tool bar(s) and status bar, together with any functions and variables stored in the `⎕SE` namespace. - -See also [Session file](../configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/sessionontop.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/sessionontop.md deleted file mode 100644 index 9b914013101..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/sessionontop.md +++ /dev/null @@ -1,6 +0,0 @@ -# SessionOnTop - -Specifies whether or not the Session may appear on top of Edit and Trace Windows in Classic Dyalog mode. - This applies only if **ClassicMode** is 1. See [ ClassicMode](./classicmode.md). - -See also [Allow session above edit windows](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/showstatusonerror.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/showstatusonerror.md deleted file mode 100644 index de9644dce54..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/showstatusonerror.md +++ /dev/null @@ -1,3 +0,0 @@ -# ShowStatusOnError - -Specifies whether or not the Status window is automatically displayed (if required) when APL attempts to write output to it. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/singletrace.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/singletrace.md deleted file mode 100644 index a6cfc859a2b..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/singletrace.md +++ /dev/null @@ -1,6 +0,0 @@ -# SingleTrace - -Specifies whether there is a single Trace window, or one Trace window per function. - This applies only if **ClassicMode** is 1. See [ ClassicMode](./classicmode.md). - -See also [Single trace window](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/skiplines.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/skiplines.md deleted file mode 100644 index d72bbb2e8dc..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/skiplines.md +++ /dev/null @@ -1,8 +0,0 @@ -# SkipLines - -This parameter causes the Tracer to automatically skip lines that contain no executable statement, with the exception of the first line in the function, and in the case of a traditional function (not a dfn), the last line if it is a comment. SkipLines is an integer made up of the sum of the following values: - -|---|----------------------------------------------------------------------------------------------------------------------------------------------------| -|1 |Skip blank lines. See also [Skip blank lines when tracing](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md) . | -|2 |Skip comment lines. See also [Skip comment lines when tracing](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md) .| -|4 |Skip locals lines. See also [Skip locals lines when tracing](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md) . | diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/sm-cols.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/sm-cols.md deleted file mode 100644 index c0f5b424209..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/sm-cols.md +++ /dev/null @@ -1,3 +0,0 @@ -# SM_Cols - -This parameter specifies the width in characters of the window used to display `⎕SM` when it is used *stand-alone* . It is **not** used if the window is specified using the SM object. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/sm-rows.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/sm-rows.md deleted file mode 100644 index 65e6a99f39a..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/sm-rows.md +++ /dev/null @@ -1,3 +0,0 @@ -# SM_Rows - -This parameter specifies the height in characters of the window used to display `⎕SM` when it is used *stand-alone* . It is **not** used if the window is specified using the SM object. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/statusonedit.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/statusonedit.md deleted file mode 100644 index 377b1b2e831..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/statusonedit.md +++ /dev/null @@ -1,5 +0,0 @@ -# StatusOnEdit - -Specifies whether or not a status bar is displayed at the bottom of an Edit window. - -See also [Show status bars](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/tabstops.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/tabstops.md deleted file mode 100644 index a09b16bd3be..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/tabstops.md +++ /dev/null @@ -1,5 +0,0 @@ -# TabStops - -This parameter specifies the number of spaces inserted by pressing the Tab key in the editor. Its default value is 4. - -See also [Tab stops every ](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md) diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/toolbarsonedit.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/toolbarsonedit.md deleted file mode 100644 index 60a3f855305..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/toolbarsonedit.md +++ /dev/null @@ -1,5 +0,0 @@ -# ToolBarsOnEdit - -Specifies whether or not tool bars are displayed along the top of individual Edit windows. - -See also [Show tool bars](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-first-x.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-first-x.md deleted file mode 100644 index f0dfa66c53a..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-first-x.md +++ /dev/null @@ -1,5 +0,0 @@ -# Trace_First_X - -This parameters specifies the initial horizontal position on the screen of the *first* trace window in character units. Subsequent trace windows will be staggered. This applies only if **ClassicMode** is 1. - -See also [Y Pos](../configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-first-y.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-first-y.md deleted file mode 100644 index da0ecc3f7fc..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-first-y.md +++ /dev/null @@ -1,5 +0,0 @@ -# Trace_First_Y - -This parameters specifies the initial vertical position on the screen of the *first* trace window in character units. Subsequent trace windows will be staggered. This applies only if **ClassicMode** is 1. - -See also [Y Pos](../configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-level-warn.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-level-warn.md deleted file mode 100644 index d1d9522400b..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-level-warn.md +++ /dev/null @@ -1,5 +0,0 @@ -# Trace_Level_Warn - -This parameter specifies the maximum number of Trace windows that will be displayed when an error occurs and **Trace_on_error** is set to 1. If there are a large number of functions in the state indicator, the display of their Trace windows may take several seconds. This parameter allows you to restrict the potential delay to a reasonable value and its default is 16. If the number of Trace windows would exceed this number, the system instead displays a warning message box. This parameter is ignored if you invoke the Tracer explicitly. This parameter applies only if **ClassicMode** is 1 and **SingleTrace** is 0. - -See also [Warn if trace stack bigger than](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-offset-x.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-offset-x.md deleted file mode 100644 index 48d75f6e954..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-offset-x.md +++ /dev/null @@ -1,5 +0,0 @@ -# Trace_Offset_X - -This parameter specifies the number of characters by which a trace window is staggered horizontally from the previous one. This applies only if **ClassicMode** is 1 and **SingleTrace** is 0. - -See also [X Offset](../configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-offset-y.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-offset-y.md deleted file mode 100644 index 5ec33c4c196..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-offset-y.md +++ /dev/null @@ -1,5 +0,0 @@ -# Trace_Offset_Y - -This parameter specifies the number of characters by which a trace window is staggered vertically from the previous one. This applies only if **ClassicMode** is 1 and **SingleTrace** is 0. - -See also [Y Offset](../configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-on-error.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-on-error.md deleted file mode 100644 index e362f57574d..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/trace-on-error.md +++ /dev/null @@ -1,5 +0,0 @@ -# Trace_On_Error - -This parameter is either 0 (the default) or 1. If set to 1, **Trace_On_Error** specifies that the Tracer is automatically deployed when execution of a defined function halts with an error. A stack of Trace windows is immediately displayed, with the top Trace window receiving the input focus. - -See also [Show trace stack on error](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/tracestopmonitor.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/tracestopmonitor.md deleted file mode 100644 index e822249cf80..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/tracestopmonitor.md +++ /dev/null @@ -1,3 +0,0 @@ -# TraceStopMonitor - -This parameter specifies which of the `⎕TRACE` (1), `⎕STOP` (2) and `⎕MONITOR` (4) columns are displayed in Trace and Edit windows. Its value is the sum of the corresponding values. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/ucmdcachefile.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/ucmdcachefile.md deleted file mode 100644 index 846b5033b39..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/ucmdcachefile.md +++ /dev/null @@ -1,10 +0,0 @@ -# UCMDCacheFile - -This parameter specifies the name of the User Command cache file. - -The default value is: -```apl -UserCommand{UcmdMajor}{UcmdMinor}.{DyalogMajor}{DyalogMinor}{U|C}{bits}.cache -``` - -For example, `UserCommand25.182U64.cache` diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/unicodetoclipboard.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/unicodetoclipboard.md deleted file mode 100644 index e4d6aca5213..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/unicodetoclipboard.md +++ /dev/null @@ -1,7 +0,0 @@ -# UnicodeToClipboard - -**Classic Edition only.** - -This parameter specifies whether or not text that is transferred to and from the Windows clipboard is treated as Unicode text. If **UnicodeToClipboard** is 0 (the default), the symbols in `⎕AV` are mapped to ASCII text (0-255). In particular, the APL symbols are mapped to ASCII symbols according to their positions in the Dyalog APL font. If **UnicodeToClipboard** is 1, the symbols in `⎕AV` are mapped to Unicode text and the APL symbols are mapped to their genuine Unicode equivalent values. - -See also [Paste text as Unicode(Classic Edition only)](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md) diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/urlhighlight.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/urlhighlight.md deleted file mode 100644 index fd0c92c215a..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/urlhighlight.md +++ /dev/null @@ -1,16 +0,0 @@ -# URLHighlight - -Specifies whether or not URLs and links are highlighted in Session and Edit windows. Its value is either 1 (highlight) or 0. The default is 0. - -If this option is selected, valid URLs are identified when the cursor is in the Session or in an Edit or Trace window. When the mouse pointer is over a URL, the URL is underscored and the appropriate items in the Session Popup menu are activated. These allow you to open the link or copy it to the clipboard. - -You may also open a URL using Ctrl+Click (Left Mouse button). - -Currently a URL string is defined to be a string starting with any of the following strings: - -- http:// -- https:// -- www. -- mailto: - -See also [Underline URLs and links](../configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/useexternalhelpurl.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/useexternalhelpurl.md deleted file mode 100644 index 083c57ebf03..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/useexternalhelpurl.md +++ /dev/null @@ -1,5 +0,0 @@ -# UseExternalHelpURL - -This parameter specifies whether or not Dyalog attempts to use the Microsoft Document Explorer and online help to display help for external objects, such as .Net Types. See [ ExternalHelpURL](externalhelpurl.md). - -See also [Use Microsoft's documentation centre for non-Dyalog topics](../configuring-the-ide/configuration-dialog/configuration-dialog-help-dmx-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/userconfigfile.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/userconfigfile.md deleted file mode 100644 index 8bf13ee1374..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/userconfigfile.md +++ /dev/null @@ -1,3 +0,0 @@ -# UserConfigFile - -This parameter specifies the name of the User Configuration file. See [Configuration Files](../configuration-files.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/usexcv.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/usexcv.md deleted file mode 100644 index ce3811cdcff..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/usexcv.md +++ /dev/null @@ -1,13 +0,0 @@ -# UseXCV - -This Boolean parameter specifies how the commonly used keystrokes for copy (ctrl+c), cut Ctrl+x) and paste (ctrl+v) are processed. - -0 = process normally (via the appropriate .DIN file)1 = pass untranslated to the host application - -The **UseXCV** parameter is defined for the IME in the Registry section `HKEY_CURRENT_USER\Software\Dyalog\UnicodeIME\` - -When **UseXCV** is 1, the keystrokes Ctrl+X, Ctrl+C and Ctrl+V are passed untranslated to `dyalog.exe` which treats them as CT, CP and PT respectively. This is likely to be true for other host applications using the Dyalog keyboard. - -The standard Dyalog keyboard (*.din) files map Shift+Del to CT, Ctrl+Ins to CP, and Shift+Ins to PT. These will therefore work independently of the **UseXCV** option. - -The standard Dyalog keyboard (*.din) files map BOTH Ctrl+X and Ctrl+Shift+Xto `⊃` So if **UseXCV** is set to 1, you must use Ctrl+Shift+X to obtain `⊃`. Likewise for C and V. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/valuetips/colourscheme.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/valuetips/colourscheme.md deleted file mode 100644 index fe97a788762..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/valuetips/colourscheme.md +++ /dev/null @@ -1,5 +0,0 @@ -# ValueTips/ColourScheme - -This parameter specifies the colour scheme used to display a Value Tip when the user hovers the mouse over a name. - -See also [Colour Scheme](../../configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/valuetips/delay.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/valuetips/delay.md deleted file mode 100644 index edc94f00dce..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/valuetips/delay.md +++ /dev/null @@ -1,5 +0,0 @@ -# ValueTips/Delay - -This parameter specifies the delay before a Value Tip is displayed when the user hovers the mouse over a name. - -See also [Display Value Tips](../../configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/valuetips/enabled.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/valuetips/enabled.md deleted file mode 100644 index 00e49b8503f..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/valuetips/enabled.md +++ /dev/null @@ -1,5 +0,0 @@ -# ValueTips/Enabled - -This parameter specifies whether or not Value Tips are enabled. When enabled, Dyalog displays the value of a variable or the code for a function when the user hovers the mouse over its name. - -See also [Display Value Tips](../../configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/wantsspecialkeys.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/wantsspecialkeys.md deleted file mode 100644 index f44c0f933b5..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/wantsspecialkeys.md +++ /dev/null @@ -1,5 +0,0 @@ -# WantsSpecialKeys - -**Unicode Edition only.** - -This parameter specifies a list of applications (for example, *putty.exe* ) that use the command strings in the Input Translate Tables. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/wrapsearch.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/wrapsearch.md deleted file mode 100644 index 0d7e168edae..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/wrapsearch.md +++ /dev/null @@ -1,5 +0,0 @@ -# WrapSearch - -This parameter specifies whether or not Search/Replace in the Editor stops at the bottom or top of the text (depending upon the direction of the search), or continues the search from the start or end as appropriate. - -See also: [Allow search to wrap](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/wrapsearchmsgbox.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/wrapsearchmsgbox.md deleted file mode 100644 index 36d26e1795c..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/wrapsearchmsgbox.md +++ /dev/null @@ -1,5 +0,0 @@ -# WrapSearchMsgBox - -Specifies whether or not a message box is displayed to inform the user when the search wraps. - -See also [Show message box if text wraps](../configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/wsext.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/wsext.md deleted file mode 100644 index 3d9e53eba0f..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/wsext.md +++ /dev/null @@ -1,13 +0,0 @@ -# WSEXT - -This parameter specifies workspace filename extensions. It complements the **WSPATH** parameter in that together they determine the file search order to satisfy `)LOAD` or `)COPY`; it also specifies the filename extension to add on `)SAVE` or `)CONTINUE` if none is explicitly provided. - -WSEXT is a string that specifies a colon-separated list of one or more extensions, including any period (".") which separates the extension from its basename. - -If undefined, WSEXT defaults to `.dws:` on Windows and macOS, and `:.dws:.DWS` on all other platforms. - -In the Windows case, this means that `)LOAD myws` will search first for a file named `myws.dws` , and then for a file named `myws` (with no extension). As file names are not case-sensitive under Windows, this will find `myws.DWS` or `MyWs.Dws` and so forth. If none are found with this extension, it will load `myws` , `MyWs` , `MYWS` etc. - -In the second (non-Windows) case note that `)LOAD myws` will search first for a file named `myws` , then `myws.dws` , then `myws.DWS`. - -When `)SAVE` and `⎕SAVE` is used without specifying a file extension, the first extension defined by WSEXT is applied to complete the file name. The default is therefore `.dws` in all cases. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/wspath.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/wspath.md deleted file mode 100644 index c44217d45a0..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/wspath.md +++ /dev/null @@ -1,12 +0,0 @@ -# WSPath - -This parameter defines the workspace path. This is a list of directories that are searched in the order specified when you `)LOAD` or `)COPY` a workspace and when you start an Auxiliary Processor without explicitly specifying a path in the name. The directory paths are specified using Operating System specific conventions and separated by ";" (Windows) or ":" (UNIX). - -Note that to load workspaces from the current directory, "." must be included in the list defined by **WSPath**.. - -The following Windows example causes `)COPY` , `)LOAD` and `)LIB` to look first in the current directory, then in `D:\MYWS` . -```apl -WSPath=.;D:\MYWS -``` - -See also [Workspace search path](../configuring-the-ide/configuration-dialog/configuration-dialog-workspace-tab.md). diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/xplookandfeel.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/xplookandfeel.md deleted file mode 100644 index 370dba90585..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/xplookandfeel.md +++ /dev/null @@ -1,3 +0,0 @@ -# XPLookAndFeel - -This Boolean parameter specifies whether or not *Native Look and Feel* is used. This affects the appearance of user-interface controls such as Buttons. The default is 1. diff --git a/windows-installation-and-configuration-guide/docs/configuration-parameters/yy-window.md b/windows-installation-and-configuration-guide/docs/configuration-parameters/yy-window.md deleted file mode 100644 index ad771b11832..00000000000 --- a/windows-installation-and-configuration-guide/docs/configuration-parameters/yy-window.md +++ /dev/null @@ -1,69 +0,0 @@ -# yy_window - -This parameter defines how Dyalog APL is to interpret a 2-digit year number. If **yy_window** is not set (the default) then under Windows, Version 13.2 onwards will adhere to the rules specified in the Windows Region and Language 2-digit year settings. - -Dyalog allows a choice of input date formats for `⎕SM` and GUI edit fields. If you have chosen a 2-digit year format such as MM/DD/YY, then an input of 02/01/00 will by default be interpreted as 1stFebruary 1900 - not 1stFebruary 2000. - -If your application uses a 4-digit year format such as YYYY-MM-DD, the problem will not arise. - -You can use the **yy_window** parameter to cause your application to interpret 2-digit dates in as required without changing any APL code. - -## Sliding versus Fixed Window - -Two schemes are in common use within the industry: Sliding or Fixed date windows. - -Use a Fixed window if there is a *specific year* , for example 1970, before which, dates are meaningless to your application. Note that with a fixed window, this date (say 1970) will still be the limit if your application is running in a hundred years' time. - -Use a Sliding window if there is a *time period* , for example 30 years, before which dates are considered too old for your application. With a sliding window, you will always be able to enter dates up to (say) 30 years old, but after a while, specific years in the past (for example 1970) will become inaccessible. - -## Setting a Fixed Window - -To make a fixed window, set parameter **yy_window** to the 4-DIGIT year which is the earliest acceptable date. For example: - -YY_WINDOW=1970 - -This will cause the interpreter to convert any 2-digit input date into a year in the range 1970, 1971 ... 2069 - -## Setting a Sliding Window - -To make a sliding window, set parameter **yy_window** to the 1- or 2-DIGIT year which determines the oldest acceptable date. This will typically be negative. - -YY_WINDOW=-30 - -Conversion of dates now depends on the current year: - -If the current year is 1999, the earliest accepted date is 1999-30 = 1969. - -This will cause the interpreter to convert any 2-digit input date into a year in the range 1969, 1970 ... 2068. - -However if your application is still running in the year 2010, the earliest accepted date then will be 2010-30 = 1980. So in the year 2010, a 2-digit year will be interpreted in the range 1980, 1981 ... 2079. - -## Advanced Settings - -You can further restrict date windows by setting an upper as well as lower year limit. - -YY_WINDOW=1970,1999 - -This causes 2-digit years to be converted only into the range 1970, 1971 ... 1999. Any 2-digit year (for example, 54) not convertible to a year in this range will cause a `DOMAIN ERROR` . - -The sliding window equivalent is: - -YY_WINDOW=-10,10 - -This would establish a valid date window, ten years either side of the current year. For example, if the current year is 1998, the valid range would be (1998-10) – (1998+10), in other words: 1988, 1989, `→` 2008. - -One way of looking at the **yy_window** variable is that it specifies a 2-element vector. If you supply only the first element, the second one defaults to the first element + 99. - -Note that the system uses only the number of digits in the year specification to determine whether it refers to a fixed (4-digits) or sliding (1-, or 2-digits) window. In fact you can have a fixed lower limit and a sliding upper limit, or vice versa. - -YY_WINDOW=1990,10 - -Allows dates as early as 1990, but not more than 10 years hence. - -YY_WINDOW=0,1999 - -Allows dates from the current year to the end of the century. - -If the second date is before, or more than 99 years after the first date, then any date conversion will result in a `DOMAIN ERROR` . This might be useful in an application where the end-user has control over the input date format and you want to disallow any 2-digit date input. - -YY_WINDOW=1,0 diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md index cec62ca7bd5..04d45ae7c7a 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-auto-complete-tab.md @@ -8,14 +8,14 @@ Table: Configuration dialog: Auto Complete |Label|Parameter|Description| |---|---|---| -|Use Auto Complete|[Enabled](../../configuration-parameters/autocomplete/enabled.md)|Specifies whether or not Auto Completion is enabled.| -|Make suggestions after|[PrefixSize](../../configuration-parameters/autocomplete/prefixsize.md)|Specifies the number of characters you must enter before Auto Completion begins to make suggestions| -|Delay completion for|[KeyboardInputDelay](../../configuration-parameters/keyboardinputdelay.md)|Specifies the delay in milliseconds before Auto Completion begins to make suggestions| -|Suggest up to|[Rows](../../configuration-parameters/autocomplete/rows.md)|Specifies the maximum number of rows (height) in the AutoComplete pop-up suggestions box.| -|Show up to|[Cols](../../configuration-parameters/autocomplete/cols.md)|Specifies the maximum number of columns (width) in the AutoComplete pop-up suggestion box| -|Keep History|[History](../../configuration-parameters/autocomplete/history.md)|Specifies whether or not AutoComplete maintains a list of previous AutoCompletions.| -|History Length|[HistorySize](../../configuration-parameters/autocomplete/historysize.md)|Specifies the number of previous AutoCompletions that are maintained| -|Include filenames|[ShowFiles](../../configuration-parameters/autocomplete/showfiles.md)|Specifies whether or not AutoCompletion suggests directory and file names for `)LOAD` , `)COPY` and `)DROP` system commands.| -|OK Key|[CompleteKey1](../../configuration-parameters/autocomplete/completekey1.md) [CompleteKey2](../../configuration-parameters/autocomplete/completekey2.md)|Specifies two possible keys that may be used to select the current option from the Auto Complete suggestion box.| -|Cancel Key|[CancelKey1](../../configuration-parameters/autocomplete/cancelkey1.md) [CancelKey2](../../configuration-parameters/autocomplete/cancelkey2.md)|Specifies two possible keys that may be used to cancel (hide) the Auto Complete suggestion box.| -|Common Key|[CommonKey1](../../configuration-parameters/autocomplete/commonkey1.md)|Specifies the key that will auto-complete the *common prefix* .| +|Use Auto Complete|[Enabled](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/enabled)|Specifies whether or not Auto Completion is enabled.| +|Make suggestions after|[PrefixSize](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/prefixsize)|Specifies the number of characters you must enter before Auto Completion begins to make suggestions| +|Delay completion for|[KeyboardInputDelay](../../../../dyalog-configuration-guide/configuration-parameters/keyboardinputdelay)|Specifies the delay in milliseconds before Auto Completion begins to make suggestions| +|Suggest up to|[Rows](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/rows)|Specifies the maximum number of rows (height) in the AutoComplete pop-up suggestions box.| +|Show up to|[Cols](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/cols)|Specifies the maximum number of columns (width) in the AutoComplete pop-up suggestion box| +|Keep History|[History](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/history)|Specifies whether or not AutoComplete maintains a list of previous AutoCompletions.| +|History Length|[HistorySize](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/historysize)|Specifies the number of previous AutoCompletions that are maintained| +|Include filenames|[ShowFiles](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/showfiles)|Specifies whether or not AutoCompletion suggests directory and file names for `)LOAD` , `)COPY` and `)DROP` system commands.| +|OK Key|[CompleteKey1](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/completekey1) [CompleteKey2](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/completekey2)|Specifies two possible keys that may be used to select the current option from the Auto Complete suggestion box.| +|Cancel Key|[CancelKey1](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/cancelkey1) [CancelKey2](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/cancelkey2)|Specifies two possible keys that may be used to cancel (hide) the Auto Complete suggestion box.| +|Common Key|[CommonKey1](../../../../dyalog-configuration-guide/configuration-parameters/autocomplete/commonkey1)|Specifies the key that will auto-complete the *common prefix* .| diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md index 228cdfee5f4..70cc844ea1e 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-general-tab.md @@ -6,11 +6,11 @@ Table: Configuration dialog: General |Label|Parameter|Description| |---|---|---| -|Recently used file list size|[File_Stack_Size](../../configuration-parameters/file-stack-size.md)|Specifies the number of the most recently used workspaces displayed in the File menu.| -|Underline URLs and links|[URLHighlight](../../configuration-parameters/urlhighlight.md)|Specifies whether or not URLs and links are highlighted in Session and Edit windows.| -|Display Value Tips|[Enabled](../../configuration-parameters/valuetips/enabled.md)|Specifies whether or not Value Tips are enabled.| -|Display Value Tips after|[Delay](../../configuration-parameters/valuetips/delay.md)|Specifies the delay before APL displays a Value Tip.| -|Colour Scheme|[ColourScheme](../../configuration-parameters/valuetips/colourscheme.md)|Specifies the colour scheme used to display Value Tips.| -|Enable DPI Scaling of the interpreter and development environment|[AutoDPI](../../configuration-parameters/autodpi.md)|Enables or disables DPI scaling for the APL Session| -|Enable DPI scaling of GUI application|[Dyalog_Pixel_Type](../../configuration-parameters/dyalog-pixel-type.md)|Determines whether Coord `'Pixel'` is treated as ScaledPixel or RealPixel.| -|Configuration saved in|[IniFile](../../configuration-parameters/inifile.md)|Specifies the full pathname of the registry folder used by APL| +|Recently used file list size|[File_Stack_Size](../../../../dyalog-configuration-guide/configuration-parameters/file-stack-size)|Specifies the number of the most recently used workspaces displayed in the File menu.| +|Underline URLs and links|[URLHighlight](../../../../dyalog-configuration-guide/configuration-parameters/urlhighlight)|Specifies whether or not URLs and links are highlighted in Session and Edit windows.| +|Display Value Tips|[Enabled](../../../../dyalog-configuration-guide/configuration-parameters/valuetips/enabled)|Specifies whether or not Value Tips are enabled.| +|Display Value Tips after|[Delay](../../../../dyalog-configuration-guide/configuration-parameters/valuetips/delay)|Specifies the delay before APL displays a Value Tip.| +|Colour Scheme|[ColourScheme](../../../../dyalog-configuration-guide/configuration-parameters/valuetips/colourscheme)|Specifies the colour scheme used to display Value Tips.| +|Enable DPI Scaling of the interpreter and development environment|[AutoDPI](../../../../dyalog-configuration-guide/configuration-parameters/autodpi)|Enables or disables DPI scaling for the APL Session| +|Enable DPI scaling of GUI application|[Dyalog_Pixel_Type](../../../../dyalog-configuration-guide/configuration-parameters/dyalog-pixel-type)|Determines whether Coord `'Pixel'` is treated as ScaledPixel or RealPixel.| +|Configuration saved in|[IniFile](../../../../dyalog-configuration-guide/configuration-parameters/inifile)|Specifies the full pathname of the registry folder used by APL| diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-help-dmx-tab.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-help-dmx-tab.md index 53b8a67f84c..8daed77aefe 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-help-dmx-tab.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-help-dmx-tab.md @@ -6,6 +6,6 @@ Table: Configuration dialog: Help/DMX |Label|Parameter|Description| |---|---|---| -|DMX messages should go to|[DMXOutputOnError](../../configuration-parameters/dmxoutputonerror.md)|If checked, these boxes cause APL to display `⎕DMX` messages in the corresponding window(s).| -|Use Microsoft's documentation centre for non-Dyalog topics|[UseExternalHelpURL](../../configuration-parameters/useexternalhelpurl.md)|If this option is checked, APL will look for help for external objects at Microsoft's documentation center, which is identified by the specified URL.| -|URL|[ExternalHelpURL](../../configuration-parameters/externalhelpurl.md)|The URL for the documentation centre.| +|DMX messages should go to|[DMXOutputOnError](../../../../dyalog-configuration-guide/configuration-parameters/dmxoutputonerror)|If checked, these boxes cause APL to display `⎕DMX` messages in the corresponding window(s).| +|Use Microsoft's documentation centre for non-Dyalog topics|[UseExternalHelpURL](../../../../dyalog-configuration-guide/configuration-parameters/useexternalhelpurl)|If this option is checked, APL will look for help for external objects at Microsoft's documentation center, which is identified by the specified URL.| +|URL|[ExternalHelpURL](../../../../dyalog-configuration-guide/configuration-parameters/externalhelpurl)|The URL for the documentation centre.| diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-input-tab-classic-edition-only.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-input-tab-classic-edition-only.md index ae8abe5970a..f3c18305ffb 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-input-tab-classic-edition-only.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-input-tab-classic-edition-only.md @@ -6,5 +6,5 @@ Table: Configuration dialog: Keyboard |Label |Parameter |Description | |-----------------------|----------------------------------------------------|------------------------------------------------------------------| -|Input table search path|[APLKeys](../../configuration-parameters/aplkeys.md)|A list of directories to be searched for the specified input table| -|Input table file |[APLK](../../configuration-parameters/aplk.md) |The name of the input table file (.DIN) | +|Input table search path|[APLKeys](../../../../dyalog-configuration-guide/configuration-parameters/aplkeys)|A list of directories to be searched for the specified input table| +|Input table file |[APLK](../../../../dyalog-configuration-guide/configuration-parameters/aplk) |The name of the input table file (.DIN) | diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-object-syntax-tab.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-object-syntax-tab.md index 84ccb377213..77aa995b696 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-object-syntax-tab.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-object-syntax-tab.md @@ -8,6 +8,6 @@ Table: Configuration dialog: Object Syntax |Label|Parameter|Description| |---|---|---| -|Expose properties of GUI Namespaces|[Default_WX](../../configuration-parameters/default-wx.md)|Specifies the value of `⎕WX` in a clear workspace.| -|Expose properties of Root|[PropertyExposeRoot](../../configuration-parameters/propertyexposeroot.md)|Specifies whether or not the names of properties, methods and events of the Root object are exposed.| -|Expose properties of Session Namespace|[PropertyExposeSE](../../configuration-parameters/propertyexposese.md)|Specifies whether or not the names of properties, methods and events of the Session object are exposed.| +|Expose properties of GUI Namespaces|[Default_WX](../../../../dyalog-configuration-guide/configuration-parameters/default-wx)|Specifies the value of `⎕WX` in a clear workspace.| +|Expose properties of Root|[PropertyExposeRoot](../../../../dyalog-configuration-guide/configuration-parameters/propertyexposeroot)|Specifies whether or not the names of properties, methods and events of the Root object are exposed.| +|Expose properties of Session Namespace|[PropertyExposeSE](../../../../dyalog-configuration-guide/configuration-parameters/propertyexposese)|Specifies whether or not the names of properties, methods and events of the Session object are exposed.| diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-output-tab-classic-edition-only.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-output-tab-classic-edition-only.md index 815eec2d86f..2cf70f8bd51 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-output-tab-classic-edition-only.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-output-tab-classic-edition-only.md @@ -6,5 +6,5 @@ Table: Configuration dialog: Output |Label |Parameter |Description | |------------------------|------------------------------------------------------|-------------------------------------------------------------------| -|Output table search path|[APLTrans](../../configuration-parameters/apltrans.md)|A list of directories to be searched for the specified output table| -|Output table file |[APLT](../../configuration-parameters/aplt.md) |The name of the output table file (.DOT) | +|Output table search path|[APLTrans](../../../../dyalog-configuration-guide/configuration-parameters/apltrans)|A list of directories to be searched for the specified output table| +|Output table file |[APLT](../../../../dyalog-configuration-guide/configuration-parameters/aplt) |The name of the output table file (.DOT) | diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md index 5646e33a725..b32808a25a6 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab.md @@ -6,21 +6,21 @@ Table: Configuration dialog: Session |Label|Parameter|Description| |---|---|---| -|`⎕IO`|[Default_IO](../../configuration-parameters/default-io.md)|The default value of `⎕IO` in a `clear ws` .| -|`⎕ML`|[Default_ML](../../configuration-parameters/default-ml.md)|The default value of `⎕ML` in a `clear ws`| -|`⎕PP`|[Default_PP](../../configuration-parameters/default-pp.md)|The default value of `⎕PP` in a `clear ws` .| -|`⎕RTL`|[Default_RTL](../../configuration-parameters/default-rtl.md)|The default value of `⎕RTL` in a `clear ws` .| -|`⎕DIV`|[Default_DIV](../../configuration-parameters/default-div.md)|The default value of `⎕DIV` in a `clear ws` .| -|`⎕WX`|[Default_WX](../../configuration-parameters/default-wx.md)|The default value of `⎕WX` in a `clear ws` .| -|Auto PW|[Auto_PW](../../configuration-parameters/auto-pw.md)|If checked, the value of `⎕PW` is dynamic and depends on the width of the Session Window.| -|Input buffer size|[Input_Size](../../configuration-parameters/input-size.md)|The size of the buffer used to store marked lines (lines awaiting execution) in the Session.| -|History size|[History_Size](../../configuration-parameters/history-size.md)|The size of the buffer used to store previously entered (input) lines in the Session| -|PFKey buffer size|[PFKey_Size](../../configuration-parameters/pfkey-size.md)|The size of the buffer used to store PFKey definitions ( `⎕PFKEY` )| -|Confirm on Deletion from Session log|[Confirm_Session_Delete](../../configuration-parameters/confirm-session-delete.md)|Specifies whether or not you are prompted to confirm the deletion of a line from the Session (and Session log).| -|Session log size|[Log_Size](../../configuration-parameters/log-size.md)|The size of the Session log buffer.| -|Session file|[Session_File](../../configuration-parameters/session-file.md)|The name of the Session file in which the definition of your session ( `⎕SE` ) is stored.| -|Use log file|[Log_File_InUse](../../configuration-parameters/log-file-inuse.md)|Specifies whether or not the Session log is saved in a session log file| -|Use log file|[Log_File](../../configuration-parameters/log-file.md)|The full pathname of the Session log file| -|Multiline Input|[Dyalog_LineEditor_Mode](../../configuration-parameters/dyalog-lineeditor-mode.md)|Specifies whether or not multi-line input is enabled in the Session.| +|`⎕IO`|[Default_IO](../../../../dyalog-configuration-guide/configuration-parameters/default-io)|The default value of `⎕IO` in a `clear ws` .| +|`⎕ML`|[Default_ML](../../../../dyalog-configuration-guide/configuration-parameters/default-ml)|The default value of `⎕ML` in a `clear ws`| +|`⎕PP`|[Default_PP](../../../../dyalog-configuration-guide/configuration-parameters/default-pp)|The default value of `⎕PP` in a `clear ws` .| +|`⎕RTL`|[Default_RTL](../../../../dyalog-configuration-guide/configuration-parameters/default-rtl)|The default value of `⎕RTL` in a `clear ws` .| +|`⎕DIV`|[Default_DIV](../../../../dyalog-configuration-guide/configuration-parameters/default-div)|The default value of `⎕DIV` in a `clear ws` .| +|`⎕WX`|[Default_WX](../../../../dyalog-configuration-guide/configuration-parameters/default-wx)|The default value of `⎕WX` in a `clear ws` .| +|Auto PW|[Auto_PW](../../../../dyalog-configuration-guide/configuration-parameters/auto-pw)|If checked, the value of `⎕PW` is dynamic and depends on the width of the Session Window.| +|Input buffer size|[Input_Size](../../../../dyalog-configuration-guide/configuration-parameters/input-size)|The size of the buffer used to store marked lines (lines awaiting execution) in the Session.| +|History size|[History_Size](../../../../dyalog-configuration-guide/configuration-parameters/history-size)|The size of the buffer used to store previously entered (input) lines in the Session| +|PFKey buffer size|[PFKey_Size](../../../../dyalog-configuration-guide/configuration-parameters/pfkey-size)|The size of the buffer used to store PFKey definitions ( `⎕PFKEY` )| +|Confirm on Deletion from Session log|[Confirm_Session_Delete](../../../../dyalog-configuration-guide/configuration-parameters/confirm-session-delete)|Specifies whether or not you are prompted to confirm the deletion of a line from the Session (and Session log).| +|Session log size|[Log_Size](../../../../dyalog-configuration-guide/configuration-parameters/log-size)|The size of the Session log buffer.| +|Session file|[Session_File](../../../../dyalog-configuration-guide/configuration-parameters/session-file)|The name of the Session file in which the definition of your session ( `⎕SE` ) is stored.| +|Use log file|[Log_File_InUse](../../../../dyalog-configuration-guide/configuration-parameters/log-file-inuse)|Specifies whether or not the Session log is saved in a session log file| +|Use log file|[Log_File](../../../../dyalog-configuration-guide/configuration-parameters/log-file)|The full pathname of the Session log file| +|Multiline Input|[Dyalog_LineEditor_Mode](../../../../dyalog-configuration-guide/configuration-parameters/dyalog-lineeditor-mode)|Specifies whether or not multi-line input is enabled in the Session.| Note: The value of size-related values defined in the above table is specified as an integer value followed by one of K, M, G, T, P or E. The default, where no character is included, is K (Kilobytes). diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md index 578fa14a506..da8aed86174 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-trace-edit-tab.md @@ -6,31 +6,27 @@ Table: Configuration dialog: Trace/Edit |Label|Parameter|Description| |---|---|---| -|Classic Dyalog mode|[ClassicMode](../../configuration-parameters/classicmode.md)|Selects pre-Version 9 behaviour for Edit and Trace windows.| -|Allow session above edit windows|[SessionOnTop](../../configuration-parameters/sessionontop.md)|Specifies whether or not the Session may appear on top of Edit and Trace Windows| -|Single trace window|[ SingleTrace](../../configuration-parameters/singletrace.md)|Specifies whether or not there is a single Trace window| -|Remember previous window position|[ClassicModeSavePosition](../../configuration-parameters/classicmodesaveposition.md)|Specifies whether or not the current size and location of the first of the editor and tracer windows are remembered in the registry for next time.| -|Allow floating edit windows|[DockableEditWindows](../../configuration-parameters/dockableeditwindows.md)|Allows individual Edit windows to be undocked from (and re-docked in) the main Edit window| -|Show status bars|[ StatusOnEdit](../../configuration-parameters/statusonedit.md)|Specifies whether or not status bars are displayed along the bottom of individual Edit windows| -|Show tool bars|[ ToolBarsOnEdit](../../configuration-parameters/toolbarsonedit.md)|Specifies whether or not tool bars are displayed along the top of individual Edit windows| -|Show trace stack on error|[Trace_On_Error](../../configuration-parameters/trace-on-error.md)|Specifies whether or not the Tracer is automatically invoked when an error or stop occurs in a defined function| -|Allow search to wrap|[ WrapSearch](../../configuration-parameters/wrapsearch.md)|Specifies whether or not Search/Replace in the Editor stops at the top or bottom of the text, or continues from the start or end as appropriate.| -|Show message box if text wraps|[ WrapSearchMsgBox](../../configuration-parameters/wrapsearchmsgbox.md)|Specifies whether or not a message box is displayed to inform the user when the search wraps.| -|Warn if trace stack bigger than|[Trace_Level_Warn](../../configuration-parameters/trace-level-warn.md)|Specifies the maximum stack size for automatic deployment of the Tracer.| -|Confirm edit window close on Close|[Confirm_Close](../../configuration-parameters/confirm-close.md)|Specifies whether or not a confirmation dialog is displayed if the user alters the contents of an edit window, then closes it without saving| -|Confirm edit window close on Edit (and Fix)|[Confirm_Fix](../../configuration-parameters/confirm-fix.md)|Specifies whether or not a confirmation dialog is displayed if the user alters the contents of an edit window, then saves it using *Fix* or *Exit*| -|Confirm edit window close on Abort|[Confirm_Abort](../../configuration-parameters/confirm-abort.md)|Specifies whether or not a confirmation dialog is displayed if the user alters the contents of an edit window, then aborts using| -|Autoformat functions|[ AutoFormat](../../configuration-parameters/autoformat.md)|Selects automatic indentation for Control Structures when function is opened for editing| -|Autoindent|[ AutoIndent](../../configuration-parameters/autoindent.md)|Selects semi-automatic indentation for Control Structures while editing| -|Double-click to Edit|[ DoubleClickEdit](../../configuration-parameters/doubleclickedit.md)|Specifies whether or not double-clicking  over a name invokes the editor| -|Skip blank lines when tracing|[ SkipLines](../../configuration-parameters/skiplines.md)|If enabled, this causes the Tracer to automatically skip blank lines.| -|Skip comment lines when tracing|[ SkipLines](../../configuration-parameters/skiplines.md)|If enabled, this causes the Tracer to automatically skip comment lines.| -|Skip locals lines when tracing|[ SkipLines](../../configuration-parameters/skiplines.md)|If enabled, this causes the Tracer to automatically skip locals lines.| -|Limit tracer display to current function in script|[AddClassHeaders](../../configuration-parameters/addclassheaders.md)|When Tracing the execution of a function in a script, the Tracer displays either just the first line of the script and the function in question (option enabled), or the entire script (option disabled).| -|Paste text as Unicode (Classic Edition only)|[ UnicodeToClipboard](../../configuration-parameters/unicodetoclipboard.md)|Specifies whether or not text transferred to and from the Windows clipboard is to be treated as Unicode| -|Tab stops every|[ TabStops](../../configuration-parameters/tabstops.md)|The number of spaces inserted by pressing Tab in an edit window| -|Exit and fix ...|[ InitFullScriptSusp](../../configuration-parameters/initfullscriptsusp.md)|See Fixing Scripts below| -|If not ...|[InitFullScriptNormal](../../configuration-parameters/initfullscriptnormal.md)|See Fixing Scripts below| +|Allow floating edit windows|[DockableEditWindows](../../../../dyalog-configuration-guide/configuration-parameters/dockableeditwindows)|Allows individual Edit windows to be undocked from (and re-docked in) the main Edit window| +|Show status bars|[ StatusOnEdit](../../../../dyalog-configuration-guide/configuration-parameters/statusonedit)|Specifies whether or not status bars are displayed along the bottom of individual Edit windows| +|Show tool bars|[ ToolBarsOnEdit](../../../../dyalog-configuration-guide/configuration-parameters/toolbarsonedit)|Specifies whether or not tool bars are displayed along the top of individual Edit windows| +|Show trace stack on error|[Trace_On_Error](../../../../dyalog-configuration-guide/configuration-parameters/trace-on-error)|Specifies whether or not the Tracer is automatically invoked when an error or stop occurs in a defined function| +|Allow search to wrap|[ WrapSearch](../../../../dyalog-configuration-guide/configuration-parameters/wrapsearch)|Specifies whether or not Search/Replace in the Editor stops at the top or bottom of the text, or continues from the start or end as appropriate.| +|Show message box if text wraps|[ WrapSearchMsgBox](../../../../dyalog-configuration-guide/configuration-parameters/wrapsearchmsgbox)|Specifies whether or not a message box is displayed to inform the user when the search wraps.| +|Warn if trace stack bigger than|[Trace_Level_Warn](../../../../dyalog-configuration-guide/configuration-parameters/trace-level-warn)|Specifies the maximum stack size for automatic deployment of the Tracer.| +|Confirm edit window close on Close|[Confirm_Close](../../../../dyalog-configuration-guide/configuration-parameters/confirm-close)|Specifies whether or not a confirmation dialog is displayed if the user alters the contents of an edit window, then closes it without saving| +|Confirm edit window close on Edit (and Fix)|[Confirm_Fix](../../../../dyalog-configuration-guide/configuration-parameters/confirm-fix)|Specifies whether or not a confirmation dialog is displayed if the user alters the contents of an edit window, then saves it using *Fix* or *Exit*| +|Confirm edit window close on Abort|[Confirm_Abort](../../../../dyalog-configuration-guide/configuration-parameters/confirm-abort)|Specifies whether or not a confirmation dialog is displayed if the user alters the contents of an edit window, then aborts using| +|Autoformat functions|[ AutoFormat](../../../../dyalog-configuration-guide/configuration-parameters/autoformat)|Selects automatic indentation for Control Structures when function is opened for editing| +|Autoindent|[ AutoIndent](../../../../dyalog-configuration-guide/configuration-parameters/autoindent)|Selects semi-automatic indentation for Control Structures while editing| +|Double-click to Edit|[ DoubleClickEdit](../../../../dyalog-configuration-guide/configuration-parameters/doubleclickedit)|Specifies whether or not double-clicking  over a name invokes the editor| +|Skip blank lines when tracing|[ SkipLines](../../../../dyalog-configuration-guide/configuration-parameters/skiplines)|If enabled, this causes the Tracer to automatically skip blank lines.| +|Skip comment lines when tracing|[ SkipLines](../../../../dyalog-configuration-guide/configuration-parameters/skiplines)|If enabled, this causes the Tracer to automatically skip comment lines.| +|Skip locals lines when tracing|[ SkipLines](../../../../dyalog-configuration-guide/configuration-parameters/skiplines)|If enabled, this causes the Tracer to automatically skip locals lines.| +|Limit tracer display to current function in script|[AddClassHeaders](../../../../dyalog-configuration-guide/configuration-parameters/addclassheaders)|When Tracing the execution of a function in a script, the Tracer displays either just the first line of the script and the function in question (option enabled), or the entire script (option disabled).| +|Paste text as Unicode (Classic Edition only)|[ UnicodeToClipboard](../../../../dyalog-configuration-guide/configuration-parameters/unicodetoclipboard)|Specifies whether or not text transferred to and from the Windows clipboard is to be treated as Unicode| +|Tab stops every|[ TabStops](../../../../dyalog-configuration-guide/configuration-parameters/tabstops)|The number of spaces inserted by pressing Tab in an edit window| +|Exit and fix ...|[ InitFullScriptSusp](../../../../dyalog-configuration-guide/configuration-parameters/initfullscriptsusp)|See Fixing Scripts below| +|If not ...|[InitFullScriptNormal](../../../../dyalog-configuration-guide/configuration-parameters/initfullscriptnormal)|See Fixing Scripts below| ## Fixing Scripts diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only.md index 0a00c03d90a..325e67a79d9 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-unicode-input-tab-unicode-edition-only.md @@ -8,9 +8,9 @@ Table: Configuration dialog: Unicode Input |Label|Parameter|Description| |---|---|---| -|Activate selected keyboard|[InitialKeyboardLayoutInUse](../../configuration-parameters/initialkeyboardlayoutinuse.md)|If checked, the specified APL keyboard is activated on start-up.| -|Show keyboards for all Languages|[InitialKeyboardLayoutShowAll](../../configuration-parameters/initialkeyboardlayoutshowall.md)|If checked, all installed keyboards are displayed. Otherwise, only Dyalog keyboards are shown| -|Keyboard|[InitialKeyboardLayout](../../configuration-parameters/initialkeyboardlayout.md)|the APL keyboard to be selected.| +|Activate selected keyboard|[InitialKeyboardLayoutInUse](../../../../dyalog-configuration-guide/configuration-parameters/initialkeyboardlayoutinuse)|If checked, the specified APL keyboard is activated on start-up.| +|Show keyboards for all Languages|[InitialKeyboardLayoutShowAll](../../../../dyalog-configuration-guide/configuration-parameters/initialkeyboardlayoutshowall)|If checked, all installed keyboards are displayed. Otherwise, only Dyalog keyboards are shown| +|Keyboard|[InitialKeyboardLayout](../../../../dyalog-configuration-guide/configuration-parameters/initialkeyboardlayout)|the APL keyboard to be selected.| |Configure Layout| |Displays thefollowng dialog box.| ## Input Method Editor Properties @@ -21,8 +21,8 @@ Table: Dyalog Input Method Editor Properties |Label|Parameter|Description| |---|---|---| -|Use Ctrl-X,C,V for clipboard|[UseXCV](../../configuration-parameters/usexcv.md)|specifies whether or not the commonly used keystrokes for copy, cut and paste are recognised as such.| +|Use Ctrl-X,C,V for clipboard|[UseXCV](../../../../dyalog-configuration-guide/configuration-parameters/usexcv)|specifies whether or not the commonly used keystrokes for copy, cut and paste are recognised as such.| |Enable Backtick Keyboard introducer| | | -|Enable Overstrikes|[ResolveOverstrikes](../../configuration-parameters/resolveoverstrikes.md)|1 = enable overstrikes. 0 = disable overstrikes| +|Enable Overstrikes|[ResolveOverstrikes](../../../../dyalog-configuration-guide/configuration-parameters/resolveoverstrikes)|1 = enable overstrikes. 0 = disable overstrikes| |Overstrikes do not require the OS introducer key| |1 = IME identifies overstrike operation automatically 0 = IME requires the key (default Ctrl+Bksp) to signal an overstrike operation| -|Use Overstrike popup|[OverstrikesPopup](../../configuration-parameters/overstrikespopup.md)|1 = enable the overstrike popup. 0 = disable the overstrike popup| +|Use Overstrike popup|[OverstrikesPopup](../../../../dyalog-configuration-guide/configuration-parameters/overstrikespopup)|1 = enable the overstrike popup. 0 = disable the overstrike popup| diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md index 29fc429ed28..786a09fc290 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-windows-tab.md @@ -6,25 +6,25 @@ Table: Configuration dialog: Windows (Edit Windows) |Label |Parameter |Description | |--------|----------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| -|Width |[Edit_Cols](../../configuration-parameters/edit-cols.md) |The maximum number of rows displayed in a new edit window. | -|Height |[Edit_Rows](../../configuration-parameters/edit-rows.md) |The maximum number of columns displayed in a new edit window. | -|X Pos |[Edit_First_X](../../configuration-parameters/edit-first-x.md) |The initial horizontal position in characters of the first edit window. | -|Y Pos |[Edit_First_Y](../../configuration-parameters/edit-first-y.md) |The initial vertical position in characters of the first edit window. | -|X Offset|[Edit_Offset_X](../../configuration-parameters/edit-offset-x.md)|The initial horizontal position in characters of the second and subsequent edit windows relative to the previous one.| -|Y Offset|[Edit_Offset_Y](../../configuration-parameters/edit-offset-y.md)|The initial vertical position in characters of the second and subsequent edit windows relative to the previous one. | +|Width |[Edit_Cols](../../../../dyalog-configuration-guide/configuration-parameters/edit-cols) |The maximum number of rows displayed in a new edit window. | +|Height |[Edit_Rows](../../../../dyalog-configuration-guide/configuration-parameters/edit-rows) |The maximum number of columns displayed in a new edit window. | +|X Pos |[Edit_First_X](../../../../dyalog-configuration-guide/configuration-parameters/edit-first-x) |The initial horizontal position in characters of the first edit window. | +|Y Pos |[Edit_First_Y](../../../../dyalog-configuration-guide/configuration-parameters/edit-first-y) |The initial vertical position in characters of the first edit window. | +|X Offset|[Edit_Offset_X](../../../../dyalog-configuration-guide/configuration-parameters/edit-offset-x)|The initial horizontal position in characters of the second and subsequent edit windows relative to the previous one.| +|Y Offset|[Edit_Offset_Y](../../../../dyalog-configuration-guide/configuration-parameters/edit-offset-y)|The initial vertical position in characters of the second and subsequent edit windows relative to the previous one. | Table: Configuration dialog: Windows (Trace Windows) |Label |Parameter |Description | |--------|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------| -|X Pos |[Trace_First_X](../../configuration-parameters/trace-first-x.md) |The initial horizontal position in characters of the first trace window. | -|Y Pos |[Trace_First_Y](../../configuration-parameters/trace-first-y.md) |The initial vertical position in characters of the first trace window. | -|X Offset|[Trace_Offset_X](../../configuration-parameters/trace-offset-x.md)|The initial horizontal position in characters of the second and subsequent trace windows relative to the previous one.| -|Y Offset|[Trace_Offset_Y](../../configuration-parameters/trace-offset-y.md)|The initial vertical position in characters of the second and subsequent trace windows relative to the previous one. | +|X Pos |[Trace_First_X](../../../../dyalog-configuration-guide/configuration-parameters/trace-first-x) |The initial horizontal position in characters of the first trace window. | +|Y Pos |[Trace_First_Y](../../../../dyalog-configuration-guide/configuration-parameters/trace-first-y) |The initial vertical position in characters of the first trace window. | +|X Offset|[Trace_Offset_X](../../../../dyalog-configuration-guide/configuration-parameters/trace-offset-x)|The initial horizontal position in characters of the second and subsequent trace windows relative to the previous one.| +|Y Offset|[Trace_Offset_Y](../../../../dyalog-configuration-guide/configuration-parameters/trace-offset-y)|The initial vertical position in characters of the second and subsequent trace windows relative to the previous one. | Table: Configuration dialog: Windows (QuadSM Window) |Label |Parameter |Description | |------|----------------------------------------------------|--------------------------------------------| -|Width |[SM_Cols](../../configuration-parameters/sm-cols.md)|The width of the `⎕SM` and prefect windows. | -|Height|[SM_Rows](../../configuration-parameters/sm-rows.md)|The height of the `⎕SM` and prefect windows.| +|Width |[SM_Cols](../../../../dyalog-configuration-guide/configuration-parameters/sm-cols)|The width of the `⎕SM` and prefect windows. | +|Height|[SM_Rows](../../../../dyalog-configuration-guide/configuration-parameters/sm-rows)|The height of the `⎕SM` and prefect windows.| diff --git a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-workspace-tab.md b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-workspace-tab.md index 94303d2bee7..bf44fe7b78e 100644 --- a/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-workspace-tab.md +++ b/windows-installation-and-configuration-guide/docs/configuring-the-ide/configuration-dialog/configuration-dialog-workspace-tab.md @@ -6,5 +6,5 @@ Table: Configuration dialog: Workspace |Label |Parameter |Description | |----------------------|--------------------------------------------------|-------------------------------------------------------------------------------------------------| -|Workspace search path |[WSPath](../../configuration-parameters/wspath.md)|A list of directories to be searched for the specified workspace when the user executes `)LOAD` .| -|Maximum workspace size|[MaxWS](../../configuration-parameters/maxws.md) |The maximum size of the workspace. | +|Workspace search path |[WSPath](../../../../dyalog-configuration-guide/configuration-parameters/wspath)|A list of directories to be searched for the specified workspace when the user executes `)LOAD` .| +|Maximum workspace size|[MaxWS](../../../../dyalog-configuration-guide/configuration-parameters/maxws) |The maximum size of the workspace. | diff --git a/windows-installation-and-configuration-guide/docs/runtime-applications-and-components.md b/windows-installation-and-configuration-guide/docs/runtime-applications-and-components.md index f26755c4cb3..c5d8f7229d8 100644 --- a/windows-installation-and-configuration-guide/docs/runtime-applications-and-components.md +++ b/windows-installation-and-configuration-guide/docs/runtime-applications-and-components.md @@ -18,7 +18,7 @@ All but the first of these are made using the *Export* dialog box accessed from ## Configuration Parameters -Configuration parameters for these run-time applications, both for the Dyalog engine and for your own application settings, may be specified in a number of ways. See [Configuration Parameters](configuration-parameters/configuration-parameters.md). +Configuration parameters for these run-time applications, both for the Dyalog engine and for your own application settings, may be specified in a number of ways. See [Configuration Parameters](../../dyalog-configuration-guide/configuration-parameters/configuration-parameters). Nevertheless, it is strongly recommended that you use Configuration files. In this section we will discuss only Application Configuration files, although User Configuration files may be used as well. @@ -54,7 +54,7 @@ The application starts by running `⎕LX` in `myapp.dws`. If a configuration fil dyalogrt.exe Load=myfn.aplf ``` -The application loads the file named `myfn.aplf` which contains the source code for a function, and executes the expression `(myfn 0⍴⊂'')` (see [Load](configuration-parameters/load.md)). If a configuration file named `myfn.dcfg` in the same directory, it is loaded and applied. +The application loads the file named `myfn.aplf` which contains the source code for a function, and executes the expression `(myfn 0⍴⊂'')` (see [Load](../../dyalog-configuration-guide/configuration-parameters/load)). If a configuration file named `myfn.dcfg` in the same directory, it is loaded and applied. If your application uses any component of the Microsoft .NET Framework, you must distribute the Bridge DLL and DyalogNet DLLs. These DLLs must be placed in the same directory as your EXE. diff --git a/windows-installation-and-configuration-guide/mkdocs.yml b/windows-installation-and-configuration-guide/mkdocs.yml index 4d6292d38db..13e367d3e30 100644 --- a/windows-installation-and-configuration-guide/mkdocs.yml +++ b/windows-installation-and-configuration-guide/mkdocs.yml @@ -61,157 +61,6 @@ nav: - The APL Command Line: apl-command-line.md - APL Exit Codes: apl-exit-codes.md - Dyalog Serial Number: dyalog-serial-number.md - - Configuration Parameters: - - Introduction: configuration-parameters/configuration-parameters.md - - AddClassHeaders: configuration-parameters/addclassheaders.md - - APLAN_FOR_EDITOR: configuration-parameters/aplan-for-editor.md - - APLAN_FOR_OUTPUT: configuration-parameters/aplan-for-output.md - - AplCoreName: configuration-parameters/aplcorename.md - - aplk: configuration-parameters/aplk.md - - aplkeys: configuration-parameters/aplkeys.md - - aplnid: configuration-parameters/aplnid.md - - aplt: configuration-parameters/aplt.md - - apltrans: configuration-parameters/apltrans.md - - APL_CODE_E_MAGNITUDE: configuration-parameters/apl-code-e-magnitude.md - - APL_COMPLEX_AS_V12: configuration-parameters/apl-complex-as-v12.md - - APL_FCREATE_PROPS_C: configuration-parameters/apl-fcreate-props-c.md - - APL_FCREATE_PROPS_J: configuration-parameters/apl-fcreate-props-j.md - - APL_FAST_FCHK: configuration-parameters/apl-fast-fchk.md - - APL_MAX_THREADS: configuration-parameters/apl-max-threads.md - - APL_TextInAplCore: configuration-parameters/apl-textinaplcore.md - - AutoDPI: configuration-parameters/autodpi.md - - AutoComplete: - - CancelKey1: configuration-parameters/autocomplete/cancelkey1.md - - CancelKey2: configuration-parameters/autocomplete/cancelkey2.md - - Cols: configuration-parameters/autocomplete/cols.md - - CommonKey1: configuration-parameters/autocomplete/commonkey1.md - - CompleteKey1: configuration-parameters/autocomplete/completekey1.md - - CompleteKey2: configuration-parameters/autocomplete/completekey2.md - - Enabled: configuration-parameters/autocomplete/enabled.md - - History: configuration-parameters/autocomplete/history.md - - HistorySize: configuration-parameters/autocomplete/historysize.md - - PrefixSize: configuration-parameters/autocomplete/prefixsize.md - - Rows: configuration-parameters/autocomplete/rows.md - - ShowFiles: configuration-parameters/autocomplete/showfiles.md - - AutoFormat: configuration-parameters/autoformat.md - - AutoIndent: configuration-parameters/autoindent.md - - auto_pw: configuration-parameters/auto-pw.md - - CFEXT: configuration-parameters/cfext.md - - ClassicMode: configuration-parameters/classicmode.md - - ClassicModeSavePosition: configuration-parameters/classicmodesaveposition.md - - CMD_PREFIX and CMD_POSTFIX: configuration-parameters/cmd-prefix-and-cmd-postfix.md - - ConfigFile: configuration-parameters/configfile.md - - confirm_abort: configuration-parameters/confirm-abort.md - - confirm_close: configuration-parameters/confirm-close.md - - confirm_fix: configuration-parameters/confirm-fix.md - - confirm_session_delete: configuration-parameters/confirm-session-delete.md - - default_div: configuration-parameters/default-div.md - - default_io: configuration-parameters/default-io.md - - default_ml: configuration-parameters/default-ml.md - - default_pp: configuration-parameters/default-pp.md - - default_pw: configuration-parameters/default-pw.md - - default_rtl: configuration-parameters/default-rtl.md - - default_wx: configuration-parameters/default-wx.md - - DMXOUTPUTONERROR: configuration-parameters/dmxoutputonerror.md - - DockableEditWindows: configuration-parameters/dockableeditwindows.md - - DoubleClickEdit: configuration-parameters/doubleclickedit.md - - dyalog: configuration-parameters/dyalog.md - - DyalogEmailAddress: configuration-parameters/dyalogemailaddress.md - - DyalogHelpDir: configuration-parameters/dyaloghelpdir.md - - DyalogInstallDir: configuration-parameters/dyaloginstalldir.md - - DyalogLink: configuration-parameters/dyaloglink.md - - DyalogStartup: configuration-parameters/dyalogstartup.md - - DyalogStartupSE: configuration-parameters/dyalogstartupse.md - - DyalogStartup_X: configuration-parameters/dyalogstartup-x.md - - DyalogWebSite: configuration-parameters/dyalogwebsite.md - - DYALOG_DISCARD_FN_SOURCE: configuration-parameters/dyalog-discard-fn-source.md - - DYALOG_EVENTLOGGINGLEVEL: configuration-parameters/dyalog-eventlogginglevel.md - - DYALOG_EVENTLOGNAME: configuration-parameters/dyalog-eventlogname.md - - DYALOG_GUTTER_ENABLE: configuration-parameters/dyalog-gutter-enable.md - - Dyalog_LineEditor_Mode: configuration-parameters/dyalog-lineeditor-mode.md - - Dyalog_NETCore: configuration-parameters/dyalog-netcore.md - - DYALOG_NOPOPUPS: configuration-parameters/dyalog-nopopups.md - - DYALOG_PIXEL_TYPE: configuration-parameters/dyalog-pixel-type.md - - DYALOG_SERIAL: configuration-parameters/dyalog-serial.md - - EditorState: configuration-parameters/editorstate.md - - Edit_Cols: configuration-parameters/edit-cols.md - - Edit_First_X: configuration-parameters/edit-first-x.md - - Edit_First_Y: configuration-parameters/edit-first-y.md - - Edit_Offset_X: configuration-parameters/edit-offset-x.md - - Edit_Offset_Y: configuration-parameters/edit-offset-y.md - - Edit_Rows: configuration-parameters/edit-rows.md - - ENABLE_CEF: configuration-parameters/enable-cef.md - - ErrorOnExternalException: configuration-parameters/erroronexternalexception.md - - ExternalHelpURL: configuration-parameters/externalhelpurl.md - - File_Stack_Size: configuration-parameters/file-stack-size.md - - greet_bitmap: configuration-parameters/greet-bitmap.md - - history_size: configuration-parameters/history-size.md - - inifile: configuration-parameters/inifile.md - - InitFullScriptNormal: configuration-parameters/initfullscriptnormal.md - - InitFullScriptSusp: configuration-parameters/initfullscriptsusp.md - - InitialKeyboardLayout: configuration-parameters/initialkeyboardlayout.md - - InitialKeyboardLayoutInUse: configuration-parameters/initialkeyboardlayoutinuse.md - - InitialKeyboardLayoutShowAll: configuration-parameters/initialkeyboardlayoutshowall.md - - input_size: configuration-parameters/input-size.md - - KeyboardInputDelay: configuration-parameters/keyboardinputdelay.md - - Load: configuration-parameters/load.md - - localdyalogdir: configuration-parameters/localdyalogdir.md - - log_file: configuration-parameters/log-file.md - - log_file_inuse: configuration-parameters/log-file-inuse.md - - log_size: configuration-parameters/log-size.md - - LX: configuration-parameters/lx.md - - mapchars: configuration-parameters/mapchars.md - - MaxAplCores: configuration-parameters/maxaplcores.md - - maxws: configuration-parameters/maxws.md - - OverstrikesPopup: configuration-parameters/overstrikespopup.md - - PassExceptionsToOpSys: configuration-parameters/passexceptionstoopsys.md - - pfkey_size: configuration-parameters/pfkey-size.md - - ProgramFolder: configuration-parameters/programfolder.md - - PropertyExposeRoot: configuration-parameters/propertyexposeroot.md - - PropertyExposeSE: configuration-parameters/propertyexposese.md - - qcmd_timeout: configuration-parameters/qcmd-timeout.md - - ResolveOverstrikes: configuration-parameters/resolveoverstrikes.md - - RIDE_Init: configuration-parameters/ride-init.md - - RIDE_Spawned: configuration-parameters/ride-spawned.md - - RunAsService: configuration-parameters/runasservice.md - - SaveContinueOnExit: configuration-parameters/savecontinueonexit.md - - SaveLogOnExit: configuration-parameters/savelogonexit.md - - SaveSessionOnExit: configuration-parameters/savesessiononexit.md - - Serial: configuration-parameters/serial.md - - SessionOnTop: configuration-parameters/sessionontop.md - - session_file: configuration-parameters/session-file.md - - ShowStatusOnError: configuration-parameters/showstatusonerror.md - - SingleTrace: configuration-parameters/singletrace.md - - SkipLines: configuration-parameters/skiplines.md - - SM_Cols: configuration-parameters/sm-cols.md - - SM_Rows: configuration-parameters/sm-rows.md - - StatusOnEdit: configuration-parameters/statusonedit.md - - TabStops: configuration-parameters/tabstops.md - - ToolBarsOnEdit: configuration-parameters/toolbarsonedit.md - - TraceStopMonitor: configuration-parameters/tracestopmonitor.md - - Trace_First_X: configuration-parameters/trace-first-x.md - - Trace_First_Y: configuration-parameters/trace-first-y.md - - Trace_level_warn: configuration-parameters/trace-level-warn.md - - Trace_Offset_X: configuration-parameters/trace-offset-x.md - - Trace_Offset_Y: configuration-parameters/trace-offset-y.md - - Trace_On_Error: configuration-parameters/trace-on-error.md - - UCMDCacheFile: configuration-parameters/ucmdcachefile.md - - UnicodeToClipboard: configuration-parameters/unicodetoclipboard.md - - URLHighlight: configuration-parameters/urlhighlight.md - - UseExternalHelpURL: configuration-parameters/useexternalhelpurl.md - - UserConfigFile: configuration-parameters/userconfigfile.md - - UseXCV: configuration-parameters/usexcv.md - - ValueTips: - - ValueTips/ColourScheme: configuration-parameters/valuetips/colourscheme.md - - ValueTips/Delay: configuration-parameters/valuetips/delay.md - - ValueTips/Enabled: configuration-parameters/valuetips/enabled.md - - WantsSpecialKeys: configuration-parameters/wantsspecialkeys.md - - WrapSearch: configuration-parameters/wrapsearch.md - - WrapSearchMsgBox: configuration-parameters/wrapsearchmsgbox.md - - WSEXT: configuration-parameters/wsext.md - - WSPATH: configuration-parameters/wspath.md - - XPLookAndFeel: configuration-parameters/xplookandfeel.md - - yy_window: configuration-parameters/yy-window.md - Registry SubFolders: registry-subfolders.md - Configuration Files: configuration-files.md - Window Captions: window-captions.md diff --git a/windows-ui-guide/docs/editor.md b/windows-ui-guide/docs/editor.md index 292533de8cc..40e0b6fae36 100644 --- a/windows-ui-guide/docs/editor.md +++ b/windows-ui-guide/docs/editor.md @@ -16,7 +16,7 @@ If the name is followed by a line-number in square brackets, for example, `MyFn[ ## Window Management (Standard) -Unless *Classic Dyalog mode* is selected (*Options/Configure/Trace/Edit*), the Editor is a Multiple Document Interface (MDI) window that may be a stand-alone window, or be docked in the Session window. Each of the objects being edited is displayed in a separate sub-window. Individual edit windows are managed using standard MDI facilities. +Unless Classic Dyalog mode is selected from the *Layout* menu, the Editor is a Multiple Document Interface (MDI) window that may be a stand-alone window, or be docked in the Session window. Each of the objects being edited is displayed in a separate sub-window. Individual edit windows are managed using standard MDI facilities. ![](img/editor-2.png) @@ -44,12 +44,9 @@ Note that when the Editor has the focus, the Editor menubar is displayed in plac ## Window Management (Classic Dyalog mode) -If *Classic Dyalog mode* is selected (*Options/Configure/Trace/Edit*) each Edit window is a top-level window created as a child of the Session window. This means that normally Edit windows appear on top of the Session. However, if the **SessionOnTop** parameter is set, the Session window, when given the focus, will appear on top of Edit windows. +If Classic Dyalog mode is selected from the [Layout menu](session-menubar.md#the-layout-menu), each Edit window is a top-level window created as a child of the Session window. This means that normally Edit windows appear on top of the Session. -When the first Edit window is opened, its position is determined as follows: - -- If the **ClassicModeSavePosition** parameter is set, the first Edit window is displayed at the position that was previously occupied by the most recently saved Edit window. -- If not, the first edit window is created at the position specified by the **edit_first_y** and **edit_first_x** parameters which are specified in terms of the size of a character in the current font relative to the top-left corner of the screen. +The first Edit window is created at the position specified by the **edit_first_y** and **edit_first_x** parameters which are specified in terms of the size of a character in the current font relative to the top-left corner of the screen. The initial size of an edit window is specified by the **edit_rows** and **edit_cols** parameters. diff --git a/windows-ui-guide/docs/file-explorer-integration.md b/windows-ui-guide/docs/file-explorer-integration.md index dc0c18b52ec..1cea0a7161f 100644 --- a/windows-ui-guide/docs/file-explorer-integration.md +++ b/windows-ui-guide/docs/file-explorer-integration.md @@ -14,7 +14,7 @@ During installation, Dyalog establishes the following file associations: When you double-click on a file with one of the above extensions, the file is opened with the corresponding application. -In addition, two items are added to the Windows Explorer context menu for directories, namely *Load with Dyalog* and *Run with Dyalog*. Both these items start Dyalog and attempt to import code from the corresponding directory using Link. The *Run with Dyalog* option also calls the function named `Run` if it exists. See [Load Parameter](../../windows-installation-and-configuration-guide/configuration-parameters/load). +In addition, two items are added to the Windows Explorer context menu for directories, namely *Load with Dyalog* and *Run with Dyalog*. Both these items start Dyalog and attempt to import code from the corresponding directory using Link. The *Run with Dyalog* option also calls the function named `Run` if it exists. See [Load Parameter](../../dyalog-configuration-guide/configuration-parameters/load). For more information about Link, see [https://dyalog.github.io/link/](https://dyalog.github.io/link/). diff --git a/windows-ui-guide/docs/multiline-session-input.md b/windows-ui-guide/docs/multiline-session-input.md index 173bdec14d5..18361a51fda 100644 --- a/windows-ui-guide/docs/multiline-session-input.md +++ b/windows-ui-guide/docs/multiline-session-input.md @@ -2,7 +2,7 @@ The Session allows multi-line input. This feature is optional, and is controlled by the value of the **Dyalog_LineEditor_Mode** configuration parameter (default is `1`, meaning that multi-line input is enabled). To disable multi-line input, set **Dyalog_LineEditor_Mode** to `0`. -See [Dyalog_LineEditor_Mode.](../../windows-installation-and-configuration-guide/configuration-parameters/dyalog-lineeditor-mode) +See [Dyalog_LineEditor_Mode.](../../dyalog-configuration-guide/configuration-parameters/dyalog-lineeditor-mode) On Microsoft Windows, multi-line input can be enabled and disabled using the **Enable Multiline Input** checkbox on the **Session** tab of the **Configuration** dialog box. See [Dyalog_LineEditor_Mode](../../windows-installation-and-configuration-guide/configuring-the-ide/configuration-dialog/configuration-dialog-session-tab). diff --git a/windows-ui-guide/docs/session-menubar.md b/windows-ui-guide/docs/session-menubar.md index 0e34de2ff76..6a27027c982 100644 --- a/windows-ui-guide/docs/session-menubar.md +++ b/windows-ui-guide/docs/session-menubar.md @@ -163,17 +163,18 @@ Table: Threads Menu Operations {: #threads-menu-operations } ## The Layout Menu -The *Layout* menu (`⎕SE.mb.layout`) provides layout options for the Debugger. +The *Layout* menu (`⎕SE.mb.layout`) selects the layout of the Session and of the tools that are docked in it, including the Editor and the Debugger. Table: Layout Menu Operations {: #debugger-layout-menu-operations } -|Item |Action |Description | -|-----------------------|-------------------|---------------------------------------------------| -|Classic |APL callback |Detaches the Debugger window | -|Debugger at the bottom |APL callback |Docks the Debugger at the bottom (default) | -|Debugger on the left |APL callback |Docks the Debugger on the left | +|Item |Action |Description | +|------------------------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +|Open… |  |Displays the *Open Session layout* dialog box, from which a Session layout file (*.layout*) can be selected | +|Classic |  |Selects Classic Dyalog mode, in which the Debugger is a separate window containing the Tracer, with the Left Argument pane docked to its left and the Right Argument pane docked to its right| +|Debugger at the bottom |  |Docks the Debugger at the bottom of the Session window (default) | +|Classic with Vertical Inline Tracing|  |As *Classic*, but with the Left Argument pane docked above the Tracer and the Right Argument pane docked below it | -The selected option does *not* persist if you restart the session. +The selected layout is saved when Dyalog exits and is restored the next time it starts; see the [LAYOUT_FILE](../../windows-installation-and-configuration-guide/configuration-parameters/layout-file) parameter. ## The Help Menu diff --git a/windows-ui-guide/docs/the-session-object/session-initialisation.md b/windows-ui-guide/docs/the-session-object/session-initialisation.md index a84b93bd8a7..897b7e39143 100644 --- a/windows-ui-guide/docs/the-session-object/session-initialisation.md +++ b/windows-ui-guide/docs/the-session-object/session-initialisation.md @@ -8,15 +8,15 @@ At the end of the initialisation, the function defined by the `.aplf` file (or t ## Implementation -Code to be installed in `⎕SE` is specified in APL source code files contained in *Session initialisation* directories identified by the **DyalogStartupSE** parameter. If this parameter is not specified, the default is a directory named `StartupSession` located in three standard locations as described below. See [DyalogStartupSE](../../../windows-installation-and-configuration-guide/configuration-parameters/dyalogstartupse) for more details. +Code to be installed in `⎕SE` is specified in APL source code files contained in *Session initialisation* directories identified by the **DyalogStartupSE** parameter. If this parameter is not specified, the default is a directory named `StartupSession` located in three standard locations as described below. See [DyalogStartupSE](../../../dyalog-configuration-guide/configuration-parameters/dyalogstartupse) for more details. Only content stored in files matching the wildcard patterns `*.dyalog` and `*.apl?` will be loaded. All such files must be appropriate for `⎕FIX`. For each subdirectory in a Session initialisation directory, a corresponding namespace is created in `⎕SE`. Any source code files in these subdirectories will be fixed in their respective corresponding namespaces, and nested subdirectories become nested namespaces, recursively -Every top-level directory that is loaded as a namespace in `⎕SE` can have a `Run` function which (depending on the value of the **DyalogStartup_X** parameter, will be called after everything has been loaded. This does not apply to sub-namespaces. See [DyalogStartup_X](../../../windows-installation-and-configuration-guide/configuration-parameters/dyalogstartup-x). +Every top-level directory that is loaded as a namespace in `⎕SE` can have a `Run` function which (depending on the value of the **DyalogStartup_X** parameter, will be called after everything has been loaded. This does not apply to sub-namespaces. See [DyalogStartup_X](../../../dyalog-configuration-guide/configuration-parameters/dyalogstartup-x). -This requires Link which is available by default. A custom version of Link can be used. See [DyalogLink](../../../windows-installation-and-configuration-guide/configuration-parameters/dyaloglink). +This requires Link which is available by default. A custom version of Link can be used. See [DyalogLink](../../../dyalog-configuration-guide/configuration-parameters/dyaloglink). The Session initialisation directories are processed in alphabetical order and code defined in each directory will replace code with the same name defined previously. In effect, this means that user-supplied content can replace content supplied by Dyalog Ltd. and version-specific content can replace version-agnostic content. diff --git a/windows-ui-guide/docs/the-session-object/session-object.md b/windows-ui-guide/docs/the-session-object/session-object.md index bbfcd0a5de2..3c2a3b60ac1 100644 --- a/windows-ui-guide/docs/the-session-object/session-object.md +++ b/windows-ui-guide/docs/the-session-object/session-object.md @@ -13,7 +13,7 @@ There is one (and only one) object of type Session and it is called `⎕SE`. You `⎕SE` is loaded from a session file when APL starts. The name of the session file is specified by the **session_file** parameter. If no session file is defined, `⎕SE` will have no children and the session will be devoid of menu bar, tool bar and status bar components. -An additional feature is provided to establish code in the Session; for more information, see the [DyalogStartupSE](../../../windows-installation-and-configuration-guide/configuration-parameters/dyalogstartupse) configuration parameter. +An additional feature is provided to establish code in the Session; for more information, see the [DyalogStartupSE](../../../dyalog-configuration-guide/configuration-parameters/dyalogstartupse) configuration parameter. You may use all of the standard GUI system functions to build or configure the components of the Session to your own requirements. You may also control the Session by changing certain of its properties.