Pomoc:Szablony

This page is a translated version of the page Help:Templates and the translation is 26% complete.
Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Lëtzebuergesch • ‎Napulitano • ‎Nederlands • ‎Tagalog • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎català • ‎dansk • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎lietuvių • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎slovenčina • ‎suomi • ‎svenska • ‎čeština • ‎беларуская (тарашкевіца)‎ • ‎български • ‎русский • ‎српски / srpski • ‎українська • ‎עברית • ‎اردو • ‎العربية • ‎سنڌي • ‎فارسی • ‎پښتو • ‎ߒߞߏ • ‎भोजपुरी • ‎हिन्दी • ‎বাংলা • ‎ಕನ್ನಡ • ‎മലയാളം • ‎ไทย • ‎中文 • ‎日本語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎한국어
PD Uwaga: Jeżeli edytujesz tę stronę, to umieszczając na niej treści wyrażasz nieodwołalną zgodę na udostępnianie Twojego materiału na podstawie wolnej licencji CC0. Przeczytaj Strony Pomocy w Domenie Publicznej, aby uzyskać więcej informacji.
PD

Jeśli masz standardowy do umieszczenia na kilku stronach, na pomoc przychodzą szablony MediaWiki. Inaczej niż rozszerzenia i pliki multimedialne, nie głównego repozytorium szablonów. Szablony mogą być napisane lub, by oszczędzić powtarzania pracy, eksportowane z innej wiki np. Wikipedii, i wtedy importowane do docelowej wiki.

Tworzenie

Szablony to standardowe strony wiki, których zawartość została zaprojektowana, by być transkludowana (osadzona) w innych stronach. Szablony podążają za konwencją, że ich nazwa jest poprzedzona "Szablon:", przypisującym je do tej przestrzeni nazw; poza tym, można utworzyć je jak każdą inną stronę wiki.

Najprostsze użycie szablonów wygląda następująco. Jeśli stworzy się stronę nazwaną "Szablon:Witaj" z zawartością:

Cześć! Witaj na wiki.

a następnie umieści kod:

{{Witaj}}

w każdej innej stronie, gdy będzie wyświetlana, będzie się pojawiał tekst "Cześć! Witaj na wiki." zamiast {{Welcome}}. Zawartość szablonu jest "transkludowana" w inną stronę, tj. jest zintegrowana ze stroną.

Można następnie umieścić {{Witaj}} gdziekolwiek w jakiejkolwiek stronie, gdzie chce się pozdrowić kogoś. Załóżmy, że jest używany na 100 stronach. Jeśli zmieni się zawartość szablonu na:

Hej! Witaj na tej wspaniałej wiki.

i odwiedzi którąkolwiek spośród tych 100 stron, gdzie został użyty ten szablon, pokaże się nowy tekst zamiast oryginalnego. Tym sposobem została zmieniona zawartość 100 stron bez edytowania ich, bo szablon jest "transkludowany" w te strony.

To podstawowy mechanizm. Jest kilka dodatkowych funkcji transkludowania, które wzbogacają ten mechanizm i czynią szablony bardzo użytecznymi.

Użycie

Szablony mogą być używane w innych stronach na następujące sposoby:

  • {{Nazwa}} — jak opisano powyżej, te odniesienie jest dynamicznie zamieniane bieżącą zawartością [[Szablon:Nazwa]] w momencie, gdy strona z odniesieniem do szablonu jest ładowana. Odniesienie jest niezmieniane w źródle strony.
  • {{subst:Nazwa}} — gdy te odniesienie do szablonu jest użyte, jest na stałe zamienione na zawartość [[Szablon:Nazwa]], gdy strona z odniesieniem jest zapisana: kopia zawartości [[Szablon:Nazwa]] zastępuje odniesienie do szablonu. Zawartość jest wtedy częścią włączającej strony i może być normalnie edytowana, osobno od oryginału. Zauważ: późniejsze zmiany źródła szblonu nie zmieniają takiej kopii na stronie z odniesieniem.
  • {{sefesubst:Nazwa}} — to zostało wprowadzone, by pozwolić na podstawienie, które nie niszczy; więcej informacji w w:en:Help:Substitution#The safesubst: modifier (ang.).
  • {{msgnw:Name}} includes the template in a form that displays it as raw wiki syntax (the way <nowiki> does) when the page containing it is fetched.

In fact, an ordinary wiki page can also be used as a template, simply by specifying the namespace it resides in, so:

  • {{Template:Pagename}} includes [[Template:Pagename]]
  • {{Talk:Pagename}} includes [[Talk:Pagename]]
  • {{:Pagename}} includes [[Pagename]]
    • {{subst::Pagename}} replaces itself with the contents of [[Pagename]]

If no such namespace exists, the full title is assumed to be a template:

  • {{Foo:Bar}} includes [[Template:Foo:Bar]]

Parametry

To enrich the mechanism of transclusion, MediaWiki allows parameters to be passed to a template when it is transcluded. Parameters allow the template to produce different contents or have different behaviors.

Suppose you wish to insert a little thank you note in the talk page of other users, such as:

Podziękowanie dla Ciebie... za all your effort. uściski, Me

The thank you note will have a reason (in this case, "all your effort") and a signature ("Me"). Your objective is that any user be able to thank any other user, for any reason whatsoever.

So that the note will look similar everywhere it is used, you can define a template called Template:Thankyou , for example.

Although the note should look similar whenever a user thanks another user, its specific contents (i.e. the reason and the signature) will be different.

For that reason, you should pass them as parameters.

If we ignore the remaining elements to format the box and place the image, the core content of the template will be this:

'''A little thank you...'''
for {{{1}}}.
hugs, {{{2}}}

Notice the use of {{{1}}} and {{{2}}}. This is the way to identify, within templates, the parameters that will be passed in when the template is used. Note that, within the template, each parameter is surrounded by three braces: {{{ }}}. This is different from normal template name usage.

When using the template on a page, you fill in the parameter values, separated by a "pipe" character (|). MediaWiki allows parameters to be passed to the template in three ways: Anonymously, Numbered, and Named.

Anonimowe parametry

To pass in anonymous parameters, list the values of those parameters sequentially:

{{Thankyou|all your effort|Me}}

In this case, the {{Thankyou}} template receives parameters {{{1}}}=all your effort and {{{2}}}=Me, producing:

Podziękowanie dla Ciebie... za all your effort. uściski, Me

The order in which anonymous parameters are passed in is crucial to its behavior. Reversing the order of the parameters, like so:

{{Thankyou|Me|all your effort}}

would produce this result:

Podziękowanie dla Ciebie... za Me. uściski, all your effort

Identifying parameters by order (with {{{1}}}, etc) works only with anonymous parameters. Any parameters identified by name, as shown below, will not be accessible to the template using ordinal numbers.
If an equal sign appears inside the argument to an anonymous template parameter, that parameter may be misinterpreted as a named parameter (which is explained below in this document) treating the text before the equal sign as the parameter name and the text after it as the argument value. This is a common problem when you need to include an external link, or an HTML element with attributes (see Task 16235). The workaround is to use named parameters instead, or even numbered parameters as explained in the following section.

Numerowane parametry

To pass in parameters by number, identify each parameter when passing it:

{{Thankyou|2=Me|1=your friendship}}

This time, template {{Thankyou}} receives parameters {{{1}}}=your friendship and {{{2}}}=Me, though they have been supplied in inverse order, and produces: Podziękowanie dla Ciebie... za your friendship. uściski, Me

This may also be useful when any of the numbered parameters contains an "=" sign.
Examples:
{{Thankyou|1=adding “=”|2=Me}}
produces
Podziękowanie dla Ciebie...

za adding “=”. uściski, Me

  Uwaga: This also requires numbering each other parameter.

Nazwane parametry

The third way of passing parameters is by name instead of numbers. In this case, the template contents would be changed to:

'''A little thank you...'''
for {{{reason}}}.
hugs, {{{signature}}}

Within the template, we use {{{reason}}} and {{{signature}}} to identify each parameter, instead of a number. To pass these parameters by name, identify each parameter when passing it:

{{Thankyou|signature=Me|reason=being who you are}}

In this case, template {{Thankyou}} receives parameters {{{reason}}}=being who you are and {{{signature}}}=Me and produces:

Podziękowanie dla Ciebie... za being who you are. uściski, Me

Named parameters are case-sensitive, so:

{{Thankyou|signature=Me|Reason=being who you are|reason=being case-sensitive}}

produces: Podziękowanie dla Ciebie... za being case-sensitive. uściski, Me

The advantage of using named parameters in your template, besides also being flexible in the order parameters can be passed, is that it makes the template code much easier to understand if there are many parameters.

Domyślne wartości

If you transclude a template that expects parameters, but do not provide their arguments, in this way:

{{Thankyou}}

in the numbered parameters example above you would get the following:

Podziękowanie dla Ciebie... za {{{1}}}. uściski, {{{2}}}

Since no arguments were passed in, the template presents the parameters themselves, instead of their respective values. In these cases, it may be useful to define default values for the parameters, i.e. values that will be used if no value is passed in. For example, if the template contents are changed to:

'''A little thank you...'''
for {{{reason|everything}}}.
hugs, {{{signature|Me}}}

then {{{reason|everything}}} defines that if no argument is provided for parameter {{{reason}}}, then the value everything will be used. Similarly, {{{signature|Me}}}, defaults parameter {{{signature}}} to value Me. Now, transcluding the template again without passing any argument results in the following:

Podziękowanie dla Ciebie... za everything. uściski, Me

Often default values are used to specify alternate names of parameters. For example, if you have {{{a|{{{b|}}} }}}, the template will first look for a parameter named "a". If it is not set, it will use the parameter named "b". If neither "a" nor "b" is set, it will output nothing.

Evaluation

This is an advanced topic which you can skip unless you need it

Generally speaking, template parameters are substituted into the template after tokenization, but as is. They are not evaluated until they are used.

This has a few consequences. First of all, if you have a Template:Start containing {{mytemplate, and a Template:End containing |foo=bar}}, and put {{start}}{{end}} on a page, mytemplate isn't transcluded, because tokens like "|" cannot be added by a template and keep their special meaning in templates. You can still use templates to control the name of a parameter or template, but you cannot split a template call amongst multiple templates.

The second consequence of this is dead-code elimination. If you make a template call like {{ #foreach: foo$n$_bar | foo$n$_bar = {{{foo$n$_bar}}}
}}
, and Template:Foo does not contain {{{1}}}, then the displaytitle is not used, since it is only evaluated when needed, and it there is no parameter to substitute it into, so it is never evaluated. This usually comes into play when using Extension:ParserFunctions, and can be especially noticed when used in combination with the int: magic word that varies by user language.

Template calls starting with the magic word subst: or safesubst: are evaluated in a separate first pass that only happens at save time, along with ~~~~ and links using the pipe trick. If they cannot be evaluated during the first pass, subst: calls are ignored, and safesubst: are treated as if a normal template.

Many but not all parser functions, parser tags and trancluded special pages are not directly included like templates but instead are replaced by a "strip marker". This means you cannot manipulate the results with parser functions like padleft: or similar functions from extensions, as they see the strip marker instead of the result of the parser function.

Recursion in templates

Including a template in itself won't throw MediaWiki into infinite recursion.

MediaWiki will stop the recursion with the template's name in bold.

For example, if the content of "Template:Aaaa" is "{{Aaaa}}", it'll show as "Template:Aaaa" and display Template loop detected: Template:Aaaa.

Control template inclusion

By default, a template's content is displayed in its entirety, both when viewed directly and when included in another page. However, you can control which parts of a template will be seen and included by the use of the <noinclude>, <includeonly> and <onlyinclude> tags.

Anything between <noinclude> and </noinclude> will be seen only when the template's page is being viewed directly, but not when it is included in another page. This is useful when you want to include text or code in a template that you do not want to propagate to any pages which include it, such as:

  • Category links when categorizing the template itself
  • Explanatory text about how to use the template

Likewise, anything between <includeonly> and </includeonly> will be processed and displayed only when the page is being included, but not when the template page is being viewed directly, and is useful in situations such as:

  • Categorizing pages which include the template. Note: when changing the categories applied by a template in this fashion, the categorization of the pages which include that template may not be updated until some time later: this is handled by the job queue . To force the re-categorization of a particular page, open that page for editing and save it without changes.
  • Ensuring that the template's code is not executed when viewing the template page itself. Typically this is because it expects parameters, and its execution without parameters has an undesired result.

Everything outside <noinclude> and <includeonly> is processed and displayed normally; that is, both when the template page is being viewed directly and when the template is included in another page.

The focus is on what is inside these two tags.

Everything outside <onlyinclude> tags is discarded in the transclusion.

Even sections tagged includeonly are discarded in the transclusion unless they are also tagged as onlyinclude.

The focus is on what is outside this tag.

Nesting of these tags is also possible.

The three partial transclusion tags enable all possible combinations of what is processed and rendered.

Comments also fill a role.

Organizing templates

For templates to be effective, users need to find them, and find out how to use them.

To find them, users can:

  1. Click Strony specjalne > Wszystkie strony
  2. In the Przestrzeń nazw: list, choose Template and click Pokaż.

To give usage information, include an example like this one on the template page:

<noinclude>
== Usage ==
Welcome users:
{{Thankyou|reason=your reason|signature=your signature}}
</noinclude>

Then, an editor can simply copy and paste the example to use the template.

Linking to a template

A template page can be linked to like any other wiki page. For example, the link Template:Navbar is generated using the wikicode {{ll|Template:Navbar|Template:Navbar}}.

On many wikis, Template:Tl can be used to provide a link to a template formatted in a way that shows the "double curly-braces" wikicode necessary to transclude the template without actually doing the tranclusion. For example, the code {{tl|Navbar}} may be used to create the link {{Navbar}}.

This construct is commonly used in template documentation, on help pages, and on talk pages when referring to templates.

The same effect can be achieved by using {{Navbar}}, but the {{tl}} approach involves much less typing.

On any given wiki the Tl template, if it exists, may or may not render the text in a "code" element, as shown here.

If not, another similarly named template may do so.

See, for example, the "See also" section of the documentation of en:Template:Tl at the English Wikipedia.

Kopiowanie z jednej wiki do innej

Templates often require CSS or other templates, so users frequently have trouble copying templates from one wiki to another. The steps below should work for most templates.

Kod MediaWiki

Jeśli masz uprawnienia do importowania (w szczególności importupload) na nowej wiki:

  1. Przejdź do Special:Export na oryginalnej wiki i pobierz plik .xml z pełną historią wszystkich niezbędnych szablonów:
    • Wprowadź nazwę szablonu w dużym polu tekstowym, np. "Szablon: Witamy". Zwróć szczególną uwagę na wielkie litery i znaki specjalne - jeśli nazwa szablonu nie jest dokładnie poprawna, eksport może nadal występować, ale plik .xml nie będzie zawierał oczekiwanych danych.
    • Zaznacz pole "Dołącz szablony".
    • Odznacz pole "Tylko bieżąca wersja, bez historii".
    • Kliknij "$submit".
  2. Przejdź do Special:Import na nowej wiki i prześlij plik .xml.

Jeśli nie masz uprawnień do importowania na nowej wiki:

  1. Przejdź do szablonu, który chcesz skopiować z oryginalnej wiki. Przejdź do strony edycji i skopiuj cały plik wikitekstu.
  2. Na nowej wiki przejdź do strony o tej samej nazwie co skopiowany szablon. Kliknij, aby utworzyć/edytować i wkleić skopiowany plik wikitekstu. W podsumowaniu edycji każdego szablonu umieść link do oryginalnej strony w celu uznania autorstwa.
  3. Wróć do oryginalnej wiki w oknie edycji, pod polem edycji, spójrz na listę "Szablony używane na tej stronie". Dla każdego wymienionego szablonu postępuj zgodnie z tymi instrukcjami. Zrób to również dla dowolnego szablonu używanego przez dowolny z tych szablonów i tak dalej.

Spowoduje to skopiowanie całego niezbędnego kodu i będzie wystarczająca dla niektórych szablonów.

Jeśli to nie zadziała, sprawdź również czerwone linki wymienione w sekcji "Strony przeniesione do bieżącej wersji tej strony:" poniżej pola edycji. Jeśli są, powtórz powyższe kroki.

Po pomyślnym zaimportowaniu szablonu i wszystkich powiązanych z nim szablonów z innej wiki, zmodyfikuj go, aby dostosować go do swojej wiki. Na przykład, aby zmienić logo, usuń zbędne kategorie lub czerwone linki.

Rozszerzenia

An extension often used in templates is ParserFunctions.

Visit page Rozszerzenie:Funkcje parsera and check if any of the functions listed there are used in the templates you've copied.

If so, you have to install the ParserFunctions extension.

To install it, you'll need system admin access to the server of your MediaWiki installation.

Another dependency that may be used in templates, especially those on Wikipedia, is Lua. Having {{#invoke: }} in template code is a good sign for it.

In case it's used, you need to install the Scribunto extension and system admin access is required too.

See that page for more instructions about installing and using the extension.

Kod CSS i JavaScript

Besides MediaWiki code, many templates make use of CSS and some rely on JavaScript to work fully. If the copied templates are not behaving as expected, this may be the cause. To copy the required CSS and JavaScript to your wiki you'll normally need to have admin privileges, because you'll be editing system messages in the "MediaWiki:" namespace.

  1. Look for the use of CSS classes (text like class="foobar") in the template text. If those classes appear in "MediaWiki:Common.css" or "MediaWiki:Monobook.css" on the original wiki, copy those classes to "MediaWiki:Common.css" on the new wiki and check if the template is now fine.
  2. If the copied template is still not working as expected, check if there is code in "MediaWiki:Common.js" or "MediaWiki:Monobook.js" on the original wiki. If so, you can try copying it to "MediaWiki:Common.js" on the new wiki. Normally, it is a good idea to only copy code from trusted sources, and first browsing the code to identify and select the parts that are relevant. You may find comments that can serve as clues to identify the functionality of each part.

Zobacz też

  • m:Help:Template – contains a much more thorough manual on how exactly templates function
  • m:Help:Advanced templates – describes even more advanced techniques such as dynamic template calls and variable parameter names

External links