编辑“︁Module:沙盒/TimWu007/RailSystems/doc”︁（章节）

== 建立系统模板 ==
将本模块引入铁道系统前，你需要首先创建一个系统数据模块。该模块为本模块的子模块，名称为 Module:RailSystems/<系统名> ，基本框架为

<syntaxhighlight lang="lua" >
local p = {}

p.lines = {
	-- 线路列表
}

-- 开通日期，用于为未开通线路标记日期，可有多行，非必需
p.lines['线路名'].openDates = { ['#default'] = '默认开通日期', ['2'] = '二期开通日期' }
p.lines['线路名2'].openDates = '单一开通日期'

local lineAliases = {
	-- 线路别名（用于简繁转换）
}
-- 用于处理别名的代码，勿删
for k, v in pairs(lineAliases) do p.lines[k] = p.lines[v] end
-- 起讫站信息必需代码，勿删
for k, v in pairs(p.lines) do v.terminals = {} end
-- 首末班车信息必需代码，勿删
for k, v in pairs(p.lines) do v.trainTime = {} end

p.stationNames = {
	-- 站名链接
}

local stationAliases = {
	-- 车站别名
}
-- 用于处理别名的代码，勿删
for k, v in pairs(stationAliases) do p.stationNames[k] = p.stationNames[v] end

-- 起讫站
p.lines['1'].terminals = { left = 'XXX', right = 'XXX' }
p.lines['2'].terminals = {
	left = { ['#field'] = 'type', ['#default'] = 'XXX', F = 'XXX'},
	right = { 'XXX' },
}

-- 首末班车
p.lines['1'].trainTime = {
	['SE'] = { first = '06:00', last = '23:00', startService = 'XXX', endService = 'XXX' },
	['ES'] = { first = '06:00', last = '23:00', startService = 'XXX', endService = 'XXX' },
}

return p
</syntaxhighlight>

=== 线路列表 ===
本模块线路列表的例子如下

<syntaxhighlight lang="lua" >
p.lines = {
	['1'] = { title = "宁波轨道交通1号线|1号线", color = '3180b7' },
	['2'] = { title = "宁波轨道交通2号线|2号线", color = 'cc0000' },
}
</syntaxhighlight>

其中，title 表示线路的条目名称及显示名称，使用“|”分隔。color 表示线路的标志色。

=== 线路开通日期 ===
本模块线路开通日期的例子如下。如果系统中无此需求可省略这部分。

<syntaxhighlight lang="lua" >
p.lines['1'].openDates = { ['#default'] = '2014-05-30', ['2'] = '2016-03-19' }
p.lines['2'].openDates = '2020-12-28'
</syntaxhighlight>

对于不分期线路，可采用“yyyy-mm-dd”字符串。对于分期线路，可以使用一个 Lua Table 指定各个分期的开通日期。

=== 站名链接 ===
本模块站名链接的例子如下

<syntaxhighlight lang="lua" >
p.lines = {
	['朝阳门'] = '朝阳门站 (北京)|朝阳门',
	['北京南站'] = '北京南站|北京南站',
	['大兴线天宫院'] = {'天宫院站|天宫院', '（[[北京地铁大兴线|大兴线]]）'},
}
</syntaxhighlight>

第一例中，站名“朝阳门”对应了链接 <nowiki>[[朝阳门站 (北京)|朝阳门]]</nowiki>，使得调用 <nowiki>{{#invoke:RailSystems|stationLink|name=朝阳门|system=BJS}}</nowiki> 时能够返回重定向后正确的连接（而非 <nowiki>[[朝阳门站|朝阳门]]</nowiki>）。

第二例中，站名“北京南站”对应的条目名为自身，因而 stationLink 返回“<nowiki>[[北京南站|北京南站]]</nowiki>”而非“<nowiki>[[北京南站站|北京南站]]</nowiki>”。需要注意的是，stationLink 根据字符串中是否存在“<nowiki>[[</nowiki>”外的“|”符号判断是否需要将字符串转换为链接。因而，单写“<nowiki>['北京南站'] = '北京南站',</nowiki>”只会返回“北京南站”的文字。

第三例中，站名“大兴线天宫院”是为了在[[北京地铁4号线]]车站条目中显示终点站为“<nowiki>[[天宫院站|天宫院]]（[[北京地铁大兴线|大兴线]]）</nowiki>”。这里使用了 Lua table 取代字符串。模块会自动扫描 table，将其中属于链接的部分组装为链接，并将所有部分拼装在一起。

=== 起讫站 ===
本模块起讫站的例子如下

<syntaxhighlight lang="lua" >
p.lines['1'].terminals = { 
	left = '湘湖',
	right = { ['#field'] = 'branch',
		['#default'] = { ['#field'] = 'type', ['#default'] = '临平、文泽路', future = '临平、下沙江滨' },
		['临平'] = '临平',
		['下沙'] = { ['#field'] = 'type', ['#default'] = '文泽路', future = '下沙江滨' },
	},
}
p.lines['2'].terminals = { 
	left = '朝阳',
	right = { ['#field'] = 'type', ['#default'] = '钱江路', ['future'] = '良渚'},
}
</syntaxhighlight>

起讫站名中，terminals 中的 left 属性表示起点站，right 属性表示终点站。两个属性的值均为迭代定义。若值为字符串，则返回站名。否则根据 <nowiki>'#field'</nowiki> 的值，判定输入参数是否符合当前 table 的某一个属性名。如果符合，取出值。否则取出 <nowiki>'#default'</nowiki> 属性的值。最后，对该值重复上述处理，直至返回结果为字符串为止。

=== 首末班车 ===
本模块起讫站的例子如下

<syntaxhighlight lang="lua" >
p.lines['1'].trainTime = {
	-- 东环南路首班车
	['东高'] = { first = '06:00', startService = '东环南路', endService = '高桥西' },
	['东霞'] = { first = '06:00', startService = '东环南路', endService = '霞浦' },
	-- 起讫站首末班车
	['霞高'] = { first = '06:00', last = '22:00', startService = '霞浦', endService = '高桥西' },
	['高霞'] = { first = '06:00', last = '22:00', startService = '高桥西', endService = '霞浦' },
}
</syntaxhighlight>

其中，trainTime 的每个属性值表示线路上的一种服务，名称可自定。此后 first 和 last 分别表示该服务首末班车的时间，而 startService 和 endService 表示服务的始发/终点站。