查看“帮助:管理映射方案”的源代码

{{帮助头部}}
{{帮助页面导航}}
'''映射表扩展'''是一个提供以SQL为基础、高效映射表系统的Mediawiki插件。管理员（或拥有编辑受保护页面权限的人）可以在特殊页面[[特殊:管理映射方案|管理映射方案]]中统一创建、修改及删除映射表。

== 安装 ==
# 你需要最新版本（1.6.1）的<code>TableMapping.zip</code>。
# 解压到<code>extensions</code>目录下。
# 在<code>LocalSettings.php</code>末尾加上<code>require_once( "$IP/extensions/TableMapping/TableMapping.php" );</code>。
# 由于此扩展需要创建两个新的SQL数据表，所以必须[http://www.mediawiki.org/wiki/Manual:Update.php 更新数据库]，这样两个新表就会被自动创建。
# 安装完成。

== 管理映射表 ==
* 有足够权限的人进入[[特殊:管理映射方案|管理映射方案]]后便会看到一个表单，可以选择执行所有管理操作。
* 其他人进入后则只会看到'''浏览已有映射方案'''的操作。
=== 单个浏览 ===
一般用户只能够浏览单个映射表，在'''方案名稱'''框里输入方案名称，或用子页的形式（例：[[特殊:管理映射方案/方案名]]）便可以浏览该映射表，不能进行任何操作。
=== 创建 ===
在'''创建/编辑映射方案'''下，'''方案名稱'''框里输入想要创建的方案名称，然后点选'''创建'''。如果该方案已经存在请使用'''编辑'''，如果需要删除请使用'''编辑所有映射方案'''。

在大框内输入好映射表内容后便可以按确定，勾选'''刷新对应模板'''的话会自动刷新刚定义的'''对应模板'''。提交前可以更改需要创建的映射表名称，提交后会进入编辑页面，同样可以更改映射表名称。

如果需要创建/编辑另外一个映射表，请按'''安全返回'''重新开始。

=== 编辑 ===
同样在'''创建/编辑映射方案'''下，'''方案名稱'''框里输入想要编辑的方案名称，然后点选'''编辑'''。如果该方案不存在请使用'''创建'''，如果需要删除请使用'''编辑所有映射方案'''。

在大框内会显示目前映射表的内容，修改好映射表内容便可以按确定，亦可以更改映射表名称，勾选'''刷新对应模板'''的话会自动刷新刚定义的'''对应模板'''及先前的'''对应模板'''（如果对应模板有更改的话）。

如果需要创建/编辑另外一个映射表，请按'''安全返回'''重新开始。

=== 批量浏览/编辑/删除 ===
在'''浏览所有映射方案'''下，可以进行两种操作：
* 浏览所有映射方案，单纯是'''单个浏览'''的叠加，不能进行任何操作。
* 编辑所有映射方案，可以进行批量'''编辑'''及'''删除'''操作，其中'''删除'''只能够在这里进行。
并有其他选项可以让操作变得更轻松：
* 默认显示状态，可以选择各个映射表框的初始状态是'''展开'''还是'''折叠'''，默认是展开。
* 排序方式，可以选择以'''按建立时间'''或'''按名称'''排序映射表框，默认是按建立时间。
* 按分类筛选，可以按定义映射表时设定的分类筛选映射表，默认是空（不筛选）。

进入'''浏览/编辑所有映射方案'''页面后，可以按位于每个映射表框右上的'''[+/-]'''展开及折叠映射表。

全部映射表默认处于不能编辑状态，需要先勾选'''登记编辑'''才能编辑。只有勾选了'''登记编辑'''的映射表才会被修改，反勾'''登记编辑'''能让系统无视该框里面的任何修改。

勾选'''刷新对应模板'''会自动刷新刚定义的'''对应模板'''及先前的'''对应模板'''（如果对应模板有更改的话）。

勾选'''登记删除'''能删除该映射表，此选项凌驾其他选项，并会自动刷新已经定义的'''对应模板'''。

编辑满意后便可以按确定，会跳转至显示各个编辑的信息及状态的页面，之后如果需要再进行其他操作的话请按'''安全返回'''重新开始。

=== 转换 ===
在'''转换已有模板'''下，'''模板名稱'''框里输入想要转换的模板名称，然后点选'''确认'''。如果与模板同名的方案已存在，将无法转换。

此功能用于把已有模板内的'''switch解析器'''转换为映射表，默认为同样的名称。转换后会进入'''创建'''页面，之后的操作与'''创建'''相同。被转换的模板必须存在及包含'''switch解析器'''，不符合的模板并不能转换。

此操作只会'''创建'''一个映射表，并不会改变模板的任何内容。

如果需要转换另外一个模板，请按'''安全返回'''重新开始。

=== 搜索/编辑映射对 ===
在'''搜索/编辑映射对'''下，输入想要搜索的'''键'''或（和）'''值'''，然后点选'''搜索'''。供使用的搜索模式有两种，分别是'''部分相同'''和'''全部相同'''，可以按需要分别对'''键'''和'''值'''设定所需的模式：
* 以'''部分相同'''搜索时会匹配所有含有搜索字串的项目。
* 以'''全部相同'''搜索时会匹配所有等于搜索字串的项目。
亦可按分类筛选，只在属于该分类的映射表内搜索，默认是空（不筛选）。

进入'''搜索/编辑映射对'''页面后，会见到以映射表分组的多行映射对，可以按需要分别编辑，编辑满意后便可以按位于最底下的确定。

提交更改前有几个注意事项：
* 清空'''键'''或'''值'''或把'''键'''设为纯空格或纯0会把该映射对'''删除'''。
* 如果更改后的'''键'''在该映射表内已经存在，更改将会'''失败'''。
* '''键'''内的空格会被去除。

== 语法 ==
映射表的定义语法十分简单，是以'''行'''为单位定义每个'''映射对'''，换句话说每个'''映射对'''均以回车分割。要注意'''键'''并不区分前导零及大小写，也不能为空、纯空格或纯0。
* 基本一对一定义语法，“'''键''' '''值'''”：
:1 地霊達の起床
:2 暗闇の風穴
:3 封じられた妖怪　～ Lost Place
:4 渡る者の途絶えた橋
* 多对一定义语法，“'''键1'''|'''键2'''|'''键n''' '''值'''”：
:1|T 地霊達の起床
:2|1-1 暗闇の風穴
:3|1-2 封じられた妖怪　～ Lost Place
:4|2-1 渡る者の途絶えた橋
由于以上语法，'''键'''不能含有空格和竖杠。并没有一对多和多对多的语法。

处理定义一般的'''映射对'''，还可以用特定'''键'''定义有特殊意义的'''映射属性'''，比如：
* '''!AUT'''，定义自动获取列表的WIKI语法，定义后每隔一定时间（由'''!LAP'''定义）或被编辑时会自动解析运算此句WIKI语法，把得到的结果用回车（\n）分割，配以递增数字为'''键'''，自动生成映射表。每次更新时会把'''映射属性'''以外的所有'''映射对'''清除，替换以新的'''映射对'''。
* '''!CAT'''，定义映射表所属分类，'''浏览所有映射方案'''中的按分类筛选功能会用到。
* '''!DEF'''，定义当在映射表找不到请求的键所对应的值时，会返回的默认值，会被语法分析器所定义的默认值覆盖。
* '''!EXP'''，定义当前自动获取列表过期日的时间戳，请勿编辑。
* '''!INH'''，定义映射表的父映射表，定义后该映射表会具有其父映射表的全部'''映射对'''，如有相同的'''键'''父映射表会被覆盖。与'''!JOI'''和'''!REV'''一起一共可以嵌套10层，处理级别最高，处理级别高的嵌套满10层后其之下的嵌套将不会被执行。
* '''!JOI'''，定义映射表的连结映射表，定义后该映射表会具有其连结映射表的全部'''键'''，而那些'''键'''的'''值'''则会变成，把'''值'''当作'''键'''输入目前映射表的返回'''值'''。与'''!DEF'''和'''!REV'''一起一共可以嵌套10层，处理级别最低。
* '''!LAP'''，定义自动获取列表的更新间隔，应设定为以秒为单位的纯数字，例如86400就是每一天更新一次，不设定时默认为86400（并不构成'''映射对'''，getmap时不会显示）。
* '''!REV'''，定义映射表的反映射表，定义后该映射表会具有其反映射表的全部'''映射对'''，只是'''键'''和'''值'''相反了。之后如有相同的'''键'''，反映射表会被覆盖。以此方法定义的'''键'''将可以含有空格和竖杠，只有纯空格或纯0的'''键'''会被去掉。反映射表可以是自己，注意反转后的'''值'''将会是全部大写的，与'''!INH'''和'''!JOI'''一起一共可以嵌套10层。
* '''!SOR'''，定义映射表的排序键，定义后可在浏览或编辑多个映射表时让系统根据排序键的值按[http://sourcefrog.net/projects/natsort/ 自然顺序]排列。
* '''!TEM'''，定义映射表的'''对应模板'''，勾选'''刷新对应模板'''时会刷新该模板，以刷新所有含有该映射表（模板）的页面。

几个映射表定义范例：
*以下范例将定义分类为“音乐名日文”，对应模板为“大战争音乐名/日文”，默认返回值为“缺少参数”，内容为大战争日文音乐名的映射表：
<pre>方案名称：大战争音乐名日文
!CAT 音乐名日文
!DEF 缺少参数
!TEM 大战争音乐名/日文
1|T 春の氷精
2 可愛い大戦争のリフレーン
3 いたずらに命をかけて
4 年中夢中の好奇心
5 真夜中のフェアリーダンス
6 妖精大戦争　～ Fairy Wars
7 ルーズレイン
8 メイガスナイト
9|E 春の氷精　- 静 -
10|P プレイヤーズスコア</pre>
*以下范例将定义一个含有“大战争音乐名中文”键值反转版的映射表：
<pre>方案名称：大战争音乐名编号2
!CAT 音乐名编号
!REV 大战争音乐名中文</pre>
*以下范例将定义一个含有“大战争音乐名编号2”和“大战争音乐名日文”键值反转版的映射表，也就是“大战争音乐名中文”和“大战争音乐名日文”各自反转后的合并：
<pre>方案名称：大战争音乐名编号
!CAT 音乐名编号
!DEF 缺少参数
!INH 大战争音乐名编号2
!TEM 大战争音乐名/编号
!REV 大战争音乐名日文</pre>

== 调用映射表 ==
此插件提供两种调用方法，分别是#getmap和#getmaparray。
=== getmap ===
直接获取指定映射表方案下指定'''键'''的对应值，不区分前导零及大小写。如果找不到该'''键'''将返回自定默认值、映射表的!DEF值或空字串，前者覆盖后者。
;格式:<code><nowiki>{{#getmap: 映射表方案名称 | 键 | 自定默认值 }}</nowiki></code>
;例子:
:<code><nowiki>{{#getmap:大战争音乐名/日文|T}}</nowiki></code> → 春の氷精
:<code><nowiki>{{#getmap:大战争音乐名/日文|11}}</nowiki></code> → 缺少参数
:<code><nowiki>{{#getmap:大战争音乐名/日文|11|无}}</nowiki></code> → 无
:<code><nowiki>{{#getmap:大战争音乐名/日文|!cat}}</nowiki></code> → 音乐名日文

=== getmaparray ===
获取指定映射表方案下的所有'''键'''（key）、'''值'''（value）或'''映射对'''（pair），按'''键'''的[http://sourcefrog.net/projects/natsort/ 自然顺序]排列。
;格式:<code><nowiki>{{#getmaparray: 映射表方案名称 | 分隔符（默认为回车） | 要求（可用值为key和pair，其他值均理解为value） }}</nowiki></code>
;例子:
:<code><nowiki>{{#getmaparray:大战争音乐名/日文|,}}</nowiki></code> → <code>音乐名,缺少参数,大战争音乐名,春の氷精,可愛い大戦争のリフレーン,いたずらに命をかけて,年中夢中の好奇心,真夜中のフェアリーダンス,妖精大戦争　～ Fairy Wars,ルーズレイン,メイガスナイト,春の氷精　- 静 -,プレイヤーズスコア,春の氷精　- 静 -,プレイヤーズスコア,春の氷精</code>
:<code><nowiki>{{#getmaparray:大战争音乐名/日文|,|key}}</nowiki></code> → <code>!CAT,!DEF,!TEM,1,2,3,4,5,6,7,8,9,10,E,P,T</code>
:<code><nowiki>{{#getmaparray:大战争音乐名/日文|\n|key}}</nowiki></code> → <code>!CAT !DEF !TEM 1 2 3 4 5 6 7 8 9 10 E P T</code>（空格实为回车）
:<code><nowiki>{{#getmaparray:大战争音乐名/日文|<br />|pair}}</nowiki></code> → <code>!CAT 音乐名<br />!DEF 缺少参数<br />!TEM 大战争音乐名<br />1 春の氷精<br />2 可愛い大戦争のリフレーン<br />3 いたずらに命をかけて<br />4 年中夢中の好奇心<br />5 真夜中のフェアリーダンス<br />6 妖精大戦争　～ Fairy Wars<br />7 ルーズレイン<br />8 メイガスナイト<br />9 春の氷精　- 静 -<br />10 プレイヤーズスコア<br />E 春の氷精　- 静 -<br />P プレイヤーズスコア<br />T 春の氷精</code>

=== getmapname ===
获取指定分类下的映射表名称列表，分类名称为空时会获取所有映射表。可以通过填写排序方式根据创建时间（id）、映射表名称（name）或!SOR（sort）属性来排序，不填写则不排序。
;格式:<code><nowiki>{{#getmapname: 映射表分类名称 | 排序方式（id、name或sort，默认为空） | 分隔符（默认为回车） }}</nowiki></code>
;例子:
:<code><nowiki>{{#getmapname:音乐名日文|sort|，}}</nowiki></code> → {{#getmapname:音乐名日文|sort|，}}

[[分类:扩展帮助文档]]