Szablon:Docparam

Z ARK: Survival Evolved Wiki
Skocz do: nawigacja, szukaj
Nazwa?

Opis?

Template-info.png Dokumentacja

Template for standardized formatting of template parameters in template documentation.

Użytkowanie

{{Docparam|nazwa=parametr|wymagane=tak|opis=opis}}

Parametry

<nienazwane 1> lub nazwa

Name of the parameter(s). Certain strings are automatically translated to allow for specification of alternative choices or parameter ranges.

Translated strings (all of these need to be enclosed by spaces):

  • >> is converted to a dash with spaces around it (" - "); used to indicate parameter ranges (e.g. "gra1 - gra5").
  • // is converted to " or "; used for alternative choices (e.g. "<unnamed 1> or title").
  • ++ is converted to a comma with a trailing space (", "); used for listing parameters which are separate but work the same (e.g. "contentA1, contentB1").
domyślne, domyślne2

The default value(s) of the parameter.

opis

Opis parametru.

(domyślne: "tak")
wymagane

Precyzuje czy ten parametr jest wymagany dla szablonu do funkcjonowania.

Dostępne opcje:

  • nie: Całkowicie opcjonalne.
  • połowicznie: Parametr jest wymagany w pewnych przypadkach lecz opcjonalny przy innych. For a range of parameters (set via up to, this means that at least one of them is required.
  • tak: Zawsze wymagany.

Kopiuj/wklej

{{Docparam|nazwa=|wymagane=|domyślne=|opis=

}}

Examples

Simple

{{Docparam|name=parameter|req=yes|default=|desc=
Description
}}

results in:

Nazwa?

Opis?

Advanced

{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc=
Description
}}

results in:

Nazwa?

Opis?