Skip to content

Commit

Permalink
v2.7 Update UserGuide for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
fjwright committed Dec 31, 2020
1 parent a068681 commit bc4c877
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 36 deletions.
49 changes: 32 additions & 17 deletions docs/UserGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,15 @@ <h2 id="MainWindow">The Main Window</h2>
in it (if any) is preserved and carried to the new display pane
arrangement, but any other REDUCE invocations are discarded.
</p>
<p>With a split pane, you can select synchronised scrolling so
that scrolling the selected REDUCE panel (in any way) also
scrolls the other REDUCE panel to the same relative position.
This facility is experimental and currently forces both REDUCE
panels to display content at the same (relative) position; the
other REDUCE panel cannot be scrolled from its current position
but will jump to the same relative position as the selected
REDUCE panel.
</p>
<p>With a split or tabbed pane, you can select the active REDUCE
panel by clicking on the desired panel in a split pane or tab on
a tabbed pane. You can also select the next REDUCE panel
Expand Down Expand Up @@ -781,30 +790,36 @@ <h3>Typeset Maths</h3>
Session Log...</em> outputs typeset maths using LaTeX markup.
</p>
<h3>Single Pane Display</h3>
<p>Selecting this causes Run-REDUCE to display the selected
REDUCE panel only. This is the default.
<p>Selecting this causes Run-REDUCE to display the selected REDUCE
panel only. This is the default.
</p>
<h3>Split Pane Display</h3>
<p>Selecting this causes Run-REDUCE to display two REDUCE
panels side-by-side. The left-hand panel displays the previously
selected REDUCE panel (if any) and is initially active. Clicking
on a REDUCE panel makes it active for input via its input editor
pane and the menus. The inactive REDUCE panel can continue to
update its output display. Both panels are the same size
initially, but you can change that by dragging the divider.
<p>Selecting this causes Run-REDUCE to display two REDUCE panels
side-by-side. The left-hand panel displays the previously
selected REDUCE panel (if any) and is initially active.
Clicking on a REDUCE panel makes it active for input via its
input editor pane and the menus. The inactive REDUCE panel can
continue to update its output display. Both panels are the same
size initially, but you can change that by dragging the divider.
</p>
<h3>Tabbed Pane Display</h3>
<p>Selecting this causes Run-REDUCE to display a tabbed pane
with the previously selected REDUCE panel (if any) displayed under
the first tab. Clicking on the <code>&times;</code> icon at the
right of the selected tab label removes that tab and the REDUCE
panel it contains. When there is only one tab, removing it
disables tabbed display but preserves the REDUCE panel that the
tab contained.
<p>Selecting this causes Run-REDUCE to display a tabbed pane with
the previously selected REDUCE panel (if any) displayed under
the first tab. Clicking on the <code>&times;</code> icon at the
right of the selected tab label removes that tab and the REDUCE
panel it contains. When there is only one tab, removing it
disables tabbed display but preserves the REDUCE panel that the
tab contained.
</p>
<h3>Synchronise Scrolling</h3>
<p>Selecting this synchronises the scrolling of the two REDUCE
panels in a split pane display; see <a href="#MainWindow">The
Main Window</a>. This menu item is disabled unless split pane
display is selected.
</p>
<h3>Add Another Tab</h3>
<p>This adds a new tab to a tabbed display. This menu item is
disabled unless tabbed pane display is selected.
disabled unless tabbed pane display is selected.
</p>

<h2 id="TemplatesMenu">The Templates Menu</h2>
Expand Down
49 changes: 32 additions & 17 deletions resources/UserGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,15 @@ <h2 id="MainWindow">The Main Window</h2>
in it (if any) is preserved and carried to the new display pane
arrangement, but any other REDUCE invocations are discarded.
</p>
<p>With a split pane, you can select synchronised scrolling so
that scrolling the selected REDUCE panel (in any way) also
scrolls the other REDUCE panel to the same relative position.
This facility is experimental and currently forces both REDUCE
panels to display content at the same (relative) position; the
other REDUCE panel cannot be scrolled from its current position
but will jump to the same relative position as the selected
REDUCE panel.
</p>
<p>With a split or tabbed pane, you can select the active REDUCE
panel by clicking on the desired panel in a split pane or tab on
a tabbed pane. You can also select the next REDUCE panel
Expand Down Expand Up @@ -781,30 +790,36 @@ <h3>Typeset Maths</h3>
Session Log...</em> outputs typeset maths using LaTeX markup.
</p>
<h3>Single Pane Display</h3>
<p>Selecting this causes Run-REDUCE to display the selected
REDUCE panel only. This is the default.
<p>Selecting this causes Run-REDUCE to display the selected REDUCE
panel only. This is the default.
</p>
<h3>Split Pane Display</h3>
<p>Selecting this causes Run-REDUCE to display two REDUCE
panels side-by-side. The left-hand panel displays the previously
selected REDUCE panel (if any) and is initially active. Clicking
on a REDUCE panel makes it active for input via its input editor
pane and the menus. The inactive REDUCE panel can continue to
update its output display. Both panels are the same size
initially, but you can change that by dragging the divider.
<p>Selecting this causes Run-REDUCE to display two REDUCE panels
side-by-side. The left-hand panel displays the previously
selected REDUCE panel (if any) and is initially active.
Clicking on a REDUCE panel makes it active for input via its
input editor pane and the menus. The inactive REDUCE panel can
continue to update its output display. Both panels are the same
size initially, but you can change that by dragging the divider.
</p>
<h3>Tabbed Pane Display</h3>
<p>Selecting this causes Run-REDUCE to display a tabbed pane
with the previously selected REDUCE panel (if any) displayed under
the first tab. Clicking on the <code>&times;</code> icon at the
right of the selected tab label removes that tab and the REDUCE
panel it contains. When there is only one tab, removing it
disables tabbed display but preserves the REDUCE panel that the
tab contained.
<p>Selecting this causes Run-REDUCE to display a tabbed pane with
the previously selected REDUCE panel (if any) displayed under
the first tab. Clicking on the <code>&times;</code> icon at the
right of the selected tab label removes that tab and the REDUCE
panel it contains. When there is only one tab, removing it
disables tabbed display but preserves the REDUCE panel that the
tab contained.
</p>
<h3>Synchronise Scrolling</h3>
<p>Selecting this synchronises the scrolling of the two REDUCE
panels in a split pane display; see <a href="#MainWindow">The
Main Window</a>. This menu item is disabled unless split pane
display is selected.
</p>
<h3>Add Another Tab</h3>
<p>This adds a new tab to a tabbed display. This menu item is
disabled unless tabbed pane display is selected.
disabled unless tabbed pane display is selected.
</p>

<h2 id="TemplatesMenu">The Templates Menu</h2>
Expand Down
2 changes: 1 addition & 1 deletion src/fjwright/runreduce/RunREDUCEFrame.fxml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
toggleGroup="$displayPaneButtonGroup"/>
<SeparatorMenuItem mnemonicParsing="false"/>
<CheckMenuItem fx:id="syncScrollCheckMenuItem" disable="true" mnemonicParsing="false"
onAction="#syncScrollCheckMenuItemAction" text="Synchronize Scrolling"/>
onAction="#syncScrollCheckMenuItemAction" text="Synchronise Scrolling"/>
<MenuItem fx:id="addTabMenuItem" disable="true" mnemonicParsing="false" onAction="#addTabMenuItemAction"
text="Add Another Tab"/>
</Menu>
Expand Down
2 changes: 1 addition & 1 deletion src/fjwright/runreduce/RunREDUCEFrame.java
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,7 @@ private void sourceForgeMenuItemAction() {
RunREDUCE.hostServices.showDocument("https://sourceforge.net/projects/reduce-algebra/");
}

static final String VERSION = "2.66";
static final String VERSION = "2.7";

@FXML
private void aboutMenuItemAction() {
Expand Down

0 comments on commit bc4c877

Please sign in to comment.