Wikipedia:Jak tworzyć szablony

Zasugerowano, aby ten artykuł zintegrować z artykułem Tworzenie automatycznych komunikatów.

Szablony (komunikaty automatyczne) umożliwiają wstawianie często powtarzających się fragmetów artykułów w formie jednego, krótkiego linku, który automatycznie "dopisuje" ten fragment do treści artykułu w momencie jego wczytywania do przeglądarki lub (w drugim wariancie) w momencie zapisywania tekstu artykułu.

Spis treści

[edytuj] Rodzaje szablonów

Można rozróżnić kilka rodzajów szablonów

szablony nawigacyjne to rodzaj szablonów mający za zadanie ułatwienie użytkownikowi poruszania się pomiędzy artykułami na ten sam temat. Przeważnie szablon nawigacyjny ma postać niewielkiej tabeli zawierającej linki do artykułów.

infoboksy to szablony specjalnego typu. Tworzy się je najczęściej przy użyciu szablonów warunkowych (specjalnych). Infoboksy posiadają parametry, które modyfikują ich wygląd i zawartość. Więcej na stronie Pomoc:Infoboks.

szablony w portalach to szablony utworzone na podstronie danego portalu w celu łatwiejszej aktualizacji danych. Są one umieszczone w przestrzeni nazw Portal

szablony informacyjne/ostrzegawcze to szablony, które nie są częścią treści artykułu, ale np. informują o tym, aby wstawić linki, dopracować artykuł, czy go usunąć. Czasami szablony informacyjne wstawiane są na strony wikipedystów czy do innych przestrzeni nazw - np.: {{test}}, {{witaj}}

szablony warunkowe/specjalne - szablony warunkowe to szablony używane w innych szablonach, np. w infoboksach lub w szablonach informacyjnych. Istnieje tez szereg szablonów specjalnych, czasami także wykorzystujących szablony warunkowe, jak np. {{lang}}

oprócz powyższych przykładów można użyć jako szablonu dowolnej strony z przestrzeni Wikipedia, Wikipedysta, MediaWiki, Pomoc oraz strony dyskusji.

[edytuj] Tworzenie i testowanie szablonów

Na początku należy zastanowić się, czy szablon jest na pewno potrzebny i zastanowić się nad odpowiednią nazwą dla niego. Szablony o podobnym zastosowaniu powinny mieć generalnie podobną nazwę, bo to ułatwia ich znalezienie.

Podobnie jak w przypadku artykułów nowy szablon najlepiej najpierw stworzyć we własnym brudnopisie (nazwa podstrony oczywiście dowolna). Aby w pełni przetestować szablon wystarczy wkleić go na stronę dyskusji brudnopisu. Odpowiedni kod to:

{{Wikipedysta:Nazwa użytkownika/brudnopis}}

Po przetestowaniu szablon można przenieść do przestrzeni nazw Szablon, korzystając z odpowiedniej zakładki. Szablon powinien być dodany też na stronie Wikipedia:Szablony do odpowiedniej kategorii. Warto też dodać instrukcję dla użytkowników na stronie dyskusji szablonu. Powinny się w niej znaleźć informacje o zastosowaniu szablonu (jeśli nie jest oczywiste) i opis parametrów (jeśli szablon takie posiada).

Warto jeszcze zwrócić uwagę, że wielkość liter w komunikatach jest ważna, to znaczy komunikat o nazwie "AbCd" nie jest tożsamy z komunikatem o nazwie "Abcd"

[edytuj] Wielkość szablonów

Wielkość szablonu powinna być dostosowana do jego funkcji.

Dla szablonów nawigacyjnych optymalną szerokością jest cała szerokość strony. Do tego celu najlepiej wykorzystać {{Uniwersalny szablon nawigacyjny}}.
Dla infoboksów szerokość powinna wynosić 250 pikseli lub - gdy to nie wystarcza - 300 pikseli.

Wielkość pozostałych szablonów nie jest dokładnie ustalona, zależy ona od funkcji jaka pełni dany szablon.

[edytuj] Kolorystyka i format szablonów

Należy wystrzegać się stosowania w szablonach kolorów, które utrudniają czytanie oraz kontrastują z ogółem strony (żółty, czerwony, niebieski).

Optymalne kolory dla szablonu to odcienie szarego oraz kolory pastelowe, np. fiolet. Dla tekstu najlepiej zostawić kolor czarny.

[edytuj] Korzystanie z komunikatów

[edytuj] Rodzaje komunikatów

Istnieją trzy sposoby wstawiania komunikatów:

metoda subst - powoduje jednokrotne wpisanie tekstu komunikatu do kodu artykułu w momencie zapisywania artykułu po edycji.
- w wyniku tej metody tekst komunikatu "łączy się" z resztą artykułu zaś sam link do komunikatu niejako "znika" z kodu artykułu, więc w rezultacie powstaje jednolity tekst, składający się z tekstu wpisanego "ręcznie" oraz wklejonego linkiem komunikatu
- korzystanie z metody subst powoduje, że przy zmianie źródłowego tekstu komunikatu, tekst wstawiony do artykułu tą metodą nie ulega zmianom.
metoda msg (addycja) - powoduje wyświetlanie aktualnego tekstu komunikatu przy każdym wczytaniu tekstu artykułu zawierającego w kodzie link do tego komunikatu.
- w wyniku tej metody link pozostaje na stałe w kodzie artykułu i jest "podstawiany" tekstem źródłowym komunikatu przy każdym wczytaniu artykuły do przeglądarki
- korzystanie z metody msg powoduje, że przy zmianie tekstu źródłowego komunikatu, zmienia się automatycznie wyświetlany tekst wszystkich artykułów, w których ten komunikat został użyty
metoda msgnw - technicznie jest to praktycznie to samo co metoda msg, z wyjątkiem tego, że cały tekst komunikatu zostaje automatycznie umieszczony między znacznikami "<nowiki></nowiki>" - umożliwia to np. wstawianie fragmentów kodu, który normalnie byłby interpretowany przez mechanizm wiki.

[edytuj] Tworzenie linków do komunikatów

Linki do komunikatów tworzy się wg schematu:

metoda msg
{{msg:solution}} albo {{solution}}

da taki efekt:
Uwaga! Poniżej znajdziesz opis rozwiązania gry.
metoda msgnw
{{msgnw:solution}}

wyświetli nam cały kod tego komunikatu bez jego interpretacji:

<div class="detail noprint"><span>[[Grafika:Information icon.svg|15px]] <span>'''[[Wikipedia:Ostrzeżenie o szczegółach|Uwaga]]!''' Poniżej znajdziesz opis rozwiązania gry.</span></span></div> <noinclude>[[Kategoria: Ostrzeżenie dla czytelnika|{{PAGENAME}}]]</noinclude>
metoda subst
{{subst:solution}}

wpisze treść tego komunikatu (co można sprawdzić edytując ten artykuł)

Uwaga: Poniżej znajdziesz opis rozwiązania gry.

[edytuj] Umieszczanie szablonów na stronie

Umiejscowienie szablonu zależy od jego rodzaju (patrz dział rodzaje szablonów):

szablony informacyjne jak np. {{disambig}} umieszcza się na samej górze artykułu, tzn. w pierwszej linijce
infoboksy umieszcza się pod nimi, także przed treścią
szablony nawigacyjne umieścić należy na końcu strony, tzn. pod linkami zewnętrznymi, a jednocześnie przed kategoriami i interwiki
w tym samym miejscu należy umieścić odpowiedni rodzaj szablonu {{stub}} (jeśli potrzebny).

Należy pamiętać, aby nie umieszczać na jednej stronie zbyt wielu szablonów oraz by się one nie dublowały. Zalecane jest, aby na stronie znajdował się tylko jeden infobox.

Ilość szablonów nawigacyjnych nie jest określona. Najlepiej, gdy jest ich maksymalnie kilka. Należy także uważać, aby szablon oparty na komunikacie {{Uniwersalny szablon nawigacyjny}} nie dublował się z szablonem {{Poprzednik Następca}}.

Ilość szablonów {{stub}} powinna być ograniczona do jednego. Najlepiej użyć w tym celu {{unistub}}.