Pomoc:Tworzenie szablonów

Szablony umożliwiają wstawianie często powtarzających się fragmentów artykułów w formie jednego, krótkiego linku (zapisywanego w postaci '''{{xxx}}''', a nie jak tradycyjny link '''[[xxx]]'''), 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.

Tworzenie i edytowanie strony szablonu

Zazwyczaj komunikat, który ma się pojawić po zalinkowaniu w postaci szablonu powinien być zapisany w przestrzeni nazw Szablon:

Co to znaczy? Aby używać szablonowych komunikatów na stronach, tworzymy najpierw treść szablonu na stronie Szablon:Treść informacji tratata. Gdy mamy taką stronę utworzoną, wówczas możemy ją wstawić na stronie w postaci {{Treść informacji tratata}}. Wyświetli się wówczas ta treść, jaką wpisaliśmy na stronę Szablon:Treść informacji tratata. Proste? :)

Żeby edytować szablon, trzeba wejść na jego stronę, czyli jeśli na stronie zauważymy w kodzie coś takiego {{Jakaś nazwa 001}}, to kopiujemy tę nazwę i wpisujemy w wyszukiwarkę Szablon:Jakaś nazwa 001. W przypadku bardziej złożonych szablonów, o których niżej, to może być nieco bardziej skomplikowane ;)

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, tj. zakładki „przenieś”. 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 nazwie jest ważna, to znaczy szablon o nazwie "AbCd" nie jest tożsamy z szablonem o nazwie „Abcd”.

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ć {{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 jaką pełni dany szablon.

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.

Korzystanie z komunikatów

Umieszczanie szablonów na stronie

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

• szablony informacyjne jak np. {{ujednoznacznienie}} 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

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.

Liczba szablonów nawigacyjnych nie jest określona. Najlepiej, gdy jest ich maksymalnie kilka.

Metody zamieszczania szablonów na stronach

Linki do komunikatów tworzy się według schematu:

{{metoda:nazwa komunikatu}}

Weźmy pod uwagę szablon {{aktualne}}

metoda prostego wstawienia szablonu

{{aktualne}} (najczęściej wykorzystywana ;)

Ten sam efekt da {{msg:aktualne}} (ale praktycznie w Wikipedii nie wykorzystujemy tej formy)

metoda msgnw

{{msgnw:aktualne}}
wyświetli nam cały kod tego komunikatu, tak, jak byśmy uniemożliwili działanie linków, tagów itd.: (w wikipedii raczej nie wykorzystywana)

{{Mbox | typ = wiadomość | grafika = {{#if:{{{link|}}}|{{ikona|wikinews|35}}|{{ikona|aktualne|35}}}} | tekst = '''{{#ifeq:{{{1|}}}|sekcja|Ta sekcja|Ten artykuł}} dotyczy [[Pomoc:Ponadczasowość|{{{2|trwającego wydarzenia}}}]].''' Informacje w {{#ifeq:{{{1|}}}|sekcja|niej|nim}} zamieszczone mogą się zmienić lub zdezaktualizować wraz z postępem zdarzenia, a początkowe doniesienia mogą być [[Wikipedia:Weryfikowalność|niepewne]]. [{{fullurl:{{FULLPAGENAME}}|action=history}} Ostatnie zmiany] te{{#ifeq:{{{1|}}}|sekcja|j sekcji|go artykułu}} [[Wikipedia:Zastrzeżenia dotyczące ryzyka|mogą nie odzwierciedlać]] najbardziej aktualnych informacji. {{#if:{{{link|}}}|'''Zobacz [[n:{{{link|}}}|relację z wydarzenia w Wikinews]]''', serwisie informacyjnym, siostrzanym projekcie [[Wikimedia Foundation|Fundacji Wikimedia]].}} }}{{#if:{{NAMESPACE}}||[[Kategoria:Aktualne]]|}}<noinclude> {{Dokumentacja}} </noinclude>

metoda subst

{{subst:aktualne}}
Użycie tej metody spowoduje, że kod szablonu zostanie zastąpiony jego treścią (efekt można zobaczyć, np. edytując tę stronę). Mimo, że treść poniżej wygląda identycznie jak przy pierwszej metodzie, to jednak po zapisaniu strony i ponownym edytowaniu przy pierwszej metodzie znajdziemy w kodzie {{aktualne}}, a przy tej - samą treść z szablonu.

Jeszcze raz, żeby łatwiej było odróżnić :)

• 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łu 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.

Dowolna strona jako szablon

Za szablon może też posłużyć dowolna strona nie należąca do przestrzeni nazw szablonów. Aby wstawić tekst ze strony nie będącej w przestrzeni nazw szablonów należy najpierw podać nazwę tej przestrzeni, dwukropek i nazwę strony (dla głównej przestrzeni należy dodać tylko dwukropek na początku nazwy), np. {{:klucz}} wstawi do artykułu całą stronę o nazwie klucz znajdującą się w przestrzeni głównej.

Należy zauważyć, że stosując jedną z metod wstawiania szablonów, opisanych w pkt. 3.2, należy w tym przypadku użyć podwójnego dwukropka według schematu: {{metoda::dowolna strona}}, np. {{subst::klucz}} aby jedna z tych metod działała poprawnie z dowolną stroną nie należąca do przestrzeni nazw szablonów.

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

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

Udokumentowanie szablonu

Należy w każdym szablonie umieścić jego opis (dokumentację własną), zawierający m.in. wykaz parametrów szablonu i spsób ich użycia. Chociaż jest technicznie możliwe umieszczenie opisu na stronie szablonu (czyli w jego kodzie), z użyciem odpowiednich konstrukcji parsera, to zdecydowanie poprawne jest umieszczenie opisu na specjalnej podstronie szablonu o nazwie ".../opis". Oczywiście podstronę taką można stworzyć samodzielnie, ale równie zdecydowanie zalecane jest użycie w tym celu specjalnego szablonu {{Dokumentacja}} poprzez umieszczenie (np. przy tworzeniu nowego szablonu) w kodzie szablonu, na jego końcu poniższej konstrukcji:

<noinclude>{{Dokumentacja}}</noinclude>

Szablon ten pozwala utworzyć podstronę dokumentacji z gotowym sformatowanym wg zwyczajów polskiej wikipedii kodem. M.in. kod ten zawiera prawidłowo urządzone miejsce na podanie kategorii opisywanego szablonu.

Kategoryzacja szablonów

Każdy szablon musi mieć przypisaną kategorię, ale jej wskazanie wymaga zastosowania odpowiednich konstrukcji. Wyboru kategorii należy dokonać na podstawie analizy kategorii szablonów.

Jawne wpisanie kategorii szablonu w jego kodzie (np. [[Kategoria:Szablony nawigacyjne]]) oczywiście umieści dany szablon we wskazanej kategorii, ale też wywoła, że również taką kategorię będą otrzymywały hasła, w których będzie on użyty (co oczywiście będzie błędnym propagowaniem tej kategorii). Ogólnie gdy podajemy kategorię szablonu w jego kodzie, to używany konstrukcji:

<noinclude>[[Kategoria:xxx]]</noinclude>

Należy jednak tego unikać i stosować podawanie kategorii w jego dokumentacji własnej, utworzonej ze sformatowanym wstępnie kodem poprzez szablon {{Dokumentacja}} (patrz wyżej). Ponadto jeśli dany szablon używa innego (wywołuje go), a ma on taką samą kategorię, to można w danym w ogóle nie wskazywać tej kategorii.