Help:TemplateData/cs

 je rozšíření používané k ukládání informací o wikitext template a jejích parametrech, takže editační rozhraní může tyto informace načíst a zobrazit v editoru šablon, což uživatelům usnadní přidávání a editaci šablon na stránkách.

Od dubna 2019 je TemplateData součástí výchozího uživatelského prostředí pro všechny uživatele na všech Wikimedia wiki, když přidávají šablonu, včetně neregistrovaných uživatelů. Výchozí zdroj i vizuální editory jej nějakým způsobem začleňují. Používá se také jinde ve skriptech, nástrojích a miniaplikacích. Pokud máte vlastní wiki, budete muset nainstalovat Extension:TemplateData.

Přidání TemplateData do šablony v podstatě spočívá v vložení malého bloku kódu JSON (vysvětleno níže) na stránce dokumentace šablony. Existují dva hlavní způsoby, jak to provést, buď ručně nebo pomocí editoru TemplateData, grafického uživatelského rozhraní umístěného na stránkách "Edit"/"Edit source" (Upravit/Upravit zdroj) šablon na wiki s nainstalovanou příponou TemplateData. JSON obsahuje seznam parametrů s informacemi o každém parametru šablony i šablony jako celku. Ty jsou nastíněny níže.

Jakmile šablona obsahuje data TemplateData, zobrazí se tato informace v uživatelském rozhraní, když uživatel přidá šablonu, někdy místo původních informací nebo někdy jako doplňující informace. V některých případech se může změnit chování editoru při úpravách nebo vkládání šablony. To může uživatelům usnadnit identifikaci toho, co se šablonou potřebují při přidávání.

Historie
TemplateData byl původně vyvinut na začátku roku 2013 s ohledem na, což bylo v té době ve fázi testování MediaWiki. VisualEditor je hlavní vizuální editační rozhraní pro Wikimedia wikis a TemplateData mu umožnilo mít užitečnější rozhraní při přidávání šablon. To bylo oficiálně podporováno VisualEditor okamžitě. Vzhledem k tomu, že VisualEditor byl rozšířen na různé hlavní Wikimedia wiki jako výchozí funkce od roku 2013 do roku 2016, TemplateData se také stala jejich součástí.

V březnu 2018 společnost Sam Wilson vyvinula rozšíření, rozšíření editoru GUI pro výchozí zdrojový editor Wikimedia, (jinak známý jako editor wikitext 2010), jehož cílem je usnadnit proces přidávání šablon pomocí informací z TemplateData. V dubnu 2019 byl TemplateWizard nastaven jako výchozí součást editoru wikitext 2010 na všech Wikimedia wiki. To znamenalo, že TemplateData byla nyní výchozí součástí vizuálního editoru i zdrojového editoru na Wikimedia wikis.

Editor Strojového popisu šablony
Editor TemplateData je nástroj zabudovaný do rozšíření TemplateData pro přidání a úpravy TemplateData pomocí grafického uživatelského rozhraní.

Je dostupný přístupem na jakoukoli stránku šablony (nebo podstránky dokumentace) a kliknutím na "Upravit" (Edit) nebo "Upravit zdroj" (Edit source). Poté, co to uděláte, uvidíte tlačítko nad editační oblastí a nadpis stránky, který říká "".



Kliknutím na toto tlačítko vstoupíte do editoru TemplateData.

Editor umožňuje přidat parametry šablony a nastavit nejběžnější atributy. Pokud již editovaná stránka obsahuje blok TemplateData, když otevřete správnou stránku v editoru TemplateData, zobrazí se již dokumentované informace. V prvním poli můžete přidat nebo aktualizovat krátký popis šablony jako prostý text. Poté můžete pomocí tlačítek "Přidat navrhované parametry" (Add suggested parameter(s)) a "Přidat parametr" (Add parameter) zdokumentovat názvy a atributy parametrů, které šablona používá.

Můžete uvést název parametru, případné aliasy, štítek a popis, který se zobrazí uživatelům. Můžete také uvést příklad použití parametru. Jediným povinným polem je Název (Name) (první pole v každém řádku), kde se zaznamenává přesný název parametru rozlišující velká a malá písmena. V rozbalovací nabídce "Typ" (Type) můžete vybrat typ obsahu, který by měl parametr obdržet, například řetězec (pro odpovědi prostého textu), stránka (pro odkazy na jiné stránky) nebo data. Pokud šablona způsobí chybu, pokud je tento parametr ponechán prázdný, označte jej jako "Povinné" (Required). Pokud je parametr běžně používán nebo doporučován, označte jej jako "Navrhovaný" (Suggested). Tlačítko "Odstranit informace o parametru" (Remove parameter information) odstraní položku parametru z TemplateData.



Po dokončení dokumentace všech parametrů klikněte na "Použít" (Apply) a vložte předformátované TemplateData do otevřeného editačního pole. Stránku musíte uložit pomocí běžného tlačítka „Uložit“ (Save) pod editačním oknem.

Upozornění: Editor TemplateData umístí TemplateData na stránku šablony nebo na podstránku dokumentace. Určete, kam budou TemplateData přidána otevřením (úpravou) stránky, na kterou má být TemplateData umístěna. Pokud je však na stejnou šablonu umístěno více bloků TemplateData, bude použit pouze jeden z těchto bloků TemplateData. Pokud již na stránce existují TemplateData, musíte upravit stránku, na které byla TemplateData dříve umístěna, aby nedošlo k náhodnému vytvoření více bloků TemplateData.

Umístění Strojového popisu šablony
TemplateData musí být na stránce, kterou popisuje nebo musí být na ní transcluded. V šabloně se obvykle zabalí do značek. Při normálním vykreslování stránky zobrazuje automaticky generovanou dokumentaci, jak je uvedeno v #Příklad.

Struktura Strojového popisu šablony
Struktura TemplateData je založena na standardu JSON. Všechny popisy v TemplateData musí být v prostém textu (žádný wikitext, žádné odkazy, "atd.").

První věcí, kterou musíte udělat, je napsat pár značek, kdekoli na podstránce dokumentace šablony, takto:

To říká softwaru, že vše mezi těmito dvěma značkami je TemplateData a mělo by se na něj při použití šablony odkazovat.

Příklad
Popisy uvnitř TemplateData se řídí standardním rozvržením. Řekněme, že máte šablonu nazvanou "Commons", která slouží k propojení s kategorií Commons o daném tématu. Vyžaduje jeden povinný parametr: název kategorie v Commons. TemplateData bude vypadat asi takto:

This would display, in the template, like so:

{   "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 }   } }

Popis a parametry
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.

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.

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

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

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

Prázdná předloha
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

Syntax error in JSON / Bad JSON format
This error occurs if you attempt to save TemplateData that has certain types of invalid JSON code, such as duplicate keys (parameters) or trailing/missing commas, in VisualEditor or the 2017 wikitext editor (JavaScript-based editors).

"Syntax error in JSON" shows if you attempt to save such code in VisualEditor or the 2017 wikitext editor, while "Bad JSON format" shows if you attempt to open up such code in the TemplateData GUI editor, on template pages.

This error can come up quite frequently while editing a template's TemplateData. The most common mistakes that cause this error include excess commas (such as trailing commas), missing commas and missing quotation marks.


 * Examples of trailing commas:


 * Examples of missing commas:


 * Example of missing quotation marks:

To fix these errors, you can either look for the errors in the code yourself, or 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.

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.

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 refers to the parameter in   that is missing. It refers to its order in the sequence, but it is one less than its actual position, since  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 refers to the parameter in   that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since  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.

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 after  equals   or   and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of  and that 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.

Unexpected property "parametername".
This error occurs if you state a parameter in any object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one object under another object that it doesn't belong to.

For example, you might have written the parameter  under the root TemplateData object instead of inside  :

Alternatively, if the unexpected parameter is under a template parameter inside, you'll see its name after "params.parametername." in the error.

To fix this, make sure your parameters are in their correct location, and make sure there aren't any spelling mistakes in the parameter names. Additionally, make sure you don't state any parameters that don't exist for an object. You can check which parameters exist for an object on this page, in the section.

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.

Omezení a zpětná vazba

 * Chybějící funkce — 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.
 * Prodlevy při zobrazování v šablonách — 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.
 * Aktuální problémy — A list of current bugs and feature requests is available in the Wikimedia bug tracker.

Další nástroje

 * : A toolbar dialog window for entering template wikitext via an form built from TemplateData.
 * 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.
 * List of all templates with TemplateData on this 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