模组:Subject bar/doc

这是Module:Subject bar的文档页面

此模块文档已评为beta版，可广泛使用。因其新近完成，请谨慎使用，以确保输出结果符合预期。

此模块文档被引用于许多页面。
为了避免造成大规模的影响，所有对此模块文档的编辑应先于沙盒或测试样例上测试。
测试后无误的版本可以一次性地加入此模块文档中，但是修改前请务必于讨论页发起讨论。

模板引用数量会自动更新。

此模块使用Lua语言：

这个模块实现了{{Subject bar}}模板。请不要从文章或其他wiki页面中使用此模块。您应该改用{{Subject bar}}模板。要使用另一个Lua模块中的模块，请继续阅读。

从其他 Lua 模块使用

像这样加载模块：

local subjectBar = require('Module:Subject bar')._main

然后你可以像这样使用subjectBar函数：

local myBar = subjectBar{
    portal = 'Portal 1',
    portal2 = 'Portal 2',
    -- ...
    commons = true,
    commons-search = 'Commons search string',
    wikt = true,
    wikt-search = 'Wiktionary search string'
    -- ...
}

有关可能参数的完整列表，请参阅Template:Subject bar/doc。