Help:TemplateData/zh

是一种存储关于wikitext模板及其参数的信息的方式，可以方便可视化编辑器在其模板编辑界面中获取显示，简化使用这些模板编辑页面的流程.

模板数据扩展已于所有基金会wiki网站上安装. 如果你自己运营维基站点，那么你需要给它安装Extension:TemplateData.

模板数据语法允许用户向模板（或包含入模板的页面，如文档页）写入小块结构化数据. 模板加上这样的数据之后，就可以在可视化编辑器里妥当显示. “结构化数据”什么的词语听起来很复杂，其实一点都不难.

TemplateData editor
有一个内建工具，可用来简易编辑模板数据.

To use the TemplateData editor, go to the template's page (or its documentation subpage) and press the "Edit" button. That will give you a button that says "", just above the open editing window:

Click this button to enter the GUI tool for editing TemplateData.

The editor allows you to add template parameters and to set the most common attributes. If the page you edited already contains a block of TemplateData, then the information already documented will automatically be shown when you open the correct page in the TemplateData editor. In the first box, you can add or update a short description of the template in plain text. After that, you can use the "Add suggested parameter(s)" and "Add parameter" buttons to document the names and attributes of the parameters that the template uses.

If the template documentation is in a subpage, the "Add suggested parameter(s)" button will only appear on the template page. A solution is to edit the template page, click on the "Add suggested parameter(s)" in the TemplateData editor and then copy-and-paste the TemplateData content (between the and tags) in the documentation subpage.

If the template page is protected, you can copy-and-paste the template code in the subpage, use the "Add suggested parameter(s)" button there, copy the TemplateData content, edit back the subpage to get rid of the template code and then paste the TemplateData content. To know where to paste the TemplateData content inside the subpage, you can edit TemplateData without adding anything; you can then replace the and tags and their content by pasting over them.

你可以列出参数的名称（必填，大小写敏感）、任意多个别名、显示时使用的文字标签（推荐）和展现给用户的描述. 你也可以提供一个使用参数的例子. 在“类型”选单中，你可以选择这个参数应接受的内容，例如字符串（纯文本输入）、页面（页面链接）或日期. 如果模板在某项留空时会出错，请将其标为“必填”；如果参数十分常用或推荐使用，请将其标为“推荐”. “移除参数信息”这个按钮会从模板数据中删掉此条参数的信息.



当您完成记录每个参数，点击“应用”插入预格式化的模板数据到打开的编辑框. 您还必须使用在编辑窗口下的“保存”按钮保存该页.

警告：模板数据编辑器将模板数据放在模板页或子文档. 你通过打开（编辑）你想要的模板数据放置的页面决定模板数据添加在哪里. 然而，如果多个模板数据块放在同一个模板中，那么只有其中一个模板数据块会被使用. 如果在页面中已经有一个模板数据，那么你需要编辑该模板数据先前放置的页面以避免意外创建多个模板数据块.

局限及疑问

 * 缺失功能 — TemplateData is an example of a tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * 模板显示延迟 — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in VisualEditor. However, it is possible that it will take several hours before the metadata will show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change and without adding any edit summary.
 * 现有问题 — 现有问题（臭虫）和特性请求可在Wikimedia错误追踪系统找到.

模板数据的位置
模板数据应该位于其描述的页面上，或包含入之. 在模板中，其一般应包裹于标签中. On normal page rendering, it displays autogenerated documentation as shown in #Example.

模板信息的结构
模板數據的结构基於「JSON」標準. 所有的模板信息内容都为纯文本（没有wikitext链接等）.

首先要在模板的任意位置打出一对 标签，就像这样：

這將能讓系統知道在兩個標籤之間的內容為模板數據，當模板被使用時即可調出其中的數據資料. 而模板數據的內容有固定的格式，將被用來列出可在模板中使用的參數.

范例
The descriptions inside TemplateData follow a standard layout; let's say that you have a template called "Commons" for linking to a Commons category about a topic. It takes one mandatory parameter: the name of the category on Commons. The TemplateData would look something like this:

This would display, in the template, like so:

{   "description": "A template for linking to a commons category about an article", "params": { "1": {           "label": "共享资源分类", "description": "要链接到的共享资源分类. ", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

描述和参数
Once you're done, hit "save". If you've made errors, it will not let you save (which is disruptive, but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.

Note that each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).

参数别名
Some templates allow a same parameter to have different names.

例如 也可以写为 或.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:

自动值
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use  to make the values stick:

多个参数
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:

类似参数
在一个有着多个参数的模板中，经常有参数互相雷同、同属一类的情况. 此时，你只需要完整指定第一个的属性，而让其余的某类参数“集成”第一个的属性.

空白样板
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

其它工具

 * TemplateDataEditor — A user script that makes the process of adding TemplateData easier. It currently exists in French (contains English, Italian, Japanese and Korean translations), and can easily be translated into other languages.
 * TemplateData Wizard — A tool that generates TemplateData through an interactive interface.
 * Skeleton TemplateData generator — A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint — A tool that allows you to validate manually-written JSON to help find errors in the syntax.
 * 在此wiki上所有带模板数据的模板列表
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data