Skip to content

Commit

Permalink
remove outdated page, update outdated instructions
Browse files Browse the repository at this point in the history 
add crosslinks to panel editors, prefs
fix html
  • Loading branch information
@silverailscolo
silverailscolo committed May 19, 2019
1 parent 283b270 commit cf8fab6
Show file tree
Hide file tree
Showing 38 changed files with 313 additions and 650 deletions.
2 changes: 0 additions & 2 deletions help/en/Map.jhm
View file
Expand Up @@ -612,8 +612,6 @@

<mapID target="html.hardware.modbus.index_documentation" url="html/hardware/modbus/index.shtml#documentation"/>

<mapID target="html.apps.PanelPro.ColorTrack" url="html/apps/PanelPro/ColorTrack.shtml"/>

<mapID target="html.tools.Logix_variable" url="html/tools/Logix.shtml#variable"/>

<mapID target="html.hardware.powerline.Names" url="html/hardware/powerline/Names.shtml"/>
Expand Down
2 changes: 1 addition & 1 deletion help/en/html/apps/DecoderPro/Files.shtml
View file
Expand Up @@ -67,7 +67,7 @@
<li>On a Linux machine, look for a .jmri directory
in your home directory.</li>

<li>On Mac OS X, Preferences are stored in a "JMRI"
<li>On macOS, Preferences are stored in a "JMRI"
folder in the /Users/me/Library/Preferences/
folder.</li>

Expand Down
173 changes: 0 additions & 173 deletions help/en/html/apps/PanelPro/ColorTrack.shtml
View file

This file was deleted.

31 changes: 16 additions & 15 deletions help/en/html/apps/PanelPro/PanelPro.shtml
View file
Expand Up @@ -271,9 +271,11 @@
"../../../package/jmri/jmrit/display/PanelEditor.shtml">Panel
Editor help page</a>.

<p>After getting the Panel the way you want, you can use the
<p>After getting the Panel the way you want, you use the
"Store panel..." entry in the "Panels" menu to write it to an
.xml file. More information about the <a href=
.xml file, allowing to reload it the next ime you run JMRI
and see all your turnouts, sensors etc as you configured them.
More information about the <a href=
"../../setup/Files.shtml">JMRI Configuration Files</a></p>

<h3>Available Icons</h3>The JMRI library contains lots of
Expand Down Expand Up @@ -317,12 +319,11 @@
prototypical, or can be simplified for easier and faster
operation, as you prefer.

<p>It's also possible to create a panel where the "track"
lines change color to indicate whether the track is occupied.
The procedure for doing that is described on a <a href=
"ColorTrack.shtml">separate page</a>. <a name="cpe" id=
"cpe"></a></p>
<p>In JMRI it's also possible to create a panel where the "track"
lines change color to indicate whether the block is occupied.
In fact that is the scope of the next paragraph.</a>.

<a name="cpe" id="cpe"></a></p>
<h2>The Control Panel Editor</h2>

<p><b>Control Panel Editor</b> is simply an alternative view
Expand Down Expand Up @@ -388,14 +389,14 @@
"../../../package/apps/TabbedPreferences.shtml">Preferences
panel Help page</a>.</p>

<p>If you add a turnout, sensor or signal to a panel using
just a number, e.g. "23", it will be assigned to the first
system on the Preference panel. To access the 2nd system, you
have to use JMRI <a href=
"../../doc/Technical/Names.shtml">System Names</a>. For
example, if the second attachment is to a LocoNet system,
you'd refer to a LocoNet Turnout as LT13; a LocoNet sensor as
LS21, etc. See the page on <a href=
<p>If you add a Turnout, Sensor or Signal Mast to a Panel
using just a number, e.g. "23" in the Add... pane of a table,
its System Name will be created using the System Connection
Prefix as set in the Preferences panel -&gt; Connections tab
(e.g. LT1 for a turnout on the L LocoNet connection).
As a second system connection is required to use a different
prefix, it is simple to use more than one hardware
system at the same time. See the page on <a href=
"../../doc/Technical/Names.shtml">Names &amp; Naming</a> for
more information.</p>
<!--#include virtual="/Footer" -->
Expand Down
81 changes: 44 additions & 37 deletions help/en/html/hardware/loconet/LocoNetClasses.shtml
View file
Expand Up @@ -137,17 +137,18 @@
implementation for it's subclasses, and adds a mechanism to
find a usable LocoNetInterface implementation.</p>

<p>The routine addLocoNetListener and removeLocoNetListener
methods are implemented here, along with a notify method to
<p>The routine <code>addLocoNetListener</code> and
<code>removeLocoNetListener</code> methods are implemented here,
along with a <code>notify</code> method to
forward LocoNetMessages to the listeners.</p>

<p>Until JMRI version 4.11.5 the static instance() method
was used by a large number of
<p>Until JMRI version 4.11.5 the static
<code>instance()</code> method was used by a large number of
jmrix.loconet classes to find a LocoNetInterface for
transmitting and receiving messages. It worked through a
"self" static member, which was initialized when a
LnTrafficController subclass object was created. All objects
wanting to send or receive over the LocoNet will thence use
wanting to send or receive over the LocoNet would thence use
the last-created LnTrafficController implementation.<br>
See the section on "<a href="#startup">Startup</a>" for
more information on this.</p><img src=
Expand Down Expand Up @@ -199,31 +200,18 @@
<p>Note that the "some remote comm class" could also be
implemented as a subclass of LnTrafficRouter, instead of
communicating with one.
<!-- This subclass from 2002 is no longer supported as of JMRI 4.3, see http://jmri.org/JavaDoc/doc/jmri/jmrix/loconet/package-tree.html (Egbert Broerse 2015)
<h3>LocoNetInterfaceScaffold</h3>
The
<a href="http://jmri.org/JavaDoc/doc/jmri/jmrix/loconet/LocoNetInterfaceScaffold.html">LocoNetInterfaceScaffold</a> class provides a LnTrafficController implementation for use in test programs.
Rather than communicate with a real LocoNet, it provides scaffolding to
make it easy to test the transmission and receipt of messages. --></p>
</p>

<h2><a name="startup" id="startup">Startup</a></h2>
<p>There are "action" classes that connect to an input source.
The main program puts these in a menu, on a button, etc,
<p>Until JMRI 4.11.5 "action" classes connected to an input source.
In the current code <span class="since">Since
<a href="/releasenotes/jmri4.11.6.shtml"
target="_blank">JMRI 4.11.6</a></span>
"ConnectionConfig" classes connect an adapter to an input
source. The main program reads them from the LnConnectionTypeList
to create a combo box in the Connection Config pane,
so that the user can select the connection desired.<br>
The current (March 2002) set is:

<ul>
<li>LocoBufferAction - creates a LocoBufferAdapter object
and configures for operation with a LocoBuffer</li>

<li>MS100Action - creates a MS100Adapter object and
configures for operation with an MS100</li>

<li>LnHexFileAction - creates an LnHexFilePort object and
configures for operation as "LocoNet Simulator"
(previously, this was known as "LocoNet Hex File", as it
can load contents from a file of hexadecimal strings)</li>
</ul>
In addition to configuring the adapter for the input source,
something has to configure the complete set of Manager
objects and the LocoNet-handling objects. These include:
Expand All @@ -233,16 +221,17 @@ make it easy to test the transmission and receipt of messages. --></p>
for objects that use memo.getLnTrafficController() to
locate an interface.</li>

<li>A ProgrammerInstance</li>
<li>A Programmer instance</li>

<li>A PowerManagerInstance</li>
<li>A PowerManager instance</li>

<li>A TurnoutManagerInstance</li>
<li>TurnoutManager etc. instances</li>
</ul>These last three provide LocoNet-based services for the
higher-level JMRI interfaces.

<p>The configure() methods in the various adapter classes do
this. That's not a very general mechanism. Although a
higher-level JMRI interfaces (the <code>instance()</code> method
was deprecated to support multiple connections. The
<code>configure()</code> methods in the various adapter classes
now handle this.)
<p>Note this wasn't a general mechanism. Although a
LnPacketizer is the right thing to connect to each of the
serial port adapters, the rest of the configuration might
vary.</p>
Expand All @@ -264,7 +253,7 @@ make it easy to test the transmission and receipt of messages. --></p>
operations properly and are therefore preferred over the
MS100.</p>

<p>The MS100Action class (package jmrix.loconet.ms100) starts
<p>The ConnectionConfig class (in package jmrix.loconet.ms100) starts
up a LocoNet connection via a MS100. When triggered, it
creates a visible MS100Frame object.</p>

Expand Down Expand Up @@ -350,6 +339,24 @@ make it easy to test the transmission and receipt of messages. --></p>
HexFileFrame object stays visible so that it can control the
flow of messages from the file.</p>

<h4>LocoBuffer II</h4>

<h4>LocoBuffer USB</h4>

<h4>Uhlenbrock Intellibox I</h4>

<h4>LocoNet over TCP</h4>

<h4>LocoNet RMI Server</h4>

<h4>LocoNet PR2/3/4</h4>

<h4>Uhlenbrock Intellibox-II (USB)</h4>

<h4>DCS52 (USB)</h4>

<h4>DCS240 (USB)</h4>

<h2>Slot and Programmer management</h2>

<p>"Slots" are basic to the operation of a LocoNet command
Expand All @@ -368,9 +375,9 @@ make it easy to test the transmission and receipt of messages. --></p>
class that wants to be notified when a slot changes.</p>

<p>Because Digitrax command stations handle programming via a
special reserved slot, the jmri.Programmer interface is also
implemented by the loconet.SlotManager class. This greatly
complicates the class, but is acceptable for now.</p>
special reserved slot, the <code>jmri.Programmer</code> interface
is also implemented by the <code>loconet.SlotManager</code> class.
This greatly complicates the class, but is acceptable for now.</p>

<p>LocoNet&reg; is a registered trademark of <a href=
"http://www.digitrax.com">Digitrax, Inc.</a></p>
Expand Down
2 changes: 1 addition & 1 deletion help/en/html/setup/Files.shtml
View file
Expand Up @@ -69,7 +69,7 @@
<li>On a Linux machine, look for a .jmri directory
in your home directory.</li>

<li>On Mac OS X, Preferences are stored in a "JMRI"
<li>On macOS, Preferences are stored in a "JMRI"
folder in the /Users/me/Library/Preferences/
folder.</li>

Expand Down

0 comments on commit cf8fab6

Please sign in to comment.