From e845c02f3957c63ce3f1e9b610fdba7ab5fef43c Mon Sep 17 00:00:00 2001
From: JerryG <42826502+jerryg2003@users.noreply.github.com>
Date: Thu, 12 Nov 2020 20:13:36 -0500
Subject: [PATCH] Update Names.shtml
Clarified components of system name per review comments by @dsand47.
---
help/en/html/doc/Technical/Names.shtml | 37 +++++++++++++-------------
1 file changed, 19 insertions(+), 18 deletions(-)
diff --git a/help/en/html/doc/Technical/Names.shtml b/help/en/html/doc/Technical/Names.shtml
index 0eaf10c7159..8b0e91ccaad 100644
--- a/help/en/html/doc/Technical/Names.shtml
+++ b/help/en/html/doc/Technical/Names.shtml
@@ -89,25 +89,26 @@
doesn't have to be convenient, but does have to have a clear
mapping from name to object and back. For example, we need a
very specific way to identify "LocoNet Turnout 23". We call
- these "system names". JMRI code will map these to and from
+ these "system names." JMRI code will map these to and from
whatever information the hardware may need.
System Name Format
- A system name is formed from a short "system prefix" representing
+ A system name is formed from a short "connection prefix" representing
the hardware system, followed by a single upper case "type letter"
- indicating the type of the object, followed by a system- and
- type-specific "suffix string" identifying a specific object.
+ indicating the type of the object (together, the "system name prefix"), followed by a system- and
+ type-specific "suffix" identifying a specific object.
- - The system prefix is a single uppercase or lowercase letter, optionally followed by one
+
- The connection prefix is a single uppercase or lowercase letter, optionally followed by one
or more digits. Therefore, "S," "s", "S2," and "s2" are all examples of valid -- and
- different -- system names. Special characters are not allowed. This simple form allows
- us to always find the system prefix and type letter even if we don't know the full list of
- hardware systems involved.
+ different -- connection names. Special characters are not allowed. This simple form allows
+ us to always find the connection prefix and type letter even if we don't know the full list of
+ hardware systems involved. Default values for different hardware systems are listed
+ below.
- The type letter defines the type of model-railroad object,
such as (T)urnout or (S)ensor, see below.
-
- The suffix string is meant to be related to the hardware
+
- The suffix string is related to the hardware
addressing for the specific hardware system, but is otherwise unconstrained.
Some are simple numbers, such as a device address. Others
are much more complicated strings to carry more complex
@@ -116,7 +117,7 @@
Examples:
- Note: These assume the default values of system prefix letters,
+ Note: These assume the default values of connection prefix letters,
but they certainly could have been defined differently, including using lower case and numbers.
@@ -128,14 +129,14 @@
on the node with address 2.
- Note in these examples that there is a pattern to the name for certain hardware. However, there is no
- assumption that names are assigned in numeric order, that is you could have CS1001, CS1021, CS3044, as
+ Note in these examples the pattern to the suffix for certain hardware. However, there is no
+ assumption these are assigned in numeric order, that is you could have CS1001, CS1021, CS3044, as
well as LS1001, cS1001, etc. as your only defined sensors.
- System Prefix
+ Connection Prefix
- Originally, the "hardware prefix" was
+ Originally, the "hardware prefix" (now called "connection prefix") was
a single uppercase letter identifying a single system
connection: L for LocoNet, N for NCE, etc. The default
letters for those are listed below. This is still by far the
@@ -152,13 +153,13 @@
"Y". You can also use a lower case or upper case letter followed by
digits, e.g. "N1" and "n2".
- Default System Letters
+ Default Connection Letters
Note that some of these are placeholders, and have no underlying
implementation. (Links are to JMRI pages with more information)
Also note that some older implementations used
formats that don't meet the current standard, with
- system letters such as
+ connection letters such as
"DX", "DCCPP", "DP", "MR", "MC", "PI", "TM".
These
need to be migrated,
@@ -369,7 +370,7 @@
Each different hardware system
- can specify the "suffix string" that follows the system and type
+ can specify the "suffix string" that follows the connection and type
letters. Generally, these are small numbers, but their exact
meaning is very system-specific. For more information, please
see the specific pages for
@@ -408,7 +409,7 @@
Adding an item to the table - Entry Format Summary
When you add an item to one of the tables, many times you only
- have to enter the numbers and have JMRI construct
+ have to enter the numbers (the suffix) and JMRI will construct
the complete system name.
Here's a summary of the options per Connection, split up for
outputs (eg. Turnouts) and inputs (eg. Sensors):