diff --git a/build.xml b/build.xml
index 75079131fb3..8c7a535f8eb 100644
--- a/build.xml
+++ b/build.xml
@@ -458,7 +458,7 @@
-
+
diff --git a/help/en/Acknowledgements.shtml b/help/en/Acknowledgements.shtml
index 193074ac8ca..08a768852fa 100644
--- a/help/en/Acknowledgements.shtml
+++ b/help/en/Acknowledgements.shtml
@@ -104,6 +104,9 @@
general has made more contributions than can be
counted.
+
Daniel Bergqvist, who added the "ask before shutdown" code,
+ improved the Bundle code and added to the Swedish translation
+
Andrew Berridge, who debugged and fixed problems with
the SPROG serial interface
@@ -472,7 +475,8 @@
Ian Havercroft, who provided the correct identification
codes for ESU decoders
-
David Heap, who provided a QSI decoder fix
+
David Heap, who provided a QSI decoder fix
+ and improved how signal head aspects are supported.
Rob Heikens, who created ESU decoder definitions and
programmer pages
@@ -975,7 +979,9 @@
comboboxes (with drop-down menus); added a 2nd turnout
circle for slips and added left, right & bottom options
for the toolbar (and re-laid out same) in the Layout Editor.
- Also wrote all the slip code for the web server.
+ Added support for DMX512 lighting.
+ Also wrote all the slip code for the web server.
+
Mark Waters, who provided numerous Zimo decoder
definitions and new Zimo MX620 definitions.
+ Certain command stations
can only access up to CV 256 or CV512. Some decoder
manufacturers have built in mechanisms to bypass this. For
example, some ESU decoders can use writes to various CVs to
@@ -624,22 +625,39 @@ selects the different algorithm needed here.
-
Accessory Decoder Ops Mode
Special programming
- packets are used by certain accessory decoders to configure
- their CVs from the DCC track signal. The capability to do
- that is written:
+
Accessory Decoder Ops Mode
+ Certain accessory decoders require special
+ programming packets to configure their CVs from the DCC track signal.
+ The capability to do that is written:
If it is "decoder" or omitted, the current address is interpreted as a 9-bit accessory decoder address.
If it is "accessory" or "output", the current address is interpreted as an 11-bit accessory output address.
If it is "signal", the current address is interpreted as an 11-bit signal decoder address.
+
+ If it is "altsignal", the current address is interpreted as an 11-bit signal decoder address,
+ using an alternative interpretation of
+ NMRA standard 9.2.1).
+
+
+ If it is "legacy", the current address is interpreted as a 9-bit address (as for "decoder")
+ but a "legacy" programming packet (as per Appendix A of
+ NMRA standard 9.2.1)
+ is sent.
+
-
+ The "Delay" parameter is optional and specifies a minimum delay (in milliseconds)
+ between successive writes. Some decoders will miss commands if the delay is too short.
+ If this is parameter is omitted, the default delay is 500 milliseconds.
+
Note that this only works for
ops-mode writes; these particular NMRA DCC packets do not perform
read operations, nor do they work in the service mode (programming
@@ -670,6 +688,36 @@ selects the different algorithm needed here.
NMRA standard 9.2.2.
+
+
Ops Mode Delayed Programming
+
+ Most locomotive decoders accept special programming packets
+ to configure their CVs from the DCC track signal (Programming on Main).
+
+ However these packets take time to process and if subsequent packets are sent
+ too soon they can be missed.
+ The capability to do add a delay after programming each CV is written:
+
The "Delay" parameter specifies
+ a minimum delay (in milliseconds) between successive writes.
+ Some decoders miss commands if the delay is too short.
+ If this is parameter is omitted, the default delay is 500 milliseconds.
+
+ Note that this only works for
+ ops-mode writes; these particular NMRA DCC packets do not perform
+ read operations, nor do they work in the service mode (programming track).
+
+
+ Note also that this particular capability only works for multi-function
+ decoders. Accessory decoders need to use the
+ Accessory Decoder Ops Mode
+ capability, which has its own "Delay" parameter.
+
+
Indexed CV Access
To access indexed CVs, include this
diff --git a/help/en/html/apps/PanelPro/ShowPanel.shtml b/help/en/html/apps/PanelPro/ShowPanel.shtml
index ac01785f8b6..52e765823be 100644
--- a/help/en/html/apps/PanelPro/ShowPanel.shtml
+++ b/help/en/html/apps/PanelPro/ShowPanel.shtml
@@ -7,7 +7,8 @@
"HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 15.17), see www.w3.org">
- JMRI: Displaying JMRI Panel Files
+ JMRI: Displaying JMRI Panel Files
+
-
+
+
@@ -37,6 +39,9 @@
You open your panel file with a web browser, and can then
read it, print it, copy and paste into a file of another
form, etc.
+
- where the 1st part of the "pull" is the
- URL for Arnie's repository.
+ where the 1st part of the "remote add" is the
+ URL for Arnie's repository, and you just have to
+ do that command once to define "arnie" as an alias
+ you can use in "git fetch".
Now Bill can work with that code, and even change
@@ -629,6 +633,9 @@
git commit -m"Fixed a bug in sternerstat handling"
git push
+ which commits the changes and pushes them up
+ into Bill's repository on Github.
+
Then Arnie can merge those changes into
his own copy with:
diff --git a/help/en/html/doc/Technical/I8N.shtml b/help/en/html/doc/Technical/I8N.shtml
index 42e8f40093f..78f83bad37f 100644
--- a/help/en/html/doc/Technical/I8N.shtml
+++ b/help/en/html/doc/Technical/I8N.shtml
@@ -427,6 +427,88 @@ using the new .properties files.
If all is well, all the message text will have been translated to UPPER CASE.
Anything you wrote that remains in lower case has not been completely internationalized.
+
+
Bundle Keys Report
+
BundleKeysReport.py, located in the scripts (not jython) directory,
+is used to analyse the bundle keys within a property file. The primary function is
+to identify unused keys. The script is run using PanelPro Panels >>
+Run Script... The output from the script is written to the Script
+Output window. The run time will vary based on the number of keys to be checked
+along with the position in the source hierarchy. It will range from several to many
+seconds.
+
+
Once a property file, normally the default/English file, is selected, all of the
+classes within the package are scanned for each key in the file. if there are
+more packages below the initial one, their classes are also scanned. This
+covers the bundle hierarchy. Note: It is possible to get false
+positive matches when a class is using a matching key but the class is using a
+private property file.
+
+
After the unused key list is built, the entire source tree is scanned for external
+references to the selected property file. If the class containing the reference uses
+any of the unused keys, those keys are removed from the unused key list. The jython
+directory is also scanned for external references.
+
+
After the scanning is done, a dialog box prompts to save the unused key list. If
+desired, the list will be written with the selected location and name.
+The default location will be the User Files Location.
+
+
The final dialog box asks if the property files should be updated. If Yes is
+selected, all of the property files in the bundle set are backed up. Each file is
+then scanned for the unused keys. When one is found, the line is updated with
+#NotUsed as a comment. If testing reveals that the key is
+actually required, the comment can be removed. Note:If
+the source tree is managed by Git, the backups will be included in the current
+branch. Either move the backups or don't select them when doing a commit.
+
+
+
Class Keys Report
+
ClassKeysReport.py, located in the scripts (not jython) directory,
+is used to identify the bundle keys used by a class. The script is run using
+PanelPro Panels >> Run Script... The output from the
+script is written to the Script Output window.
+
+
When the script is started, a file selection dialog is displayed. Select either
+a Java class file or a Java package directory. If a directory is selected, all
+of the *.java files within the directory will be processed. The Bundle.java file
+is excluded.
+
+
For each file, the script scans for Bundle.getMessage( and
+getString(. The first word after the
+parenthesis is returned as the bundle key. A word is defined as the characters
+a-z, A-Z, 0-9 and underscore. If the first word is a Locale reference, the
+second word is returned.
+
+
Here is a typical output line:
+
+ 783, Search Type = Local, Key Type = Variable, Key = 'titleId', Text = addLogixFrame = new JmriJFrame(rbx.getString(titleId));
+
+Field List
+
+
The source code line number
+
Search Type
+
+
Local: getString, such as rbx.getString()
+
Bundle: getMessage()
+
+
+
Key Type
+
+
String: A word wrapped in double quotes
+
Variable: A plain word
+
+
+
The key
+
The source code line
+
+
Only the variable key types are displayed in the script output window.
+Note: A key that contains non-word characters will be truncated
+and assigned the Variable key type.
+
+
+
When the script is done scanning, it provides an option to export the entire
+key list to a CSV file.
+
diff --git a/help/en/html/doc/Technical/gitdeveloper.shtml b/help/en/html/doc/Technical/gitdeveloper.shtml
index df5fe08de67..2fe96b2ef4a 100644
--- a/help/en/html/doc/Technical/gitdeveloper.shtml
+++ b/help/en/html/doc/Technical/gitdeveloper.shtml
@@ -257,7 +257,10 @@ To push the current branch and set the remote as upstream, use
-
Submit a Pull Request
The last step is to make your
+
Submit a Pull Request
+
+ Once your changes are complete and ready to go,
+ the last step is to make your
changes, already visible in your GitHub repository, known to
the JMRI maintainers so that one of them can pull it into the
main JMRI repository. To do that, you create and submit a
@@ -322,7 +325,7 @@ To push the current branch and set the remote as upstream, use
If you have any questions about the use of those on your PR,
you can add a comment to the PR and somebody will get back to you.
-
If there are any problems, you can make additional edits,
+
If there are any problems found in the CI process, you can make additional edits,
commit those files to the same branch, and push them
to your repository. That'll get them included in an updated
version of your PR automatically, rerun the tests, etc.
diff --git a/help/en/html/hardware/loconet/Addressing.shtml b/help/en/html/hardware/loconet/Addressing.shtml
index 6704d2efb54..7ecaf81e649 100644
--- a/help/en/html/hardware/loconet/Addressing.shtml
+++ b/help/en/html/hardware/loconet/Addressing.shtml
@@ -608,6 +608,31 @@
use both, you should skip version 1 by providing just the
LOCONETSV2MODE option.
+
+
Addressing Op Switches in Digitrax boards
+
(The following was first fully available in JMRI
+ 4.9.7. Versions before that may not be complete).
+
+
Digitrax boards like the PM4, BDL168, SE8c and
+ DS64 use a special protocol to program their Op Switches.
+ If you specify a programming mode of LOCONETBDOPSWMODE,
+ DecoderPro will use that protocol.
+
+
CVs are specified with the format "113.3",
+ where the part after the period is the specific
+ Op Switch number, and the part before is
+ board-specific:
JMRI can communicate with an Uhlenbrock Intellibox via the
- Intellibox built-in serial port, the Intellibox-II USB port
- and the LocoNet® protocol. This page provides details on
- the possibilities.
+ Intellibox built-in serial port, the Intellibox II/Basic USB port
+ and the LocoNet™ protocol.
+ This page provides details on the possibilities.
+
Supported Hardware
Command Station
-
Intellibox-I
-
-
Intellibox-II
+
Intellibox
+
Intellibox IR
+
Intellibox Basic
+
Intellibox II
IB-Com
Fleischmann Twin Center (software version 1.1 or
later)
-
+
+
Limitations
Full support of Intellibox-II has been added to JMRI in
version 3.11.1 and up. It is not available in previous
versions 3.10 and below.
-
+
+
Connecting
Direct serial connection
This section is applicable to the
- "Intellibox-I", which includes
+ "Intellibox-I" group, which includes
Intellibox command stations are divided into two types,
- called "Intellibox-I":
+
Intellibox command stations are divided into two groups:
+
"Intellibox-I (Serial)":
Intellibox ref. 65000
@@ -159,7 +163,9 @@
Fleischmann Twin Center (software version 1.1 or
later)
-
and "Intellibox-II":
+
+
+
"Intellibox-II (USB)":
Intellibox II ref. 65100
@@ -172,17 +178,30 @@
Start the JMRI program and configure it to:
-
Select "Digitrax" as the System Manufacturer for your
- connection
+
Select "Uhlenbrock" as the System Manufacturer for your
+ connection.
Select the appropriate System Connection for your
- hardware.
+ hardware, either Intellibox-I or -II.
+
+
Select the serial port used for this connection.
+
+
The single corresponding Command Station (group) choice will be selected
+ automatically.
+
+
If diseried, adjust the system prefix and connection user name.
+ Note that an existing panel contains a certain prefix and changing this
+ option here will lead to an error upon loading such a panel.
+
+
+
Save and restart.
+
+
+
JMRI Uhlenbrock Tools
-
Select either the "Intellibox-I" or "Intellibox-II" as
- the Command Station Type.
- Save and restart.
+
The Intellibox Command Stations can't be configured over their
+ LocoNet connection. Please use the keyboard and consult the manual.
This page provides an example of using the JMRI Simple
Signal Logic (in short: SSL) to control Signals Heads
- connected to a Digitrax SE8c board. This also works for other
+ connected to a Digitrax SE8C board. This also works for other
types of single head hardware signals, including LEDs
connected to stationary decoders, C/MRI systems, etc.
Please try our ready-to-use example
@@ -173,9 +175,9 @@ Red, Red and Yellow respectively.
To learn how signals are configured in SSL, open the
"Simple Signal Logic" item in the Tools menu. In the pane that opens,
enter a Signal (Head) Name, e.g. "Section 5A", in the top
text field and hit the Return key. You should get
@@ -267,7 +269,7 @@ Red, Red and Yellow respectively.
You can also use the "Add..." button on the Turnout
Table to open a pane to enter new Turnouts.
-
The "Turnout Control..." pane in the Tools menu
+
The "Turnout Control..." pane, found in the Tools menu,
also creates a new Turnout entry for every turnout
address you operate.
@@ -275,20 +277,19 @@ Red, Red and Yellow respectively.
If you have Signal Heads connected to "turnout-type"
outputs, tell the program about those Turnout addresses too
- (SE8c users skip this step).
+ (SE8C users skip this step).
+
Tell PanelPro
- how your Signal Heads are addressed:
-
From the Tools menu, open the "Tables" >
- "Signals" > "Signal Heads" tool.
+
From the PanelPro Tools menu, open the Tables
+ > Signals > Signal Heads tool.
Click the "Add..."
@@ -353,9 +354,9 @@ Red, Red and Yellow respectively.
Logic (SSL) Tool.
Open the "Simple Signal Logic" tool from the "Tools"
menu. You should get a pane with a number of fields:
-
diff --git a/help/en/images/SslExample.png b/help/en/images/SslExample.png
new file mode 100644
index 00000000000..5b1a2c21522
Binary files /dev/null and b/help/en/images/SslExample.png differ
diff --git a/help/en/package/jmri/jmrit/blockboss/BlockBossFrame.shtml b/help/en/package/jmri/jmrit/blockboss/BlockBossFrame.shtml
index 3615effefdb..27bca70ed26 100644
--- a/help/en/package/jmri/jmrit/blockboss/BlockBossFrame.shtml
+++ b/help/en/package/jmri/jmrit/blockboss/BlockBossFrame.shtml
@@ -8,7 +8,7 @@
JMRI: Simple Signal Logic
-
+
-
JMRI: Simple Signal Logic
+
JMRI: Simple Signal Logic
+
Contents
The documentation below describes Signaling with JMRI
@@ -41,8 +41,9 @@
Simple Signal Logic (SSL) provided the first method to
@@ -56,7 +57,7 @@
Don't use the SSL Tool when you have already built Signal
Masts and the more advanced Signal Mast Logic in the same
Panel/Configuration file.
- SSL has no tool to delete an SSL entry or provide an overview
+ SSL has no option to delete an SSL entry or provide an overview
of all SSL rules other than looking at the XML file of your
Panel, so make notes as you add SSL items and back up your
configuration XML file.
@@ -73,9 +74,9 @@
means for setting up basic signals in an intuitive manner,
without the user having to be familiar with all of the logic
necessary to account for the different Signal Aspects.
-
The Simple Signal Logic Tool allows you to configure JMRI
@@ -84,21 +85,21 @@
each Signal Head on:
-
Signal Head Named The Signal Head being
+
For Signal Head: The Signal Head being
driven.
-
Protects Sensor/s Which sensors (occupancy
+
Protects Sensor/s: Which sensors (occupancy
detectors) cover the block immediately past the signal.
When any of these sensors show "active" the Signal Head
will be set to red.
-
Red When Turnout If the block contains a
- Turnout, enter the Turnout System Name and use the
- selection button to choose whether you're entering the
- Closed or Thrown leg. The Signal Head will be set to red
+
Red When Turnout: If the block contains a
+ Turnout, pick or enter the Turnout System Name and use the
+ selection buttons to choose whether you're entering the
+ Closed or Thrown leg. The Signal Head will be set to Rred
whenever the turnout is set against this track.
-
Protects Signal The next Signal Head that the
+
Protects Signal: The next Signal Head that the
train will reach; this Signal Head will be set Yellow if
the next signal head is red.
@@ -108,20 +109,20 @@
signal head is yellow, thereby giving four-block
signaling.
-
Limited Speed If the checkbox is checked, this
+
Limited Speed If this checkbox is checked, this
Signal Head will be set to Yellow as the least restrictive
Aspect.
-
Restricting Speed If the checkbox is checked, this
+
Restricting Speed If this checkbox is checked, this
Signal Head will be set to Flashing Red as the least restrictive
Aspect.
-
Is Distant Signal If the checkbox is checked,
+
Is Distant Signal If this checkbox is checked,
this Signal will be set to the most restrictive aspect of
either this Signal Head or the next protected Signal
Head.
-
Approach Lighting Sensor The sensor that
+
Approach Lighting Sensor: The sensor that
controls whether this Signal Head is lit or not. Only the
actual hardware Signal Head on the layout will go dark.
Panel indicators will show the normal signal Appearance.
@@ -145,9 +146,9 @@
required for each one.
Pause your mouse over any entry or item in the SSL
- creation window for a brief "tooltip" help reminder.
+ creation pane for a brief "tooltip" help reminder.
-
It's clear that this won't cover complicated interlockings
+
It's clear that SSL won't cover complicated interlockings
nor will it cover the speed-signaling seen on some
prototypes. However, when combined with the logic
capabilities of JMRI
-
In the Add New Signal window that appears choose the
+
In the Add New Signal Head pane that appears, choose the
"Virtual Signal" type.
-
Enter a system name such as IH1000.
+
Enter a system name such as "IH1000".
-
Click OK to enter this head into the Signal Head
+
Click Create to enter this head into the Signal Head
Table.
-
Enter all the signal heads that you will be using for
+
Enter all the Signal Heads that you will be using for
this test, using different names. The actual name doesn't
matter, they just have to be different.
-
Now select Simple Signal Logic in the
+
Now select Simple Signal Logic... in the
Tools menu.
-
Fill in the various entries to match your signals
+
Fill in the various entries to match your signal's
requirements as previously shown.
Click Apply to make this entry active.
@@ -211,24 +213,24 @@
Check to be sure that the outputs (Turnout addresses)
that will control your Signals Heads are in the Turnout
- Table. If not, click the Add button at the bottom of
- the Turnout Table.
+ Table. If not, click the Add... button at the bottom
+ of the Turnout Table.
In the Add New Turnout window that appears, enter a
- system name, (e.g. LT1) and "test" for user name, then
- click OK.
+ System Name, (e.g. "LT1") and "test" for User Name, then
+ click Create. Note: All System Names of JMRI objects must follow
- the JMRI Naming rules, starting with a capital letter for
- the DCC connection type (e.g. L for LocoNet) followed bij a
+ the JMRI Naming rules, starting with a capital prefix for
+ the DCC connection type (e.g. "L" for LocoNet) followed bij a
capital T in the case of Turnouts and the actual hardware
- number of the Turnout.
+ address of the Turnout.
Clicking on the corresponding Closed/Thrown
entries in the Turnout Table should now cause your Signal
- Head to change.
+ Head to change state.
-
Select Signal Head Table in the Tools
- menu.
+
Select Signal Heads in the Tools > Tables
+ > Signals menu.
In the Signal Head Table window that appears, click
Add... to begin defining a new Signal Head.
@@ -237,35 +239,38 @@
correct signal type to match your hardware. The required
item boxes will appear.
-
Enter a system name. For example LH152. Note:
- Signal Head system names must start with CH, IH, LH, NH,
- XH, etc. and be followed by the number of the Signal
- Head.
+
Enter a System Name, for example "LH152". Note:
+ Signal Head system names must start with the connection
+ prefix plus "H" for Head (i.e. CH, IH, LH, NH, XH, etc.)
+ and be followed by the hardware address ("number") of the
+ Signal Head.
-
Next enter one or more Turnout numbers that will
- control this signal. Note: In the case of SE8c style
- signals just enter the first Turnout number of each pair.
+
Next pick or create one or more Turnouts that will
+ control this Signal Head. Note: In the case of
+ SE8C connected signals, just enter the first Turnout number
+ of each pair.
The second Turnout number is automatically known.
-
Click OK to enter this head into the Signal Head
- Table.
+
Click Create to enter this head into the Signal
+ Head Table.
Enter all the Signal Heads that you will be using.
-
Now select Simple Signal Logic in the
- Tools menu.
+
Now select Simple Signal Logic... in the
+ PanelPro Tools menu.
Fill in the various entries to match the requirements
- of your first Signal (Head) as previously shown.
+ of your first signal as previously shown.
Click Apply to make this entry active.
-
Repeat steps 13-14 for each of your Signal Heads
+
Repeat steps 13-14 for each of your Signal Heads.
Be sure to save your work by selecting "Save Panels..."
from the Panels menu.
diff --git a/help/en/package/jmri/jmrit/blockboss/SimpleSignalExample.shtml b/help/en/package/jmri/jmrit/blockboss/SimpleSignalExample.shtml
index 96a8b6ed0aa..0ed7598c3d8 100644
--- a/help/en/package/jmri/jmrit/blockboss/SimpleSignalExample.shtml
+++ b/help/en/package/jmri/jmrit/blockboss/SimpleSignalExample.shtml
@@ -6,7 +6,8 @@
- JMRI: Simple Signal Logic Example
+ JMRI: Simple Signal Logic Example
+
Go to the Simple
- Signal Logic example.
+ Signal Logic example.
-
+
@@ -53,8 +53,8 @@
have installed after using the Open File System
Directory menu item in one of the Icon Editor windows and
pressed the Add to Catalog button there. (The "Add to
- Catalog" button does not appear in this window.) Below the
- trees is a "Preview" pane that displays the images found in
+ Catalog" button does not appear in this window.) Next to each
+ tree is a "Preview" pane that displays the images found in
any node that you have selected from one of the above trees.
"Nodes" are the folder icons that appear when you click on
the handle to the left of a folder icon. Clicking on a node
@@ -64,14 +64,14 @@
The "Preview" pane has a label that states how many image
files are referenced in the node. Beneath each image (icon)
is a label that states the "scale" at which the image is
- displayed. Below the icons are radio buttons that provide
- three background for the icons. This may help you determine
- what parts of the icon are opaque and what parts are
- transparent.
+ displayed. Below the icons are "View on:" combo boxes
+ that allow you to choose a background for the icons.
+ This may help you determine what parts of the icon are
+ opaque and what parts are transparent.
The right side is the Image Index you may edit. It
- is similar to the left pane in that the top panel is the tree
- of the Index you are creating. Likewise, the bottom panel
+ is similar to the left pane in that the left half shows the tree
+ of the Index you are creating. Likewise, the right half
displays the images found in any node of the tree that you
select. Initially, there will be just one node labeled "Image
Index". You are able to add additional nodes to this node by
@@ -79,28 +79,36 @@
The Menus
-
The Find Icons menu has two items:
+
The File menu shown with the Create/Edit Image Index
+ pane contains three items:
-
Store ImageIndex. This stores a permanent record
+
Store Image Index. This stores a permanent record
of the Image Index that will be restored the next time the
Panel Editor is opened. The Image Index will be included in
- the Catalog trees used by the Icon Editors.
+ the Catalog trees used by the Icon Editors.
+
Open a File System Directory. This opens a file
- chooser dialog where you may open any directory that that
+ chooser dialog where you may open any directory that
has image files. To open the directory, select any image
- file contained in it and a window will attempt to display
- all the image files found in the directory.
-
-
+ file contained in it and a pane will attempt to display
+ all the image files found in that directory.
+ See Icon
+ Editors for more details on this menu item.
-
The icons displayed in the "preview" panel of any
+ The icons displayed in the "preview" panel of any
directory window opened from this menu item can be added
to the Image Index. How to do this is described
- below.
+ below.
+
+
+
+ Search File System for Icons. Opens a file chooser
+ dialog to start a search for image files. A panel filled with
+ all found image files is shown as the search finishes.
+ Drag one of the found icons to your Catalog.
@@ -154,11 +162,12 @@
Index node.
-
Note: the "preview" panel will only show these
+
Note: the "preview" pane will only show these
changes after leaving the node and then returning to the
node.
-
+
+
diff --git a/help/en/package/jmri/jmrit/catalog/ImageIndex.png b/help/en/package/jmri/jmrit/catalog/ImageIndex.png
index 68f4e014b79..e420ef1a36c 100644
Binary files a/help/en/package/jmri/jmrit/catalog/ImageIndex.png and b/help/en/package/jmri/jmrit/catalog/ImageIndex.png differ
diff --git a/help/en/package/jmri/jmrit/catalog/ImageIndex.shtml b/help/en/package/jmri/jmrit/catalog/ImageIndex.shtml
index 9a0a69105b8..33c94b34bc7 100644
--- a/help/en/package/jmri/jmrit/catalog/ImageIndex.shtml
+++ b/help/en/package/jmri/jmrit/catalog/ImageIndex.shtml
@@ -1,6 +1,5 @@
-
In either editor,
when in edit mode, the last item in the File menu is
- Change view to "..." ("..." being the other editor).
+ Change view to "xx" ("xx" being the other editor).
Selecting this item switches the view from one editor mode to
the other editor mode.
@@ -75,13 +75,14 @@
Panel Editor does not. In Panel Editor the Edit menu
opens an edit window. In Control Panel Editor the Edit
menu adds three additional menus to the panel: File,
- Options, Zoom, AddItems, Circuit
+ Options, Zoom, Add Items, Circuit
Builder and Draw Shapes.
Control Panel Editor Menus
When in Edit mode, the
following menus are displayed.
-
File Menu
The File menu changes it items
+
File Menu
+ The File menu changes its items
between edit mode and operating mode. In edit mode the items
are the same as the items in the File menu of the Panel
Editor's edit window with a few additional items. They are:
@@ -99,7 +100,7 @@
Change View to Panel Editor
-
Delete This Panel...
+
Delete this Panel...
Close Editor
@@ -164,7 +165,8 @@
The menu also has items for setting Panel
Scrollbars and to Show Tooltips.
-
Zoom Menu
The Zoom(percentage)... item will
+
Zoom Menu
+ The Zoom(percentage)... item will
enlarge or reduce the panel size.
The Zoom to Fit item will enlarge or reduce the
@@ -178,15 +180,19 @@
panel window, then you should repeat "Zoom to Fit" to resize
the display to fit the new panel window dimensions.
-
AddItems Menu
The Item Palette menu item opens
+
Add Items Menu
+ The Item Palette menu item opens
a tabbed window which allows you to add item icons to the
panel. Each item type has a tab in the window. Adding items
is done by drag and drop. Iconic items may have multiple sets
of icons to choose from. Icon sets may be customized and
added or deleted to suit the user. Details may be found at
- The Item Palette. Note that
- the Item Palette can also be opened with the accelerator key,
- Control P.
+ The Item Palette help.
+ Note that the Item Palette can also be opened with the
+ accelerator key, Control P. The icons are displayed on the
+ background of the last editor to call the Item Palette.
+ Once visible, use the bottom of the pane use the "Show on:"
+ combo box to slect a different background.
The Palette in Control Panel Editor does not support the
Slip/3-Way/Scissor turnout icons that are available
@@ -211,28 +217,29 @@
These menu items are described in Warrants. .
-
Circuit Builder
When two or more Occupancy Blocks are
- defined this menu appears. The items under this menu provide
+
Circuit Builder
+
This menu appears when two or more Occupancy Blocks are
+ defined. The items under this menu provide
a graphic user interface (GUI) for defining Occupancy Blocks,
Portals and Paths, that is, a track circuit. Descriptions of
- the menu items are found in Circuit Builder.
+ the menu items are found in
+ Circuit Builder.
-
Draw Shapes
This menu allows drawing of various
- geometric shapes.
+
Draw Shapes
+ This menu allows drawing of various geometric shapes.
-
Draw Rectangle .
+
Draw Rectangle
-
Draw Round Rectangle .
+
Draw Round Rectangle
-
Draw Polygon .
+
Draw Polygon
-
Draw Circle .
+
Draw Circle
-
Draw Ellipse .
+
Draw Ellipse
-
Disable Selecting Shapes .
+
Disable Selecting Shapes
With the exception of Draw Polygon, each of the draw
items is make with a mouse click and drag. Polygon shapes are
made with a sequence of mouse clicks and the polygon
@@ -251,11 +258,12 @@
mode. This feature can be used to mask and unmask help
information to your panel or to highlight items.
-
Mouse operation in Control Panel Editor
Control Panel
- Editor does not implement the rollover highlighting found in
- Panel Editor.
+
Mouse operation in Control Panel Editor
+ Control Panel Editor does not implement the rollover
+ highlighting found in Panel Editor.
-
Selection
In Control Panel Editor selection is done
+
Selection
+ In Control Panel Editor selection is done
with a simple click. Items are deselected with Control click
When items are stacked, Shift-click will select the
@@ -265,7 +273,8 @@
item above the background. Control-click over only the
background will select the background icon.
-
Multiple Selection
As with Panel Editor, a selection
+
Multiple Selection
+ As with Panel Editor, a selection
group can be made using the "selection fence" - a dotted red
rectangle that will select all the items completely
within the fence. If the Shift key is
@@ -284,7 +293,8 @@
by dragging it with the control key held down.
Duplicating Selections Within Control Panel
- Editor
Copying an item or selection group is done by
+ Editor
+ Copying an item or selection group is done by
bringing up the popup for one of the selected items. When the
Duplicate popup menu item is clicked, a Copy of the
selection group is made on top of the original selections.
@@ -293,18 +303,19 @@
original postion. The copy procedure can be repeated on the
newly positioned copy to continue to make more copies.
-
Item Popups in Control Panel Editor
Right click
- (meta-click on Mac or Linux) brings up the popup menu for the
- item.
+
Item Popups in Control Panel Editor
+ Right click (meta-click on Mac or Linux) brings up the
+ popup menu for the item.
Hold the Control key down to open the popup menu
for a background item.
-
Edit Text Attributes
The Edit Text Attributes
- popup item opens a dialog to set any of the item's text
- attributes.
+
Edit Text Attributes
+ The Edit Text Attributes popup item opens a dialog
+ to set any of the item's text attributes.
-
Multiple Selection Editing
When a popup menu item is
+
Multiple Selection Editing
+
When a popup menu item is
invoked from an item that is a member of a selection group,
all of the edited values that were made in the popup are
applied to all members of the selection group if that value
@@ -312,7 +323,8 @@
changed on one of the items in the selection group then the
font size is changed in all items in the group. If say, a
fast clock were included in this group, then no change would
- be made to the clock.
+ be made to the clock.
+
diff --git a/help/en/package/jmri/jmrit/display/IconAdder.shtml b/help/en/package/jmri/jmrit/display/IconAdder.shtml
index 49b47572863..2684a28dce4 100644
--- a/help/en/package/jmri/jmrit/display/IconAdder.shtml
+++ b/help/en/package/jmri/jmrit/display/IconAdder.shtml
@@ -7,7 +7,7 @@
"HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 15.17), see www.w3.org">
jmri: Icon Editor Help
-
+
The Icon Editors
-
Contents of the Icon Editors
Contents of the Icon Editors
Five of the Icon Editors: (Right Hand Turnout, Left Hand
@@ -75,7 +75,7 @@
Panel.
Pressing the Change Icon Button
+ "images/AddPanel2.png" align="right">
Pressing this button will add a pane labeled
Catalog to the window. It will show one or more
@@ -94,10 +94,11 @@
indicates the icon is displayed at full size. If a large
image file had been found, the scale might be 0.25:1 to
indicate that the display is 1/4 the actual size of the image
- that could be transferred to the Panel. Below the icons are
- radio buttons that allow you to adjust the background to the
- icons. This may help in determining what parts of the icon
- are opaque and what parts are transparent.
+ that could be transferred to the Panel. Below the icons is a
+ "View On:" combo box that allows you to choose the background to
+ the icons. This may help in determining what parts of the icon
+ are opaque and what parts are transparent. Initially, the current
+ Panel background color is used.
The Catalog pane will always display at least one tree
titled "Program Directory". This is the resource directory
@@ -263,7 +264,8 @@
later.
-
+
+
diff --git a/help/en/package/jmri/jmrit/display/ItemPalette.shtml b/help/en/package/jmri/jmrit/display/ItemPalette.shtml
index 32ee8dcb1b2..1c70ddaf754 100644
--- a/help/en/package/jmri/jmrit/display/ItemPalette.shtml
+++ b/help/en/package/jmri/jmrit/display/ItemPalette.shtml
@@ -25,7 +25,8 @@
-
The Item Palette
The Item Palette is used to
+
The Item Palette
+ The Item Palette is used to
place icons and text onto Control Panel Editor panels.
The palette is a tabbed window with tabs for each item type.
The common method all items use to add an item to a panel is
@@ -36,14 +37,17 @@
row from a table to associate that particular device with the
icon - and then drag the icon to the panel.
-
Iconic Items
For those items using icons, multiple
+
Iconic Items
+ For those items using icons, multiple
sets of icons are offered by the Item Palette. In each of
these cases several different icon sets are provided by
default. Radio buttons are used to select an icon set.For
example, under the sensor tab you may have sets of large
jewels, small jewels, each size with several sets with
different colors for active and inactive - e.g. red-green,
- yellow-dark, etc.
+ yellow-dark, etc.
+ The individual icons are displayed in the preview on the
+ background of the last editor to open the Item Palette.
The Show Icons button displays all the icons in the
selected set.
@@ -293,9 +294,9 @@
horizontally on your panel. To make maximum use of these
tools, design your panel with turnouts oriented vertically or
horizontally (the orientation does not have to be exact, just
- mostly vertical or mostly horizontal).
+ mostly vertical or mostly horizontal).
+
Using the Layout Editor Tool Bar
The tool bar is used to add items to a panel, and to
@@ -433,10 +434,9 @@
below, along with which created items they apply to and
whether they are optional or required.
-
- Since 4.7.3:
- Most of the toolbar's text fields have now been replaced with
- combo boxes. A combo box combines a text field
+
Since 4.7.3
+ Most of the toolbar's options are set using combo boxes.
+ A combo box combines a text field
with a drop down list. You may ether type text into the
text field or select an item from the drop down list.
Selecting an item from the drop down list will copy it
@@ -548,9 +548,9 @@
When pressed, the Change Icons... button on the
tool bar brings up an icon editor for either sensor icons,
signal mast icons, signal head icons, or general purpose icons,
- depending uponmwhether Sensor Icon, Signal Mast Icon,
- Signal Head Icon, or Icon Label is checked.
- If none of these items is checked, the button press is ignored.
+ depending upon whether Sensor Icon, Signal Mast Icon,
+ Signal Head Icon, or Icon Label is checked in the toolbar.
+ If none of these items is checked, the menu choice is ignored.
For Signal Mast Icons and Signal Head Icons, the Layout Editor
defaults to the left-facing short icons found at
"resources/icons/smallschematics/searchlights/". If you are
@@ -559,11 +559,11 @@
icons have black borders.
-
Using the Layout Editor Floating Toolbox
since 4.7.2
-
The classic toolbar resides to the top or side of the panel. The
- toolbox floats on the screen and can be moved around. It provides
+
+
The classic toolbar resides to the top or side of the panel. The
+ toolbox floats on the screen and can be moved around. It provides
all of the same functions as the toolbar.
The radio buttons, checkboxes, combo boxes and labels are grouped
@@ -573,9 +573,9 @@
of the related panel.
Since the Toolbox is a standard window, it contains the Close
- and Minimize buttons. The Close button hides the toolbox,
- it does not delete it. To show it again, select the toolbox name
- from the Window menu. The minimize button behaves in the
+ and Minimize buttons. The Close button hides the toolbox,
+ it does not delete it. To show it again, select the toolbox name
+ from the Window menu. The minimize button behaves in the
traditional manner with the toolbox becoming an icon on the operating system task
bar. Use the Window menu or click on the task bar icon to make it
visible.
@@ -648,7 +648,6 @@
determines the sort order
-
Allow Repositioning - When this item is checked,
@@ -1122,7 +1121,7 @@
Zoom selected. Since zooming is temporary, the zoom
factor is not preserved when a panel is saved.
-
As of 4.7.3 the Layout Editor Zoom
+
Since 4.7.3The Layout Editor Zoom
is saved and restored per-system. Also the mouse wheel (with
alt-(option-)key) may be used to zoom in and out.
@@ -1271,8 +1270,9 @@
These tools are briefly described above under Using Layout Editor's Tools Menu, and are
discussed in detail on the help page of the tool's dialog
- pane.
+ pane.
+
Turnouts
Layout Editor supports six different types of turnouts
@@ -1401,8 +1401,9 @@
3, or Block 4 entries are blank, the default block
is used. Block connection points are numbered 1, 2, 3 and 4,
proceeding from the upper left connection point in a
- clockwise direction.
+ clockwise direction.
+
Track Segments and Connection Points
A Track Segment is a two ended piece of track between
@@ -1771,8 +1772,9 @@
have wheels and track clean, and to have enough cars in each
train with current drawing wheels to ensure a block doesn't
loose detection before the train enters the next
- block.
+ block.
+
Tips
Because of the way a Layout Editor panel is refreshed, the
@@ -1925,7 +1927,7 @@
actually installing them on your layout.
diff --git a/help/en/package/jmri/jmrit/display/MultiSensorIconAdder.shtml b/help/en/package/jmri/jmrit/display/MultiSensorIconAdder.shtml
index 08839ae305b..729bb382b54 100644
--- a/help/en/package/jmri/jmrit/display/MultiSensorIconAdder.shtml
+++ b/help/en/package/jmri/jmrit/display/MultiSensorIconAdder.shtml
@@ -17,7 +17,8 @@
-
+
+
@@ -37,8 +38,8 @@
and the Image Index
Editor page for details on their use.
-
Contents of the MultiSensor Icon Editor
+
Contents of the MultiSensor Icon Editor
+
The icons in the MultiSensor Icon Editor differ only in
that there are several "active" icons. Each corresponds to a
@@ -56,8 +57,8 @@
When all the active icons are assigned sensors, the Add
to Panel button will become active and it can be pressed
- to install the Multisensor into the Panel.
-
+ to install the Multisensor into the Panel.
+
diff --git a/help/en/package/jmri/jmrit/display/PanelEditor.shtml b/help/en/package/jmri/jmrit/display/PanelEditor.shtml
index 08d849a9676..14a6c7522b9 100644
--- a/help/en/package/jmri/jmrit/display/PanelEditor.shtml
+++ b/help/en/package/jmri/jmrit/display/PanelEditor.shtml
@@ -17,7 +17,8 @@
-
+
+
@@ -27,7 +28,7 @@
The Panel Editor
-
+
A Panel is a set of Icons representing various components of
a layout. Some of the Icons available in JMRI include
Turnouts, Signals Masts and Sensors. You can include a
@@ -68,7 +69,7 @@
around after inserting it, but you currently can't edit the
text later.
-
A dropdown menu where you may choose the type of icon
@@ -99,7 +100,8 @@
Add Fast Clock
Add Icon (unassociated to any JMRI device)
- In most cases, selecting one of these items will
+
+
In most cases, selecting one of these items will
open a window from which icons or values can be chosen.
For the items referring to a JMRI device (e.g. turnout,
sensor, etc.) a pick list of the available devices is
@@ -109,7 +111,7 @@
value of item into the panel. The Background item
provides images for the background of the panel. Further
details on using these windows are described on the
- Icon Editors page.
+ Icon Editors page.
The two choices for icons that do not open windows are
RPS Reporter and Fast Clock. These items install their
@@ -347,7 +349,7 @@
LocoNet system, you'd refer to a LocoNet Turnout as LT13; a
LocoNet Sensor as LS21, etc.
Six signal heads may be placed around the 3-way turnout as
shown below:
The turnout at the throat, is referred to as Turnout
diff --git a/help/en/package/jmri/jmrit/display/3_WayTurnout.jpg b/help/en/package/jmri/jmrit/display/images/3_WayTurnout.jpg
similarity index 100%
rename from help/en/package/jmri/jmrit/display/3_WayTurnout.jpg
rename to help/en/package/jmri/jmrit/display/images/3_WayTurnout.jpg
diff --git a/help/en/package/jmri/jmrit/display/AddPanel.png b/help/en/package/jmri/jmrit/display/images/AddPanel.png
similarity index 100%
rename from help/en/package/jmri/jmrit/display/AddPanel.png
rename to help/en/package/jmri/jmrit/display/images/AddPanel.png
diff --git a/help/en/package/jmri/jmrit/display/images/AddPanel2.png b/help/en/package/jmri/jmrit/display/images/AddPanel2.png
new file mode 100644
index 00000000000..038c73b9346
Binary files /dev/null and b/help/en/package/jmri/jmrit/display/images/AddPanel2.png differ
diff --git a/help/en/package/jmri/jmrit/display/PanelEditor.png b/help/en/package/jmri/jmrit/display/images/PanelEditor.png
similarity index 100%
rename from help/en/package/jmri/jmrit/display/PanelEditor.png
rename to help/en/package/jmri/jmrit/display/images/PanelEditor.png
diff --git a/help/en/package/jmri/jmrit/display/PanelEditor2.png b/help/en/package/jmri/jmrit/display/images/PanelEditor2.png
similarity index 100%
rename from help/en/package/jmri/jmrit/display/PanelEditor2.png
rename to help/en/package/jmri/jmrit/display/images/PanelEditor2.png
diff --git a/help/en/package/jmri/jmrit/signalling/EntryExitFrame.shtml b/help/en/package/jmri/jmrit/entryexit/EntryExitFrame.shtml
similarity index 99%
rename from help/en/package/jmri/jmrit/signalling/EntryExitFrame.shtml
rename to help/en/package/jmri/jmrit/entryexit/EntryExitFrame.shtml
index a008d429da9..bf678d8d89e 100644
--- a/help/en/package/jmri/jmrit/signalling/EntryExitFrame.shtml
+++ b/help/en/package/jmri/jmrit/entryexit/EntryExitFrame.shtml
@@ -27,6 +27,7 @@
+
JMRI: Entry/Exit (NX)
Overview
The Entry/Exit system uses Sensors assigned to
@@ -225,8 +226,9 @@
that the blocks are made Occupied, then Unoccupied in the
correct order, leaving the last block Occupied, thus simulating
a train passing through the interlock. To do this, reselect the
- route and select "Clear Down".
+ route and select "Clear Down".
+