Help:TemplateData/pl



Co to jest TemplateData?
TemplateData to odpowiedni zapis, który pozwala przechowywać informacje o szablonach i ich parametrach w taki sposób, aby VisualEditor mógł je pobrać i wyświetlić w edytorze szablonów, ułatwiając tym samym ich edycję.

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
Po skończonej pracy należy wcisnąć "zapisz". Schematu nie będzie można zapisać, jeśli w TemplateData pojawiły się jakieś błędy. Jest to uciążliwe, ale oznacza też, że nie nic nie zostanie zniszczone nieświadomie. W przypadku napotkania błędów, postaraj się wyjaśnić na tej stronie, jak do tego doszło, a my spróbujemy pomóc.

Zauważ, że każda informacja w TemplateData jest zamknięte obustronnie poprzez znak " (wyjątek stanowią  i  ) i oddzielona od następnej przy użyciu przecinka (nie dotyczy to tylko ostatniej informacji).



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:



Wiele parametrów
Jeśli w szablonie znajduje się wiele parametrów, to można powtarzać kolejne sekcje (zaczynając od pierwszego taga - "1") i wypełniać w nich potrzebne elementy. Należy natomiast zauważyć, że kolejne parametry należy oddzielać przecinkami tak, jak w przykładzie:



Podobne parametry
Jeśli szablon ma wiele parametrów, może się zdarzyć, że niektóre z nich będą miały identyczne cechy. W takim przypadku należy wprowadzić wszystkie właściwości tylko dla pierwszego, a następne mogą je odziedziczyć.



Przykładowy schemat
Poniższy przykład można skopiować, aby na jego podstawie stworzyć nowy TemplateDate. Zawiera on jednak tylko najczęściej używane wartości.



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.
 * Aktualne problemy — Aktualna lista błędów i uwag jest dostępna w bugzilli.



Narzędzia

 * w:fr:Utilisateur:Ltrlg/scripts/TemplateDataEditor.js — Skrypt użytkownika, który upraszcza proces dodawana TemplateData (aktualnie dostępny tylko w wersji francuskiej).