Help:TemplateData/zh

是一种存储关于wikitext模板及其参数的信息的方式，可以方便可视化编辑器在其模板编辑界面中获取显示，简化使用这些模板编辑页面的流程. 它也用于脚本、维护工具和小工具等其他领域.

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

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

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

要使用模板数据编辑器，前往模板页面（或其文档页），点按“编辑”按钮. 在打开的编辑窗口上方，你会看到一个写着“”的按钮：

点击这个按钮就可以进入编辑模板数据的图形化工具.

编辑器允许您添加模板参数和设置最常见的属性. 如果您编辑的页面已包含一个TemplateData块，则在TemplateData编辑器中打开正确的页面时，将自动显示已记录的信息. 在第一个框中，您可以添加或更新纯文本的模板的简短描述. 之后，您可以使用“添加建议的参数”和“添加参数”按钮记录模板使用的参数的名称和属性

如果模板页面被保护，可以在子页面中复制并粘贴模板代码，使用“添加建议参数”按钮，复制TemplateData内容，编辑回子页以摆脱模板代码然后粘贴TemplateData内容. 要知道在Subpage中将TemplateData内容粘贴到哪里，您可以编辑TemplateData而不添加任何内容;您可以通过粘贴 和 标记及其内容来替换它们.

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



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

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

局限及疑问

 * 缺失功能 — 模板数据是一个工具的例子，它提供了很少的功能，希望用户将有助于指导他们想要的功能的开发. 如果您想要请求模板数据的新功能，请l让我们知道.
 * 模板显示延迟 — 将模板数据添加到模板后，在可视化编辑器中打开模板时，元数据应立即可见. 但是，可能需要几个小时的时间才会显示元数据. 您可以通过对模板页面本身（而不是文档子页面）进行空编辑来强制更新. 要执行空白编辑，请打开模板页面进行编辑，并保存页面，“而不进行任何更改，也不添加任何编辑摘要”.
 * 现有问题 — 现有问题（bug）和特性请求可在Wikimedia错误追踪系统找到.

模板数据的位置
模板数据应该位于其描述的页面上，或包含入之. 在模板中，其一般应包裹于标签中. 在正常页面呈现时，它显示自动生成的文档，如#范例中所示.

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

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

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

范例
TemplateData中的描述遵循标准布局;让我们假设你有一个名为“Commons”的模板，用于链接到关于主题的Commons类别. 它需要一个强制参数：在Commons上的类别的名称. TemplateData看起来像这样：

这个模板当中会像这样显示：

{   "description": "一个用于链接到共享资源分类的模板", "params": { "1": {           "label": "共享资源分类", "description": "要链接到的共享资源分类. ", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

描述和参数
Each parameter for TemplateData is listed below with a description and example. They are also listed at Extension:TemplateData#Format.

The order of the parameters does not affect functionality, as long as those within, for example, the  object are kept within the object.

Note that this information is current as of February 2020 and may change if new parameters are added or the template editors get updates to treat certain parameters differently or fix certain behaviours.

Within the parameter's name
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the TemplateData documentation.

一旦您完成，点击“保存”即可. 如果您做出了错误，它将不会让您保存（这或许是破坏，但意思是您不能损坏任何东西）. 您应该运行调试错误，在反馈页面介绍您要尝试进行的操作，并且我们将很高兴帮助.

Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

请注意：信息的每一部分都被引号封闭（ 和 除外），且用逗号与下一部分分离开（除非这是最后一个）.

自定义格式
When editing the  value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.


 * - start of the template
 * - content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like . If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  to indent new lines)
 * - end of the template

The wikitext should at least meet the minimum of, otherwise there will be an invalid format string error.

Effects of the type parameter
The  parameter can have multiple different effects or no effect depending on the value and depending on the template editor. Its effects are listed as follows.



The  value is intended for numerical values, including minus values and decimals.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,,  causes the input box to display a "+" and "-" button on either side, which raise or lower a number value in the input box, respectively, and the user can only type numbers into the box. The buttons can also lower the number into negatives.



The  value is intended for any string of plain text.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  has no visible effect compared to.



The  value is intended for content that should be forced to stay on one line.


 * In VisualEditor and the 2017 wikitext editor,  prevents a parameter's input box from allowing new lines, which are usually possible in these editors.
 * In the 2010 wikitext editor with TemplateWizard,  has no visible effect (input boxes do not allow new lines by default in this editor).



The https:// value is intended for a URL, with Internet protocol (e.g., "https://") included.


 * In VisualEditor and the 2017 wikitext editor,  makes the input box display an external link icon (a square with arrow pointing out of it) in the left hand side of the box and makes the box glow red when the user clicks away without entering a URL value that includes a valid Internet protocol (e.g., "https://", "ftp://" or "//") followed by some text. This second effect is similar to that of the "required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested" or "deprecated").
 * In the 2010 wikitext editor with TemplateWizard,  has no visible effect.



The  value is intended for a page name on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of pages on the wiki, such as Wikipedia articles, which can be selected. Namespaces can also be defined in the search. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-page from being inputted.



The  value is intended for a file name hosted either locally on a wiki or on Wikimedia Commons.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box show a suggestion dropdown menu containing a list of files hosted both locally and on Wikimedia Commons, which can be selected. It also shows the thumbnail of the files. It has no other visible effect and doesn't prevent a non-file from being inputted.



The  value is intended for the name of a template.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of templates, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-template from being inputted.



The  value is intended for a username on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of actual users' names, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-username from being inputted.



The  value is intended for wikitext of page content, for example, links, images or text formatting.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.



The  value is intended for wikitext that cannot stand alone, i.e. it lacks an opening or closing tag or refers to other parts of wikitext.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.

With other parameters


 * In VisualEditor and the 2017 wikitext editor,  overrides the visible effects of  : when both are set, the input box will not contain a URL icon nor glow red when the user clicks away without entering a valid URL.
 * In the 2010 wikitext editor with TemplateWizard,  overrides the effects of  : the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".

空白样板
您可以复制下面的空白样本来向一个模板中添加新的模板信息. 只包含最常见的标签.

Syntax error in JSON / Bad JSON format
If you attempt to save TemplateData that has certain types of invalid JSON, such as duplicate keys (parameters) or trailing/missing commas, in VisualEditor or the 2017 wikitext editor (JavaScript-based editors), you will see the error message "Syntax error in JSON". These errors can come up quite frequently while heavily editing a template's TemplateData.

Examples of trailing commas:

Examples of missing commas:

Another common cause is missing quotation marks:

Additionally, if you attempt to open up such invalid JSON with the TemplateData GUI editor, you will see the error message "Bad JSON format".

To fix these errors, you can enter the JSON block into an external JSON validator, such as JSONLint, and it will highlight the problematic commas and keys that should be removed. Alternatively, you can look for the errors in the code yourself.

Due to a longstanding bug, users using the 2010 wikitext editor are able to save pages that have such invalid JSON (details: ), as the JavaScript parser is less strict and allows invalid JSON.

Property "format" is expected to be ...
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "Property "format" is expected to be "inline", "block", or a valid format string."

To fix this, make sure the value in  equals ,   or, if it's wikitext, contains a minimum of. Additionally, if it's wikitext, make sure there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats. Alternatively, you can remove the  parameter to remove this error.

Required property "paramOrder(number)" not found.
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets is the parameter in  that is missing (it is one less, since it is an array; 0 is the first one, 1 is the second, etc.).

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Invalid value for property "paramOrder(number)".
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets is the parameter in the  that is missing (it is one less, since it is an array; 0 is the first one, 1 is the second, etc.).

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Property "params.parametername.required" is expected to be of type "boolean".
This error occurs if you put quotation marks around the value of either  or.

These are boolean values, not strings, therefore they require no quotation marks. To fix this, remove any quotation marks around the values  or   for these parameters.

Required property "params" not found.
This error occurs if there is no  object in the TemplateData. This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes. See the section above on how to add the  parameter.

其它工具

 * : A toolbar dialog window for entering template wikitext via an form built from TemplateData.
 * TemplateData Wizard: 一个通过交互式界面生成模板信息的工具.
 * Skeleton TemplateData generator: 一个读取模板源wiki代码的工具，尝试寻找使用的所有参数，并按列出的参数输出纲要文档.
 * JSONLint: 一种允许您验证手动写入的JSON以帮助查找语法中的错误工具.
 * 在此wiki上所有带模板数据的模板列表
 * 使用dewiki template TemplateData模板数据在框中被显示出来，且该模板被添加到有模板信息的分类当中.