Pomoc:Jak dodać TemplateData


Skrót: WP:TD+

Pomoc:Jak dodać TemplateData w encyklopedii

Z Wikipedii, wolnej encyklopedii To jest wersja przejrzana, która została oznaczona 23 lis 2020. Na przejrzenie oczekują zmiany w szablonach lub plikach, które są zawarte na tej stronie. Przejdź do nawigacji Przejdź do wyszukiwania VisualEditor Jak używać Jak możesz pomóc Inne Dla ekspertów

TemplateData – 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.

Uwaga: przeciętny użytkownik VE niekoniecznie zna techniczny język wiki, natomiast widzi „pola” (technicznie: parametry), które ma wypełnić treścią (d. wartościami). Pamiętajmy więc, by wypełniając TemplateData, używać zrozumiałych dla użytkownika nazw.

Spis treści

Sposoby edycji TemplateData | edytuj kod

Aby edytować TemplateData, należy na stronie edycji dokumentacji szablonu nacisnąć przycisk Zarządzaj dokumentacją szablonu.

Można też ręcznie modyfikować lub tworzyć tag <templatedata> według instrukcji podanej poniżej, lub można posłużyć się edytorem TemplateData Michała Łazowika.

Struktura TemplateData | edytuj kod

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 <templatedata>, które należy wstawić w dowolnym miejscu na stronie dokumentacji szablonu. Ilustruje to poniższy przykład:

<templatedata> { ... <-- miejsce na treść TemplateData } </templatedata> 

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 | edytuj kod

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:

<templatedata> { "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 } } } </templatedata> 

Taki zapis powinien na stronie dokumentacji szablonu przyjąć poniższą formę:

Szablon do linkowania kategorii w serwisie Commons powiązanej z artykułem

Opis i parametry | edytuj kod

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ą true i false) i oddzielona od następnej przy użyciu przecinka (nie dotyczy to tylko ostatniej informacji).

Aliasy parametrów | edytuj kod

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

Na przykład {{Commons|kategoria=Jabłka}} może być też zapisany jako {{Commons|Jabłka}} lub {{Commons|link=Jabłka}}.

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

 "params": { "kategoria": { ... "aliases": ["1", "link"] } 

Wiele parametrów | edytuj kod

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:

 "params": { "1": { ... }, <-- przecinek jest tutaj "2": { ... }, <-- i tutaj "3": { ... } } 

Podobne parametry | edytuj kod

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ć.

 "params": { "temat1": { "label": "Temat", "description": "Temat wymieniony na stronie ujednoznacznienia", "type": "string" }, "temat2": { "inherits": "temat1" }, "temat3": { "inherits": "temat1" }, } 

Preferowany format szablonu | edytuj kod

Istnieje możliwość ustalenia, jak będzie generowany wikikod wstawiający szablon. Odpowiada za to właściwość "format", którą kreatorze ustawić go można klikając przełączniki. Parametr ten dodawany jest w tym samym poziomie co "description" (opis szablonu) i "params" (z lista parametrów)

Może przyjmować następujące wartości:

  • block - blokowy - wypełniane parametry będą obecne w wikikodzie jeden pod drugim (np. tak jak w infoboksach)
  • inline - liniowy - kod szablonu będzie wstawiony w jednej linii
  • brak - jeżeli format nie będzie ustalony (brak obecności właściwości "format"), edytor wizualny pozostawi szablon tak jak był wcześniej zapisany, a nowo wstawiane szablony będą wstawiane w jednej linii
  • niestandardowy - inny sposób zapisu kodu szablonu w formacie, który należy podać w polu tekstowym pod tymi opcjami (edytorem) lub jako wartość parametru "format"

Przykładowy schemat | edytuj kod

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

<templatedata> { "description": "", "params": { "1": { "label": "", "description": "", "type": "" }, "2": { "label": "", "description": "", "type": "" } } } </templatedata> 

Ograniczenia i pytania | edytuj kod

  • 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 phabricatorze.
Na podstawie artykułu: "Pomoc:Jak dodać TemplateData" pochodzącego z Wikipedii
OryginałEdytujHistoria i autorzy