Template:Doc/doc/zh: Difference between revisions
1416006136 (talk | contribs) (update) |
1416006136 (talk | contribs) (parameter descriptions updated →参数和示例) |
||
Line 22: | Line 22: | ||
如果没有某种语言的文档,将显示消息“文档页面 <页面> 不存在。”,并且语言标志将以红色突出显示。如果 {{param|pagespace}} 或实际页面空间是{{MdCode|oneclick|User}},则会显示消息“<用户> 没有提供有关他自己关于该语言的信息(<页面>)”。 | 如果没有某种语言的文档,将显示消息“文档页面 <页面> 不存在。”,并且语言标志将以红色突出显示。如果 {{param|pagespace}} 或实际页面空间是{{MdCode|oneclick|User}},则会显示消息“<用户> 没有提供有关他自己关于该语言的信息(<页面>)”。 | ||
==参数== | ==参数和示例== | ||
{| class=standard-table | style="width:100%;" | |||
|- | |||
! style="width:5%;|参数 | |||
! style="width:30%;|描述 | |||
! 示例 | |||
! style="width:50%;|预览 | |||
|- | |||
|{{param|1}} | |||
|{{param|1}}: 用于切换模板分配的参数: | |||
*如果需要标准文档块,请不要在此参数中输入任何内容。 | |||
*0 – 会显示消息“这是 <页面> 的文档子页面。” | |||
*1 – 会显示消息“这是文档 <页面> 的沙盒子页面。” | |||
*2 – 会显示消息“该文档不是沙盒页面。” | |||
*3 – 会显示消息“这是 <page> 的信息子页面”。对用户子页面很有用。 | |||
*4 – 将显示消息“这是用于多个页面上的文档子页面”。如果使用 {{param|list}} 参数,则文本将为:“这是用于 <页面列表> 中列出的多个页面上的文档子页面。”。 | |||
| | |||
{{MdCodeBlock|<nowiki>{{doc}}</nowiki>}} | |||
{{MdCodeBlock|<nowiki>{{doc|0}}</nowiki>}} | |||
{{MdCodeBlock|<nowiki>{{doc|1}}</nowiki>}} | |||
{{MdCodeBlock|<nowiki>{{doc|2}}</nowiki>}} | |||
{{MdCodeBlock|<nowiki>{{doc|3}}</nowiki>}} | |||
{{MdCodeBlock|<nowiki>{{doc|4}}</nowiki>}} | |||
| | |||
{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc}}}} | |||
{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|0}}}} | |||
{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|1}}}} | |||
{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|2}}}} | |||
{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|3}}}} | |||
{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|4}}}} | |||
|- | |||
|{{param|list}} | |||
|指定使用特定文档页面列出页面的页面或类别。仅当参数 {{param|1}} 设置为 4 时才使用。 | |||
|{{MdCodeBlock|<nowiki>{{doc|4|list=1}}</nowiki>}} | |||
|{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|4|list=1}}}} | |||
|- | |||
|{{param|docpage}} | |||
|将用作文档的页面。 | |||
|{{MdCodeBlock|<nowiki>{{doc|docpage=Main Page}}</nowiki>}} | |||
|{{ExpandBox:zh-cn|{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|docpage=Main Page}}}}}} | |||
|- | |||
|{{param|content</语言代码>}} | |||
|将用作文档的内容,而不是单独的页面。使用时,主工具是隐藏的。 | |||
|{{MdCodeBlock|<nowiki>{{doc|content=Something|content/zh-cn=某物}}</nowiki>}} | |||
|{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|content=Something|content/zh-cn=某物}}}} | |||
|- | |||
|{{param|pagespace}} | |||
|页面空间是自动确定的,但你可以输入自己的页面空间。标题中的文本取决于以下参数: | |||
*Template → “模板文档” | |||
*File → “摘要” | |||
*User → “关于” | |||
*其他情况下为 “文档” | |||
{{note:zh-cn|如果 {{param|pagespace}} 或实际页面空间是“User”,则文本将取自 /about 子页面,而不是 /doc。}} | {{note:zh-cn|如果 {{param|pagespace}} 或实际页面空间是“User”,则文本将取自 /about 子页面,而不是 /doc。}} | ||
|{{MdCodeBlock|<nowiki>{{doc|content=Something|content/zh-cn=某物}}</nowiki>}} | |||
{{MdCodeBlock|<nowiki>{{doc|content=Something|content/zh-cn=某物|pagespace=User}}</nowiki>}} | |||
{{MdCodeBlock|<nowiki>{{doc|content=Something|content/zh-cn=某物|pagespace=File}}</nowiki>}} | |||
{{MdCodeBlock|<nowiki>{{doc|content=Something|content/zh-cn=某物|pagespace=}}</nowiki>}} | |||
|{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|content=Something|content/zh-cn=某物}}}} | |||
{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|content=Something|content/zh-cn=某物|pagespace=User}}}} | |||
{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|content=Something|content/zh-cn=某物|pagespace=File}}}} | |||
{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|content=Something|content/zh-cn=某物|pagespace=}}}} | |||
|- | |||
|{{param|tools}} | |||
|控制应显示哪些工具按钮: | |||
*0 – 无按钮。 | |||
*1 – 仅显示按钮“创建”“查看”“编辑”、“页面历史”。 | |||
*其他情况下显示全部按钮。 | |||
|{{MdCodeBlock|<nowiki>{{doc|docpage=Main Page|tools=0}}</nowiki>}} | |||
{{MdCodeBlock|<nowiki>{{doc|docpage=Main Page|tools=1}}</nowiki>}} | |||
|{{ExpandBox:zh-cn|{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|docpage=Main Page|tools=0}}}}}} | |||
{{ExpandBox:zh-cn|{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|docpage=Main Page|tools=1}}}}}} | |||
|- | |||
|{{param|nolang}} | |||
|如果设置为 1 则移除语言栏。 | |||
|{{MdCodeBlock|<nowiki>{{doc|docpage=Main Page|nolang=1}}</nowiki>}} | |||
|{{ExpandBox:zh-cn||{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|docpage=Main Page|nolang=1}}}}}} | |||
|- | |||
|{{param|examples}} | |||
|可以复制并在其他页面上使用的示例请转到此处。使用时,“示例”按钮出现在文档块标题下方的左侧。 | |||
|{{MdCodeBlock|<nowiki>{{doc|content=Something|content/zh-cn=某物|examples=something<br>something<br>something<br>something<br>something}}</nowiki>}} | |||
|{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|content=Something|content/zh-cn=某物|examples=something<br>something<br>something<br>something<br>something}}}} | |||
|- | |||
|{{param|noscroll}} | |||
|如果你使用带有少量示例的 {{param|examples}} 参数,此设置将关闭滚动条所需的右侧额外填充(滑动条)。 | |||
|{{MdCodeBlock|<nowiki>{{doc|content=Something|content/zh-cn=某物|examples=something<br>something<br>something<br>something<br>something|noscroll=1}}</nowiki>}} | |||
|{{Doc/PreviewBlock|padding=2px 10px 2px 10px|style=border: 1px solid rgba(255,255,255,.2); box-shadow: 0 5px 10px rgba(0,0,0,.5)|{{doc|content=Something|content/zh-cn=某物|examples=something<br>something<br>something<br>something<br>something|noscroll=1}}}} | |||
|} | |||
==创建文档== | ==创建文档== |
Revision as of 04:37, 14 January 2023

Don't forget to purge the contents of the base page upon creating or editing this subpage.
模板 {{doc}}
旨在向各个页面(主要是模板页面)添加文档块。某种语言的子页面将根据用户界面的语言加载到文档块中。如果是英文,文档将取自 /doc
子页面。但在所有其他情况下,文档将取自子页面 /doc/<语言代码>
工具
主工具位于文档块上方的右上角:
创建
– 打开文档的创建页面。仅在文档未创建时显示。查看
– 打开文档页面。编辑
– 打开打开文档的编辑页面。页面历史
– 打开文档页面的更改历史记录。
另外,在右上角有一个标有省略号 [ ... ] 的按钮。它可以展开/折叠其他工具:
沙盒
– 打开子页面 {{mdCode|desaturated|/sandbox 的创建页面并复制原始页面的代码,或者,如果此页面存在,则直接打开它。测试用例
– 打开 {{mdCode|desaturated|/testcases 子页面。对于在不同情况下测试模板很有用。子页面
– 打开 Special:PrefixIndex 并输入本页面名以搜索全部子页面。清除缓存(刷新页面)
– 打开一个窗口,其中包含有关清除页面(缓存)的消息。
语言栏
在右上角的工具下,有一些标志可以将文档切换到另一种语言。切换是通过在页面链接中插入 &uselang=<语言代码>
来实现的,因此,如果你单击另一种语言,那么随着文档,界面语言将发生变化。
如果将 {{{nolang}}} 设置为 1,则可以删除语言栏。
如果没有某种语言的文档,将显示消息“文档页面 <页面> 不存在。”,并且语言标志将以红色突出显示。如果 {{{pagespace}}} 或实际页面空间是User
,则会显示消息“<用户> 没有提供有关他自己关于该语言的信息(<页面>)”。
参数和示例
参数 | 描述 | 示例 | 预览 |
---|---|---|---|
{{{1}}} | {{{1}}}: 用于切换模板分配的参数:
|
Template:MdCodeBlock Template:MdCodeBlock Template:MdCodeBlock Template:MdCodeBlock Template:MdCodeBlock Template:MdCodeBlock |
![]() This is a documentation subpage for Template:Doc.
Don't forget to purge the contents of the base page upon creating or editing this subpage. ![]() This is the sandbox subpage for Template:Doc. (diff)
![]() This is the Template:Doc info subpage.
![]() This documentation subpage 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. |
{{{list}}} | 指定使用特定文档页面列出页面的页面或类别。仅当参数 {{{1}}} 设置为 4 时才使用。 | Template:MdCodeBlock | ![]() This documentation subpage 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. |
{{{docpage}}} | 将用作文档的页面。 | Template:MdCodeBlock |
|
{{{content</语言代码>}}} | 将用作文档的内容,而不是单独的页面。使用时,主工具是隐藏的。 | Template:MdCodeBlock | |
{{{pagespace}}} | 页面空间是自动确定的,但你可以输入自己的页面空间。标题中的文本取决于以下参数:
|
Template:MdCodeBlock
Template:MdCodeBlock Template:MdCodeBlock Template:MdCodeBlock |
|
{{{tools}}} | 控制应显示哪些工具按钮:
|
Template:MdCodeBlock |
|
{{{nolang}}} | 如果设置为 1 则移除语言栏。 | Template:MdCodeBlock | Template:ExpandBox:zh-cn |
{{{examples}}} | 可以复制并在其他页面上使用的示例请转到此处。使用时,“示例”按钮出现在文档块标题下方的左侧。 | Template:MdCodeBlock | Template:Doc/PreviewBlock |
Template:Param | 如果你使用带有少量示例的 Template:Param 参数,此设置将关闭滚动条所需的右侧额外填充(滑动条)。 | Template:MdCodeBlock | Template:Doc/PreviewBlock |
创建文档
Template:Warning:zh-cn 要开始创建文档,请单击右上角的“创建”按钮。在文档的最开头,添加模板 Template:Tl 并在参数 Template:Param 中输入 0。之后,你将看到一条消息,指出这是一个文档子页面。为了使此消息不会出现在文档块中,应按以下方式编写: Template:MdCode 然后编写文档本身的文本。首先有一个简短的描述,然后 - 取决于编写文档的目的。