TemplateData to sposób na dodanie dokumentacji do szablonów. Użycie TemplateData pozwala to wizualnemu edytorowi szablonów na przedstawienie ogólnych informacji o szablonie, dokładnego użycia różnych parametrów i sformatowania gotowego kodu źródłowego w jednolity sposób.
TemplateData jest zbudowane w oparciu o obiekt JSON zbliżony do kodu interaktywnych map otoczonego przez znaczniki <templatedata>. Edytor szablonów zawiera również wizualne narzędzie pomagające w ich tworzeniu.
Poniższa strona jest jedynie wprowadzeniem do korzystania z TemplateData. Pełna dokumentacja znajduje się w dokumentacji Mediawiki.
TemplateData można dodać zarówno do samej strony szablonu, jak i do podstrony z jego dokumentacją. Jeśli zarówno sam szablon, jak i podstrona dokumentacji zawierają blok TemplateData, zostanie użyty ten w samym szablonie. Zaleca się użycie podstrony dokumentacji do przechowywania danych TemplateData — reszta przewodnika zakłada, że tak właśnie jest.
Najłatwiejszym sposobem pracy z TemplateData jest edytor danych szablonu. Działa on tak samo we wszystkich edytorach.
Edytor danych szablonu
Otwórz stronę dokumentacji szablonu do edycji, np. „Szablon:Zalążek/dokumentacja.
Kliknij „Zarządzaj danymi szablonu”.
Otworzy się edytor danych szablonu (patrz obraz po prawej).
Wpisz krótki opis szablonu w polu opisu szablonu, np. „Ten szablon służy do oznaczania zalążków".
Wybierz „Liniowy” lub „Blokowy” jako sugerowane formatowanie wikitekstu.
Kliknij „Dodaj parametr”.
Dodawanie informacji o parametrach
Kliknij nazwę parametru np. 1 obok ikony hamburgera.
Zostanie otwarty widok informacji o parametrach.
Widok informacji o parametrze
Wypełnij niektóre pola, np. „Etykieta”: „Powód”, „Typ" z „Linia” i wybierz „Wymagane”.
Kliknij „Gotowe”.
Kliknij „Zastosuj”. Blok TemplateData jest teraz zawarty w źródle strony.
„Zapisz zmiany” stronę jak zwykle.
Jeśli wszystko poszło dobrze, tabela z wprowadzonymi informacjami zostanie wyświetlona jako ostatnia na stronie.
Pola szablonu[]
Przegląd edytora danych szablonu
Edytor dokumentacji szablonu pokazuje przegląd szablonu i umożliwia tworzenie i edycję bloku TemplateData.
„Język” to wybrany język interfejsu użytkownika. Jeśli różni się on od języka wiki, należy przełączyć się na język wiki. Jeśli język nie jest widoczny w menu, można go dodać za pomocą opcji „Dodaj język”. Kod wybranego języka jest wyświetlany dla różnych pól.
„Opis szablonu” również pokazuje kod dla wybranego języka. Powinien on zawierać krótki opis przeznaczenia szablonu.
„Edytuj mapowania” jest używane w niektórych projektach Wikimedia. Nie jest używany na Fandomie.
„Sugerowane formatowanie wikitekstu” pozwala na określone sposoby formatowania źródła wikitekstu generowanego przez edytor szablonów.
„Nieokreślony” spróbuje zachować format źródła użyty w istniejącym szablonie, a w przeciwnym razie użyje formatu inline.
„Liniowy” sformatuje wikitekst szablonu w jednej linii, np. {{Stub|Sekcja dokumentacji jest niedokończona}}.
„Blokowy” sformatuje szablon wikitext z jednym parametrem na linię. Jest to doskonałe rozwiązanie np. dla infoboxów.
„Niestandardowy” pozwoli na specyficzne formatowanie. Zobacz sekcję „Custom formats” w dokumentacji Mediawiki.
„Parametry szablonu” pokazuje zdefiniowane parametry. Możesz zmienić ich kolejność, przeciągając hamburgery. Obok znajduje się etykieta parametru, a poniżej jego opis. Po prawej stronie znajduje się nazwa parametru, zdefiniowana w kodzie źródłowym szablonu. W przypadku nienazwanych parametrów są one wyświetlane po prostu jako liczba.
Dodatkowe parametry można dodać, klikając przycisk „Dodaj parametr”. Spowoduje to dodanie parametru z etykietą i nazwą wprowadzoną do bloku TemplateData. Należy pamiętać, że nie jest możliwe dodanie nienazwanych parametrów w ten sposób, należy kliknąć „Dodaj 1 proponowany parametr”, aby dodać nienazwane parametry. Sugestie są oparte na zapisanym szablonie.
Pola parametru[]
Widok informacji o parametrach
„Nazwa” będzie nazwą parametru lub numerem dla nienazwanych parametrów.„Aliasy” pozwala na alternatywne nazwy parametrów i jest przydatny do łączenia nazwanych i nienazwanych parametrów ze sobą.
„Etykieta” zastępuje nazwę parametru w edytorze szablonów i jest również wyświetlana na liście parametrów szablonu. Wysoce zalecane dla nienazwanych parametrów lub nazw parametrów takich jak "row1".
„Opis” będzie wyświetlany razem z nazwą parametru.
„Przykład” jest przykładem sposobu wypełnienia parametru i będzie wyświetlany poniżej pola wartości parametru w edytorze szablonów.
„Typ” to czytelny dla komputera opis typu wartości przechowywanej przez parametr. Najczęstsze wartości to:
Ciąg znaków
Zwykły tekst.
Linia
Pojedyncza linia zwykłego tekstu.
Treść
Przeznaczony dla wikitekstu, w tym linków, obrazków lub szablonów.
Nazwa strony
Pokazuje pole do wstawienia nazwy strony.
Plik
Wyświetla pole do wstawienia nazwy pliku.
Szablon
Pokazuje pole do wstawienia nazwy szablonu.
Liczba
Pojedyncza liczba.
Wartość logiczna
1 (prawda), 0 (fałsz) lub puste.
Data
Data w formacie RRRR-MM-DD. Niektóre edytory szablonów wyświetlają pole wyboru daty.
„Sugerowane wartości” wyświetli proste pole rozwijane z sugerowanymi wartościami.
Opcja Domyślnie będzie wyświetlana w kolorze szarym w polu wprowadzania w edytorze szablonów. Zostanie ona zastąpiona przez dowolną wartość wprowadzoną przez użytkownika i nie zostanie zapisana, jeśli nie zostanie wprowadzona żadna wartość.
„Wartość automatyczna” to wartość, która zostanie automatycznie dodana przez edytor szablonów, jeśli użytkownik nie zdecyduje się wprowadzić własnej wartości. Przydatne np. do dodawania {{subst:REVISIONUSER}}.
„Przestarzały” wskazuje parametr, który nie powinien być już używany.
„Wymagane” wskazuje parametr, który musi zostać wprowadzony.
„Sugerowany” wskazuje parametr, którego wprowadzenie jest zalecane.
Parametry, które nie są przestarzałe, wymagane lub sugerowane będą oznaczone jako opcjonalne.
Wskazówki i dobre nawyki[]
Edytuj blok TemplateData w innej sesji edycji niż resztę szablonu. W ten sposób wybór „Dodaj 1 proponowany parametr” będzie odzwierciedlał aktualny stan szablonu, a ty nie ryzykujesz niezgodności między kodem źródłowym rzeczywistego szablonu a blokiem TemplateData.
Wprowadzanie poszczególnych parametrów może być dość żmudne. Rób przerwy i często zapisuj, ale pamiętaj, aby wykonać wszystkie kroki „Gotowe” - „Zastosuj” - „Zapisz zmiany”!.
Ograniczenia[]
Blok TemplateData ma obecnie wpływ tylko na edytor szablonów. Surowa edycja źródła całkowicie ominie informacje TemplateData.
„Wartość automatyczna” nie działa z liczbą lub datą.
Wikitekst nie jest analizowany ani formatowany przez edytor dokumentacji szablonu. Każdy wikitekst wprowadzony np. w autovalue zostanie przekazany surowo do strony.
Dalsze wsparcie
Szukasz dalszego wsparcia lub masz pytanie? Sprawdź poniższe linki, aby dowiedzieć się więcej.
