Help:TemplateData/pl



Co to jest TemplateData?
TemplateData is a way of storing information about a template and its parameters, so that the VisualEditor can retrieve and display it in the template editor, thus making it easier to edit templates.

TemplateData allows users to write small bits of structured data to a template page, or to be transcluded into that template page (such as on a documentation page). Once a template has this structured data, it can be displayed properly in the VisualEditor. While this may sound complex, it's actually very easy.



Struktura TemplateData
Struktura TemplateData opiera się na standardzie JSON i jest dość prosta. Ważnym jest tylko, aby pamiętać, że TemplateData musi być zapisywany samym tekstem (żadnego wikikodu, linków, itp.).

Pierwszym krokiem do stworzenia nowego szablonu jest zastosowanie dwóch  tagów, które należy wstawić w dowolnym miejscu na stronie dokumentacji szablonu. Poniżej ilustruje to przykład:

Tagi te poinformują oprogramowanie, że wszystko zawarte między nimi należy do TemplateData i powinno się do nich odwoływać w trakcie korzystania z danego szablonu.



Przykład
Treść zawarta między tagami ma zestandaryzowany zapis. Powiedzmy, że mamy szablon o nazwie "Commons", który odwołuje się do kategorii na Commons powiązanej z danym artykułem. Szablon ten ma jeden obowiązkowy parametr: nazwę kategorii na Commons. W takim przypadku odpowiedni zapis TemplateData powinien wyglądać tak:

Taki zapis powinien na stronie dokumentacji szablonu przyjąć poniższą formę: {       "description": "Szablon do linkowania kategorii w serwisie Commons powiązanej z artykułem", "params": { "1": {                       "label": "kategoria Commons", "description": "Kategoria Commons, do której chcesz linkować", "type": "string", "required": true }       } }



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



Aliasy parametrów
Niektóre szablony używają różnych nazw dla jednego parametru.

Na przykład  może być też też zapisany jako   lub.

Aby dodać informację o tych nazwach do TemplataData, należy po prostu dodać poniższy zapis:



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:



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



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



Ograniczenia i pytania

 * Brakujące funkcje — TemplateData is very much an example of 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.
 * Opóźnienia pokazywania w szablonach — 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 takes hours before the metadata 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.
 * Current issues — A list of current bugs and feature requests is available in bugzilla.



Narzędzia

 * w:fr:Utilisateur:Ltrlg/scripts/TemplateDataEditor.js — A user script that makes the process of adding TemplateData easier (currently only available in French).