Skip to content
Permalink
Browse files

fix faq js

  • Loading branch information...
silverailscolo committed May 27, 2019
1 parent 2664de9 commit 5dc2b1f19d9f357f8c259340754013046879706e
@@ -41,33 +41,32 @@
questions" list. Items get listed here if they're asked a
lot, even if they're also available somewhere else.</p>

<dl>
<dt class="left"><a name="newdecoder" id="newdecoder">How
<dl class="faq">
<dt class="on"><a name="newdecoder" id="newdecoder">How
can I get a new decoder type defined?</a></dt>

<dd class="first">
<p>A completely new decoder needs a new or updated
configuration file. You can <a href=
<dd>
A completely new decoder needs a new or updated
decoder configuration file. You can <a href=
"CreateDecoder.shtml">create your own</a> or ask on
<a href=
"https://groups.io/g/jmriusers">JMRI
users</a> for somebody to create one for
you.</p>
"https://groups.io/g/jmriusers">JMRI users</a> for
somebody to create one for you.<br>

<p>In many cases, you can use an existing decoder that's
In many cases, you can use an existing decoder that's
"close enough". For example, a decoder from the same
manufacturer that has a different size or current rating
might have the same configuration CVs, so it's decoder
definition would work fine.</p>
might have the same configuration CVs, so its decoder
definition would work fine.
</dd>

<dt class="left"><a name="newfile" id="newfile">What do I
do with this new decoder file?</a></dt>
<dt><a name="newfile" id="newfile">What do I do with this
new decoder file?</a></dt>

<dd class="first">
<p>For DecoderPro to use the definition of a decoder type
<dd>
For DecoderPro to use the definition of a decoder type
in a new decoder file, the new file has to be included in
DecoderPro's index of decoder types. To do this:</p>
DecoderPro's index of decoder types. To do this:

<ul>
<li>In your JMRI install directory, you should find a
@@ -83,30 +82,30 @@
new definition should be available to you.</li>
</ul>

<p>Please make sure that the new configuration file has
Please make sure that the new configuration file has
been contributed to the project so it will be included in
future releases, and so you won't have to remake the
index each time you update.</p>
index each time you update.
</dd>

<dt class="left"><a name="update" id="update">How can I get
<dt><a name="update" id="update">How can I get
the latest decoder definitions?</a></dt>

<dd class="first">
<p>The easiest way to update really is to download a new
<dd>
The easiest way to update really is to download a new
version of the program. This is unlikely to cause
problems, and automatically installs the latest versions
of that have been contributed to DecoderPro.</p>
of that have been contributed to DecoderPro.<br>

<p>Updates occur continuously between versions of the
Updates occur continuously between versions of the
program. As files are contributed, we make them available
on our <a href="http://jmri.org/xml/decoders">collected
decoder definitions</a> web page. You can download them
from there, but note that most web browsers will not let
you directly view them; you really do have to download
them.</p>
them.<br>

<p>While people are working on decoder definitions, they
While people are working on decoder definitions, they
often put their draft definitions in the <a href=
"https://groups.io/g/jmriusers/files">"Files"
area of JMRI users </a> (log in to
@@ -116,14 +115,14 @@
Note that as an anti-spam measure, you will have to
<a href=
"https://groups.io/g/jmriusers/join">
join the group</a> to be able to download the files.</p>
join the group</a> to be able to download the files.
</dd>

<dt class="left"><a name="lb-xp" id="lb-xp">Why does my
<dt><a name="lb-xp" id="lb-xp">Why does my
LocoBuffer-II not work in Windows XP?</a></dt>

<dd class="first">
<p>With Windows XP, your serial port parameters might not
<dd>
With Windows XP, your serial port parameters might not
be properly set for hardware flow control. To fix this,
right-click on My Computer and select Properties. Go to
the Hardware tab and click on Device Manager. Open up the
@@ -132,7 +131,7 @@
select Properties. Go to the Port Settings tab and set
the options to: <em>19200, 8, None, 1, Hardware</em>.
Click <em>OK</em>. Close the Properties panel. Restart
JMRI and verify your connection settings.</p>
JMRI and verify your connection settings.
</dd>
</dl><!--#include virtual="/Footer" -->
</div><!-- closes #mainContent-->
@@ -32,7 +32,7 @@

<div id="mainContent">
<h1>JMRI: PanelPro Frequently Asked Questions</h1>
<dl>
<dl class="faq">
<dt id="context" class="on">How does
JMRI tie into the rest of my layout?</dt>
<dd class="first"><!-- by Jim Betz -->
@@ -139,8 +139,8 @@
</ol>
</dd>

<dt id="store" class="left">How do I save my work?</dt>
<dd class="first">There are several ways to save
<dt id="store">How do I save my work?</dt>
<dd>There are several ways to save
your panel. This is because the program has to store both
configuration (turnouts, sensors, etc) and layout (the
details of your specific panel) information.<br>
@@ -160,9 +160,9 @@
configuration information at that same time (which guarantees
they'll work when reloaded)</dd>

<dt id="multifile" class="left">Can I store just the
configuration information?</dt>
<dd class="first">You
<dt id="multifile">Can I store just the
configuration information?</dt>
<dd>You
can store just the "configuration" information in a file,
which you can save without worrying about whether your
panel(s) are open, etc. If you do this, you can also save
@@ -185,9 +185,9 @@
Configuration..." instead.
</dd>

<dt id="showfile" class="left">How can I see my saved
configuration, including Turnouts etc and panels?</dt>
<dd class="first">JMRI does not remember the Turnout, Sensor
<dt id="showfile">How can I see my saved
configuration, including Turnouts etc and panels?</dt>
<dd>JMRI does not remember the Turnout, Sensor
or Reporter table entries from
a previous JMRI session unless you take specific action to save your
information, and unless you take specific action to instruct JMRI to read
@@ -223,20 +223,23 @@
containing the appropriate information. Select the "Open Panels" button
to read those files into JMRI.</dd>

<dt id="location" class="left">Where should I put my custom icons and other
<dt id="location">Where should I put my custom icons and other
files?</dt>
<dd class="first"><p>The best place to put your own files is in the
<dd>The best place to put your own files is in the
JMRI Preferences directory (all JMRI apps use <a href=
"../../setup/Files.shtml#location">the same directory</a>).
You should put any locally-modified versions of files here so
they don't get overwritten by a new version of the program.
Any files that the program writes to contain local
information, e.g. roster entries, are also written here.<br>
The location of this varies by computer type:</p>
The location of this varies by computer type:
<img src="../../../images/IconFileTree.gif" alt=
"Screen shot of file tree" align="right" width="288" height=
"327" hspace="5" vspace="0">

<ul>
<li>On a Linux machine, look for a .jmri directory in your
home directory.</li>
<li>On a Linux machine, look for a <code>.jmri</code>
directory in your home directory.</li>

<li>On a Macintosh, look in the Preferences folder of the
current System Folder if running MacOS 8 or 9, or the
@@ -248,24 +251,31 @@
have multiple users configured; Search for a "JMRI"
directory to find it.</li>
</ul>
<p>Make sure you find the preferences, and <em>not</em> the
The easiest way to find the preferences location is to start
a JMRI program, e.g. DecoderPro or PanelPro, select
"Locations..." from the "Help" menu and click on [User Files
Location].<br>
A special treat for Windows users: if you go to the Windows Start
Menu, in the JMRI section, you can select
"Preferences" to have it open that directory for
you.<br>

Make sure you go to the preferences, and <em>not</em> the
original application package. They are kept separate to
simplify updating the program version. You'll know you've
found the right place if you see the preferences files that
store your applications settings:<br>
<tt>PanelProConfig2.xml</tt>.<br>
<code>PanelProConfig2.xml</code>.<br>
You can also search for this file to find this directory:
<br>
<img src="../../../images/IconFileTree.gif" alt=
"Screen shot of file tree" align="right" width="288" height=
"327" hspace="5" vspace="0">If you have created icons that
If you have created icons that
you want to be able from the panel editor, put them in a
directory called "resources" in the Preferences directory.
They'll then show up in the "files" part of the selection box
when you press a "Change icon..." button on the panel
editor.</p>
editor.<br>

<p>For example, if the Preferences directory contains the
For example, if the Preferences directory contains the
files shown below, you'll get the file display shown at the
right.
<code>&gt; ls resources/ decoderpro.gif green.gif
@@ -280,8 +290,8 @@
overwritten when you install a future version (a newer
version of a file, perhaps to fix a problem, will overwrite
your copy; the replacement is based on the file's date).<br>
More information about the
<a href="../../setup/Files.shtml">JMRI Configuration Files</a></p>
See
<a href="../../setup/Files.shtml">JMRI Configuration Files</a>
</dd>
</dl>
<!--#include virtual="/Footer" -->
@@ -68,6 +68,7 @@ layout.
<li><dfn><a href="../../../package/jmri/jmrit/dispatcher/Dispatcher.shtml">Dispatcher</a></dfn>
<li><dfn><a href="../../tools/Routes.shtml">Routes</a></dfn>
<li><dfn><a href="../../tools/fastclock/index.shtml">Fast Clocks</a></dfn>
<li><dfn><a href="../../tools/uss/index.shtml">USS CTC</a></dfn>
<li><dfn><a href="../../tools/scripting/index.shtml">Scripting</a></dfn>
<li><dfn><a href="../../doc/Technical/TurnoutFeedback.shtml">Turnout Feedback</a></dfn>
</ul>
@@ -16,7 +16,6 @@
<link rel="icon" href="/images/jmri.ico" type="image/png">
<link rel="home" title="Home" href="/"><!-- /Style -->
<!-- FAQ-Head -->

<script type="text/javascript">
/*<![CDATA[*/document.documentElement.className="hasJS";/*]]>*/
</script>
@@ -61,13 +61,13 @@
Any files that the program writes to containing local
information, e.g. Roster entries and Panel files, are
also written here.
<P>
<br>
The default user's Preferences location varies by
computer operating system. Normally, it's located:

<ul>
<li>On a Linux machine, look for a .jmri directory
in your home directory.</li>
<li>On a Linux machine, look for a <code>.jmri</code>
directory in your home directory.</li>

<li>On macOS, Preferences are stored in a "JMRI"
folder in the /Users/me/Library/Preferences/
@@ -81,23 +81,24 @@
called "JMRI".</li>
</ul>

<p>The easiest way to find the preferences location is to start a JMRI
program, e.g. DecoderPro or PanelPro, and select
"Locations ..." from the "Help" menu. A special treat
for Windows users: if you go to the Windows Start
Menu, in the JMRI section, you can select
The easiest way to find the preferences location is to
start a JMRI program, e.g. DecoderPro or PanelPro, select
"Locations..." from the "Help" menu and click on [User Files
Location].<br>
A special treat for Windows users: if you go to the Windows
Start Menu, in the JMRI section, you can select
"Preferences" to have it open that directory for
you.</p>
you.</li>

<li>User files can be stored under the preferences location,
but JMRI can also be configured to put them somewhere else.
<p>You may set or change the location scripts and
<br>You may set or change the location scripts and
user files in the <a href=
"../../package/apps/TabbedPreferences.shtml#FileLocations">
Preferences... -&gt; File Locations</a> panel. Note
that changing the "User Files Location" will also
change the default location for Panels, Rosters
etc.</p>
etc.
</li>
</ol>
</dd>
@@ -61,7 +61,7 @@
the <a href="Start.shtml">introductory page</a> shows some
of the basic commands.</p>
<p>See also <a href="Python.shtml">Python/Jython Language</a> for general FAQ about the language.</p>
<p>See also <a href="WhatWhere.shtml">Jython Scripting "What...Where"</a> for other interesting tidbits.</p>
<p>See also <a href="WhatWhere.shtml">Jython Scripting "What... Where"</a> for other interesting tidbits.</p>

<!-- = = = = = = = = = = = = The How To's = = = = = = = = = = = = = = = = = -->

@@ -165,7 +165,7 @@
<h3>Alternative syntax in Python</h3>

<p>The Python language provides alternative ways of addressing objects and methods. It is not the purpose
of this FAQ to explain all of these, but it is worth noting that the above examples could have been written
of this short intro to explain all of these, but it is worth noting that the above examples could have been written
as:</p>

<pre>
@@ -564,7 +564,6 @@ SensndExample().start()
<p><a href="#HowToTopOfPage">[Go to top of page]</a></p>
</div>


<!--#include virtual="/Footer" -->
</div><!-- closes #mainContent-->
</div><!-- closes #mBody-->

0 comments on commit 5dc2b1f

Please sign in to comment.
You can’t perform that action at this time.