Skip to content

Commit d9b19df

Browse files
committed
Update UserGuide.
1 parent 757e029 commit d9b19df

3 files changed

Lines changed: 44 additions & 13 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## A JavaFX GUI to run any CLI version of the REDUCE Computer Algebra System
44

5-
### Francis Wright, October 2020
5+
### Francis Wright, November 2020
66

77
Run-REDUCE-FX is a re-implementation of
88
[Run-REDUCE](https://fjwright.github.io/Run-REDUCE/) using JavaFX
@@ -260,3 +260,4 @@ selected.
260260
* Give sqrt a width of 3 but remove the width of the n in an nth root.
261261
The output from "int.tst" is now reasonable.
262262
* v2.25 Highlight warnings and errors with an appropriate background colour.
263+
* Update UserGuide.

docs/UserGuide.html

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,12 @@ <h3>Clear I/O Display</h3>
472472
the <em>Save / Append Session Log...</em> item on
473473
the <em>File</em> menu before clearing!
474474
</p>
475+
<h3>Restart REDUCE</h3>
476+
<p>This does a full clean restart of the last-run REDUCE command,
477+
which is equivalent to <em>Stop REDUCE</em> followed
478+
by <em>Clear I/O Display</em> followed by running the last-run
479+
REDUCE command.
480+
</p>
475481
<h3 id="Configure">Configure REDUCE...</h3>
476482
<p>This displays a dialogue that allows you to configure the
477483
REDUCE directories and commands. The defaults should work for
@@ -643,6 +649,9 @@ <h3>I/O Colouring</h3>
643649
input are red, algebraic-mode output is blue, and echoed file
644650
input and symbolic-mode output are not coloured.
645651
</p>
652+
<p>When I/O colouring is enabled, Run-REDUCE-FX highlights
653+
warnings and errors with appropriate background colours.
654+
</p>
646655
<p>Note that turning I/O colouring on does not fully take effect
647656
until the next input prompt. Turning I/O colouring off (by
648657
selecting <em>None</em>) takes effect immediately and turning it
@@ -658,10 +667,10 @@ <h3>Typeset Maths</h3>
658667
Typeset Maths is currently experimental. It interacts badly
659668
with redfront I/O colouring, so don't try to use the two
660669
together: one will effectively cancel the other. The display
661-
may be incorrect in some cases, such as with the switch
662-
setting <em>on list</em>. If any TeX markup appears (coloured
663-
red) in the output then please let me know! <em>Save Session
664-
Log...</em> outputs typeset maths using TeX markup.
670+
may be incorrect in some cases, e.g. with unusual switch
671+
settings such as <em>on list</em>. If any TeX markup appears
672+
(coloured red) in the output then please let me know! <em>Save
673+
Session Log...</em> outputs typeset maths using TeX markup.
665674
</p>
666675
<h3>Single Pane Display</h3>
667676
<p>Selecting this causes Run-REDUCE-FX to display the selected
@@ -967,11 +976,15 @@ <h3>Differences from the CSL REDUCE GUI, etc.</h3>
967976
(the name of) a single character. As a special case, display
968977
<code>identifier_bar</code> as
969978
\(\overline{\mathit{identifier}}\) (for
970-
any <code>identifier</code>). See the examples in the table
979+
any <code>identifier</code>), which can be followed by digits
980+
or "_" as described above. See the examples in the table
971981
below. Ignore <code>fancy_lower_digits</code>.</li>
972982
<li>Display <code>repart</code> and <code>impart</code> as
973983
\(\Re\) and \(\Im\).</li>
974-
<li>Line breaking is currently thoroughly broken!</li>
984+
<li>Display <code>abs(x)</code> as \(|x|\) and matrix
985+
assignments as assignments.</li>
986+
<li>Do not display superfluous space around commas in algebraic
987+
lists and flat printed matrix rows.</li>
975988
</ul>
976989
<table>
977990
<tr><th>Identifier</th><th>Displays as</th></tr>
@@ -983,6 +996,8 @@ <h3>Differences from the CSL REDUCE GUI, etc.</h3>
983996
<tr><td><code>z_bar</code></td><td>\(\bar{z}\)</td></tr>
984997
<tr><td><code>complex_variable_bar</code></td>
985998
<td>\(\overline{\mathit{complex\_variable}}\)</td></tr>
999+
<tr><td><code>z_bar123</code></td><td>\(\bar{z}_{123}\)</td></tr>
1000+
<tr><td><code>z_bar_k</code></td><td>\(\bar{z}_k\)</td></tr>
9861001
</table>
9871002
<h3>Derivatives</h3>
9881003
<p>

src/fjwright/runreduce/UserGuide.html

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,12 @@ <h3>Clear I/O Display</h3>
472472
the <em>Save / Append Session Log...</em> item on
473473
the <em>File</em> menu before clearing!
474474
</p>
475+
<h3>Restart REDUCE</h3>
476+
<p>This does a full clean restart of the last-run REDUCE command,
477+
which is equivalent to <em>Stop REDUCE</em> followed
478+
by <em>Clear I/O Display</em> followed by running the last-run
479+
REDUCE command.
480+
</p>
475481
<h3 id="Configure">Configure REDUCE...</h3>
476482
<p>This displays a dialogue that allows you to configure the
477483
REDUCE directories and commands. The defaults should work for
@@ -643,6 +649,9 @@ <h3>I/O Colouring</h3>
643649
input are red, algebraic-mode output is blue, and echoed file
644650
input and symbolic-mode output are not coloured.
645651
</p>
652+
<p>When I/O colouring is enabled, Run-REDUCE-FX highlights
653+
warnings and errors with appropriate background colours.
654+
</p>
646655
<p>Note that turning I/O colouring on does not fully take effect
647656
until the next input prompt. Turning I/O colouring off (by
648657
selecting <em>None</em>) takes effect immediately and turning it
@@ -658,10 +667,10 @@ <h3>Typeset Maths</h3>
658667
Typeset Maths is currently experimental. It interacts badly
659668
with redfront I/O colouring, so don't try to use the two
660669
together: one will effectively cancel the other. The display
661-
may be incorrect in some cases, such as with the switch
662-
setting <em>on list</em>. If any TeX markup appears (coloured
663-
red) in the output then please let me know! <em>Save Session
664-
Log...</em> outputs typeset maths using TeX markup.
670+
may be incorrect in some cases, e.g. with unusual switch
671+
settings such as <em>on list</em>. If any TeX markup appears
672+
(coloured red) in the output then please let me know! <em>Save
673+
Session Log...</em> outputs typeset maths using TeX markup.
665674
</p>
666675
<h3>Single Pane Display</h3>
667676
<p>Selecting this causes Run-REDUCE-FX to display the selected
@@ -967,11 +976,15 @@ <h3>Differences from the CSL REDUCE GUI, etc.</h3>
967976
(the name of) a single character. As a special case, display
968977
<code>identifier_bar</code> as
969978
\(\overline{\mathit{identifier}}\) (for
970-
any <code>identifier</code>). See the examples in the table
979+
any <code>identifier</code>), which can be followed by digits
980+
or "_" as described above. See the examples in the table
971981
below. Ignore <code>fancy_lower_digits</code>.</li>
972982
<li>Display <code>repart</code> and <code>impart</code> as
973983
\(\Re\) and \(\Im\).</li>
974-
<li>Line breaking is currently thoroughly broken!</li>
984+
<li>Display <code>abs(x)</code> as \(|x|\) and matrix
985+
assignments as assignments.</li>
986+
<li>Do not display superfluous space around commas in algebraic
987+
lists and flat printed matrix rows.</li>
975988
</ul>
976989
<table>
977990
<tr><th>Identifier</th><th>Displays as</th></tr>
@@ -983,6 +996,8 @@ <h3>Differences from the CSL REDUCE GUI, etc.</h3>
983996
<tr><td><code>z_bar</code></td><td>\(\bar{z}\)</td></tr>
984997
<tr><td><code>complex_variable_bar</code></td>
985998
<td>\(\overline{\mathit{complex\_variable}}\)</td></tr>
999+
<tr><td><code>z_bar123</code></td><td>\(\bar{z}_{123}\)</td></tr>
1000+
<tr><td><code>z_bar_k</code></td><td>\(\bar{z}_k\)</td></tr>
9861001
</table>
9871002
<h3>Derivatives</h3>
9881003
<p>

0 commit comments

Comments
 (0)