Module:Wy/sk/Adjacent Stations/doc

This is the documentation page for Module:Wy/sk/Adjacent Stations

Template:Wy/sk/Sidebar Adjacent stations Lua error in package.lua at line 80: module 'Module:Message box/configuration' not found. Template:Wy/sk/High-use Template:Wy/sk/Module rating

This module implements {{{{{2}}}}}, {{{{{2}}}}}, {{{{{2}}}}}, {{{{{2}}}}}, {{{{{2}}}}} and {{{{{2}}}}}. Please see those templates' pages for documentation on how to use those templates. (Instructions for the convert function of this module are in the {{{{{2}}}}} documentation.)

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

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.

TermsEdit

Template:Wy/sk/for

  • Lua has data types. The ones relevant here are boolean, string, number, and table.
    • A boolean is either true or false.
    • A string is text, stored as a list of characters. While Lua has several ways of indicating strings within code, in the Lua examples here, strings are indicated by enclosing text in double quotes (e.g. "This is a string").
    • A number is a numerical value, like 0.5 or 42.
    • A table is a structure that can contain other objects, including other tables.
      • An empty table looks like {} in the code.
      • Tables have keys and values, which are typically of the structure ["key"] = value; each key–value pair is separated by a comma. All keys used here are strings or numbers.
      • {"text", "more text"} is equivalent to {[1] = "text", [2] = "more text"}.
  • A variable can be defined using local variable_name = "value".
  • Whitespace is any tab, line break or other space. Whitespace doesn't matter in Lua, but all examples here except for those inline with text are neatly indented for readability, with separate table keys on separate lines.
  • A return statement (e.g. return variable_name) causes a function to exit and reports the value of variable_name. The "function" here is the code in the main module calling the subpage, and the variable_name should be the data table.

Basic structureEdit

Two modules are demonstrated below:

Blank Template:Wy/sk/syntaxhighlight
Example Template:Wy/sk/syntaxhighlight

The example module is Module:Adjacent stations/Kaohsiung Rapid Transit.

  • The two required table entries are "station format" and "lines". The former is a table with data to form links to station articles, and the latter is a table containing a table for each line.
  • "system title" is the text in the middle cell of the table header row.
  • "station format" defines the default name format for station articles and exceptions. The first variable ("%1 metro station") is the default. Exceptions are listed as key–value pairs (e.g. "Zuoying"–"Zuoying HSR station"), where the key is the input name. The module displays the input name and links to the article with the formatted name, replacing "%1" with the input. Alternatively, the full wikilink and be entered. This can be used to have the display be different from the input.
  • "lines" is where the lines are listed. The names here are used internally and not displayed, so choose a concise one.
  • "line title" is the text displayed in the middle of each row indicating the line; "left terminus" is the default station name for the left side terminus, and "right terminus" is the default station name for the right side terminus.
  • Each "color" entry is the colour of the line.

Below is Module:Adjacent stations/Taiwan High Speed Rail: Template:Wy/sk/syntaxhighlight

  • x (defined in the first line) is a string used for formatting the station name. The variable x is used inside the "station format" table for the three articles where the title ends in "station" instead of "HSR station". This practice is optional but helpful when many articles fit a second pattern.
  • The module recognises a virtual line named ["_default"]. The title and colour of this line is used for all lines unless overridden. Parameters are used in the absence of a specified line= in transclusion.

Main layer (1)Edit

Parameter Type Used in Module:Wy/sk/Adjacent Stations Description
["lang"] String Yes Values are "en-US" and "en-GB". If not set, "en-GB" is assumed.
["system title"] String Yes Text in the middle cell of the header.
["system icon"] String Yes Image used in the middle cell of the {{{{{2}}}}} header and by {{{{{2}}}}}.
["system icon format"] String No Icon type, used by {{{{{2}}}}}. If specified and not "image", the value is passed to the function that implements {{{{{2}}}}}.
["system color"] String No RGB hex triplet (three or six characters, like "BE2D2C" or "039"). Can be called by using only one parameter in {{{{{2}}}}}.
["header stop noun"] String Yes The noun after 'preceding' and 'following' in the left and right header cells. Default value is "station".
["name format"] String No CSS for the header of {{{{{2}}}}} and anything else using the style function with Template:Wy/sk/para. Values can be strings or nested tables, with the first level being for the line (whatever's in Template:Wy/sk/para of {{{{{2}}}}}). 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 No RGB hex triplet for {{{{{2}}}}} subheaders and anything else using the style function with Template:Wy/sk/para. By default, it is a light gray. Values can be strings or nested tables, like those for "name format".
["header text color"] String No RGB hex triplet for {{{{{2}}}}} subheaders and anything else using the style function with Template:Wy/sk/para. 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 Yes 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 Yes Data table containing line tables.
["aliases"] Table Yes 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.

For editorsEdit

Disambiguating stationsEdit

Station links are generated using the station format part of the data module. Each data module defines a default case and then exceptions, if necessary. Station format is an array, similar to a switch with cases. Take Module:Adjacent stations/Incheon Subway, shown below:

Template:Wy/sk/syntaxhighlight

The default case is "%1 station", listed first. The "%1" expands to whatever the passed name of the station is. "Bakchon" becomes Bakchon station. There are several exceptions. The two usual reasons for exceptions are disambiguation or presenting a name in a non-standard way. In this case, the Incheon Subway serves three stations whose names are disambiguated: Arts Center station (Incheon), Central Park station (Incheon), and Mansu station (Incheon). This is handled by specifying a key for each station and supplying a different format. Since all three are disambiguated the same way, you can define a local variable at the top of the module:

Template:Wy/sk/syntaxhighlight

This can then be used with the exceptions:

Template:Wy/sk/syntaxhighlight

Were it written out, it would look like this:

Template:Wy/sk/syntaxhighlight

For developersEdit

Suggestions are welcomed on the talk page.

To-do listEdit

  • Convert more systems from {{{{{2}}}}}, {{{{{2}}}}}, {{{{{2}}}}} and {{{{{2}}}}}
  • Make an example module which contains all of the module's features, to avoid excessive examples in the documentation (maybe based on {{{{{2}}}}})
  • Allow direct replacement of {{{{{2}}}}}?
  • Function for calling a line terminus (for station layouts?)
  • Before translation: figure out how to handle grammatical gender and inflection in various languages with the i18n table (e.g. these phrases)
  • Allow inline sources to be added
  • Figure out Wikidata integration (require sources on Wikidata end)
  • Add a short list of changes from {{{{{2}}}}}, for the convenience of the many editors who have used it in the last 11 years
    • changes in function (new structure, data inside module, circular and branch functionality changed, replacement of manual cell merging…)
    • parameter name changes (-left and -right, mostly – search {{{{{2}}}}} for Template:Wy/sk/(((, maybe with the TemplateData generator, to make a list)