Editing Template:Adjacent stations doc/doc

{{Documentation subpage}}
'''Template:Adjacent stations doc''' is a documentation competent used on [[Module:Adjacent stations]] system sub-pages.

== Usage ==
All parameters are optional. The ''System'' name is automatically inserted.

{|class="wikitable plainrowheaders"
! scope="col" | Parameter
! scope="col" | Notes
|-
! scope="row" | {{para|former}}
| Any value. Should be used if the service is a former service.
|-
! scope="row" | {{para|place}}
| The location of where the service operates.
|-
! scope="row" | {{para|link}}
| The link to the system article. Should be used if the title of the module page is not the correct link that leads to the system article. This happens if a system abbreviation or a descriptive title is used, or if the article uses disambiguation while the module does not.
|-
! scope="row" | {{para|previous_name}}
| The previous name of the service. Should be used if the service changed names and the previous one is notable to mention.
|-
! scope="row" | {{para|including}}
| Additional line or services the module handles.
|-
! scope="row" | {{para|for}}
| A descriptive text for a related module page. 
|-
! scope="row" | {{para|for_link}}
| The link to the related module. If {{para|for_link}} and {{para|former}} are used, sets the text to {{tq|For the current services}}.
|-
! scope="row" | {{para|alias}}
| The name of another module that redirects to the current module. Sometimes a module is created with a shorter name to simplify usages.
|-
! scope="row" | {{para|main}}
| The name of the non-redirect module. Should be used on redirect pages.
|}

=== TemplateData ===
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"description": "Documentation competent used on Module:Adjacent stations system sub-pages.",
	"params": {
		"former": {
			"label": "Is former service?",
			"type": "line",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Any value. Should be used if the service is a former service."
		},
		"place": {
			"label": "Place",
			"type": "line",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The location of where the service operates."
		},
		"link": {
			"label": "Link",
			"type": "wiki-page-name",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The link to the system article. Should be used if the title of the module page is not the correct link that leads to the system article. This happens if a system abbreviation or a descriptive title is used, or if the article uses disambiguation while the module does not."
		},
		"previous_name": {
			"label": "Previous service name",
			"type": "line",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The previous name of the service. Should be used if the service changed names and the previous one is notable to mention."
		},
		"including": {
			"label": "including",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Additional line or services the module handles."
		},
		"for": {
			"label": "For",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "A descriptive text for a related module page."
		},
		"for_link": {
			"label": "For link",
			"type": "wiki-page-name",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The link to the related module. If for_link= and former= are used, sets the text to \"For the current services\"."
		},
		"alias": {
			"label": "alias",
			"type": "line",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The name of another module that redirects to the current module. Sometimes a module is created with a shorter name to simplify usages."
		},
		"main": {
			"label": "Main module",
			"type": "line",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "The name of the non-redirect module. Should be used on redirect pages."
		}
	}
}
</templatedata>
{{Collapse bottom}}


== Examples ==
<!-- Examples need updating
Using the companies from ''[[The Railway Series]]'' as an example,

<code><nowiki>{{Adjacent stations doc}}</nowiki></code> on {{blue|Module:Adjacent stations/North Western Railway/doc}} produces 
{{divbox|gray||This is a data module for [[Module:Adjacent stations]]. It supports services operated by the [[North Western Railway (fictional)|North Western Railway]].}}


<code><nowiki>{{Adjacent stations doc|former}}</nowiki></code> on {{blue|Module:Adjacent stations/Tidmouth, Knapford & Elsbridge Railway/doc}} produces 
{{divbox|gray||This is a data module for [[Module:Adjacent stations]]. It supports former [[Tidmouth, Knapford & Elsbridge Railway]] lines.}}


<code><nowiki>{{Adjacent stations doc|place=the [[Island of Sodor]]}}</nowiki></code> on {{blue|Module:Adjacent stations/North Western Railway/doc}} produces 
{{divbox|gray||This is a data module for [[Module:Adjacent stations]]. It supports services in the [[Island of Sodor]] operated by the [[North Western Railway (fictional)|North Western Railway]].}}


<code><nowiki>{{Adjacent stations doc|former|link=no|alt=Sodor & Mainland Railway}}</nowiki></code> on {{blue|Module:Adjacent stations/S&M/doc}} produces 
{{divbox|gray||This is a data module for [[Module:Adjacent stations]]. It supports former S&M ([[Sodor & Mainland Railway]]) lines.}}


<code><nowiki>{{Adjacent stations doc|incl=including the [[Sodor & Mainland Railway]], the [[Tidmouth, Wellsworth & Suddery Railway]], the [[Tidmouth, Knapford & Elsbridge Railway]], and the [[Wellsworth & Suddery Railway]]}}</nowiki></code> on {{blue|Module:Adjacent stations/North Western Railway/doc}} produces 
{{divbox|gray||This is a data module for [[Module:Adjacent stations]]. It supports services operated by the [[North Western Railway (fictional)|North Western Railway]], including the [[Sodor & Mainland Railway]], the [[Tidmouth, Wellsworth & Suddery Railway]], the [[Tidmouth, Knapford & Elsbridge Railway]], and the [[Wellsworth & Suddery Railway]].}}


<code><nowiki>{{Adjacent stations doc|for=London & North Western Railway}}</nowiki></code> on {{blue|Module:Adjacent stations/North Western Railway/doc}} produces 
{{divbox|gray||This is a data module for [[Module:Adjacent stations]]. It supports services operated by the [[North Western Railway (fictional)|North Western Railway]]. For the [[London & North Western Railway]], use {{blue|Module:Adjacent stations/London & North Western Railway}}.}}

<code><nowiki>{{Adjacent stations doc|the2=no|for=NWR|type=&amp;ndash; [[British Railways]]' former [[North Western Region]])}}</nowiki></code> on {{blue|Module:Adjacent stations/North Western Railway/doc}} produces 
{{divbox|gray||This is a data module for [[Module:Adjacent stations]]. It supports services operated by the [[North Western Railway (fictional)|North Western Railway]]. For [[NWR]] – [[British Railways]]' former [[The Other Railway|North Western Region]], use {{blue|Module:Adjacent stations/NWR}}.}}

-->

== See also ==
* {{tl|Rail template doc}}

<includeonly>{{Sandbox other||
[[Category:Rail transport templates]]
}}</includeonly>