มอดูล:Adjacent stations/doc

This module implements {{Adjacent stations}}, {{Rail icon}}, {{Rail color box}}, {{Line link}}, {{Station link}} and {{Rail color}}. Please see those templates' pages for documentation on how to use those templates. (Instructions for the convert function of this module are in the {{Adjacent stations}} documentation.)

The aforementioned templates rely on data stored in subpages for this module (list). For example, {{Rail icon|MRT}} generates using Module:Adjacent stations/MRT.

It is possible to create and edit data by following existing examples, but having some knowledge of Lua helps prevent mistakes. If you have programmed or used Lua before, you may like to skip the next subsection.

Hierarchy and list of parameters

1. The first layer of the table is data for the entire system, as well as output options.
2. Under the system table is the list of lines.
3. The third layer is data for a given line.
4. Each line can have 'types'. This can be either types of services or branches of the line.
5. The fifth layer is data for a given type.

If not specified, all keys and values are strings.

Main layer (1)

Parameter	Type	Used in {{Adjacent stations}}	Description
["lang"]	String	ใช่	ค่าเริ่มต้นสำหรับภาษาไทยคือ "th-TH"
["system title"]	String	ใช่	Text in the middle cell of the header.
["system icon"]	String	ใช่	Image used in the middle cell of the {{Adjacent stations}} header and by {{Rail icon}}.
["system icon format"]	String	ไม่	Icon type, used by {{Rail icon}}. If specified and not "image", the value is passed to the function that implements {{Rail color box}}.
["system color"]	String	ไม่	RGB hex triplet (three or six characters, like "BE2D2C" or "039"). Can be called by using only one parameter in {{Rail color}}.
["header stop noun"]	String	ใช่	The noun after 'preceding' and 'following' in the left and right header cells. Default value is "station".
["name format"]	String	ไม่	CSS for the header of {{Infobox station}} and anything else using the style function with |1=header. Values can be strings or nested tables, with the first level being for the line (whatever's in |style2= of {{Infobox station}}). The second level is currently unused. The first entry in a nested table with no key (i.e. with key 1) is the default.
["header background color"]	String	ไม่	RGB hex triplet for {{Infobox station}} subheaders and anything else using the style function with |1=subheader. By default, it is a light gray. Values can be strings or nested tables, like those for "name format".
["header text color"]	String	ไม่	RGB hex triplet for {{Infobox station}} subheaders and anything else using the style function with |1=subheader. By default, it is calculated based on the header background color. Values can be strings or nested tables, like those for ["name format"].
["station format"]	Table or string	ใช่	Table containing station format strings. The first entry without a specified key (i.e. with the key being the number 1) is the default, and all other entries must have keys corresponding to the input. Format strings without wikilink brackets are converted to links, with the input (usually the station name) used as the displayed text. Tables can be nested within this table to indicate options based on the line and line type passed to this template. %1, %2 and %3 can be used in all strings regardless of the level of nesting to be replaced respectively by the station input, the line input (after alias replacement) and the type input (after alias replacement).
["lines"]	Table	ใช่	Data table containing line tables.
["aliases"]	Table	ใช่	Table containing aliases (as table keys) for lines (as values). All keys are lowercase, as the input is treated as case-insensitive by being lower-cased.

Station format table (2)

Parameter	Type	Used in {{Adjacent stations}}	Description
[1]	String	ใช่	Default format.
["non-default station name"]	String or table	ใช่	Format for a non-default station, or line-specific format table.

Line-specific format table (3)

Parameter	Type	Used in {{Adjacent stations}}	Description
[1]	String	ใช่	Default format.
["line name"]	String or table	ใช่	Format for a non-default station, or type-specific format table.

Type-specific format table (4)

Parameter	Type	Used in {{Adjacent stations}}	Description
[1]	String	ใช่	Default format.
["type name"]	String	ใช่	Format for a non-default station.

Line table (3)

A virtual line named ["_default"] can be added to set default values for all lines. Currently, this is available for three parameters.

Parameter	Type	Used in {{Adjacent stations}}	Description
["title"]	String	ใช่	The text displayed in the middle cell, typically a link to the line's article. If not specified, then the data in ["_default"] is used (%1 in the default value is replaced by the input after alias replacement).
["short name"]	String	ไม่	Abbreviated line name used by {{Rail color box}} and {{Short line link}}.
["icon"]	String	ไม่	Image used by {{Rail icon}}. If not specified, then the data in ["_default"] is used (%1 in the default value is replaced by the input after alias replacement).
["icon format"]	String	ไม่	Icon type used by {{Rail icon}}. If specified and not "image", the value is passed to the function that implements {{Rail color box}}.
["color"]	String	ใช่	RGB hex triplet. Lines fall back to the ["_default"] colour (if any) or the system's colour if they themselves do not have one; types fall back to the line's colour (if any), to the ["_default"] colour (if any) or to the system's colour. This colour is used in the second and fourth columns of {{Adjacent stations}}, and by {{Rail color box}} and {{Rail icon}} as the emphasised colour. By default, if a type and its line both have a colour, then the line's colour will be treated as the background colour (see next section) for the line name in the middle cell. This can be turned off by setting the type's background colour to "" or "transparent".
["background color"]	String	ใช่	RGB hex triplet (three or six characters). This colour is optional and is only displayed behind the line name in the middle cell. The module adds transparency so that all text displayed over the background is legible.
["border color"]	String	ไม่	RGB hex triplet used by {{Rail color box}}.
["text color"]	String	ไม่	RGB hex triplet used by {{Rail color box}}.
["left terminus"]	String	ใช่	The station which is usually the left terminus of the line. If there are multiple stations by default, the value should be a table containing numbered values (e.g. ["left terminus"] = {"Chesham", "Amersham"}). The key ["via"] in that table can be used to append 'via' and the value's station link.
["right terminus"]	String	ใช่	The station which is usually the right terminus of the line; behaves like ["left terminus"].
["note-mid"]	String	ใช่	Default small text below line and type names. Overridden by |note-mid= in transclusion.
["circular"]	Boolean	ใช่	If the value is true then the termini will display without 'toward'/'towards'. May be overridden by type.
["oneway-left"]	Boolean	ใช่	If the value is true then 'One-way operation' will display instead of the left terminus.
["oneway-right"]	Boolean	ใช่	Right counterpart of oneway-left.
["types"]	Table	ใช่	Table containing the line type tables.

Type table (5)

Parameter	Type	Used in {{Adjacent stations}}	Description
["title"]	String	ใช่	The name of the line type. In {{Adjacent stations}}, this is displayed as normal-sized text below the line name in the middle cell; in {{Rail color box}}, for some options this is displayed after the line name, separated from it by a spaced en dash (this is also used for the nonstop text). To avoid displaying a type name, set this to "".
["short name"]	String	ไม่	Abbreviated line name used by {{Rail color box}} and {{Short line link}}.
["icon"]	String	ไม่	Image used by {{Rail icon}}.
["icon format"]	String	ไม่	Icon type used by {{Rail icon}}. If specified and not "image", the value is passed to the function that implements {{Rail color box}}.
["color"]	String	ใช่	RGB hex triplet. Lines fall back to the ["_default"] colour (if any) or the system's colour if they themselves do not have one; types fall back to the line's colour (if any), to the ["_default"] colour (if any) or to the system's colour. This colour is used in the second and fourth columns of {{Adjacent stations}}, and by {{Rail color box}} and {{Rail icon}} as the emphasised colour. By default, if a type and its line both have a colour, then the line's colour will be treated as the background colour (see next section) for the line name in the middle cell. This can be turned off by setting the type's background colour to "" or "transparent".
["background color"]	String	ใช่	RGB hex triplet (three or six characters). This colour is optional and is only displayed behind the line name in the middle cell. The module adds transparency so that all text displayed over the background is legible.
["border color"]	String	ไม่	RGB hex triplet used by {{Rail color box}}.
["text color"]	String	ไม่	RGB hex triplet used by {{Rail color box}}.
["left terminus"]	String	ใช่	The station which is usually the left terminus of the line. Overrides line terminus. If there are multiple stations by default, the value should be a table containing numbered values (e.g. ["left terminus"] = {"Chesham", "Amersham"}). The key ["via"] in that table can be used to append 'via' and the value's station link.
["right terminus"]	String	ใช่	The station which is usually the right terminus of the line; behaves like ["left terminus"].
["note-mid"]	String	ใช่	Default small text below line and type names. Overridden by |note-mid= in transclusion.
["circular"]	Boolean	ใช่	If the value is true then the termini will display without 'toward'/'towards'.