Template:Doc

来自Valve Developer Community
跳转到导航 跳转到搜索
Warning icon.png
This template is used on many pages and changes may be widely noticed.

Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage.
Consider discussing changes on the talk page before implementing them.

Additional info:
Over 1800+ template pages are using this template
Todo: Exclude Sandbox subpage and other from this template. Also do some code cleanup.
English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文(臺灣) (zh-tw)
Icon-translate.png Available doc translations
查看
页面历史
Icon-translate.png
本模板使用字符串子页面
请遵循该子页面上的格式添加翻译。
字符串数量:16
翻译的大致情况:English (en) 100% Deutsch (de) 43.75% Español (es) 50% Esperanto (eo) 50% Hrvatski (hr) 100% 日本語 (ja) 6.25% 한국어 (ko) 6.25% Ქართული (ka) 12.5% Nederlands (nl) 6.25% Polski (pl) 6.25% Português (pt) 6.25% Português do Brasil (pt-br) 6.25% Русский (ru) 68.75% Українська (uk) 6.25% Tiếng Việt (vi) 25% 中文 (zh) 93.75% 
Template:Doc
Logo-template.png
概述
嵌入一个文档子页面
类型
包装器模板
贡献人员
不适用
创建日期
22/08/2022
(2022年8月22日)
Notes
不适用
子页面
文档
预加载页面
沙盒
字符串页面
测试用例页面
不适用
修订信息
最后编辑者
THE OWL
最后编辑日期
17/11/2024
20241117020633
修订大小
12479 bytes
12.479 kilobytes
0.012479 megabytes
技术信息
页面标识符
47769
包括翻译
是否使用解析器函数?
是否使用变量?

模板 {{doc}} 旨在向各个页面(主要是模板页面)添加文档块。某种语言的子页面将根据用户界面的语言加载到文档块中。如果是英文,文档将取自 /doc 子页面。但在所有其他情况下,文档将取自子页面 /doc/<语言代码>

工具

主工具位于文档块上方的右上角:

  • 创建 – 打开文档的创建页面。仅在文档未创建时显示。
Note.png注意:如果没有任何文档,按钮会加载一个预加载文档 Template:Doc/preload/zhTemplate:Doc/preload/<语言代码>(如果 UI 的语言不为英语并且预加载页面的翻译存在)作为新页面的内容并打开编辑页面。如果有一个英文文档,则按钮会预加载英文文档。
  • 查看 – 打开文档页面。
  • 编辑 – 打开打开文档的编辑页面。
  • 页面历史 – 打开文档页面的更改历史记录。
Note.png注意:如果没有上述工具,则文档的文本是使用 {{{content}}} 参数编写的,或者参数 {{{tools}}} 已设置为 0。

另外,在右上角有一个标有省略号 [ ... ] 的按钮。它可以展开/折叠其他工具:

  • 沙盒 – 打开子页面 /sandbox 的创建页面并复制原始页面的代码,或者,如果此页面存在,则直接打开它。
  • 测试用例 – 打开 /testcases 子页面。对于在不同情况下测试模板很有用。
  • 子页面 – 打开 Special:PrefixIndex 并输入本页面名以搜索全部子页面。
  • 清除缓存(刷新页面) – 打开一个窗口,其中包含有关清除页面(缓存)的消息。

语言栏

在右上角的工具下,有一些标志可以将文档切换到另一种语言。切换是通过在页面链接中插入 &uselang=<语言代码> 来实现的,因此,如果你单击另一种语言,那么随着文档,界面语言将发生变化。

如果没有某种语言的文档,将显示消息“文档页面 <页面> 不存在。”,并且语言标志将以红色突出显示。如果 {{{pagespace}}} 或实际页面空间是User,则会显示消息“<用户> 没有提供有关他自己关于该语言的信息(<页面>)”。

参数

  • {{{1}}}: 用于切换模板分配的参数:
    • 如果需要标准文档块,请不要在此参数中输入任何内容。
    • 0 – 会显示消息“这是 <页面> 的文档子页面。。”
    • 1 – 会显示消息“这是文档 <页面> 的沙盒子页面。”
    • 2 – 会显示消息“该文档不是沙盒页面。”
    • 3 – 会显示消息“这是 <page> 的信息子页面”。对用户子页面很有用。
    • 4 – 将显示消息“这是用于多个页面上的文档子页面。”。如果使用 {{{list}}} 参数,则文本将为:“这是用于 <页面列表> 中列出的多个页面上的文档子页面。”。
  • {{{list}}}: 指定使用特定文档页面列出页面的页面或类别。仅当参数 {{{1}}} 设置为 4 时才使用。
  • {{{docpage}}}: 将用作文档的页面。
  • {{{content</语言代码>}}}: 将用作文档的内容,而不是单独的页面。使用时,主工具是隐藏的。
  • {{{pagespace}}}: 页面空间是自动确定的,但你可以输入自己的页面空间。标题中的文本取决于以下参数:
    • Template → “模板文档”
    • File → “摘要”
    • User → “关于”
    • 其他情况下为 “文档”
Note.png注意:如果 {{{pagespace}}} 或实际页面空间是“User”,则文本将取自 /about 子页面,而不是 /doc。
  • {{{tools}}}:控制应显示哪些工具按钮:
    • 0 – 无按钮。
    • 1 – 仅显示按钮“创建”“查看”“编辑”、“页面历史”。
    • 其他情况下显示全部按钮。

创建文档

Warning.pngWarning:如果你想在文本中的某处添加符号“|”(模板和其他 MediaWiki 元素不受影响),请使用&#124;

要开始创建文档,请单击右上角的“创建”按钮。该按钮将加载预加载文档(如果有一个英文文档则会将其作为预加载文档)。然后编写文档本身的文本。首先有一个简短的描述,然后 - 取决于编写文档的目的。如果想添加分类,只需要在文档指示的地方添加即可。

子页面

本模板还有一些子页面和子模板。创建它们是为了让事情更简单。

{{Doc/subpage}}

本模板是 <noinclude>{{doc|0}}</noinclude> 的替换版本。它可以替代 <noinclude>{{doc|0}}</noinclude>

其目的与 {{Documentation subpage}} 相同。

它可以避免预加载页面无法加载 <noinclude>{{doc|0}}</noinclude> 的问题。

{{Doc/Sandbox other}}

此模板将内容分别添加到主模板及其子页面(文档)中。它对于添加类别很有用。

其目的与 {{Sandbox other}} 相同。

Template:Doc/preload

这是单击创建按钮时的预加载页面。你可以为它添加翻译。

{{Doc/PreviewBlock}}

已弃用。请使用 {{Capsule}} 替代。