Help:TemplateData/pl

 jest sposobem na przechowywanie informacje o wikitekstowych szablonach i ich parametrów, dzięki czemu edytor wizualny może je wyświetlać w oknie edycji wstawianego szablonu.

Rozszerzenie TemplateData jest zainstalowane na wszystkich wiki obsługiwanych przez Wikimedia Foundation. Jeżeli masz swoją wiki i chcesz też z niego korzystać, zainstaluj odpowiednie rozszerzenie.

Składnia TemplateData pozwala użytkownikom na napisanie małej porcji danych strukturalnych na stronie szablonu lub na transkludowanej na niej stronie (na przykład podstronie dokumentacji szablonu). Gdy szablon będzie miał już dodane dane strukturalne, będzie on poprawnie wyświetlany w edytorze wizualnym. Może to brzmi skomplikowanie, ale jest bardzo proste.

Edytor TemplateData
Jest wbudowane narzędzie do łatwego edytowania TemplateData.

Aby użyć edytora TemplateData, przejdź na stronę wybranego szablonu (lub na jego podstronę dokumentacji) i kliknij przycisk "Edytuj". Na stronie edycji kodu szablonu, tuż nad polem tekstowym będzie widoczny przycisk "":

Kliknij ten przycisk, aby wejść do narzędzia GUI służącego do edycji TemplateData.

Ten edytor umożliwia dodanie parametrów szablonu i ustawienia ich najważniejszych atrybutów. Jeżeli strona zawiera już TemplateData to już udokumentowane informacje zostaną wyświetlone jeżeli otworzysz edytor TemplateData przy edycji właściwej strony. W pierwszym polu możesz dodać lub zmienić krótki opis szablonu (czysty tekst). Następnie możesz użyć przycisków "Dodaj proponowane parametry" i "Dodaj parametr", aby opisać nazwy i właściwości parametrów używanych przez szablon.

Jeśli dokumentacja szablonu znajduje się na podstronie, przycisk "Dodaj proponowane parametry" pojawi się tylko na stronie szablonu. Rozwiązaniem jest edytowanie strony szablonu, kliknięcie na "Dodaj proponowane parametry" w edytorze TemplateData, a następnie skopiowanie i wklejenie zawartości TemplateData (między znacznikami i ) na podstronie dokumentacji.

Jeśli strona szablonu jest zabezpieczona, możesz skopiować kod szablonu i wkleić na podstronie, użyć tam przycisku "Dodaj proponowane parametry", skopiować zawartość szablonu TemplateData, następnie edytować podstronę, aby pozbyć się kodu szablonu i wkleić zawartość TemplateData. Aby zobaczyć, gdzie należy wkleić zawartość TemplateData na podstronie, możesz edytować TemplateData bez dodawania czegokolwiek; następnie możesz zastąpić znaczniki i oraz ich zawartość, wklejając zawartość na nie.

Możesz podać nazwę parametru, dowolne jego aliasy, etykietę i opis, który będzie wyświetlany użytkownikom. Można również podać przykład użycia tego parametru. Jedynym wymaganym polem jest Nazwa (pierwsze pole w każdym wierszu), gdzie zapisujesz dokładną nazwę parametru, pamiętając, że wielkość liter ma znaczenie. W rozwijanym menu "Typ" możesz wybrać typ zawartości, którą powinien mieć ten parametr, na przykład ciąg znaków (dla tekstu bez formatowania), strona (odnośnik do innej strony) lub data. Jeśli szablon spowoduje błąd, gdy parametr pozostanie pusty, oznacz go jako "Wymagane". Jeśli parametr jest powszechnie używany lub zalecany, zaznacz go jako "Sugerowany". Przycisk "Usuń informację o parametrze" spowoduje usunięcie parametru z szablonu TemplateData.



Po zakończeniu opisywania parametrów kliknij przycisk "Zastosuj", aby wstawić wstępnie sformatowany TemplateData do otwartego okna edycji. Musisz jeszcze zapisać stronę, używając zwykłego przycisku "Zapisz" pod oknem edycji.

Uwaga: Edytor TemplateData umieści dokumentację na stronie szablonu lub na podstronie dokumentacji. Ty decydujesz, gdzie TemplateData zostanie dodana, otwierając (edytując) stronę, na której chcesz umieścić TemplateData. Jeśli jednak w tym samym szablonie znajduje się wiele bloków TemplateData, zostanie użyty tylko jeden z nich. Jeśli na stronie jest już TemplateData, musisz zmodyfikować stronę, na której TemplateData została wcześniej umieszczona, aby uniknąć przypadkowego utworzenia wielu bloków TemplateData.

Ograniczenia i pytania

 * Brakujące funkcje — TemplateData jest przykładem narzędzia, które zostało udostępnione z nielicznymi funkcjami, w nadziei, że użytkownicy pomogą kierować rozwojem funkcji, których potrzebują. Jeśli chcesz poprosić o nowe funkcje dla TemplateData, prosimy daj nam znać.
 * Opóźnienia w wyświetlaniu w szablonach — Po dodaniu TemplateData do szablonu, metadane powinny być widoczne natychmiast po otwarciu szablonu w edytorze wizualnym. Jest jednak możliwe, że zajmie to kilka godzin zanim metadane się pojawią. Możesz wymusić aktualizację, wprowadzając pustą edycję do samej strony szablonu (nie do podstrony dokumentacji). Aby przeprowadzić pustą edycję, otwórz stronę szablonu do edycji i zapisz stronę bez dokonywania żadnych zmian i bez dodawania opisu zmian.
 * Aktualne problemy — Aktualna lista błędów i żądań funkcji jest dostępna w trackerze błędów Wikimedia.

Lokalizacja TemplateData
TemplateData powinien być na stronie, którą opisuje, lub dołączony do niej. W szablonie zazwyczaj jest otoczony znacznikami. Przy normalnym wyświetleniu strony, pokazuje automatycznie wygenerowaną dokumentację, jak w #Przykładzie.

Struktura TemplateData
Struktura TemplateData bazuje na standardzie JSON. Zauważ, że wszystkie opisy w TemplateData muszą być zwykłym tekstem (bez wikitekstu, bez linków, itd.).

Pierwsza rzecz, jaką trzeba zrobić, jest wpisanie pary znaczników  gdziekolwiek na podstronie dokumentacji szablonu, w ten sposób:

Przekazuje to oprogramowaniu, że wszystko pomiędzy dwoma znacznikami to TemplateData i powinno być wywołane, gdy szablon jest używany.

Przykład
Opisy wewnątrz TemplateData podlegają standardowemu układowi. Powiedzmy, że masz szablon nazwany "Kategorie" do przypisywania kategorii do artykułu. Wymaga to jednego obowiązkowego parametru: Nazwa kategorii w Kategorie. TemplateData wyglądałby tak:

Spowoduje to wyświetlenie w szablonie czegoś takiego:

{   "description": "Szablon przypisujący kategorię do artykułu", "params": { "1": {           "label": "Nazwa kategorii", "description": "Nazwa kategorii, którą chcesz przypisać.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

Opis i parametry
Kiedy skończysz, kliknij "Zapisz". Jeśli popełnisz błędy, edytor nie pozwoli zapisać zmian (co jest destrukcyjne, ale oznacza, że nic nie można zepsuć). Jeśli wystąpią błędy, wyjaśnij na stronie opinii, co próbujesz zrobić, a chętnie pomożemy.

Zauważ, że każdy zestaw informacji jest zamknięty w cudzysłowy (z wyjątkiem  i  ) i oddzielony od następnego zestawu przecinkiem (oprócz ostatniego).

Aliasy parametrów
Niektóre szablony pozwalają, aby ten sam parametr miał różne nazwy.

Na przykład,  może być również zapisane jako   lub.

Aby dodać te informacje do TemplateData, wystarczy dodać aliasy do informacji o parametrze:

Wartość automatyczna
Możesz określić "wartość automatyczną" dla parametru. Gdy użytkownicy dodają szablon do strony, ta wartość zostanie dodana automatycznie. Na przykład, wiele szablonów czyszczących wymaga daty dodania; jeśli określisz wartość automatyczną dla parametru szablonu data, wtedy data zostanie wypełniona automatycznie.

Aby dodać te informacje do TemplateData, wystarczy dodać autovalue do informacji o parametrze. Możesz także chcieć użyć prefiksu  z wartościami, aby uczynić je przyklejonymi:

Wiele parametrów
Jeśli masz wiele parametrów, wystarczy powtórzyć każdą sekcję (zaczynając od znacznika "1") i wypełnić ją tak, jak widać. Zauważ, że jeśli szablon ma wiele parametrów, musisz je rozdzielić przecinkiem w templatedata, tak jak poniżej:

Podobne parametry
Kiedy szablon ma wiele parametrów, niektóre z nich mogą być tego samego rodzaju. W tym przypadku wystarczy wypełnić pełne właściwości dla pierwszego z nich, a kolejne mogą "dziedziczyć" te właściwości.

Pusty wzór dokumentu
Możesz skopiować pusty wzór dokumentu poniżej, aby dodać nowy TemplateData do szablonu. Dołączone zostały tylko najpopularniejsze znaczniki.

Inne narzędzia

 * TemplateDataEditor: Skrypt użytkownika, który ułatwia dodawanie TemplateData. Obecnie istnieje w języku francuskim (zawiera tłumaczenia w języku angielskim, włoskim, japońskim i koreańskim) i może być łatwo przetłumaczone na inne języki.
 * TemplateData Wizard: Narzędzie, które generuje TemplateData za pośrednictwem interaktywnego interfejsu.
 * Skeleton TemplateData generator: Narzędzie, które czyta wikikod źródłowy szablonu, próbuje znaleźć wszystkie używane parametry i wyświetla szkielet dokumentu z listą parametrów.
 * JSONLint: Narzędzie, które umożliwia sprawdzenie poprawności ręcznie napisanego kodu JSON, aby ułatwić znalezienie błędów w składni.
 * 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