Szablon:Dopracować

Użycie

Szablonu należy używać do oznaczania artykułów, które nie są napisane zgodnie z zaleceniami edycyjnymi, a więc wymagają dopracowania.

W postaci ogólnej wywołanie szablonu ma poniższą postać - kursywą wskazano miejsca, w których należy wpisać adekwatny tekst:

{{Dopracować|sekcja|co dopracować|sekcja dyskusji=Nazwa sekcji dyskusji z wyjaśnieniami}}

Występują w nim trzy parametry (argumenty) - dwa pozycyjne (nienazwane lub inaczej numeryczne - 1 i 2) oraz jeden kluczowy (nazwany) z nazwą "sekcja dyskusji". Wszystkie są opcjonalne, czyli można ich nie podać (jak to zobrazowano w szóstym poniższym przykładzie), ale jest to zdecydowanie niezalecane - efektem takiego szablonu jest bardzo enigmatyczny komunikat.

Zgodnie z regułami parsera MediaWiki dla parametrów pozycyjnych podajemy tylko ich wartość (ciąg znaków po symbolu potoku do następnego takiego symbolu lub do podwójnych nawiasów klamrowych prawych), a ustalenie który to parametr określa pozycja danej wartości na liście parametrów, czyli ciągu znaków po pierwszym znaku potoku "|" (parametry pozycyjne mogą być traktowane też jak kluczowe, ale w tej instrukcji to pominiemy).

Konstrukcja szablonu dla parametrów pozycyjnych jest specyficzna i trudna dla osoby nieobeznanej z funkcjami parsera.

W wywołaniu szablonu może być podawana dla nich jedna lub dwie wartości wartości. Ale jeśli jest podana tylko jedna wartość, to kod szablonu traktuje to jako przypadek niepodania wartości parametru nr 1, a podaną wartość przypisuje parametrowi 2, czyli przyjmuje ten tekst jako wyjaśnienie co należy dopracować. Jeśli są podane dwie wartości, to pierwsza musi być słowem "sekcja" (i oczywiście takie wywołanie szablonu powinno być wstawione w sekcji) - podanie innego słowa spowoduje uznanie go za pominięcie parametru nr 1 i przypisanie tego słowa parametrowi nr 2. Ponadto jeśli pierwsza wartość to "sekcja", to musi być też podana druga wartość - dla parametru nr 2, gdyż pominięcie tej wartości spowoduje częściowo błędne działanie szablonu. Podając wartość parametru nr 2, czyli tekst, który pojawi się po tekście "Należy ... poprawić:" koniecznie trzeba ułożyć ten tekst tak, aby był poprawny gramatycznie. Będzie to tekst odpowiadający na pytanie - co należy poprawić? Na przykład zły będzie tekst "styl jest nieencyklopedyczny", a poprawny "styl - nie jest encyklopedyczny". Można wreszcie użyć jako wartości parametru nr 2 słowa "styl", co spowoduje pojawienie się w ramce generowanej przez szablon tekstu "styl - powinien mieć encyklopedyczną formę" z odsyłaczem (linkiem) do naszych zaleceń Styl - poradnik dla autorów - pokazane to jest w drugim poniższym przykładzie.

Szablon może też wyświetlić informację o tym, że dodatkowe wyjaśnienia są na stronie dyskusji danego artykułu. Odpowiedni tekst wyświetli się tylko wtedy, gdy dany artykuł ma założoną stronę dyskusji. Domyślnie kod szablonu wyświetla komunikat, że taka informacja być może znajduje się w sekcji "Dopracować" strony dyskusji. Jeśli wyjaśnienia są w sekcji dedykowanej (np. z nazwą "Styl do ulepszenia"), to używając parametru kluczowego "sekcja dyskusji=Styl do ulepszenia" można wskazać tę sekcję.

Poniższe przykłady obrazują dane wyjaśnienia.

Jeżeli dla parametru nr 2 podano wartość "styl", to artykuł jest dodawany do kategorii Artykuły wymagające poprawy stylu. W przeciwnym razie szablon dodaje artykuł do kategorii Artykuły wymagające dopracowania.

Przykłady

1. podanie jednej wartości dla parametrów pozycyjnych, co oznacza że jest to wartość parametru nr 2, czyli wskazanie, co należy poprawić

{{Dopracować|dane liczbowe - są niepoprawnie, składy - są nieaktualne, transliterację nazwisk}}

Ten artykuł wymaga dopracowania zgodnie z zaleceniami edycyjnymi. Należy w nim poprawić: dane liczbowe - są niepoprawnie, składy - są nieaktualne, transliterację nazwisk. Dokładniejsze informacje o tym, co należy poprawić, być może znajdują się na stronie dyskusji tego artykułu w sekcji Dopracować Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu.

2. podanie jako drugiego parametru słowa "styl" zmienia kategorię i wywołuje informację odnoszącą do strony z zaleceniami dotyczącymi stylu encyklopedycznego

{{Dopracować|styl}}

Ten artykuł wymaga dopracowania zgodnie z zaleceniami edycyjnymi. Należy w nim poprawić: styl - powinien mieć encyklopedyczną formę. Dokładniejsze informacje o tym, co należy poprawić, być może znajdują się na stronie dyskusji tego artykułu w sekcji Dopracować Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu.

3. podanie dwóch wartości - dla parametrów pozycyjnych 1 i 2

{{Dopracować|sekcja|styl wypowiedzi - jest nieencyklopedyczny}}

Ta sekcja wymaga dopracowania zgodnie z zaleceniami edycyjnymi. Należy w niej poprawić: styl wypowiedzi - jest nieencyklopedyczny. Dokładniejsze informacje o tym, co należy poprawić, być może znajdują się na stronie dyskusji tego artykułu w sekcji Dopracować Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu.

4. podanie jednej wartości dla parametrów pozycyjnych, co oznacza że jest to wartość parametru nr 2, oraz parametru kluczowego

{{Dopracować|styl wypowiedzi - jest nieencyklopedyczny|sekcja dyskusji=Styl do ulepszenia}}

Ten artykuł wymaga dopracowania zgodnie z zaleceniami edycyjnymi. Należy w nim poprawić: styl wypowiedzi - jest nieencyklopedyczny. Dokładniejsze informacje o tym, co należy poprawić, znajdują się w sekcji Styl do ulepszenia dyskusji tego artykułu Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu.

5. podanie tylko wartości dla parametru kluczowego

{{Dopracować|sekcja dyskusji=Styl do ulepszenia}}

Ten artykuł wymaga dopracowania zgodnie z zaleceniami edycyjnymi. Dokładniejsze informacje o tym, co należy poprawić, znajdują się w sekcji Styl do ulepszenia dyskusji tego artykułu Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu.

6. niezalecanie - pominięcie wszystkich wartości dla parametrów

{{Dopracować}}

Ten artykuł wymaga dopracowania zgodnie z zaleceniami edycyjnymi. Dokładniejsze informacje o tym, co należy poprawić, być może znajdują się na stronie dyskusji tego artykułu w sekcji Dopracować Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu.

7. częściowo błędne działanie - podanie wartości parametru nr 1 i brak wartości dla parametru nr 2

{{Dopracować|sekcja}}

Ta sekcja wymaga dopracowania zgodnie z zaleceniami edycyjnymi. Należy w niej poprawić: {{{2}}}. Dokładniejsze informacje o tym, co należy poprawić, być może znajdują się na stronie dyskusji tego artykułu w sekcji Dopracować Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu.

8. częściowo błędne działanie - podanie dwóch wartości parametrów pozycyjnych, ale pierwsza nie jest słowo "sekcja", więc kod szablonu przyjmuje, że jest to wartość parametru nr 2 - czyli opis co należy zmienić, i pomija wartość drugą

{{Dopracować|sekta|opis sekty}}

Ten artykuł wymaga dopracowania zgodnie z zaleceniami edycyjnymi. Należy w nim poprawić: sekta. Dokładniejsze informacje o tym, co należy poprawić, być może znajdują się na stronie dyskusji tego artykułu w sekcji Dopracować Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu.

Zobacz też

• Lista szablonów dotyczących problemów i dyskusji