Szablon:Podstrona dokumentacji

Dokumentacja szablonu [zobacz] [edytuj] [historia] [odśwież]

Ten szablon jest używany na wielu stronach.
Wszystkie eksperymenty należy przeprowadzać w swoim brudnopisie lub na stronach testowych. Przetestowane zmiany powinny być dodawane w jednej edycji.

Użycie

Ten szablon powinien być umieszczany na górze stron "/opis". Zmienia swój wygląd w zależności od strony, na której jest wyświetlany:

Na stronach "/opisowych" wyświetla informację, że strona jest dokumentacją oraz daje link do szablonu.
Na innych stronach (np. stronach dołączających stronę "/opisową") informuje o tym, że dokumentacja jest dołączana z innej strony.

Opis parametrów dodatkowych

Parametry dodatkowe tego szablonu.
`nazwa przestrzeni nazw` - przestrzeń nazw, w której znajduje się jednostka, (opcjonalny, domyślnie jego wartość jest nazwę przestrzeni nazw, w której siedzi ten szablon), `nazwa jednostki` - jest to nazwa strony, bez przestrzeni nazw, występującej na polskim serwisie Wikibooks, (opcjonalny, domyślnie jego wartość jest nazwą aktualnej jednostki, w której siedzi ten szablon), `typ jednostki` - używana do nazywania jednostek w dowolnej przestrzeni nazw, gdy jednostkę umieszczono w jakieś z tych przestrzeni nazw, lub przypisano ją do jakieś z tych przestrzeni ustawionej za pomocą zmiennej: `nazwa przestrzeni nazw`, oto wartości tej zmiennej: `strona szablonu` - strona szablonu, jest to przestrzeń nazw Szablon, `strona opisu szablonu` - strona opisu szablonu, jest to przestrzeń nazw Szablon, `strona modułu` - strona modułu, jest to przestrzeń nazw Moduł, `strona opisu modułu` - strona opisu modułu, jest to przestrzeń nazw Moduł, `strona brudnopisu szablonu` - szablon w przestrzeni nazw Szablon w nibyprzestrzeni nazw: Szablon:Brudnopis, `strona brudnopisu opisu szablonu` - opis szablonu w przestrzeni nazw Szablon w nibyprzestrzeni nazw: Szablon:Brudnopis, `strona brudnopisu modułu` - moduł w przestrzeni nazw Moduł w nibyprzestrzeni nazw: Moduł:Brudnopis, `strona brudnopisu opisu modułu` - opis modułu w przestrzeni nazw Moduł w nibyprzestrzeni nazw: Moduł:Brudnopis, (opcjonalny, szablon domyślnie sam ustawia do jakiego typu jednostki, należy jednostka, powyżej wymienionego), `nazwij jednostką` - wartość niepusta, wtedy szablon jednostkę nazywa po prostu `jednostką`, w przeciwnym wypadku szablon nazywa zbiory w zależności do jakiej przestrzeni nazw ona zależy i od rodzaju strony, `bez kategorii` - wartość niepusta, tzn. wtedy szablon nie umieszcza strony w żadnej kategorii, w przeciwnym przypadku umieszcza (opcjonalny). Zmienna: `typ jednostki`, nie jest używana do wyświetlania rodzaju jednostki, gdy zmienna: `nazwij jednostką`, jest niepusta, wtedy ona jest nazywana `jednostką`.

Przykłady użycia błędnego, szablonu

Kategorie błędów tego szablonu.

Gdy nazwa przestrzeni w zmiennej: nazwa przestrzeni nazw, jest nieprawidłowa, a więc działania tego szablonu są równoważne, jeśli napiszemy je ogólnie według przykładu:
- {{Podstrona dokumentacji|nazwa przestrzeni nazw=MojaPrzestrzeń}}.
Szablon umieszcza stronę w kategorii: Szablony informacyjne - nieprawidłowa nazwa przestrzeni nazw.
co da w efekcie:

Szablon {{Podstrona dokumentacji}} zgłosił następujące błędy:

Wartość, nazwy przestrzeni nazw, dla korzystanej jednostki jest nieprawidłowa.

Szablony informacyjne - nieprawidłowa nazwa przestrzeni nazw^[1]

Gdy szablon został wstawiony na stronę w przestrzeni innej, niż obsługiwane przestrzenie nazw, lub ustawiono wartość parametru: nazwa przestrzeni nazw, na inną wartość, niż te, a więc działania tego szablonu są równoważne, jeśli napiszemy je przykładowo:
- {{Podstrona dokumentacji}} - wstawiono szablon do nieobsługiwanej przestrzeni nazw,
- {{Podstrona dokumentacji|nazwa przestrzeni nazw=}} - gdy ustawiono nazwę przestrzeni nazw na wartość inną, niż obsługiwaną przestrzeń nazw, tutaj ustawiono na przestrzeń nazw (główna).
Szablon umieszcza stronę w kategorii: Szablony informacyjne - nieobsługiwana przestrzeń nazw.
co da w efekcie:

Szablon {{Podstrona dokumentacji}} zgłosił następujące błędy:

Szablon wartości, nazwy przestrzeni nazw, dla korzystanej jednostki nie obsługuje.

Szablony informacyjne - nieobsługiwana przestrzeń nazw^[1]

Gdy w szablonie użyto zmiennej: nazwa jednostki, o wartości pustej, a więc działania tego szablonu są równoważne, jeśli napiszemy je przykładowo:
- {{Podstrona dokumentacji|nazwa przestrzeni nazw=Szablon|nazwa jednostki=}} - gdy w szablonie ustawiono na obsługiwaną przestrzeń nazw, tutaj na przestrzeń nazw Szablon,
- {{Podstrona dokumentacji|nazwa jednostki=}} - gdy szablon wstawiono na stronę w obsługiwanej przestrzeni nazw.
Szablon umieszcza stronę w kategorii: Szablony informacyjne - pusta nazwa jednostki.
co da w efekcie:

Szablon {{Podstrona dokumentacji}} zgłosił następujące błędy:

Wartość, nazwy jednostki, dla korzystanej jednostki jest pusta.

Szablony informacyjne - pusta nazwa jednostki^[1]

Gdy w szablonie użyto zmiennej: nazwa jednostki, o wartości nieprawidłowej, a więc działania tego szablonu są równoważne, jeśli napiszemy je przykładowo:
- {{Podstrona dokumentacji|nazwa przestrzeni nazw=Szablon|nazwa jednostki={{{1}}}}} - gdy szablon użyto z parametrem nazwy jednostki zawierającą w sobie wyrażenie między innymi typu: {{{1}}}.
Szablon umieszcza stronę w kategorii: Szablony informacyjne - nieprawidłowa nazwa jednostki.
co da w efekcie:

Szablon {{Podstrona dokumentacji}} zgłosił następujące błędy:

Wartość, nazwy jednostki, dla korzystanej jednostki jest nieprawidłowa.

Szablony informacyjne - nieprawidłowa nazwa jednostki^[1]

Gdy w szablonie użyto zmiennej: typ jednostki, o niewłaściwej wartości oraz jego umieszczono na stronie w dowolnej obsługiwanej przestrzeni nazw, lub nadano wartość zmiennej: nazwa przestrzeni nazw, o nazwie, któreś z tych przestrzeni, a więc działania tego szablonu są równoważne, jeśli napiszemy je przykładowo:
- {{Podstrona dokumentacji|nazwa przestrzeni nazw=Szablon|typ jednostki=jakaś}} - gdy ustawiono przestrzeń nazw Szablon i nieprawidłowy typ jednostki,
- {{Podstrona dokumentacji|typ jednostki=jakaś}} - gdy wstawiono szablon na stronę do przestrzeni nazw Szablon i ustawiono nieprawidłowy typ jednostki.
Szablon umieszcza stronę w kategorii: Szablony informacyjne - nieprawidłowa wartość typu jednostki.
co da w efekcie:

Szablon {{Podstrona dokumentacji}} zgłosił następujące błędy:

Podana wartość zmiennej typ jednostki jest nieprawidłowa.

Szablony informacyjne - nieprawidłowa wartość typu jednostki^[1]

Gdy w szablonie użyto zmiennej: typ jednostki, o wartości niezgodnej z podaną nazwą przestrzeni nazw z parametrów szablonu, jeśli napiszemy je przykładowo:
- {{Podstrona dokumentacji|nazwa przestrzeni nazw=Szablon|typ jednostki=artykuł}} - gdy ustawiono przestrzeń nazw Szablon i niezgdodną z typem jednostki.
Szablon umieszcza stronę w kategorii: Szablony informacyjne - niezgodna wartość typu jednostki.
co da w efekcie:

Szablon {{Podstrona dokumentacji}} zgłosił następujące błędy:

Podana wartość zmiennej typ jednostki jest niezgodna z podaną zmienną: nazwą przestrzeni nazw.

Szablony informacyjne - niezgodna wartość typu jednostki^[1]

Gdy w szablonie użyto zmiennej: typ jednostki, o wartości niezgodnej z podaną nazwą przestrzeni nazw i nazwą jednostki z parametrów szablonu, jeśli napiszemy je przykładowo:
- {{Podstrona dokumentacji|nazwa przestrzeni nazw=Szablon|nazwa jednostki=Strona główna podręcznika|typ jednostki=artykuł}} - gdy ustawiono przestrzeń nazw Szablon i nazwę jednostki niezgdodną z typem jednostki.
Szablon umieszcza stronę w kategorii: Szablony informacyjne - niezgodne parametry pudełkowe.
co da w efekcie:

Szablon {{Podstrona dokumentacji}} zgłosił następujące błędy:

Podana wartość zmiennej typ jednostki jest niezgodna z podanymi parametrami pudełkowymi.

Szablony informacyjne - niezgodne parametry pudełkowe^[1]

Przykład

Przykład w przestrzeni Szablon w przypadku szablonu {{Mapa/opis}}

{{Podstrona dokumentacji}}.

To jest podstrona dokumentacji dla szablonu {{Mapa}}.
Zawiera ona informacje na temat sposobu użycia, kategoryzacji szablonu i inną zawartość niebędącą częścią oryginalnej strony.

Opisy szablonów^[1]

{{Podstrona dokumentacji|[[Strona szablonu]]}}

To jest podstrona dokumentacji dla szablonu {{Strona szablonu}}.
Zawiera ona informacje na temat sposobu użycia, kategoryzacji szablonu i inną zawartość niebędącą częścią oryginalnej strony.

Opisy szablonów^[1]

{{Podstrona dokumentacji|[[Strona szablonu]]|[[Strona dokumentacji]]}}

To jest podstrona dokumentacji dla szablonu {{Strona szablonu}}.
Właściwa strona dokumentacji znajduje się na stronie Strona dokumentacji.
Zawierają one informacje na temat sposobu użycia, kategoryzacji szablonu i inną zawartość niebędącą częścią oryginalnej strony.

Opisy szablonów^[1]

Przykład w przestrzeni Szablon w przypadku szablonu `{{Strona szablonu/opis}}`

{{Podstrona dokumentacji}}.

To jest podstrona dokumentacji dla szablonu {{Strona szablonu}}.
Zawiera ona informacje na temat sposobu użycia, kategoryzacji szablonu i inną zawartość niebędącą częścią oryginalnej strony.

Opisy szablonów - sierotki^[1]
Opisy szablonów^[2]

Przykład w przestrzeni Szablon w przypadku szablonu {{Mapa}}

{{Podstrona dokumentacji}}.

Szablony z opisami^[1]

{{Podstrona dokumentacji|[[Strona szablonu]]}}

Szablony z opisami^[1]

{{Podstrona dokumentacji|[[Strona szablonu]]|[[Strona dokumentacji]]}}

Szablony z opisami^[1]

Przykład w przestrzeni Moduł w przypadku modułu {{#invoke:Mapa/opis}}

{{Podstrona dokumentacji}}

To jest podstrona dokumentacji dla modułu {{#invoke:Mapa}}.
Zawiera ona informacje na temat sposobu użycia, kategoryzacji modułu i inną zawartość niebędącą częścią oryginalnej strony.

Opisy modułów^[1]

{{Podstrona dokumentacji|[[Strona modułu]]}}

To jest podstrona dokumentacji dla modułu {{#invoke:Strona modułu}}.
Zawiera ona informacje na temat sposobu użycia, kategoryzacji modułu i inną zawartość niebędącą częścią oryginalnej strony.

Opisy modułów^[1]

{{Podstrona dokumentacji|[[Strona modułu]]|[[Strona dokumentacji]]}}

To jest podstrona dokumentacji dla modułu {{#invoke:Strona modułu}}.
Właściwa strona dokumentacji znajduje się na stronie Strona dokumentacji.
Zawierają one informacje na temat sposobu użycia, kategoryzacji modułu i inną zawartość niebędącą częścią oryginalnej strony.

Opisy modułów^[1]

Przykład w przestrzeni Moduł w przypadku modułu `{{#invoke:Strona modułu/opis}}`

{{Podstrona dokumentacji}}.

To jest podstrona dokumentacji dla modułu {{#invoke:Strona modułu}}.
Zawiera ona informacje na temat sposobu użycia, kategoryzacji modułu i inną zawartość niebędącą częścią oryginalnej strony.

Opisy modułów - sierotki^[1]
Opisy modułów^[2]

Przykład w przestrzeni Moduł w przypadku modułu {{#invoke:Mapa}}

{{Podstrona dokumentacji}}

Moduły z opisami^[1]

{{Podstrona dokumentacji|[[Strona modułu]]}}

Moduły z opisami^[1]

{{Podstrona dokumentacji|[[Strona modułu]]|[[Strona dokumentacji]]}}

Moduły z opisami^[1]

Błędy

Błędy należy zgłaszać na stronie Wikibooks:Kwestie techniczne.

Zobacz też

Rodzina {{Dokumentacji}}

Szablon:Dokumentacja (edytuj|dyskusja|historia|linkujące|obserwuj|rejestr|CSS|opis)

Szablon:Podstrona dokumentacji (edytuj|dyskusja|historia|linkujące|obserwuj|rejestr|CSS|opis)

Szablon:Podstrona dokumentacji/opis (edytuj|dyskusja|historia|linkujące|obserwuj|rejestr|CSS|opis)

Szablon:Podstrona dokumentacji/brudnopis (edytuj|dyskusja|historia|linkujące|obserwuj|rejestr|CSS|opis)

Szablon:Podstrona dokumentacji/test (edytuj|dyskusja|historia|linkujące|obserwuj|rejestr|CSS|opis)

Powyższy opis jest dołączany ze strony Szablon:Podstrona dokumentacji/opis. (edytuj | historia)
Kategorie należy dodawać do podstrony /opis. Zobacz podstrony tego szablonu.

Źródło: „https://pl.wikibooks.org/w/index.php?title=Szablon:Podstrona_dokumentacji&oldid=481245”