Skip to content

Commit

Permalink
Update documentation for v2.0 release, including a new screen shot.
Browse files Browse the repository at this point in the history
  • Loading branch information
fjwright committed Sep 14, 2020
1 parent 8a6c609 commit 391f23c
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 43 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,14 +150,10 @@ Run-REDUCE-FX currently uses a bundled copy of
the input editor and the bottom of each template dialogue.
* Handle more of the non-standard TeX markup generated by fmprint.

### Updates since last release
### Version 2.0

* Fix the display of big delimiters in typeset maths.
* Always insert parentheses when calling a function using the pop-up
keyboard, rewrite ln to log and remove the space after sqrt.

* v1.91 Replace all KaTeX woff2 fonts with woff versions.
This fixes the big delimiters problem. I hope that WebView in a later
version of JavaFX will accept woff2 fonts and I can switch back.
* Add WebEngine debugging code from debugWebEngine branch.
* Add div margin styles to improve vertical spacing of typeset maths.
* Remove \> controls (tabs) from fmprint output, which don't seem to serve any
useful purpose, using katexMacros.
* Always insert parentheses when calling a function using the pop-up keyboard,
and rewrite ln to log.
### Updates since last release
Binary file modified docs/Run-REDUCE-FX.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 10 additions & 10 deletions docs/UserGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,11 @@ <h2 id="PopupKeyboard">The Pop-up Keyboard</h2>
function button on the bottom half of the pop-up keyboard causes
that function to be applied to the selected text if there is any
(i.e. wrapped around it using parentheses) or otherwise to be
inserted (without parentheses) at the text cursor. The pop-up
then closes. The pop-up also closes if you click anywhere outside
it, or you can close it by clicking on the <em>Close</em> button
in the bottom left corner or by pressing the <em>Escape</em> key
on your main keyboard.
inserted followed by parentheses at the text cursor, which is left
within the parentheses. The pop-up then closes. The pop-up also
closes if you click anywhere outside it, or you can close it by
clicking on the <em>Close</em> button in the bottom left corner or
by pressing the <em>Escape</em> key on your main keyboard.
</p>
<p>If you don't have a middle mouse-button but you have a wheel
mouse then pressing on the wheel may generate a middle
Expand Down Expand Up @@ -616,11 +616,11 @@ <h3>Typeset Maths</h3>
typeset and centred horizontally. <strong>WARNINGS:</strong>
Typeset Maths is currently experimental. It interacts badly
with redfront I/O colouring, so don't try to use the two
together: one will effectively cancel the other. Big delimiters
are not handled correctly: they or their components are too
small. If any TeX markup appears (coloured red) in the output
then please let me know! <em>Save Session Log...</em> outputs
typeset maths using TeX markup.
together: one will effectively cancel the other. The display
may be incorrect in some cases, such as with the switch
setting <em>on list</em>. If any TeX markup appears (coloured
red) in the output then please let me know! <em>Save Session
Log...</em> outputs typeset maths using TeX markup.
</p>
<h3>Single Pane Display</h3>
<p>Selecting this causes Run-REDUCE-FX to display the selected
Expand Down
24 changes: 12 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
### 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)

Note that Run-REDUCE-FX now requires the javafx.web module &ndash; see the [Install and Run Guide](InstallAndRun.md).

Run-REDUCE-FX is a Graphical User Interface for running the
[REDUCE](https://reduce-algebra.sourceforge.io/) Computer Algebra
System that should provide a fairly consistent user experience across
all platforms. It is implemented in JavaFX and the executable
application takes the form of the JAR file *Run-REDUCE-FX.jar*. Click
on the link above to download the latest release.
System that should provide a consistent user experience across all
implementations of REDUCE and all platforms. It is implemented in
JavaFX and the executable application takes the form of the JAR file
[Run-REDUCE-FX.jar](https://github.com/fjwright/Run-REDUCE-FX/releases/latest/download/Run-REDUCE-FX.jar).
Click on the link here or above to download the latest release.

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

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

Francis Wright, September 2020
2 changes: 1 addition & 1 deletion src/fjwright/runreduce/RunREDUCEFrame.java
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ private void sourceForgeMenuItemAction() {
@FXML
private void aboutMenuItemAction() {
Alert alert = new Alert(Alert.AlertType.INFORMATION,
"Version 1.91, September 2020\n" +
"Version 2.0, September 2020\n" +
"\u00A9 2020 Francis Wright");
alert.getDialogPane().setMinHeight(Region.USE_PREF_SIZE);
alert.initOwner(RunREDUCE.primaryStage);
Expand Down
20 changes: 10 additions & 10 deletions src/fjwright/runreduce/UserGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,11 @@ <h2 id="PopupKeyboard">The Pop-up Keyboard</h2>
function button on the bottom half of the pop-up keyboard causes
that function to be applied to the selected text if there is any
(i.e. wrapped around it using parentheses) or otherwise to be
inserted (without parentheses) at the text cursor. The pop-up
then closes. The pop-up also closes if you click anywhere outside
it, or you can close it by clicking on the <em>Close</em> button
in the bottom left corner or by pressing the <em>Escape</em> key
on your main keyboard.
inserted followed by parentheses at the text cursor, which is left
within the parentheses. The pop-up then closes. The pop-up also
closes if you click anywhere outside it, or you can close it by
clicking on the <em>Close</em> button in the bottom left corner or
by pressing the <em>Escape</em> key on your main keyboard.
</p>
<p>If you don't have a middle mouse-button but you have a wheel
mouse then pressing on the wheel may generate a middle
Expand Down Expand Up @@ -616,11 +616,11 @@ <h3>Typeset Maths</h3>
typeset and centred horizontally. <strong>WARNINGS:</strong>
Typeset Maths is currently experimental. It interacts badly
with redfront I/O colouring, so don't try to use the two
together: one will effectively cancel the other. Big delimiters
are not handled correctly: they or their components are too
small. If any TeX markup appears (coloured red) in the output
then please let me know! <em>Save Session Log...</em> outputs
typeset maths using TeX markup.
together: one will effectively cancel the other. The display
may be incorrect in some cases, such as with the switch
setting <em>on list</em>. If any TeX markup appears (coloured
red) in the output then please let me know! <em>Save Session
Log...</em> outputs typeset maths using TeX markup.
</p>
<h3>Single Pane Display</h3>
<p>Selecting this causes Run-REDUCE-FX to display the selected
Expand Down

0 comments on commit 391f23c

Please sign in to comment.