Naming Conventions: Difference between revisions
Jump to navigation
Jump to search
(Created page with "Introduction In developing a resource like this, there are a number of things you need to present in a particular way to aid tasks later on. The main area of concern is nami...") |
No edit summary |
||
Line 3: | Line 3: | ||
In developing a resource like this, there are a number of things you need to present in a particular way to aid tasks later on. The main area of concern is naming things in a consistent wayso that searching for them later becomes more reliable. I have therefore adopted the following conventions for naming things. | In developing a resource like this, there are a number of things you need to present in a particular way to aid tasks later on. The main area of concern is naming things in a consistent wayso that searching for them later becomes more reliable. I have therefore adopted the following conventions for naming things. | ||
'''Sub-class letters''' | |||
*Where | *Where reference is made to a locomotive or wagon class and it has a sub-class letter, the main class letter is uppercase and all sub-class letters are lower case with no space between them. | ||
**Locomotive - Wab | |||
**Wagon - Lpa | |||
'''Class references''' | |||
*Where an article or reference mentions a Class of locomotive or wagon, the following two forms need to be used, noting the upper and lower case C in the word class and the underscore between the class letter and the word class. | |||
**Locomotive - Ja_Class | **Locomotive - Ja_Class | ||
**Wagon - Kp_class | **Wagon - Kp_class | ||
'''Specific Locomotive or wagon''' | |||
*Where an individual locomotive or wagon is mentioned, we need to differentiate between loco's and wagons so we use the following | |||
**Loco_Ja1274 | |||
**Wagon_Kp2804 | |||
'''Locomotive Names''' | |||
*Where mention is made of a locomotive's name, e.g. a class name like 'Pacific', 'Columbia' etc or a personal name like "Ivanhoe" or` "Josephine" the following convention should be used | |||
**'Columbia' for a class name and | |||
**"Josephine" for a personal name | |||
* |
Revision as of 21:52, 25 April 2023
Introduction
In developing a resource like this, there are a number of things you need to present in a particular way to aid tasks later on. The main area of concern is naming things in a consistent wayso that searching for them later becomes more reliable. I have therefore adopted the following conventions for naming things.
Sub-class letters
- Where reference is made to a locomotive or wagon class and it has a sub-class letter, the main class letter is uppercase and all sub-class letters are lower case with no space between them.
- Locomotive - Wab
- Wagon - Lpa
Class references
- Where an article or reference mentions a Class of locomotive or wagon, the following two forms need to be used, noting the upper and lower case C in the word class and the underscore between the class letter and the word class.
- Locomotive - Ja_Class
- Wagon - Kp_class
Specific Locomotive or wagon
- Where an individual locomotive or wagon is mentioned, we need to differentiate between loco's and wagons so we use the following
- Loco_Ja1274
- Wagon_Kp2804
Locomotive Names
- Where mention is made of a locomotive's name, e.g. a class name like 'Pacific', 'Columbia' etc or a personal name like "Ivanhoe" or` "Josephine" the following convention should be used
- 'Columbia' for a class name and
- "Josephine" for a personal name