Module:Documentation/config

----------------------------------------------------------------------------------------------------
--
--                               Module:Documentation 的配置
--
-- 在这里您可以设置 Module:Documentation 中使用的参数和消息的值，以将其本地化到您的维基和语言。
-- 除非另有说明，此处给出的值应为字符串值。
----------------------------------------------------------------------------------------------------

local i18n = require('i18n')
local function format(id)
	return i18n.get(id)
end

local cfg = {} -- 请勿编辑此行。

cfg['templatestyles-scr'] = 'Module:Documentation/styles.css'

----------------------------------------------------------------------------------------------------
-- 保护模板配置
----------------------------------------------------------------------------------------------------

-- cfg['protection-template']
-- 显示保护图标（在英文维基上是一个挂锁）的模板名称。
cfg['protection-template'] = 'pp-template'

-- cfg['protection-reason-edit']
-- 传递给 [[Module:Protection banner]] 的编辑保护模板的保护原因。
cfg['protection-reason-edit'] = 'template'

--[[
-- cfg['protection-template-args']
-- 发送给保护模板的任何参数。这应该是一个 Lua 表。
-- 例如，如果保护模板是 "pp-template"，并且 wikitext 模板调用看起来像 "{{pp-template|docusage=yes}}"，
-- 那么这个表应该看起来像 "{docusage = 'yes'}"。
 --]]
 cfg['protection-template-args'] = {docusage = 'yes'}

--[[
----------------------------------------------------------------------------------------------------
-- 沙盒通知配置
--
-- 在沙盒页面上，模块可以显示一个模板，通知用户当前页面是沙盒，以及测试用例页面的位置等。
-- 模块根据 cfg['sandbox-subpage'] 的值决定页面是否为沙盒。
-- 以下设置配置通知中包含的消息。
----------------------------------------------------------------------------------------------------
--]]

-- cfg['sandbox-notice-image']
-- 沙盒通知中显示的图像。
cfg['sandbox-notice-image'] = '[[File:Edit In Sandbox Icon - Color.svg|40px|alt=|link=]]'

--[[
-- cfg['sandbox-notice-pagetype-template']
-- cfg['sandbox-notice-pagetype-module']
-- cfg['sandbox-notice-pagetype-other']
-- 沙盒页面的页面类型。显示的消息取决于当前主题命名空间。
-- 此消息用于 cfg['sandbox-notice-blurb'] 或 cfg['sandbox-notice-diff-blurb']。
--]]
cfg['sandbox-notice-pagetype-template'] = format('sandbox-notice-pagetype-template')
cfg['sandbox-notice-pagetype-module'] = format('sandbox-notice-pagetype-module')
cfg['sandbox-notice-pagetype-other'] = format('sandbox-notice-pagetype-other')

--[[
-- cfg['sandbox-notice-blurb']
-- cfg['sandbox-notice-diff-blurb']
-- cfg['sandbox-notice-diff-display']
-- cfg['sandbox-notice-blurb'] 或 cfg['sandbox-notice-diff-blurb'] 是沙盒通知的开头句子。
-- 后者有一个差异链接，但前者没有。$1 是页面类型，根据我们所在的命名空间，
-- 它可以是 cfg['sandbox-notice-pagetype-template']、cfg['sandbox-notice-pagetype-module'] 
-- 或 cfg['sandbox-notice-pagetype-other']。$2 是主模板页面的链接，$3 是沙盒和主模板之间的差异链接。
-- 差异链接的显示值由 cfg['sandbox-notice-compare-link-display'] 设置。
--]]
cfg['sandbox-notice-blurb'] = format('sandbox-notice-blurb')
cfg['sandbox-notice-diff-blurb'] = format('sandbox-notice-diff-blurb')
cfg['sandbox-notice-compare-link-display'] = format('sandbox-notice-compare-link-display')

--[[
-- cfg['sandbox-notice-testcases-blurb']
-- cfg['sandbox-notice-testcases-link-display']
-- cfg['sandbox-notice-testcases-run-blurb']
-- cfg['sandbox-notice-testcases-run-link-display']
-- cfg['sandbox-notice-testcases-blurb'] 是一个句子，通知用户有一个与此沙盒对应的测试用例页面可以编辑。
-- $1 是测试用例页面的链接。cfg['sandbox-notice-testcases-link-display'] 是该链接的显示值。
-- cfg['sandbox-notice-testcases-run-blurb'] 是一个句子，通知用户有一个与此沙盒对应的测试用例页面可以编辑，
-- 以及一个运行它的链接。$1 是测试用例页面的链接，$2 是运行测试用例的页面的链接。
-- cfg['sandbox-notice-testcases-run-link-display'] 是运行测试用例链接的显示值。
--]]
cfg['sandbox-notice-testcases-blurb'] = format('sandbox-notice-testcases-blurb')
cfg['sandbox-notice-testcases-link-display'] = format('sandbox-notice-testcases-link-display')
cfg['sandbox-notice-testcases-run-blurb'] = format('sandbox-notice-testcases-run-blurb')
cfg['sandbox-notice-testcases-run-link-display'] = format('sandbox-notice-testcases-run-link-display')

-- cfg['sandbox-category']
-- 添加到所有模板沙盒的分类。
cfg['sandbox-category'] = 'Template sandboxes'

----------------------------------------------------------------------------------------------------
-- 起始框配置
----------------------------------------------------------------------------------------------------

-- cfg['documentation-icon-wikitext']
-- 模板顶部显示的图标的 wikitext。
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'

----------------------------------------------------------------------------------------------------
-- 链接框（结束框）配置
----------------------------------------------------------------------------------------------------

-- cfg['transcluded-from-blurb']
-- 当文档从另一个页面嵌入时显示的通知。$1 是该页面的 wikilink。
cfg['transcluded-from-blurb'] = format('transcluded-from-blurb')

--[[
-- cfg['create-module-doc-blurb']
-- 在模块命名空间中，当文档子页面不存在时显示的通知。
-- $1 是一个链接，用于使用预加载 cfg['module-preload'] 和显示 cfg['create-link-display'] 创建文档页面。
--]]
cfg['create-module-doc-blurb'] = format('create-module-doc-blurb')

----------------------------------------------------------------------------------------------------
-- 实验说明配置
----------------------------------------------------------------------------------------------------

--[[
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-module']
-- 实验说明是邀请编辑者在沙盒和测试用例页面中进行实验的文本。
-- 它仅在模板和模块命名空间中显示。使用默认的英文设置，它可能看起来像这样：
--
-- 编辑者可以在此模板的沙盒 (编辑 | 差异) 和测试用例 (编辑) 页面中进行实验。
--
-- 在这个例子中，"沙盒"、"编辑"、"差异"、"测试用例" 和 "编辑" 都将是链接。
--
-- 有两个版本，cfg['experiment-blurb-template'] 和 cfg['experiment-blurb-module']，
-- 取决于我们所在的命名空间。
-- 
-- 参数：
--
-- $1 是沙盒页面的链接。如果沙盒存在，它的格式如下：
--
--     cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display'])
-- 
-- 如果沙盒不存在，它的格式如下：
--
--     cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display'])
-- 
-- cfg['sandbox-create-link-display'] 的链接使用 cfg['template-sandbox-preload'] 或 
-- cfg['module-sandbox-preload'] 预加载页面，具体取决于当前命名空间。cfg['mirror-link-display'] 的链接
-- 加载默认编辑摘要 cfg['mirror-edit-summary']。
--
-- $2 是测试用例页面的链接。如果测试用例页面存在，它的格式如下：
--
--     cfg['testcases-link-display'] (cfg['testcases-edit-link-display'])
--
-- 如果测试用例页面不存在，它的格式如下：
-- 
--     cfg['testcases-link-display'] (cfg['testcases-create-link-display'])
--
-- 如果测试用例页面不存在，cfg['testcases-create-link-display'] 的链接使用 cfg['template-testcases-preload'] 
-- 或 cfg['module-testcases-preload'] 预加载页面，具体取决于当前命名空间。
--]]
cfg['experiment-blurb-template'] = format('experiment-blurb-template')
cfg['experiment-blurb-module'] = format('experiment-blurb-module')

----------------------------------------------------------------------------------------------------
-- 沙盒链接配置
----------------------------------------------------------------------------------------------------

-- cfg['sandbox-subpage']
-- 通常用于沙盒的模板子页面名称。
cfg['sandbox-subpage'] = 'sandbox'

-- cfg['template-sandbox-preload']
-- 模板沙盒页面的预加载文件。
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'

-- cfg['module-sandbox-preload']
-- Lua 模块沙盒页面的预加载文件。
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'

-- cfg['sandbox-link-display']
-- "沙盒" 链接的显示文本。
cfg['sandbox-link-display'] = format('sandbox-link-display')

-- cfg['sandbox-edit-link-display']
-- 沙盒 "编辑" 链接的显示文本。
cfg['sandbox-edit-link-display'] = format('sandbox-edit-link-display')

-- cfg['sandbox-create-link-display']
-- 沙盒 "创建" 链接的显示文本。
cfg['sandbox-create-link-display'] = format('sandbox-create-link-display')

-- cfg['compare-link-display']
-- "比较" 链接的显示文本。
cfg['compare-link-display'] = format('compare-link-display')

-- cfg['mirror-edit-summary']
-- 当用户点击 "镜像" 链接时使用的默认编辑摘要。$1 是模板页面的 wikilink。
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'

-- cfg['mirror-link-display']
-- "镜像" 链接的显示文本。
cfg['mirror-link-display'] = format('mirror-link-display')

-- cfg['mirror-link-preload']
-- 当用户点击 "镜像" 链接时预加载的页面。
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'

----------------------------------------------------------------------------------------------------
-- 测试用例链接配置
----------------------------------------------------------------------------------------------------

-- cfg['testcases-subpage']
-- 通常用于测试用例的模板子页面名称。
cfg['testcases-subpage'] = 'testcases'

-- cfg['template-testcases-preload']
-- 模板测试用例页面的预加载文件。
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'

-- cfg['module-testcases-preload']
-- Lua 模块测试用例页面的预加载文件。
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'

-- cfg['testcases-link-display']
-- "测试用例" 链接的显示文本。
cfg['testcases-link-display'] = format('testcases-link-display')

-- cfg['testcases-edit-link-display']
-- 测试用例 "编辑" 链接的显示文本。
cfg['testcases-edit-link-display'] = format('testcases-edit-link-display')

-- cfg['testcases-create-link-display']
-- 测试用例 "创建" 链接的显示文本。
cfg['testcases-create-link-display'] = format('testcases-create-link-display')

----------------------------------------------------------------------------------------------------
-- 添加分类说明配置
----------------------------------------------------------------------------------------------------

--[[
-- cfg['add-categories-blurb']
-- 指导用户将分类添加到 /doc 子页面的文本。如果设置了 "content" 或 "docname fed" 参数，则不使用，
-- 因为不清楚在哪里添加分类。$1 是 /doc 子页面的链接，显示值为 cfg['doc-link-display']。
--]]
cfg['add-categories-blurb'] = format('add-categories-blurb')

-- cfg['doc-link-display']
-- 链接到 /doc 子页面时显示的文本。
cfg['doc-link-display'] = '/doc'

----------------------------------------------------------------------------------------------------
-- 子页面链接配置
----------------------------------------------------------------------------------------------------

--[[
-- cfg['subpages-blurb']
-- "此模板的子页面" 说明文本。$1 是主模板子页面的链接，显示值为 cfg['subpages-link-display']。
-- 在英文版本中，此说明文本只是链接后跟一个句点，链接显示提供实际文本。
--]]
cfg['subpages-blurb'] = format('subpages-blurb')

--[[
-- cfg['subpages-link-display']
-- "此页面的子页面" 链接的显示文本。$1 是 cfg['template-pagetype']、cfg['module-pagetype'] 
-- 或 cfg['default-pagetype']，具体取决于当前页面是在模板命名空间、模块命名空间还是其他命名空间中。
--]]
cfg['subpages-link-display'] = format('subpages-link-display')

-- cfg['template-pagetype']
-- 模板页面的页面类型显示文本。
cfg['template-pagetype'] = format('template-pagetype')

-- cfg['module-pagetype']
-- Lua 模块页面的页面类型显示文本。
cfg['module-pagetype'] = format('module-pagetype')

-- cfg['default-pagetype']
-- 模板或 Lua 模块以外的页面的页面类型显示文本。
cfg['default-pagetype'] = format('default-pagetype')

----------------------------------------------------------------------------------------------------
-- 文档链接配置
----------------------------------------------------------------------------------------------------

-- cfg['doc-subpage']
-- 通常用于文档页面的子页面名称。
cfg['doc-subpage'] = 'doc'

-- cfg['file-docpage-preload']
-- 文件命名空间中文档页面的预加载文件。
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'

-- cfg['docpage-preload']
-- 所有命名空间中模板文档页面的预加载文件。
cfg['docpage-preload'] = 'Template:Documentation/preload'

-- cfg['module-preload']
-- Lua 模块文档页面的预加载文件。
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'

----------------------------------------------------------------------------------------------------
-- 打印版本配置
----------------------------------------------------------------------------------------------------

-- cfg['print-subpage']
-- 用于打印版本的模板子页面名称。
cfg['print-subpage'] = 'Print'

-- cfg['print-link-display']
-- 链接到 /Print 子页面时显示的文本。
cfg['print-link-display'] = '/Print'

-- cfg['print-blurb']
-- 如果 /Print 子页面存在时显示的文本。$1 是子页面的链接，显示值为 cfg['print-link-display']。
cfg['print-blurb'] = format('print-blurb')

-- cfg['display-print-category']
-- 如果 /Print 子页面存在，设置为 true 以启用 cfg['print-category'] 的输出。
-- 这应该是一个布尔值（true 或 false）。
cfg['display-print-category'] = true

-- cfg['print-category']
-- 如果 cfg['display-print-category'] 设置为 true 且 /Print 子页面存在时输出的分类。
cfg['print-category'] = 'Templates with print versions'

----------------------------------------------------------------------------------------------------
-- HTML 和 CSS 配置
----------------------------------------------------------------------------------------------------

-- cfg['main-div-id']
-- 主 HTML "div" 标签的 "id" 属性。
cfg['main-div-id'] = 'template-documentation'

-- cfg['main-div-classes']
-- 添加到主 HTML "div" 标签的 CSS 类。
cfg['main-div-class'] = 'ts-doc-doc'
cfg['header-div-class'] = 'ts-doc-header'
cfg['heading-div-class'] = 'ts-doc-heading'
cfg['content-div-class'] = 'ts-doc-content'
cfg['footer-div-class'] = 'ts-doc-footer plainlinks'

cfg['sandbox-class'] = 'ts-doc-sandbox'

-- cfg['start-box-linkclasses']
-- 起始框中 [查看][编辑][历史] 或 [创建] 链接使用的 CSS 类。
cfg['start-box-linkclasses'] = 'ts-tlinks-tlinks mw-editsection-like plainlinks'

-- cfg['start-box-link-id']
-- 起始框中链接的 HTML "id" 属性。
cfg['start-box-link-id'] = 'doc_editlinks'

----------------------------------------------------------------------------------------------------
-- 跟踪分类配置
----------------------------------------------------------------------------------------------------

-- cfg['display-strange-usage-category']
-- 如果模块在 /doc 子页面或 /testcases 子页面上使用，设置为 true 以启用 cfg['strange-usage-category'] 的输出。
-- 这应该是一个布尔值（true 或 false）。
cfg['display-strange-usage-category'] = false

-- cfg['strange-usage-category']
-- 如果 cfg['display-strange-usage-category'] 设置为 true 且模块在 /doc 子页面或 /testcases 子页面上使用时输出的分类。
cfg['strange-usage-category'] = 'Pages with strange ((documentation)) usage'

--[[
----------------------------------------------------------------------------------------------------
-- 配置结束
--
-- 请勿编辑此行以下的内容。
----------------------------------------------------------------------------------------------------
--]]

return cfg