Skip to content

Commit 391f23c

Browse files
committed
Update documentation for v2.0 release, including a new screen shot.
1 parent 8a6c609 commit 391f23c

6 files changed

Lines changed: 39 additions & 43 deletions

File tree

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -150,14 +150,10 @@ Run-REDUCE-FX currently uses a bundled copy of
150150
the input editor and the bottom of each template dialogue.
151151
* Handle more of the non-standard TeX markup generated by fmprint.
152152

153-
### Updates since last release
153+
### Version 2.0
154+
155+
* Fix the display of big delimiters in typeset maths.
156+
* Always insert parentheses when calling a function using the pop-up
157+
keyboard, rewrite ln to log and remove the space after sqrt.
154158

155-
* v1.91 Replace all KaTeX woff2 fonts with woff versions.
156-
This fixes the big delimiters problem. I hope that WebView in a later
157-
version of JavaFX will accept woff2 fonts and I can switch back.
158-
* Add WebEngine debugging code from debugWebEngine branch.
159-
* Add div margin styles to improve vertical spacing of typeset maths.
160-
* Remove \> controls (tabs) from fmprint output, which don't seem to serve any
161-
useful purpose, using katexMacros.
162-
* Always insert parentheses when calling a function using the pop-up keyboard,
163-
and rewrite ln to log.
159+
### Updates since last release

docs/Run-REDUCE-FX.png

90.4 KB
Loading

docs/UserGuide.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -197,11 +197,11 @@ <h2 id="PopupKeyboard">The Pop-up Keyboard</h2>
197197
function button on the bottom half of the pop-up keyboard causes
198198
that function to be applied to the selected text if there is any
199199
(i.e. wrapped around it using parentheses) or otherwise to be
200-
inserted (without parentheses) at the text cursor. The pop-up
201-
then closes. The pop-up also closes if you click anywhere outside
202-
it, or you can close it by clicking on the <em>Close</em> button
203-
in the bottom left corner or by pressing the <em>Escape</em> key
204-
on your main keyboard.
200+
inserted followed by parentheses at the text cursor, which is left
201+
within the parentheses. The pop-up then closes. The pop-up also
202+
closes if you click anywhere outside it, or you can close it by
203+
clicking on the <em>Close</em> button in the bottom left corner or
204+
by pressing the <em>Escape</em> key on your main keyboard.
205205
</p>
206206
<p>If you don't have a middle mouse-button but you have a wheel
207207
mouse then pressing on the wheel may generate a middle
@@ -616,11 +616,11 @@ <h3>Typeset Maths</h3>
616616
typeset and centred horizontally. <strong>WARNINGS:</strong>
617617
Typeset Maths is currently experimental. It interacts badly
618618
with redfront I/O colouring, so don't try to use the two
619-
together: one will effectively cancel the other. Big delimiters
620-
are not handled correctly: they or their components are too
621-
small. If any TeX markup appears (coloured red) in the output
622-
then please let me know! <em>Save Session Log...</em> outputs
623-
typeset maths using TeX markup.
619+
together: one will effectively cancel the other. The display
620+
may be incorrect in some cases, such as with the switch
621+
setting <em>on list</em>. If any TeX markup appears (coloured
622+
red) in the output then please let me know! <em>Save Session
623+
Log...</em> outputs typeset maths using TeX markup.
624624
</p>
625625
<h3>Single Pane Display</h3>
626626
<p>Selecting this causes Run-REDUCE-FX to display the selected

docs/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
### Key links: [Run-REDUCE-FX.jar](https://github.com/fjwright/Run-REDUCE-FX/releases/latest/download/Run-REDUCE-FX.jar) | [Install and Run](InstallAndRun.md) | [User Guide](UserGuide.html)
22

3-
Note that Run-REDUCE-FX now requires the javafx.web module &ndash; see the [Install and Run Guide](InstallAndRun.md).
4-
53
Run-REDUCE-FX is a Graphical User Interface for running the
64
[REDUCE](https://reduce-algebra.sourceforge.io/) Computer Algebra
7-
System that should provide a fairly consistent user experience across
8-
all platforms. It is implemented in JavaFX and the executable
9-
application takes the form of the JAR file *Run-REDUCE-FX.jar*. Click
10-
on the link above to download the latest release.
5+
System that should provide a consistent user experience across all
6+
implementations of REDUCE and all platforms. It is implemented in
7+
JavaFX and the executable application takes the form of the JAR file
8+
[Run-REDUCE-FX.jar](https://github.com/fjwright/Run-REDUCE-FX/releases/latest/download/Run-REDUCE-FX.jar).
9+
Click on the link here or above to download the latest release.
1110

1211
![Run-REDUCE-FX screen shot](Run-REDUCE-FX.png "Run-REDUCE-FX screen shot")
1312

@@ -31,23 +30,24 @@ that it currently provides:
3130
distributions.
3231
* A REDUCE input/output display pane that scrolls in both directions
3332
as necessary. Its contents can be saved to a file and/or erased.
33+
* Optional typeset-style display of mathematical output.
3434
* A multi-line input editing pane that also scrolls in both directions
3535
as necessary. Previous input is remembered and can be scrolled
36-
through, edited and re-input. A final terminator can be added
36+
through, edited and re-input. A final terminator is normally added
3737
automatically if appropriate when input is sent to REDUCE.
38-
* Split or tabbed panes running independent REDUCE processes.
38+
* Optional split or tabbed panes running independent REDUCE processes.
3939
* Menu items to handle REDUCE file input/output and load standard
4040
REDUCE packages, similar to the facilities provided by the CSL
4141
REDUCE GUI.
42-
* Menu options to make the REDUCE input prompt bold and to colour the
43-
input/output display based on the input mode or redfront.
42+
* Optional bold prompts and coloured input/output text based on the
43+
input mode (algebraic or symbolic) or using redfront.
4444
* Templates to construct structured expressions and statements.
4545
* A popup keyboard to access symbolic constants, Greek letters and
4646
elementary functions.
47-
* Dialogues to access functions using conventional notation.
47+
* Dialogues to access standard mathematical functions using
48+
conventional notation.
4849
* Easy access to the Run-REDUCE-FX User Guide, the standard
4950
documentation distributed with REDUCE as HTML or PDF files, the
5051
REDUCE Web Site and the SourceForge Project Site.
51-
* Experimental typeset-style display of mathematics.
5252

5353
Francis Wright, September 2020

src/fjwright/runreduce/RunREDUCEFrame.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -644,7 +644,7 @@ private void sourceForgeMenuItemAction() {
644644
@FXML
645645
private void aboutMenuItemAction() {
646646
Alert alert = new Alert(Alert.AlertType.INFORMATION,
647-
"Version 1.91, September 2020\n" +
647+
"Version 2.0, September 2020\n" +
648648
"\u00A9 2020 Francis Wright");
649649
alert.getDialogPane().setMinHeight(Region.USE_PREF_SIZE);
650650
alert.initOwner(RunREDUCE.primaryStage);

src/fjwright/runreduce/UserGuide.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -197,11 +197,11 @@ <h2 id="PopupKeyboard">The Pop-up Keyboard</h2>
197197
function button on the bottom half of the pop-up keyboard causes
198198
that function to be applied to the selected text if there is any
199199
(i.e. wrapped around it using parentheses) or otherwise to be
200-
inserted (without parentheses) at the text cursor. The pop-up
201-
then closes. The pop-up also closes if you click anywhere outside
202-
it, or you can close it by clicking on the <em>Close</em> button
203-
in the bottom left corner or by pressing the <em>Escape</em> key
204-
on your main keyboard.
200+
inserted followed by parentheses at the text cursor, which is left
201+
within the parentheses. The pop-up then closes. The pop-up also
202+
closes if you click anywhere outside it, or you can close it by
203+
clicking on the <em>Close</em> button in the bottom left corner or
204+
by pressing the <em>Escape</em> key on your main keyboard.
205205
</p>
206206
<p>If you don't have a middle mouse-button but you have a wheel
207207
mouse then pressing on the wheel may generate a middle
@@ -616,11 +616,11 @@ <h3>Typeset Maths</h3>
616616
typeset and centred horizontally. <strong>WARNINGS:</strong>
617617
Typeset Maths is currently experimental. It interacts badly
618618
with redfront I/O colouring, so don't try to use the two
619-
together: one will effectively cancel the other. Big delimiters
620-
are not handled correctly: they or their components are too
621-
small. If any TeX markup appears (coloured red) in the output
622-
then please let me know! <em>Save Session Log...</em> outputs
623-
typeset maths using TeX markup.
619+
together: one will effectively cancel the other. The display
620+
may be incorrect in some cases, such as with the switch
621+
setting <em>on list</em>. If any TeX markup appears (coloured
622+
red) in the output then please let me know! <em>Save Session
623+
Log...</em> outputs typeset maths using TeX markup.
624624
</p>
625625
<h3>Single Pane Display</h3>
626626
<p>Selecting this causes Run-REDUCE-FX to display the selected

0 commit comments

Comments
 (0)