帮助:模板数据

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Help:TemplateData and the translation is 89% complete.
Other languages:
Bahasa Indonesia • ‎Cymraeg • ‎Deutsch • ‎English • ‎Esperanto • ‎Ilokano • ‎Lëtzebuergesch • ‎Nederlands • ‎Oromoo • ‎Scots • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎asturianu • ‎azərbaycanca • ‎català • ‎dansk • ‎emiliàn e rumagnòl • ‎español • ‎euskara • ‎français • ‎føroyskt • ‎galego • ‎hrvatski • ‎italiano • ‎lietuvių • ‎magyar • ‎occitan • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎slovenčina • ‎slovenščina • ‎suomi • ‎svenska • ‎čeština • ‎Ελληνικά • ‎български • ‎македонски • ‎русский • ‎српски / srpski • ‎українська • ‎հայերեն • ‎ייִדיש • ‎עברית • ‎العربية • ‎تۆرکجه • ‎سنڌي • ‎فارسی • ‎پښتو • ‎अङ्गिका • ‎अवधी • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎ไทย • ‎ქართული • ‎中文 • ‎日本語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎한국어
PD 注意:当您编辑本页面时,即代表同意以CC0协议授权您的贡献。您可以在公有领域帮助页面找到更多信息。
PD

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

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

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

模板数据编辑器

有一个内建工具,可用来简易编辑模板数据。

要使用模板数据编辑器,前往模板页面(或其文档页),点按“编辑”按钮。在打开的编辑窗口上方,你会看到一个写着“管理模板数据”的按钮:

Manage template documentation button for TemplateData 2014.png

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

模板数据编辑工具的截图。

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

如果模板文档位于子页面,“添加建议的参数”按钮将只在模板页面出现。 解决方案是编辑模板页面,单击TemplateData编辑器中的“添加建议的参数”,然后在文档子页面中复制并粘贴TemplateData内容(<templatedata>和</templatedata>标签之间)

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

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

TemplateData编辑器的屏幕截图,显示添加的第二个参数

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

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

局限及疑问

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

模板数据的位置

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

模板信息的结构

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

首先要在模板的任意位置打出一对<templatedata>标签,就像这样:

<templatedata>
{
    ...       // 此处为模板数据内容
}
</templatedata>

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

范例

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

<templatedata>
{
    "description": "用于链接到条目相关共享资源分类的模板",
    "params": {
        "1": {
            "label": "共享资源分类",
            "description": "要链接到的共享资源分类。",
            "default": "Category:CommonsRoot",
            "type": "string",
            "required": true
        }
    }
}
</templatedata>

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

一个用于链接到共享资源分类的模板

Template parameters

ParameterDescriptionTypeStatus
共享资源分类1

要链接到的共享资源分类。

Default
Category:CommonsRoot
Stringrequired

描述和参数

description 第一项是"description",即模板的简要说明,内容包括模板的功用以及使用的时机。
"description": "用于链接到贡献资源分类",
format 接下来是"format",描述模板的维基文本表现如何排版。 这可以设置为"inline"(默认)和"block"的标准格式,或自定义格式;参见下文以获取更多详情

如果设置为"inline"则会生成不带空白字符的维基文本表示:

{{Foo|bar=baz|qux=quux}}

如果设为"block"则会生成含有换行符和空格分块的维基文本:

{{Foo
| bar = baz
| qux = quux
}}
"format": inline
params 接下来的"params"表示接下来的段落描述模板的诸个参数。

所有跟着模板的参数都放在"params"节里。

"params": {
    ...    // 此处为参数
}
  在每个参数的小节中,第一个标签是“在模板中”参数的名称。

如果参数有名字,例如{{{category-link}}},那么标签应该写作"category-link"

如果参数“无名”(匿名参数),意味着其只是类似“{{{1}}}”的一个数字,标签应该写作"1"

关于某个参数的全部信息都写在以其名称命名的小节内。

"1": {     // 参数名
    ...    // 此处为参数信息
}
label 接下来是"label",可填入人类可判读中文名称,这个名称将会在可视化编辑器中显示。
"label": "共享资源分类",
description 接下来我们又遇上"description"了。这次要给的是参数描述,不是整个模板的。
"description": "要链接到的共享资源分类。",
default 然后是"default"。有些模板使用一个不另行指定时自动选择的默认值,而此项告诉用户默认值是什么。

如果没有默认值,您可以忽略此参数。

"default": "Category:CommonsRoot",
type 接下来是"type",控制可视化模板编辑器如何解读参数。参数类型可以是:
  • "string": 一组字符,例如现在这句话;
  • "number": 一组数字;
  • "boolean": '0' for false, '1' for true, '' for unknown;
  • "wiki-user-name": 表明用户名的字符串;
  • "wiki-page-name": 表明页面标题的字符串。
  • "wiki-file-name": 一个文件名。

其他类型包括: "unknown", "date", "url", "wiki-template-name", "content", "unbalanced-wikitext", "line"

"type": "string",
required 接下来是"required",只可为true(真)、false(假)两种。

这条控制填入参数是否对模板必须。若不指定,则假定为false

"required": true
suggested 接下来是"suggested",只可为true(真)、false(假)两种。

这是一个对于模板用户而言非“必须”但推荐是高价值(但并不是强制的)的参数的状态。如果您不进行说明,此状态将被认定为false

"suggested": true
deprecated 最后,有"deprecated",此处可以设置为truefalse或一个描述用户应该做什么的字符串。

这是一个不再应该被使用的参数的状态,但仍然暂时存在。 这可能是因为此模板的使用正在从一套参数被移动到另一套。 如果您不进行说明,此处将被认定为false

"deprecated": "Please use 'publicationDate' instead."

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

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

请注意:信息的每一部分都被引号封闭(truefalse除外),且用逗号与下一部分分离开(除非这是最后一个)。

自定义格式

When editing custom format strings in the TemplateData editor you can either type \n or press the enter key to represent a newline; in either case it will display as in the entry field.

您可以使用的格式示例
目标 格式字符串 输出
行内格式 {{_|_=_}}
inline
{{Foo|bar=baz|qux=quux}}{{Bar}}
区块格式 {{_\n| _ = _\n}}
block
{{Foo
| bar = baz
| qux = quux
}}{{Bar
}}
No space before the parameter name,

each template on its own line

\n{{_\n|_ = _\n}}\n
{{Foo
|bar = baz
|qux = quux
}}
{{Bar
}}
缩进每个参数 {{_\n |_ = _\n}}
{{Foo
 |bar = baz
 |qux = quux
}}{{Bar
}}
Align all parameter names to a given length {{_\n|_______________ = _\n}}\n
{{Foo
|bar             = baz
|qux             = quux
|veryverylongparameter = bat
}}
{{Bar
}}
Pipe characters at the end of the previous line {{_|\n _______________ = _}}
{{Foo|
  bar             = baz|
  qux             = quux}}{{Bar}}
Inline style with more spaces, must be at start of line \n{{_ | _ = _}}
{{Foo | bar = baz | qux = quux}}
{{Bar }}
Template at the start of a line, indent-aligned parameters, pipe beforehand \n{{_ |\n _______________ = _}}
{{Foo |
  bar             = baz |
  qux             = quux}}
{{Bar}}

参数别名

部分模板容许一个相同的参数有不同的名称。

例如{{Commons|category=Apples}}也可以写为{{Commons|Apples}}{{Commons|link=Apples}}

要将该信息加入到模板信息中,您只需要将这些别名加入到参数信息中。

    "params": {
        "分类": {
            ...
            "aliases": ["1", "链接"]
        }

自动值

您可以给一个参数指定一个“自动值”。当用户将此模板加入一个页面,这个值将会被自动添加。例如,很多清理模板需要添加日期;如果您为这个模板的日期参数指定了一个自动值,该日期就将被自动加入。

要将该信息加入到模板信息中,您只需要将这些自动值加入到参数信息中。 您将可能想使用subst:来使这些值被固定:

    "params": {
        "日期": {
            ...
            "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
        }

多个参数

如果您有多个参数,只需重复每个部分(从标签“1”开始),并将其按照您的需要填写。请注意,如果一个模板具有多个参数,您需要在模板信息中将它们用逗号分隔开,就像这样:

"params": {
    "1": {
        ...
    },      // 注意此处的逗号
    "2": {
        ...
    },      // 以及此处
    "3": {
        ...
    }
}

类似参数

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

    "params": {
        "话题1": {
            "label": "话题",
            "description": "一个在该消歧义页面被提及的话题",
            "type": "string"
        },
        "话题2": {
            "inherits": "话题1"
        },
        "话题3": {
            "inherits": "话题1"
        },
    }

空白样板

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

<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": ""
        },
        "2": {
            "label": "",
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

Errors

Syntax Error in JSON / Bad JSON format

Due to a long standing bug, users using the old wikitext editor are able to save pages which have certain types of invalid JSON, such as duplicate keys or trailing commas (details: 任务T128029). However if you attempt to save this page in a JavaScript based editor, such as VisualEditor or the 2017 Wikitext editor, you will see an error message "Syntax error in JSON," as the JavaScript parser is stricter and doesn't allow invalid JSON. Additionally, if you attempt to open up such invalid JSON with the Template Data 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 https://jsonlint.com/, and it will highlight the problematic commas and keys so they can be removed.

其它工具

帮助:扩展:模板助手
A toolbar dialog window for entering template wikitext via an form built from TemplateData.
TemplateData Wizard
一个通过交互式界面生成模板信息的工具。
Skeleton TemplateData generator
一个读取模板源wiki代码的工具,尝试寻找使用的所有参数,并按列出的参数输出纲要文档。
JSONLint
一种允许您验证手动写入的JSON以帮助查找语法中的错误工具。