Help:DataTemplat

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Help:TemplateData and the translation is 10% complete.

Other languages:
अङ्गिका • ‎العربية • ‎asturianu • ‎azərbaycanca • ‎تۆرکجه • ‎български • ‎বাংলা • ‎català • ‎čeština • ‎dansk • ‎Deutsch • ‎Zazaki • ‎Ελληνικά • ‎emiliàn e rumagnòl • ‎English • ‎español • ‎euskara • ‎فارسی • ‎suomi • ‎føroyskt • ‎français • ‎Frysk • ‎galego • ‎עברית • ‎हिन्दी • ‎hrvatski • ‎magyar • ‎Հայերեն • ‎Bahasa Indonesia • ‎Ilokano • ‎italiano • ‎日本語 • ‎ქართული • ‎한국어 • ‎Lëtzebuergesch • ‎lietuvių • ‎मराठी • ‎Nederlands • ‎occitan • ‎Oromoo • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎Scots • ‎سنڌي • ‎slovenščina • ‎svenska • ‎Türkçe • ‎українська • ‎Tiếng Việt • ‎ייִדיש • ‎中文
PD Catatan: Ketika Anda menyunting halaman ini, Anda setuju untuk melepas kontribusi Anda di bawah CC0. Lihat Halaman Bantuan Ranah Umum (Public Domain) untuk informasi lebih lanjut.
PD

TemplateDataExtension:TemplateData is a way of storing information about a wikitext template and its parameters, so that VisualEditor can retrieve and display it in its template editor, thus making it easier to edit pages using that template.

The TemplateData extension is installed on all wikis operated by the Wikimedia Foundation. Jika Anda memiliki wiki sendiri, maka Anda perlu menginstal Extension: TemplateData.

Sintaksis TemplateData memungkinkan pengguna menulis bit kecil data terstruktur ke halaman template, atau untuk ditransklusikan ke dalam halaman template (seperti pada halaman dokumentasi template). Setelah template memiliki data terstruktur ini, gambar dapat ditampilkan dengan benar di VisualEditor. Meskipun ini mungkin terdengar rumit, sebenarnya sangat mudah.

editor TemplateData[edit]

Ada tool built-in untuk mengedit TemplateData dengan cara yang lebih sederhana.

Untuk menggunakan editor TemplateData, buka halaman template (atau subdirektori dokumentasinya) dan tekan tombol "Edit". Itu akan memberi Anda tombol yang bertuliskan "$ manage", tepat di atas jendela pengeditan yang terbuka:

Manage template documentation button for TemplateData 2014.png

Klik tombol ini untuk masuk ke tool GUI untuk mengedit TemplateData.

Tangkapan layar alat pengeditan 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.

Catatan Catatan: 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 <templatedata> and </templatedata> 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 <templatedata> and </templatedata> tags and their content by pasting over them.

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. You can also provide an example how to use the parameter. The only required field is Name (the first field in each row), which is where you record the exact, case-sensitive name of the parameter. In the "Type" dropdown menu, you can choose the type of content that the parameter should receive, such as a string (for plain-text answers), page (for links to other pages), or dates. If the template will produce an error if this parameter is left blank, please mark it as "Required". If the parameter is commonly used or recommended, then mark it as "Suggested". The "Remove parameter information" button will delete the parameter's entry from TemplateData.

When you are finished documenting each of the parameters, click "Apply" to insert the pre-formatted TemplateData into the open editing box. You must still save the page, using the normal "Save" button underneath the editing window.

Caution: The TemplateData editor will place TemplateData on either the template page or on a documentation subpage. You determine where the TemplateData will be added by opening (editing) the page that you want the TemplateData to be placed on. However, if multiple TemplateData blocks are placed on the same template, then only one of those TemplateData blocks will be used. If there is already TemplateData on a page, then you need to edit the page where the TemplateData was previously placed to avoid accidentally creating multiple blocks of TemplateData.

Limitations and questions[edit]

  • Missing features — 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.
  • Delays in showing in templates — 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.
  • Current issues — Daftar bug dan permintaan fitur terkini tersedia di pelacak bug Wikimedia.

Location of TemplateData[edit]

TemplateData ada pada halaman yang dideskripsikannya, atau transcluded ke dalamnya. In a template, it shall typically be wrapped into <noinclude>Noinclude tags. On normal page rendering, it displays autogenerated documentation as shown in #Example.

Structure of TemplateData[edit]

Struktur TemplateData didasarkan pada standar JSON. Perhatikan bahwa semua deskripsi di TemplateData harus dalam teks biasa (tidak ada wikitext, tidak ada tautan, dll ).

The first thing to do is to type out a pair of <templatedata> tags, anywhere on the template's documentation subpage, like so:

<templatedata>
{
    ...       // TemplateData content goes here
}
</templatedata>

This tells the software that everything between the two tags is TemplateData, and should be referenced when the template is used.

Example[edit]

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:

<templatedata>
{
    "description": "A template for linking to a commons category about an article",
    "params": {
        "1": {
            "label": "Commons category",
            "description": "The commons category you want to link to.",
            "default": "Category:CommonsRoot",
            "type": "string",
            "required": true
        }
    }
}
</templatedata>

This would display, in the template, like so:

A template for linking to a commons category about an article

Template parameters

Parameter Description Type Status
Commons category 1

The commons category you want to link to.

Default
Category:CommonsRoot
Example
empty
Auto value
empty
String required

Description and parameters[edit]

description The first tag is a "description", which describes what the template does.
"description": "A template for linking to a commons category",
format Next is "format", which describes how the template's wikitext representation should be laid out. This can be set to either "inline" (baku) or "block".

If the parameter is set to "inline" it will create a wikitext representation with no white space, like so:

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

If the parameter is set to "block" it will create a wikitext representation with line breaks and single spaces between each part, like so:

{{Foo
| bar = baz
| qux = quux
}}
"format": inline
params There is then a "params" tag, which indicates that subsequent sections cover each parameter in the template.

All the parameters that follow are included in the "params" section.

"params": {
    ...    // parameters go here
}
  Within each parameter's subsection, the first tag is the name of the template parameter within the template.

If the parameter has a name, like {{{category-link}}}, this tag would be "category-link".

If the parameter is "unnamed", meaning it's just a number like {{{1}}}, this tag would be "1".

All the bits of information about this parameter are included in the section that starts with the parameter's name.

"1": {     // name of the parameter
    ...    // information about the parameter goes here
}
label Next we have "label", in which you put a human-readable title for the parameter that will be displayed within the template editor.
"label": "Commons category",
description We then have "description": this time, it's a description of the parameter, not of the template as a whole.
"description": "The commons category you want to link to.",
default Next is "default". Some templates have a default value that is used unless you change it. This item tells the user what the default value for this parameter is.

You can ignore this parameter if there's no default.

"default": "Category:CommonsRoot",
type After that we have "type", which controls how the template editor will interpret that parameter. This can be:
  • "string": a set of characters, like this sentence;
  • "number": a set of digits;
  • "wiki-user-name": a set of characters that represents a user's name;
  • "wiki-page-name": a set of characters that represents a page's title.
  • "wiki-file-name": a file name.
"type": "string",
required We then have "required", which can be set to either true or false.

This simply controls whether filling out the parameter is mandatory for that template. If you don't specify, it will be assumed to be false.

"required": true
suggested There is "suggested", which can be set to either true or false.

This is a status for parameters which are not 'required' but are recommended to be high value (but not mandatory) for template users. If you don't specify, it will be assumed to be false.

"suggested": true
deprecated

Finally, there is "deprecated", which can be set to true, false, or a string describing what users should instead do.

This is a status for parameters which should not be used any more, but still exist for the time being. This could be because uses of the template are being moved from one set of parameters to another. If you don't specify, it will be assumed to be false.

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

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 true and false), and separated from the next bit by a comma (unless it's the last one).

Parameter aliases[edit]

Some templates allow a same parameter to have different names.

For example, {{Commons|category=Apples}} could also be written as {{Commons|Apples}} or {{Commons|link=Apples}}.

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

    "params": {
        "category": {
            ...
            "aliases": ["1", "link"]
        }

Auto value[edit]

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 the prefix subst: with the values to make them stick:

    "params": {
        "date": {
            ...
            "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
        }

Multiple parameters[edit]

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:

"params": {
    "1": {
        ...
    },      // notice the comma here
    "2": {
        ...
    },      // and here
    "3": {
        ...
    }
}

Similar parameters[edit]

When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.

    "params": {
        "topic1": {
            "label": "Topic",
            "description": "A topic mentioned on this disambiguation page",
            "type": "string"
        },
        "topic2": {
            "inherits": "topic1"
        },
        "topic3": {
            "inherits": "topic1"
        },
    }

Blank boilerplate[edit]

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

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

Other tools[edit]

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.