Difference between revisions of "Help:Project Route Maps"

From Railway Operation Simulator Wiki
Jump to navigation Jump to search
m
m (Replaced ROS with RailOS)
 
(4 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
To create a routemap, use the following code:
 
To create a routemap, use the following code:
 
   <nowiki>{{Routemap
 
   <nowiki>{{Routemap
   |title=<Insert Route Name Here>
+
   |title={{#invoke:String|replace|{{PAGENAME}}| Route|}}
 
   |inline=1
 
   |inline=1
 
   |map=
 
   |map=
Line 17: Line 17:
 
   <nowiki>left main text! !icon ID~~right main text</nowiki>
 
   <nowiki>left main text! !icon ID~~right main text</nowiki>
  
Typically, routemaps should be created to represent the ROS route reasonably accurately, even if this means some junctions in real life are excluded.
+
Typically, routemaps should be created to represent the RailOS route reasonably accurately, even if this means some junctions in real life are excluded.
  
 
=== Aligning Icons ===
 
=== Aligning Icons ===
Line 31: Line 31:
 
=== Bilingual Station Names ===
 
=== Bilingual Station Names ===
 
If bilingual station names are present in a route, it is advisable to also include them in the route diagram. In this case, the following format should be used:
 
If bilingual station names are present in a route, it is advisable to also include them in the route diagram. In this case, the following format should be used:
   <nowiki>left remark~~left main text~~! !icon ID~~~~right main text~~right remark</nowiki>
+
   <nowiki>left remark~~left main text~~! !icon ID~~ ~~right main text~~right remark</nowiki>
 
The main text should be used for the English name, then the remark used for the alternative language, which should be in brackets and small.
 
The main text should be used for the English name, then the remark used for the alternative language, which should be in brackets and small.
  
Line 53: Line 53:
 
}}
 
}}
 
There are three types of station included in the BSIcons, shown on the right. It is suggested they are used as follows:
 
There are three types of station included in the BSIcons, shown on the right. It is suggested they are used as follows:
* INT: Interchange station - used where the route interchanges with several others (not necessarily part of the ROS route), or for very large stations. Typically only a few will appear on each routemap, however maps for metro routes, such as the London Underground, may have many more.
+
* INT: Interchange station - used where the route interchanges with several others (not necessarily part of the RailOS route), or for very large stations. Typically only a few will appear on each routemap, however maps for metro routes, such as the London Underground, may have many more.
 
* BHF: Large stations - typically used for stations where services regularly terminate, or pass each other. Can also be used for stations where the majority or all services stop. Optionally, they can be used on single track branches to denote stations with passing points, if you do not wish to use the specific passing place station icons. Additionally, terminus stations will typically be a BHF where they're not already an INT.
 
* BHF: Large stations - typically used for stations where services regularly terminate, or pass each other. Can also be used for stations where the majority or all services stop. Optionally, they can be used on single track branches to denote stations with passing points, if you do not wish to use the specific passing place station icons. Additionally, terminus stations will typically be a BHF where they're not already an INT.
 
* HST: Small stations - these should be used for the vast majority of stations.
 
* HST: Small stations - these should be used for the vast majority of stations.
Line 67: Line 67:
 
* DST: Large depots or other non-passenger locations.
 
* DST: Large depots or other non-passenger locations.
 
* ENDE: Individual sidings, or where there are only a few sidings.
 
* ENDE: Individual sidings, or where there are only a few sidings.
* CONT: Where the depot/sidings don't appear on the ROS route, you may wish to use this instead.
+
* CONT: Where the depot/sidings don't appear on the RailOS route, you may wish to use this instead.
  
 
=== Naming Continuations ===
 
=== Naming Continuations ===
For continuations to other lines, if the line has a name (eg. Portsmouth Direct Line, East Coast Main Line), it would be ideal to use this as the visible text. Otherwise, use the next large or well-known station along the route (this should also be used if the line name is generic, such as Reading - Exeter Line). Where an ROS route exists for the line beyond this continuation, it should be linked.
+
For continuations to other lines, if the line has a name (eg. Portsmouth Direct Line, East Coast Main Line), it would be ideal to use this as the visible text. Otherwise, use the next large or well-known station along the route (this should also be used if the line name is generic, such as Reading - Exeter Line). Where an RailOS route exists for the line beyond this continuation, it should be linked.
 
For continuations to depots or sidings, the name of the location should be used, and nothing is required to be linked.
 
For continuations to depots or sidings, the name of the location should be used, and nothing is required to be linked.
  
Line 89: Line 89:
  
 
Shifts exist for various sizes up to a full icon. Anything over that amount should be created using the standard 45° or 90° curves, as required. Generally 45° curves are preferable if the space is available.
 
Shifts exist for various sizes up to a full icon. Anything over that amount should be created using the standard 45° or 90° curves, as required. Generally 45° curves are preferable if the space is available.
 +
 +
[[Category:Wiki Contribution]]

Latest revision as of 16:29, 19 March 2023

All BSIcons can be found here.

Creating a RouteMap

To create a routemap, use the following code:

 {{Routemap
  |title={{#invoke:String|replace|{{PAGENAME}}| Route|}}
  |inline=1
  |map=

  }}

The route is then placed in the space between the "map=" and the closing braces.

Icons are placed in the routemap in the following format:

 left-left remark~~left remark~~left main text~~left dist./time! !icon ID~~right dist./time~~right main text~~right remark~~right-right remark

However, typically only the following will be required:

 left main text! !icon ID~~right main text

Typically, routemaps should be created to represent the RailOS route reasonably accurately, even if this means some junctions in real life are excluded.

Aligning Icons

To add more icons in the same row, simply add a backslash between the icon codes. When multiple icons are used, the text is shifted to account for the row with the most icons (ie. the widest row). Other rows are centralised based on this, so sometimes extra backslashes should be added either side to ensure icons are aligned.

Different Widths

By default, all icons are a standard width. However, some are half-width, quarter-width or double-width. The following letters can be used on their own in an icon slot to help align rows where non-standard width icons are present:

  • c: quarter width
  • d: half width
  • cd: three-quarter width
  • b: double width

Bilingual Station Names

If bilingual station names are present in a route, it is advisable to also include them in the route diagram. In this case, the following format should be used:

 left remark~~left main text~~! !icon ID~~ ~~right main text~~right remark

The main text should be used for the English name, then the remark used for the alternative language, which should be in brackets and small.

Stacking Icons

Sometimes, the specific icon required is not available. In this case, multiple icons can be stacked in the same slot, to create more complex icons. To do this, add an exclamation mark and a tilde (!~) between each icon code.

Conventions

Route map conventions are rather up to individual preferences, however the following suggestions have been compiled.

Track Type

  • By adding the "u" prefix to icons, the track can be turned blue to denote a metro route. Otherwise, the track should be left the standard red.
  • By adding the "t" prefix to icons, the track can be converted into a tunnel.

Stations

Stations
INT
BHF
HST

There are three types of station included in the BSIcons, shown on the right. It is suggested they are used as follows:

  • INT: Interchange station - used where the route interchanges with several others (not necessarily part of the RailOS route), or for very large stations. Typically only a few will appear on each routemap, however maps for metro routes, such as the London Underground, may have many more.
  • BHF: Large stations - typically used for stations where services regularly terminate, or pass each other. Can also be used for stations where the majority or all services stop. Optionally, they can be used on single track branches to denote stations with passing points, if you do not wish to use the specific passing place station icons. Additionally, terminus stations will typically be a BHF where they're not already an INT.
  • HST: Small stations - these should be used for the vast majority of stations.

Other Locations

Other Locations
CONT
DST
ENDEe
  • DST: Large depots or other non-passenger locations.
  • ENDE: Individual sidings, or where there are only a few sidings.
  • CONT: Where the depot/sidings don't appear on the RailOS route, you may wish to use this instead.

Naming Continuations

For continuations to other lines, if the line has a name (eg. Portsmouth Direct Line, East Coast Main Line), it would be ideal to use this as the visible text. Otherwise, use the next large or well-known station along the route (this should also be used if the line name is generic, such as Reading - Exeter Line). Where an RailOS route exists for the line beyond this continuation, it should be linked. For continuations to depots or sidings, the name of the location should be used, and nothing is required to be linked.

Text Styles

  • For interchange stations use bold text. Use normal text for all other stations.
  • For continuations (at the end of the route), use italic text.
  • All depots, sidings, loops, tunnels, bridges and other named locations/features should use small italic text. In this case, apply the small modifier (<small></small>) twice.
  • For second language location names, apply the small modifier (<small></small>) once.

Parallel Connections

Parallel Connections
Use This
KRWgl\KRWg+r
Not This
ABZgl\ABZg+r

Where possible, connections between parallel lines should be accomplished using shifts and branches, rather than 90° curves, as shown on the right.

Shifts exist for various sizes up to a full icon. Anything over that amount should be created using the standard 45° or 90° curves, as required. Generally 45° curves are preferable if the space is available.