Naming Conventions: Difference between revisions

Latest revision as of 20:35, 29 November 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 way so that searching for them later becomes more reliable. I have therefore adopted a conventions for naming things. Because a significant number of pages have already been generated with this kind of data, it will take a while to update all old entries that do not comply. All Observer references are to the new standard so that is at least a consistent source.

Class Letters

Locomotive and Wagon class letters always have the primary Class letter as a capital
- Locomotive e.g. X
- Wagon e.g. M

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 e.g. Wab
- Wagon e.g. Lpa

Class references

Where an article or reference mentions a Class of locomotive or wagon, the following two forms need to be used, the underscores between words.
- Locomotive e.g. Ja_Class_Loco (or locomotive or locomotives)
- Wagon e.g. Kp_Class_Wagon

Specific Locomotive, tram or wagon

Where an individual locomotive or wagon is mentioned, the number comes directly after any Class letters and is prefixed as shown;
- Loco_Ja1274
- Tram_43
- Tram-trailer_17
- 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" use single or double quotes
- 'Pacific' for a class name and
- "Josephine" for a personal name

Train Numbers

Train numbers need to be identified as such by adding Train_ to it as follows
- Train_144

Train Names

Train names are dealt with like locomotive Class names, in single quotes but have a Train definition attached
- 'Southerner'_Train

'People Page Names'

Any number of People can be added to the wiki. Because there will be many instances of identical names, the Page names for those people sill needs to be unique

For this reason a Page referring to a Person has the Heading 'Person' followed by a unique number. The first line below the page title will be the person's name.

@@ Line 1: / Line 1: @@
 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.
+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 way so that searching for them later becomes more reliable. I have therefore adopted a conventions for naming things. Because a significant number of pages have already been generated with this kind of data, it will take a while to update all old entries that do not comply. All Observer references are to the new standard so that is at least a consistent source.
+'''Class Letters'''
+*Locomotive and Wagon class letters always have the primary Class letter as a capital
+**Locomotive  e.g. '''X'''
+**Wagon e.g. '''M'''
 '''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  e.g. Wab
+**Locomotive  e.g. '''Wab'''
-**Wagon e.g. Lpa
+**Wagon e.g. '''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.
+*Where an article or reference mentions a Class of locomotive or wagon, the following two forms need to be used, the underscores between words.
-**Locomotive e.g. Ja_Class
+**Locomotive e.g. '''Ja_Class_Loco''' (or locomotive or locomotives)
-**Wagon e.g. Kp_class
+**Wagon e.g. '''Kp_Class_Wagon'''
 '''Specific Locomotive, tram  or wagon'''
-*Where an individual locomotive or wagon is mentioned, we need to differentiate between loco's and wagons so we use the following
+*Where an individual locomotive or wagon is mentioned, the number comes directly after any Class letters and is prefixed as shown;
-**Loco_Ja1274
+**'''Loco_Ja1274'''
-**Tram_43
+**'''Tram_43'''
-**Tram-trailer_17
+**'''Tram-trailer_17'''
-**Wagon_Kp2804
+**'''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" use single or double quotes
-**'Pacific' for a class name and
+**''''Pacific'''' for a class name and
-**"Josephine" for a personal name
+**'''"Josephine"''' for a personal name
 '''Train Numbers'''
 *Train numbers need to be identified as such by adding Train_ to it as follows
-**Train_144
+**'''Train_144'''
 '''Train Names'''
-*Train names are dealt with like locomotive Class names, in single quotes
+*Train names are dealt with like locomotive Class names, in single quotes but have a Train definition attached
-**'Southerner'
+**''''Southerner'_Train'''
+''''People Page Names''''
+*Any number of People can be added to the wiki. Because there will be many instances of identical names, the Page names for those people sill needs to be unique
+For this reason a Page referring to a Person has the Heading 'Person' followed by a unique number. The first line below the page title will be the person's name.

Naming Conventions: Difference between revisions

Latest revision as of 20:35, 29 November 2023

Navigation menu

Search