Difference between revisions of "Help:Project Pages"

From Railway Operation Simulator Wiki
Jump to navigation Jump to search
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{Notice|1=After creating a new project page with the name of the project as the title, use the following syntax to generate the common content. Some parameters can be passed into this, namely the country and time period. This can then be edited to add extra information. <nowiki>{{subst:EmptyProjectPage|Country=|TimePeriod=|TOC=|difficulty=|author=}}</nowiki> |heading=Project Page Creation}}
 +
 +
'''Template: <nowiki>{{subst:EmptyProjectPage|Country=|TimePeriod=|TOC=|difficulty=|author=}}</nowiki>'''
 +
 
When creating pages for community created projects, you should use this general format.
 
When creating pages for community created projects, you should use this general format.
  
−
At the top of the page, you should include an Infobox. You should use the slightly edited Template:Infobox rail line.
+
At the top of the page, you should include an Infobox. You should use the Template:Infobox ROSProject.
  
−
{{Infobox rail line
+
To generate an infobox you can use the following syntax. Note that parameters are all optional, so can be removed if not required for a specific project.
−
| name            = Example Infobox
 
−
| author          = Author
 
−
| image            = [[File:Example i18n.svg|Example i18n]]
 
−
| image_alt        = Image Alternative
 
−
| caption          = Railway Diagram in ROS
 
−
| type            = Railway Type
 
−
| status          = Status on the Project
 
−
| locale          = Location (Or fictional)
 
−
| start            = Start Location
 
−
| end              = End Location
 
−
| stations        = Number of Stations
 
−
| linelength_km    =
 
−
| linelength_mi    =
 
−
| linelength      = Length of railway
 
−
| tracks          = General track layout
 
−
| speed_km/h      =
 
−
| speed_mph        =
 
−
| speed            = General track speed
 
−
| signalling      = Signalling type
 
−
| website          = Link to ROS website
 
−
| map              =
 
−
| map_name        = Track Map goes here (WIP)
 
−
| map_state        = uncollapsed
 
−
| embedded        =
 
−
| connected        = Test Project 2
 
−
}}
 
−
 
 
−
To generate an infobox you can use the following piece of text, included are some examples of what goes in each box. You can copy and paste this example into the page.
 
  
 
<pre>
 
<pre>
 
<nowiki>
 
<nowiki>
−
{{Infobox rail line
+
{{Infobox ROSProject
−
| name             = Name of Route
+
| name       = Name of Route
−
| author          = Author
+
| description = Route Description
−
| image            = File:Example railway.png
+
| country    = Country Code
−
| image_alt        = Alternative text for image
+
| time_period = Rough Time Period
−
| caption          = Railway Diagram in ROS
+
| company    = Train companies that operate the route, can use one or more.
−
| type            = Railway Type (Mainline, Metro, Branch Lines...)
+
| difficulty  = Difficulty of the route (1-10)
−
| status          = Status on the Project (Released, Work in Progress)
+
| author      = Name of Author(s)
−
| locale          = Location (Or Fictional)
+
| repository  = Link to GitHub repository
−
| start            = Start Location (First station / major hub)
+
| website     = Link to ROS website page
−
| end              = End Location (Last station / major hub)
+
| map        = <!-- Include the route map template here -->
−
| stations        = Number of Stations
 
−
| linelength_km    = <!-- You can enter a number here and it will be automatically converted to mi -->
 
−
| linelength_mi    = <!-- You can enter a number here and it will be automatically converted to kilometers -->
 
−
| linelength      = Use if above two do not apply
 
−
| tracks          = How many tracks wide in general? (1 with passing loops, 2, 4?)
 
−
| speed_km/h      = <!-- General track speed, you can enter a number here and it will be automatically converted to mph -->
 
−
| speed_mph        = <!-- General track speed, you can enter a number here and it will be automatically converted to km/h -->
 
−
| speed            = Use if above two do not apply
 
−
| signalling      = Signalling type (Most likely block signalling)
 
−
| website         = Link to ROS website
 
−
| map             = <!-- Leave blank, this is WIP -->
 
−
| map_name         = <!-- Leave blank, this is WIP -->
 
−
| map_state        = <!-- Leave blank, this is WIP -->
 
−
| embedded        = <!-- Leave blank, this is WIP -->
 
−
| connected        = A list of geographically connected projects
 
 
}}
 
}}
 
</nowiki>
 
</nowiki>
 
</pre>
 
</pre>
 +
 +
Following the infobox, include a brief description of the route. This could include history, background, or just some interesting facts.
 +
 +
== Timetable ==
 +
 +
Give some details about the timetable
 +
 +
The table below allows a summary of standard services to be provided. This should work for most routes however for some the headings may need adjusting (see [[Harrow-on-the-Hill]], [[Glasgow Central]]).
 +
 +
Frequency should be in tph where possible, or if tpd is more applicable, include the "tpd" in the cell. ''Limited'' or ''Infrequent'' can also be used if necessary.
 +
 +
Services should be grouped by train operating company - each company should only appear once in the left most column. Where possible, services should also be grouped such that stations are not repeated, or are repeated as little as possible if unavoidable.
 +
 +
Merge cells using 'colspan="#"' and rowspan="#" where possible, except for in the frequency column.
 +
 +
Train Operating Company colours can be found [https://en.wikipedia.org/wiki/Template:National_Rail_colour here] - sometimes these aren't the best colours to use, for example for South Western Railway it is better to use the Island Line colour. If the required colour is not there (eg London Underground line colours), a hex code can be used instead. Typically the train operating company should be in white to be legible, however in some cases black text is better.
 +
{| class="wikitable"
 +
| colspan="4"; style="text-align: center" | '''<Insert Route Name> Services'''
 +
|-
 +
| style="text-align: center" | '''Train Operating Company''' || style="text-align: center" | '''Origin''' || style="text-align: center" | '''Destination''' || style="text-align: center" | '''Frequency (tph)'''
 +
|-
 +
| rowspan="2"; style="background:#{{National Rail colour|London Overground}}; color: white" | London Overground
 +
| Origin 1 || Destination 1 || 4
 +
|-
 +
| rowspan="2" | Origin 2 || Destination 2 || 2
 +
|-
 +
| rowspan="2"; style="background:#{{National Rail colour|Thameslink}}; color: white" | Thameslink
 +
| rowspan="3" | Destination 3 || 1tpd
 +
|-
 +
| rowspan="2" | Origin 3 || 2
 +
|-
 +
| rowspan="4"; style="background:#{{National Rail colour|Great Northern}}" | Great Northern
 +
| 2
 +
|-
 +
| Origin 4 || rowspan="2" | Destination 4 || 0.5
 +
|-
 +
| Origin 2 || 1
 +
|-
 +
| Origin 5 || Destination 5 || ''Infrequent''
 +
|}
 +
 +
Peak only services and freight services should not typically be included in the table. Instead these should be briefly be mentioned below. Exceptions apply - see [[Thameslink Core]].
 +
 +
== Operational Tips ==
 +
 +
Optional - if there are any operating tips for the route, include them here. You may like to use heading 3 to separate them if there are lots of tips, for example by location
 +
 +
== Trivia ==
 +
 +
Optional - if there's any random facts about the route that you want to mention
 +
 +
Add a link to the appropriate category here
 +
 +
[[Category:Wiki Contribution]]

Latest revision as of 10:17, 29 January 2023

Lua error in package.lua at line 80: module 'strict' not found.

Template: {{subst:EmptyProjectPage|Country=|TimePeriod=|TOC=|difficulty=|author=}}

When creating pages for community created projects, you should use this general format.

At the top of the page, you should include an Infobox. You should use the Template:Infobox ROSProject.

To generate an infobox you can use the following syntax. Note that parameters are all optional, so can be removed if not required for a specific project. 


{{Infobox ROSProject
| name        = Name of Route
| description = Route Description
| country     = Country Code
| time_period = Rough Time Period
| company     = Train companies that operate the route, can use one or more.
| difficulty  = Difficulty of the route (1-10)
| author      = Name of Author(s)
| repository  = Link to GitHub repository
| website     = Link to ROS website page
| map         = <!-- Include the route map template here -->
}}

Following the infobox, include a brief description of the route. This could include history, background, or just some interesting facts.

Timetable

Give some details about the timetable

The table below allows a summary of standard services to be provided. This should work for most routes however for some the headings may need adjusting (see Harrow-on-the-Hill, Glasgow Central).

Frequency should be in tph where possible, or if tpd is more applicable, include the "tpd" in the cell. Limited or Infrequent can also be used if necessary.

Services should be grouped by train operating company - each company should only appear once in the left most column. Where possible, services should also be grouped such that stations are not repeated, or are repeated as little as possible if unavoidable.

Merge cells using 'colspan="#"' and rowspan="#" where possible, except for in the frequency column.

Train Operating Company colours can be found here - sometimes these aren't the best colours to use, for example for South Western Railway it is better to use the Island Line colour. If the required colour is not there (eg London Underground line colours), a hex code can be used instead. Typically the train operating company should be in white to be legible, however in some cases black text is better.

<Insert Route Name> Services
Train Operating Company Origin Destination Frequency (tph)
London Overground Origin 1 Destination 1 4
Origin 2 Destination 2 2
Thameslink Destination 3 1tpd
Origin 3 2
Great Northern 2
Origin 4 Destination 4 0.5
Origin 2 1
Origin 5 Destination 5 Infrequent

Peak only services and freight services should not typically be included in the table. Instead these should be briefly be mentioned below. Exceptions apply - see Thameslink Core.

Operational Tips

Optional - if there are any operating tips for the route, include them here. You may like to use heading 3 to separate them if there are lots of tips, for example by location

Trivia

Optional - if there's any random facts about the route that you want to mention

Add a link to the appropriate category here

Retrieved from ‘https://wiki.railos.org/index.php?title=Help:Project_Pages&oldid=3599’