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

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

Położenie 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 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 }   } }

Opis i parametry
Each parameter for TemplateData is listed below with a description and example. They are also listed at Extension:TemplateData#Format.

The order of the parameters does not affect functionality, as long as those within, for example, the  object are kept within the object.

Note that this information is current as of February 2020 and may change if new parameters are added or the template editors get updates to treat certain parameters differently or fix certain behaviours.

Within the parameter's name
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the TemplateData documentation.

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  i  ) i oddzielony od następnego zestawu przecinkiem (oprócz ostatniego).

Własne formatowanie
When editing the  value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.


 * - start of the template
 * - content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like . If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  to indent new lines)
 * - end of the template

The wikitext should at least meet the minimum of, otherwise there will be an invalid format string error.

Effects of the type parameter
The  parameter can have multiple different effects or no effect depending on the value and depending on the template editor. Its effects are listed as follows.



The  value is intended for numerical values, including minus values and decimals.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,,  causes the input box to display a "+" and "-" button on either side, which raise or lower a number value in the input box, respectively, and the user can only type numbers into the box. The buttons can also lower the number into negatives.



The  value is intended for any string of plain text.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  has no visible effect compared to.



The  value is intended for content that should be forced to stay on one line.


 * In VisualEditor and the 2017 wikitext editor,  prevents a parameter's input box from allowing new lines, which are usually possible in these editors.
 * In the 2010 wikitext editor with TemplateWizard,  has no visible effect (input boxes do not allow new lines by default in this editor).



The https:// value is intended for a URL, with Internet protocol (e.g., "https://") included.


 * In VisualEditor and the 2017 wikitext editor,  makes the input box display an external link icon (a square with arrow pointing out of it) in the left hand side of the box and makes the box glow red when the user clicks away without entering a URL value that includes a valid Internet protocol (e.g., "https://", "ftp://" or "//") followed by some text. This second effect is similar to that of the "required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested" or "deprecated").
 * In the 2010 wikitext editor with TemplateWizard,  has no visible effect.



The  value is intended for a page name on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of pages on the wiki, such as Wikipedia articles, which can be selected. Namespaces can also be defined in the search. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-page from being inputted.



The  value is intended for a file name hosted either locally on a wiki or on Wikimedia Commons.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box show a suggestion dropdown menu containing a list of files hosted both locally and on Wikimedia Commons, which can be selected. It also shows the thumbnail of the files. It has no other visible effect and doesn't prevent a non-file from being inputted.



The  value is intended for the name of a template.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of templates, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-template from being inputted.



The  value is intended for a username on a wiki.


 * In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard),  makes the parameter input box show a suggestion dropdown menu containing a list of actual users' names, which can be selected. Additionally, in VisualEditor and the 2017 wikitext editor, it forces the input box content to stay on one line. It has no other visible effect and doesn't prevent a non-username from being inputted.



The  value is intended for wikitext of page content, for example, links, images or text formatting.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.



The  value is intended for wikitext that cannot stand alone, i.e. it lacks an opening or closing tag or refers to other parts of wikitext.


 * In VisualEditor and the 2017 wikitext editor,  has no visible effect.
 * In the 2010 wikitext editor with TemplateWizard,  makes the parameter input box one line taller and allows new lines, which regular input boxes in the 2010 wikitext editor do not.

With other parameters


 * In VisualEditor and the 2017 wikitext editor,  overrides the visible effects of  : when both are set, the input box will not contain a URL icon nor glow red when the user clicks away without entering a valid URL.
 * In the 2010 wikitext editor with TemplateWizard,  overrides the effects of  : the value of "autovalue" will not be automatically placed in the input box if the parameter type is "number".

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.

Syntax error in JSON / Bad JSON format
If you attempt to save TemplateData that has certain types of invalid JSON, such as duplicate keys (parameters) or trailing/missing commas, in VisualEditor or the 2017 wikitext editor (JavaScript-based editors), you will see the error message "Syntax error in JSON". These errors can come up quite frequently while heavily editing a template's TemplateData.

Examples of trailing commas:

Examples of missing commas:

Another common cause is missing quotation marks:

Additionally, if you attempt to open up such invalid JSON with the TemplateData 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 JSONLint, and it will highlight the problematic commas and keys that should be removed. Alternatively, you can look for the errors in the code yourself.

Due to a longstanding bug, users using the 2010 wikitext editor are able to save pages that have such invalid JSON (details: ), as the JavaScript parser is less strict and allows invalid JSON.

Property "format" is expected to be ...
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "Property "format" is expected to be "inline", "block", or a valid format string."

To fix this, make sure the value in  equals ,   or, if it's wikitext, contains a minimum of. Additionally, if it's wikitext, make sure there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats. Alternatively, you can remove the  parameter to remove this error.

Required property "paramOrder(number)" not found.
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets is the parameter in  that is missing (it is one less, since it is an array; 0 is the first one, 1 is the second, etc.).

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Invalid value for property "paramOrder(number)".
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets is the parameter in the  that is missing (it is one less, since it is an array; 0 is the first one, 1 is the second, etc.).

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Property "params.parametername.required" is expected to be of type "boolean".
This error occurs if you put quotation marks around the value of either  or.

These are boolean values, not strings, therefore they require no quotation marks. To fix this, remove any quotation marks around the values  or   for these parameters.

Required property "params" not found.
This error occurs if there is no  object in the TemplateData. This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes. See the section above on how to add the  parameter.

Inne narzędzia

 * : 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.