--=REKLAMA=--

Szablon

Dokumentacja

Z Joomla!WikiPL

Wersja Zwiastun (dyskusja | edycje) z dnia 11:46, 31 maj 2018

(różn.) ← poprzednia wersja | przejdź do aktualnej wersji (różn.) | następna wersja → (różn.)
[ przeglądaj][edytuj][historia] Szablon:Dokumentacja - dokumentacja

Ten szablon wyświetla automatycznie opis danej strony w ramce, którą teraz widzisz, a której zawartość jest dołączana z innej strony. Szablon jest przeznaczony dla stron, które są włączane do innych stron, np. szablonów.

Stosowanie

<noinclude>{{dokumentacja}}</noinclude>
albo 
<noinclude>{{dokumentacja|:przestrzeńnazw:jakiś artykuł}}</noinclude>
albo  
<noinclude>{{dokumentacja|strona szablonu}}</noinclude>


Normalny /opis

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

/opis umieszczony na innej stronie

<noinclude>{{Dokumentacja|Szablon:Jakaś strona/opis}}</noinclude>

Zawartość z parametru

<noinclude>{{Dokumentacja|zawartość=To jest dokumentacja.}}</noinclude>

Zawartość z parametru z linkami [zobacz][edytuj]

<noinclude>{{Dokumentacja
|1 = Szablon:Jakaś strona/opis
|zawartość ={{Szablon:Jakaś strona/opis|parametry}}
}}</noinclude>

Umiejscowienie szablonu

Ten kod powinien zostać dodany na końcu kodu szablonu bez żadnych spacji poprzedzających "<noinclude>" (spowodowałoby to dodatkowy niepotrzebny odstęp na stronach, na których szablon byłby zastosowany).

Parametr, którego użyto powyżej do włączenia arbitralnie określonej strony dokumentacji. Jeśli nie zostanie podany argument/nazwa strony zostanie dodana nazwa podstrony /doc -- tylko w ten sposób strona /doc zastosowana jest do strony rodzica (odnosi się).

Kategorie i linki interwiki dodawaj do dokumentacji strony pomiędzy znacznikami <includeonly> </includeonly>

Zmiana sposobu wyświetlania dokumentacji

Jeśli to niezbędne, można zmienić sposób wyświetlania nagłówka:

  • {{Dokumentacja| nagłówek = ...}} − ten parametr zmieni treść nagłówka z "Dokumentacja" na wpisany. Jeżeli zostanie ustawiony pusty parametr cała linia nagłówka (włączając link do edycji) zniknie.

Jeśli strona dokumentacji zawiera znaczniki <includeonly> albo <noinclude> w części dokumentacji, zastąp znak "<" znakami: "&lt;".

Funkcje

Jeżeli strona dokumentacji nie istnieje, link "edytuj" zamieni się na link "stwórz" zawierający parametr preload, dzięki czemu pole edycji zostanie wypełnione podstawowym kodem dokumentacji. Nagłówek zależy od przestrzeni nazw, na przykład "Dokumentacja szablonu" zostanie wyświetlona w przestrzeni nazw 'Szablon'.

Uzasadnienie

Ten szablon jest metodą bezpiecznego oddzielenia dokumentacji szablonu od kodu szablonu, poprzez umieszczenie dokumentacji na oddzielnej stronie. Pozwala to na całkowite zabezpieczenie szablonu, jednocześnie umożliwiając pozostawienie dokumentacji niezabezpieczonej, tak by wszyscy mogli ją edytować. Ponadto rozwiązanie takie redukuje obciążenie zasobów serwera w wyniku ominięcia technicznych ograniczeń szablonów. Zobacz objaśnieniem dla projektantów pod adresem: Wikipedia Village pump.