模块:TableTools/doc

本模板用来在一個頁面裡，轉換不同地區的翻譯用語或指定特定的標題。加入此模板的页面顶部会出现NoteTA（-{zh:本页使用了标题或全文手工转换，现处于不转换模式;zh-hans:本页使用了标题或全文手工转换，现处于简体转换模式;zh-cn:本页使用了标题或全文手工转换，现处于中国大陆简体模式;zh-my:本页使用了标题或全文手工转换，现处于马来西亚简体模式;zh-sg:本页使用了标题或全文手工转换，现处于新加坡简体模式;zh-hant:本页使用了标题或全文手工转换，现处于繁体转换模式;zh-hk:本页使用了标题或全文手工转换，现处于香港繁体模式;zh-mo:本页使用了标题或全文手工转换，现处于澳门繁体模式;zh-tw:本页使用了标题或全文手工转换，现处于台湾繁体模式;}-）标志。

请将模板放在页面顶部——模板转换功能只对其下方的源代码奏效。

使用說明

用法為：

-{}-
{{NoteTA
|T=标题转换
|G1=公共转换组1
|G2=公共转换组2
...
|1=转换用词1
|2=转换用词2
...
}}

其中「T」是標題转换。「G1」「G2」是公共轉換組，最大至「G10」。「1」「2」是全文轉換，最大為「30」。

G1至G10参数用来导入一些已定义好的公共转换组，比如物理学。直接引用公共转换组有很多好处，方便在一个领域和主题的条目中共同使用，方便维护，没有个数限制，可以实现单向转换。

可展開下面的列表查詢可用的公共轉換組，或查閱Category:公共轉換組模板分類。關於公共轉換組的詳細說明和創建過程可查閱Qiuwen:字詞轉換處理/公共組轉換。

示例

例一（使用全文转换）：

{{NoteTA
|1=zh-cn:量子计算机;zh-tw:量子計算機;
|2=zh-cn:信息;zh-tw:資訊;
}}

例二（使用标题转换和兩個全文转换）：

{{NoteTA
|T=zh-cn:雷霆 (最终幻想);zh-tw:雷光;
|1=zh-cn:雷霆;zh-tw:雷光;
|2=zh-cn:最终幻想;zh-tw:Final Fantasy;
}}

在例二，大陸譯名「雷霆」有另有條目佔據，標題需加消歧義括號，臺港譯名「雷光」因沒有同名條目，不需要消歧義括號。此時使用標題轉換，即可解決消歧義括號不對等的問題。

例三（引入變形金剛組转换，同时增加一个单独的全文转换）：

{{NoteTA
|G1=變形金剛
|1=zh-cn:迈克尔·贝;zh-tw:麥可·貝;
}}

在例三，組轉換調用的是對應子頁面Template:CGroup/變形金剛，所以結尾勿加入「;」，否則會視為調用不存在的Template:CGroup/變形金剛;而無效。

例四（單向轉換）：

{{NoteTA
|1=某地文化=>zh-cn:大陆文化;某地文化=>zh-tw:臺灣文化;某地文化=>zh-hk:香港文化;
}}

在例四，由於沒有加入zh-sg的單向轉換規則，在「新加坡簡體」下「字詞轉換」方框顯示紅字「在手动语言转换规则中检测到错误」，如有需要，可再加上適用的「...=>zh-sg:...;」轉換。

例五（指定不轉換）：

{{NoteTA
|1=种
}}

在例五，當無設定標的時，則指定用詞不轉換。勿加「;」，否則會視為不完整的單向轉換規則而無作用。

例六（單、雙向混合轉換）：

{{NoteTA
|1=zh-tw:熊麻吉;zh-hk:賤熊30;zh-sg:熊麻吉;
|2=熊麻吉=>zh-cn:泰迪熊;賤熊30=>zh-cn:泰迪熊;
}}

在例六，維持無歧義的用詞雙向轉換，再將有歧義的用詞單向轉換，而條目內則採無歧義用詞，也就無需都要單向轉換還得一一對應。雖「字詞轉換」方框仍顯示紅字「在手动语言转换规则中检测到错误」，但不影響運作。

进阶使用说明

本模板还可以添加一些命名参数，以用于更广泛的目的。以下为参数的解释：

• dt:标题转换的说明，填写该参数时，标题转换的说明以该参数为准。
• d1,d2……d30：用于对第n个全文转换进行说明，填写该参数时，该转换的说明以该参数为准。

其他注意事項

請在填上各地區的標題轉換後，順道為各地區的標題建立重定向頁，因為填寫NoteTA並不會自動建立地區標題重定向的。

若某條目被掛上模板:Tlx者，表示需要加入人工地區詞轉換模板模板:Tlx。需要NoteTA模板的頁面

如果要在模板内使用本模板，请将本模板置于<no-{}-wiki></now-{}-iki>内，避免与包含其的页面的NoteTA模板产生冲突（特点为条目标题栏仍有一个NoteTA的标志）。

本模块包含一系列用于处理Lua表的函数。这是个元模块，用于其他Lua模块调用，而不应该由#invoke直接调用。

加载模块

如需加载任何函数，首先需要加载模块。

<syntaxhighlight lang="lua"> local TableTools = require('Module:TableTools') </syntaxhighlight>

isPositiveInteger

<syntaxhighlight lang="lua"> TableTools.isPositiveInteger(value) </syntaxhighlight>

如果value是正整数，返回true，否则返回false。虽然此函数不是应用于表的，但这里仍收录了此函数以决定一个给定的键是否在表的数组部分或哈希部分。

isNan

<syntaxhighlight lang="lua"> TableTools.isNan(value) </syntaxhighlight>

如果value是NaN值，返回true，否则返回false。虽然此函数不是应用于表的，但这里仍收录了此函数以决定一个值能否作为有效的键。（将NaN作为键会报错。）

shallowClone

<syntaxhighlight lang="lua"> TableTools.shallowClone(t) </syntaxhighlight>

返回表格的副本。返回的值是一个新表，但是所有的子表和函数都会共用。不会绕过元表，但返回的表自身不会带有元表。如需在创建新表时不共享子表格且要复制元表，可以使用mw.clone。

shallowCloneArray

<syntaxhighlight lang="lua"> TableTools.shallowCloneArray(t) </syntaxhighlight>

返回数组的副本。返回的值是一个新的数组类似于shallowClone，但是只会复制数组部分。

rawShallowClone

<syntaxhighlight lang="lua"> TableTools.rawShallowClone(t) </syntaxhighlight>

类似于TableTools.shallowClone，但是迭代时会绕过__pairs元表。

appendAll

<syntaxhighlight lang="lua"> TableTools.appendAll(t, anotherArray) </syntaxhighlight>

在数组t的末尾添加数组anotherArray的所有内容。会修改t，不返回值。

removeDuplicates

<syntaxhighlight lang="lua"> TableTools.removeDuplicates(t) </syntaxhighlight>

从数组中返回重复值。此函数仅用于标准的数组，所有非正整数键的一律忽略，第一个nil后的值也会忽略。（对于包含nil的数组，可以先使用compressSparseArray。）此函数尝试保护数组的顺序：有重复值时，仅保留最早出现的那个。例如，对于表模板:Code，removeDuplicates返回模板:Code。

numKeys

<syntaxhighlight lang="lua"> TableTools.numKeys(t) </syntaxhighlight>

接收表t并以数字顺序返回拥有非nil值的正整数键的数量。例如，对于模板:Code，numKeys返回模板:Code。

allNumKeys

<syntaxhighlight lang="lua"> TableTools.allNumKeys(t) </syntaxhighlight>

类似于numKeys，但是不限于正整数。

affixNums

<syntaxhighlight lang="lua"> TableTools.affixNums(t, prefix, suffix) </syntaxhighlight>

接收表t并返回包含含有可选前缀prefix和可选后缀suffix的键的数量的数组。例如，对于表模板:Code和前缀'a'，affixNums返回模板:Code。prefix和suffix的值均按字面解释（不使用正则表达式）。

allAffixNums

<syntaxhighlight lang="lua"> TableTools.allAffixNums(t, prefix, suffix) </syntaxhighlight>

类似于affixNums，但是不限于正整数。

numData

<syntaxhighlight lang="lua"> TableTools.numData(t, compress) </syntaxhighlight>

假如一个表有像foo1、bar1、foo2、baz2这样的键，返回如下格式的子表的表模板:Code。不以整数结尾的键存储在命名为other的子表中。compress选项会压缩表以便通过ipairs迭代。

allPrefixedNumKeys

<syntaxhighlight lang="lua"> TableTools.allPrefixedNumKeys(t, pattern) </syntaxhighlight>

假设有模板:Code这样的表，返回模板:Code这样的表。非以数字结尾的表会被忽略，且该表的子表可能是稀疏数组。

pattern用于指定正则表达式匹配。例如，若pattern为'^(category)(.+)$'只会匹配以“category”开头，任意数字（可以是小数、负数）结尾的部分。这个正则表达式需要捕获两个值，第一个值是前缀，即返回的表的键，第二个值是可能是数字的部分，应当有可能用tonumber转化为数字。

compressSparseArray

<syntaxhighlight lang="lua"> TableTools.compressSparseArray(t) </syntaxhighlight>

接收一个带有一个或更多nil值的数组t，移除所有的nil值，不影响其他值的顺序，以便于安全地通过ipairs遍历。所有非正整数的键都会移除。例如，对于表模板:Code，compressSparseArray返回模板:Code。

compressExtendedSparseArray

<syntaxhighlight lang="lua"> TableTools.compressExtendedSparseArray(t) </syntaxhighlight>

类似于compressSparseArray，但是不会移除非正整数键和小数键。

sparseIpairs

<syntaxhighlight lang="lua"> TableTools.sparseIpairs(t) </syntaxhighlight>

这是用于遍历稀疏数组t的迭代器函数。类似于ipairs，但会一直迭代直到最高的数字键，而ipairs遇到第一个nil就可能会终止。忽略所有的非正整数键。

sparseIpairs常用于通用的for循环。

<syntaxhighlight lang="lua"> for i, v in TableTools.sparseIpairs(t) do

  -- 代码

end </syntaxhighlight>

注意sparseIpairs会在实现时使用pairs。尽管一些键看上去被忽略，但实际上运行时也会遍历到。

extendedSparseIpairs

<syntaxhighlight lang="lua"> TableTools.extendedSparseIpairs(t) </syntaxhighlight>

类似于sparseIpairs，但是不会忽略非正整数键和小数键。

size

<syntaxhighlight lang="lua"> TableTools.size(t) </syntaxhighlight>

寻找“键/值对”表的大小。例如，对于模板:Code，size返回2。函数也可以用于数组，但是对于数组，使用#操作符更高效。注意，为了查找表的大小，函数会使用pairs函数以遍历所有的表键。

rawSize

<syntaxhighlight lang="lua"> TableTools.rawSize(t) </syntaxhighlight>

类似于size，但是会忽略__pairs元方法。

keysToList

<syntaxhighlight lang="lua"> TableTools.keysToList(t, keySort) </syntaxhighlight>

返回表的键的列表，并按默认比较函数或者自定义keySort函数排序，与table.sort的comp函数类似。

rawKeysToList

<syntaxhighlight lang="lua"> TableTools.rawKeysToList(t, keySort) </syntaxhighlight>

类似于keysToList，但是会忽略__pairs元方法。

sortedPairs

<syntaxhighlight lang="lua"> TableTools.sortedPairs(t, keySort) </syntaxhighlight>

迭代表，并使用keysToList函数来排序键。如果只有数字键，sparseIpairs可能更高效。

该函数不能作为表的__pairs元方法，否则会出现堆栈溢出。

rawSortedPairs

<syntaxhighlight lang="lua"> TableTools.rawSortedPairs(t, keySort) </syntaxhighlight>

类似于rawSortedPairs，但是会忽略__pairs元方法，可以作为表的__pairs元方法。

isArray

<syntaxhighlight lang="lua"> TableTools.isArray(t) </syntaxhighlight>

如果表中的所有键都是以1开始的接连不断的整数，返回true。

listToSet

<syntaxhighlight lang="lua"> TableTools.listToSet(arr) </syntaxhighlight>

从表arr的数组部分创建一个集（set）。用arr的任何值来索引集都会返回true。

<syntaxhighlight lang="lua"> local set = TableTools.listToSet { "a", "b", "c" } assert(set["a"] == true) </syntaxhighlight>

invert

<syntaxhighlight lang="lua"> TableTools.invert(t) </syntaxhighlight>

交换数组中的键和值。例如，invert{ "a", "b", "c" }产生{ a = 1, b = 2, c = 3 }。

deepCopy

<syntaxhighlight lang="lua"> TableTools.deepCopy(orig, noMetatable, alreadySeen) </syntaxhighlight>

返回表orig的副本，类似于mw.clone，所有非函数的值都会复制，并保留表的唯一性。如果noMetatable为true，则不会复制元表（如有）。可以复制由mw.loadData加载的表。

与mw.clone类似，但mw.clone不能够复制由mw.loadData加载的表，也不允许拒绝复制元表。

sparseConcat

<syntaxhighlight lang="lua"> TableTools.sparseConcat(t, sep) </syntaxhighlight>

按顺序连接被正整数索引的表的所有值。

inArray

<syntaxhighlight lang="lua"> TableTools.inArray(arr, valueToFind) </syntaxhighlight>

如果valueToFind是数组arr的成员，返回<syntaxhighlight lang="lua" inline>true</syntaxhighlight>，否则返回<syntaxhighlight lang="lua" inline>false</syntaxhighlight>。