Help:TemplateData
 |
Uwaga: Jeśli edytujesz tę stronę, wyrażasz nieodwołalną zgodę na udostępnianie Twojego materiału na podstawie wolnej licencji CC0. Zobacz Strony Pomocy w Domenie Publicznej, aby uzyskać więcej informacji.
|
|
TemplateData 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. Jest również używany w innych skryptach, narzędziach i gadżetach.
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.
Contents
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 „Zarządzaj danymi szablonu”:
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 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 <templatedata> i </templatedata> 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.
Położenie TemplateData
TemplateData powinien być na stronie, którą opisuje, lub dołączony do niej.
W szablonie zazwyczaj jest otoczony znacznikami <noinclude>.
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 <templatedata> gdziekolwiek na podstronie dokumentacji szablonu, w ten sposób:
<templatedata>
{
... // Zawartość TemplateData trafia tutaj
}
</templatedata>
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:
<templatedata>
{
"description": "Szablon tworzący link do kategorii na Wikimedia Commons związanej z artykułem",
"params": {
"1": {
"label": "Nazwa kategorii na Commons",
"description": "Nazwa kategorii na Commons, do której chcesz utworzyć link.",
"default": "Category:CommonsRoot",
"type": "string",
"required": true
}
}
}
</templatedata>
Spowoduje to wyświetlenie w szablonie czegoś takiego:
Szablon tworzący link do kategorii na Wikimedia Commons związanej z artykułem
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Nazwa kategorii na Commons | 1 | Nazwa kategorii na Commons, do której chcesz utworzyć link.
| String | required |
Opis i parametry
| description | Pierwszym znacznikiem jest "description", który opisuje, co robi szablon.
|
"description": "Szablon przypisujący kategorię do artykułu",
|
|---|---|---|
| format | Następny to "format", który opisuje jak wikitekst szablonu powinien wyglądać. Może przyjąć standardową wartość "inline" (domyślnie) i "block", lub własny format; zobacz poniżej po szczegóły
Jeśli parametr jest ustawiony na
Jeśli parametr zostanie ustawiony na {{Foo
| bar = baz
| qux = quux
}}
|
"format": inline
|
| params | Dalej jest znacznik "params", który wskazuje, że kolejne sekcje opisują wszystkie parametry szablonu.
Wszystkie poniższe parametry są zawarte w sekcji |
"params": {
... // tu idą parametry
}
|
| W podsekcji każdego parametru pierwszy znacznik jest nazwą parametru szablonu wewnątrz szablonu.
Jeśli parametr ma nazwę, np. Jeśli parametr jest "bez nazwy", czyli jest tylko numerem Wszystkie informacje o tym parametrze są zawarte w sekcji, która zaczyna się od nazwy parametru. |
"1": { // nazwa parametru
... // tu trafiają informacje o parametrze
}
| |
| label | Następnie mamy "label", w którym umieszczamy czytelny dla użytkownika tytuł dla parametru, który będzie wyświetlany w edytorze.
|
"label": "Nazwa kategorii",
|
| description | Dalej mamy "description": tym razem jest to opis parametru, a nie całości szablonu.
|
"description": "Nazwa kategorii, którą chcesz przypisać.",
|
| default | Następny jest "default". Niektóre szablony posiadają wartość domyślną, która jest używana, chyba że ją zmienisz. Ten element informuje użytkownika o domyślnej wartości tego parametru.
Możesz zignorować ten parametr, jeśli nie ma wartości domyślnej. |
"default": "Category:CommonsRoot",
|
| type | Potem mamy "type", który kontroluje, jak edytor danych szablonu ma interpretować ten parametr. Może to być:
Other types include:
|
"type": "string",
|
| required | Teraz mamy "required", który można ustawić na wartość true lub false.
Kontroluje to, czy wypełnienie parametru jest obowiązkowe dla tego szablonu. Jeśli tego nie określisz, przyjmuje się, że jest to |
"required": true
|
| suggested | Dalej jest "suggested", który może być ustawiony na true lub false.
Jest to status dla parametrów, które nie są 'wymagane', ale zalecane, ze względu na ważną zawartość (nie obowiązkową) dla użytkowników szablonów. Jeśli tego nie określisz, przyjmuje wartość |
"suggested": true
|
| deprecated | Na końcu mamy "deprecated", który może być ustawiony na true, false, lub treść opisującą, co użytkownicy powinni zrobić.
Jest to status parametrów, których nie należy już używać, ale przez jakiś czas będą jeszcze obecne.
Może to być spowodowane tym, że użycie szablonu jest przenoszone z jednego zestawu parametrów do innego.
Jeśli tego nie określisz, przyjmuje się, że jest to |
"deprecated": "Please use 'publicationDate' instead."
|
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.
Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.
Zauważ, że każdy zestaw informacji jest zamknięty w cudzysłowy (z wyjątkiem true i false) i oddzielony od następnego zestawu przecinkiem (oprócz ostatniego).
Własne formatowanie
Podczas edytowania ciągów formatowania niestandardowego w edytorze TemplateData możesz wpisać \n, lub nacisnąć klawisz Enter, aby wstawić znak nowej linii; w obu przypadkach będzie wyświetlany jako ↵ w polu wejściowym.
| Cel | Zapis formatowania | Rezultat |
|---|---|---|
| Formatowanie w linii | {{_|_=_}} inline
|
{{Foo|bar=baz|qux=quux}}{{Bar}}
|
| Formatowanie w bloku | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| qux = quux
}}{{Bar
}}
|
| Brak spacji przed nazwą parametru,
każdy szablon w osobnej linii |
\n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|qux = quux
}}
{{Bar
}}
|
| Wcięcie przed każdym parametrem | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|qux = quux
}}{{Bar
}}
|
| Dopasuj wszystkie nazwy parametrów do podanej długości | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|qux = quux
|veryverylongparameter = bat
}}
{{Bar
}}
|
| Znak pionowej kreski na końcu poprzedniej linii | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
qux = quux}}{{Bar}}
|
| Styl w linii z większą ilością spacji, musi znajdować się na początku linii | \n{{_ | _ = _}}
|
{{Foo | bar = baz | qux = quux}}
{{Bar }}
|
| Szablon na początku wiersza, wyrównanie długości parametrów, znak pionowej kreski w poprzedniej linii | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
qux = quux}}
{{Bar}}
|
Aliasy parametrów
Niektóre szablony pozwalają, aby ten sam parametr miał różne nazwy.
Na przykład, {{Kategorie|kategoria=Jabłka}} może być również zapisane jako {{Kategorie|Jabłka}} lub {{Kategorie|link=Jabłka}}.
Aby dodać te informacje do TemplateData, wystarczy dodać aliasy do informacji o parametrze:
"params": {
"kategoria": {
...
"aliases": ["1", "link"]
}
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 subst: z wartościami będącymi szablonami lub funkcjami parsera, aby uczynić je utrwalonymi:
"params": {
"data": {
...
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
}
Wiele parametrów
Jeśli masz wiele parametrów, wystarczy powtórzyć każdą sekcję (zaczynając od znacznika "1") i wypełnić ją według uznania. Zauważ, że jeśli szablon ma wiele parametrów, musisz je rozdzielić przecinkiem w templatedata, tak jak poniżej:
"params": {
"1": {
...
}, // zwróć uwagę na przecinek tutaj
"2": {
...
}, // i tutaj
"3": {
...
}
}
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.
"params": {
"temat1": {
"label": "Temat",
"description": "Temat omawiany na tej stronie ujednoznaczniającej",
"type": "string"
},
"temat2": {
"inherits": "temat1"
},
"temat3": {
"inherits": "temat1"
},
}
Pusty wzór dokumentu
Możesz skopiować poniższy pusty wzór dokumentu poniżej, aby dodać nowy TemplateData do szablonu. Uwzględnione zostały tylko najpopularniejsze znaczniki.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Errors
Syntax Error in JSON / Bad JSON format
Due to a long standing bug, users using the old wikitext editor are able to save pages which have certain types of invalid JSON, such as duplicate keys or trailing commas (details: zadanie T128029). However if you attempt to save this page in a JavaScript based editor, such as VisualEditor or the 2017 Wikitext editor, you will see an error message "Syntax error in JSON," as the JavaScript parser is stricter and doesn't allow invalid JSON. Additionally, if you attempt to open up such invalid JSON with the Template Data GUI editor, you will see the error message, "Bad JSON format." To fix these errors, you can enter the JSON block into an external JSON validator, such as https://jsonlint.com/, and it will highlight the problematic commas and keys so they can be removed.
Inne narzędzia
- Help:Extension:TemplateWizard
- A toolbar dialog window for entering template wikitext via an form built from TemplateData.
- 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, które ułatwia znalezienie błędów w składni.
- Lista wszystkich szablonów z TemplateData na tej wiki.
- Dzięki szablonowi TemplateData na dewiki, dane szablonu są wyświetlane w ramce, a szablon jest dodawany do kategorii szablonów z danymi szablonu.
