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 pozwala użytkownikom na tworzenie małych struktur danych na stronie szablonu lub załączonej do niego strony (np. podstrony dokumentacji). Szablon będzie wyświetlany poprawnie w edytorze wizualnym, gdy będzie posiadał tę strukturę. Być może brzmi to skomplikowanie, ale w praktyce jest bardzo proste.



TemplateData editor
There is a built-in tool for editing TemplateData. It may not be installed on your wiki yet.

To use the TemplateData editor, go to the template's page (or its documentation subpage) and press the "Edit" button. That will give you a button that says "", just above the open editing window: Click this button to enter the GUI tool for editing TemplateData. The editor allows you to add one row per template parameter 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 "Import parameters" and "Add parameters" buttons to document the names and attributes of the parameters that the template uses.

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. 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 pop-up 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" 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.



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

Pierwszym krokiem do stworzenia nowego szablonu jest zastosowanie dwóch znaczników, które należy wstawić w dowolnym miejscu na stronie dokumentacji szablonu. Ilustruje to poniższy przykład:

Znaczniki te poinformują oprogramowanie, że wszystko zawarte pomię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 znacznikami 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ć", "default": "Category:CommonsRoot", "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ęta 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:



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  to make the values stick:



Wiele parametrów
Jeśli w szablonie znajduje się wiele parametrów, to można powtarzać kolejne sekcje (zaczynając od pierwszego znacznika - "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 jest przykładem narzędzia, które zostało udostępnione tylko z kilkoma funkcjami, ale kolejne mają być dodawane przy pomocy użytkowników. Jeśli chciałbyś zgłosić swoje pomysły, które pozwolą ulepszyć TemplateData, to daj nam znać.
 * Opóźnienia pokazywania w szablonach — Po udanym dodaniu TemplateData do szablonu, efekt powinien być od razu widoczny w edytorze wizualnym. Może się jednak zdarzyć, że potrwa to kilka godzin. Da się przyspieszyć to poprzez wykonanie pustej edycji w samym szablonie (nie na podstronie dokumentacji). Aby to zrobić, należy edytować stronę szablonu i zapisać ją bez dokonania żadnej zmiany.
 * Aktualne problemy — Aktualna lista błędów i uwag jest dostępna w bugzilli.



Other tools

 * TemplateDataEditor — Skrypt użytkownika, ułatwiający proces dodawania TemplateData. Aktualnie istnieje w języku angielskim i francuskim i może być przetłumaczony na inne języki.
 * TemplateData Wizard — Narzędzie generujące TemplateData poprzez interaktywny interfejs.
 * Skeleton TemplateData generator — Narzędzie, które odczytuje wikikod źródłowy szablonu, próbuje znaleźć wszystkie użyte parametry i wyświetla szkielet dokumentu z wymienionymi parametrami.
 * JSONLint — Narzędzie pozwalające sprawdzić poprawność ręcznie wpisanego JSON aby pomóc znaleźć błędy w składni.
 * List of all templates with TemplateData on this wiki