Help:TemplateData

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

Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Cymraeg • ‎Deutsch • ‎English • ‎Frysk • ‎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 • ‎suomi • ‎svenska • ‎čeština • ‎Ελληνικά • ‎български • ‎русский • ‎српски / srpski • ‎українська • ‎հայերեն • ‎ייִדיש • ‎עברית • ‎العربية • ‎تۆرکجه • ‎سنڌي • ‎فارسی • ‎پښتو • ‎अङ्गिका • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎মেইতেই লোন্ • ‎ไทย • ‎ქართული • ‎中文 • ‎日本語 • ‎한국어
PD Oharra: Orri hau aldatzean, zure ekarpena CC0-ren lizentziapean uztea onartzen duzu. Ikusi Domeinu Publikoko Laguntza Orriak informazio gehiagorako.
PD

TemplateData wikitextu txantiloi bati eta haren parametroei buruzko informazioa gordetzeko modu bat da, VisualEditor-ek berreskuratu eta erakus dezan txantiloi editorean, honela errazagoa izan dadin txantiloiak aldatzea.

The TemplateData extension is installed on all wikis operated by the Wikimedia Foundation. If you have your own wiki, then you will need to install Extension:TemplateData.

TemplateData sintaxiak erabiltzaileei aukera ematen die informazio estrukturatuaren parte txikiak txantiloi- orri batera idazteko, edo txantiloi-orri batean txertatzeko(txantiloi-dokumentazio orri bat bezalaxe). Behin txantiloi batek informazio hori estrukturatua izanda, egoki heda daiteke Ikusizko Editorean. Konplexua dirudien arren, berez oso erraza da.

TemplateData editorea

Bada tresna integratu bat TemplateData modu sinpleagoan editatzeko.

TemplateData editorea erabiltzeko, joan txantiloiaren orrira (edo haren dokumentuaren azpiorrira) eta sakatu "Aldatu" botoia. Horrek "TemplateData kudeatu" dioen botoi bat emango dizu, justu edizio lehioaren gainean:

Manage template documentation button for TemplateData 2014.png

Sakatu botoi hau TemplateData aldatzeko GUI tresnan sartzeko.

A screenshot of the TemplateData editing tool

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 <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.

Zerrendatu ditzakezu parametroaren izena, horrentzako edozein ordezko izen edo alias, etiketa eta erabiltzaileei bistaratuko zaien azalpena. Derrigorrezko eremu bakarra izena da(aurreneko eremua errenkada bakoitzean), non erregistro zehatza grabatzen baita, parametrotik letra larri eta xehean artean bereiziz. Agerturiko menuan, parametroak jaso beharreko eduki mota hauta dezakezu, nola eta katea (testu arrunten erantzunetarako), orria (beste orrietarako loturentzat) edota datak bezala. Txantiloiak errorea sortuko balu parametro hau zurian utzita, mesedez markatu ezazu "Derrigorrezko" moduan. Baldin parametroa sarri erabiltzen edo gomendatzen bada, markatu ezazu "Iradokia" moduan. "Ezabatu" botoiak parametroaren sarrera ezabatuko du TemplateData-tik.

TemplateData editorearen argazkia, bigarren parametro bat gehitzen erakusten

Txantiloi bakoitzak dokumentatzeaz amaitzen duzunean, klik egin Aplikatu botoian edizio kaxa irekian aurrez fomateatutako TemplateData sartzeko. honez gaizki, orria gorde beharko duzu ohiko Gorde botoian sakatuz.

Erne: TemplateData editoreak TemplateData txantiloiaren orrian edo bai dokumentazio azpiorrian jarriko du. Zuk erabaki dezakezu TemplateData non joango den TemplateData joatea nahi duzun orria irekiz. Hala ere, txantiloi baten barruan hainbat TemplateData bloke txertatuak badaude, orduan TemplateData bloke horietako bat baino ez da gehituko. Orrian dagoeneko TemplateData badago, TemplateData aurrez sartua zegoen orria aldatu beharko duzu ustekabean TemplateData bloke anitzak ez sortzeko.

Limitations and questions

  • Falta diren funtzionalitateak — 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 the visual editor. 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.
  • Oraingo arazoak — Egungo akatsen eta funtzionalitate eskaeren zerrenda erabilgarri dago Wikimedia bug tracker-n.

TemplateData-ren kokapena

TemplateData shall be on the page it describes, or be transcluded into it. In a template, it shall typically be wrapped into <noinclude> tags. On normal page rendering, it displays autogenerated documentation as shown in #Example.

TemplateData-ren egitura

TemplateData's structure is based around the JSON standard. Note that all descriptions in TemplateData must be in plain text (no wikitext, no links, etc.).

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-ko edukia hemen doa
}
</templatedata>

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

Adibidea

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": "Txantiloi bat artikulu bati buruzko Commons kategoriara lotzeko",
    "params": {
        "1": {
            "label": "Commons kategoria",
            "description": "Lotu nahi duzun Commons kategoria.",
            "default": "Category:CommonsRoot",
            "type": "string",
            "required": true
        }
    }
}
</templatedata>

Txantiloian, honela agertuko da:

Txantiloi bat artikulu bati buruzko Commons kategoriara lotzeko

Template parameters

ParameterDescriptionTypeStatus
Commons kategoria1

Lotu nahi duzun Commons kategoria.

Default
Category:CommonsRoot
Stringrequired

Deskribapena eta parametroak

description Lehenengo etiketa "description" da, zeinek txantiloiak egiten duena deskribatzen duen.
"description": "Txantiloi bat Commons kategoria bati lotzeko",
format Next is "format", which describes how the template's wikitext representation should be laid out. This can be set to the standard formats of "inline" (lehenetsia) and "block", or to a custom format; see below for more details.

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 "params" etiketa bat dago, geroko atalek txantiloiko parametro bakoitza estaltzen dutela adierazten dutenak.

Jarraitzen duten parametro guztiak "params" atalean sartuta daude.

"params": {
    ...    // parametroak hona doaz
}
  Within each parameter's subsection, the first tag is the name of the template parameter within the template.

Parametroak izenik badu, {{{category-link}}} bezala, etiketa hori "category-link" izango da.

Parametroa "izen gabea" bada, esanahia {{{1}}} bezalako zenbakia du, etiketa hori "1" izango da

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

"1": {     // parametroaren izena
    ...    // Parametroari buruzko informazioa hemen doa
}
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 kategoria",
description "description" dugu ondoren: oraingoan, parametroaren deskripzioa da, ez txantiloiarena osotasunean.
"description": "Lotu nahi duzun Commons kategoria.",
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. The most common types are:
  • "string": karaktere multzo bat, esaldi hauxe bezala;
  • "number": digitu multzoa;
  • "boolean": '0' for false, '1' for true, '' for unknown;
  • "wiki-user-name": lankide baten izena ordezkatzen duen karaktere multzoa
  • "wiki-page-name": orri baten titulua ordezkatzen duen karaktere multzoa.
  • "wiki-file-name": fitxategi baten izena.

Other types include: "unknown", "date", "url", "wiki-template-name", "content", "unbalanced-wikitext", "line"

"type": "string",
required Badugu beraz "required", true ala false bezala ezarri daitekeena.

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

Azkenik, "suggested" dago, true ala false bezala ezarri daitekeena.

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 if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

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).

Custom formats

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.

Examples of formats you can use
Objective Format string Output
Inline formatting {{_|_=_}}
inline
{{Foo|bar=baz|qux=quux}}{{Bar}}
Block formatting {{_\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
}}
Indent each parameter {{_\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}}

Parameter aliases

Txantiloi batzuk parametro bakar batek izen ezberdinak izateko aukera ematen dute.

Adibidez, {{Commons|category=Apples}} izan daiteke ere idatzia {{Commons|Apples}} edo {{Commons|link=Apples}} bezala.

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

    "params": {
        "kategoria": {
            ...
            "aliases": ["1", "lotura"]
        }

Auto value

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": {
        "data": {
            ...
            "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
        }

Multiple parameters

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": {
        ...
    },      // eta hemen
    "3": {
        ...
    }
}

Antzeko parametroak

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": {
        "1 Gaia": {
            "label": "Gaia",
            "description": "Argipen orri honetan aipatutako gai bat",
            "type": "string"
        },
        "2 Gaia": {
            "inherits": "1 Gaia"
        },
        "3 Gaia": {
            "inherits": "1 Gaia"
        },
    }

Blank boilerplate

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>

Beste tresnak

Help:Extension:TemplateWizard
A toolbar dialog window for entering template wikitext via an form built from TemplateData.
TemplateData Wizard
Interfaze interaktiboaren bidez TemplateData sortzen duen tresna.
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
Tresna bat aukera ematen duena eskuz idatzitako JSON-en baliketak egitea sintaxia akatsak aurkitzen laguntzeko.