Wikipedia:Tworzenie automatycznych komunikatów
Z Wikipedii
Tworzenie i korzystanie z automatycznych komunikatów
 |
Zasugerowano, aby ten artykuł zintegrować z artykułem Jak tworzyć szablony. (dyskusja) |
Automatyczne komunikaty umożliwiają wstawianie często powtarzających się fragmentó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] Tworzenie i testowanie komunikatów
Na początku należy zastanowić się, czy dany komunikat automatyczny (szablon) jest na pewno potrzebny i zastanowić się nad odpowiednią nazwą dla niego. Szablony o podobnym zastosowaniu powinny mieć generalnie podobny przedrostek, 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}}
(oczywiście zamiast "Nazwa użytkownika" należy wpisać swoją nazwę użytkownika)
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 "BaNaNa" nie jest tożsamy z komunikatem o nazwie "Banana"
[edytuj] Korzystanie z komunikatów
[edytuj] Rodzaje komunikatów
Istnieją trzy sposoby wstawiania komunikatów:
- 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.
- 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.
[edytuj] Wstawianie komunikatów
Komunikaty wstawia się do artykułów wg następującego schematu:
{{metoda:nazwa_komunikatu}}
Przy czym zazwyczaj pomija się metodę wyświetlania podając samą nazwę komunikatu – wówczas użyta jest metoda msg opisana na początku.
[edytuj] Przykłady
- 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 style="border-top: 2px solid #ddd; border-bottom:2px solid #ddd; margin-left: 12px; padding: 3px;">[[Grafika:Information icon.svg|16px]]'''[[Wikipedia:Ostrzeżenie o szczegółach|Uwaga:]] Poniżej znajdziesz opis rozwiązania gry.'''</div> <noinclude>[[Kategoria: Ostrzeżenie dla czytelnika|{{PAGENAME}}]]</noinclude>
- metoda subst
{{subst:solution}}
wpisze tu treść tego komunikatu i zniknie (co można sprawdzić edytując ten artykuł :-) )(poniżej był kiedyś komunikat typu subst - a teraz zamiast niego jest tylko sama jego treść :-))
Uwaga: Poniżej znajdziesz opis rozwiązania gry.
[edytuj] Uwagi końcowe
Jeśli stosowana jest metoda msg a w tekście komunikatu jest umieszczony link do innej strony typu [[jakaś strona]] to link ten jest rejestrowany na stronie specjalnej Linkujące jako linkujący do jakaś strona ze strony w której jest umieszczony dany komunikat. W rezultacie Specjalna:Linkujące dla strony, do której prowadzi łącze z często używanego szablonu zawiera wszystkie strony z tym szablonem.
