Szablon:Ombox/opis
To jest podstrona dokumentacji dla strony Szablon:Ombox. Zawiera ona informacje na temat użycia tej strony, jej kategoryzację i inną zawartość niebędącą częścią oryginalnej strony. |
Ten szablon jest używany na wielu stronach Aby uniknąć nadmiernego obciążenia serwera wszystkie eksperymenty należy przeprowadzać w swoim brudnopisie. Przetestowane zmiany powinny być dodawane w jednej edycji. |
To jest ombox (other messages box) – szablon szablonów. Jest on używany do tworzenia szablonów informacyjnych i ostrzegawczych. Oferuje on kolorowania tła, obrazki oraz ramki, które pozwalają dopasować go do sytuacji.
Użycie[edytuj kod]
Najprostsze wywołanie szablonu:
{{ombox|tekst = Jakiś tekst, który ma na celu zademonstrowanie działania szablonu}}
Wyświetla on taki komunikat:
Jakiś tekst, który ma na celu zademonstrowanie działania szablonu |
Bardziej złożone wywołanie:
{{ombox | typ = dobry | grafika = tu zaleca się podać szablon ikona w wielkości 35px, np. {{ikona|pt|35}} | tekst = Tekst wiadomości }}
Powoduje ono wyświetlenie następującego komunikatu:
Tekst wiadomości |
Style szablonu[edytuj kod]
Szablon ma 6 przygotowanych stylów głównych, które są przełączane za pomocą parametru typ. Jeśli ten parametr nie został użyty lub została podana inna wartość niż jedna z poniższych, wykorzystywany jest typ „wiadomość”.
typ=poważny Poważne problemy artykułem/szablonem. Powinien być używany do informowania o błędnym wywołaniu jakiegoś szablonu wykorzystującego ombox. |
typ=zawartość Ważne problemy z treścią artykułu/szablon. |
typ=styl Problemy natury stylistycznej z artykułem/szablonem. |
typ=integruj Artykuł musi zostać zintegrowany z innym. Wykorzystywany także do informacji o tłumaczeniu, źródle i wymaganym zintegrowaniu historii edycji. |
typ=wiadomość Typ domyślny, wykorzystywany do informacji. |
typ=ochrona Artykuł został zabezpieczony lub wymaga zabezpieczenia. Może też być wykorzystywany do informacji czysto technicznych. |
Oprócz powyższych 6 stylów, powstały dodatkowe dwa do specjalnych informacji.
typ=polecany WikiFNiN:Polecane artykuły |
typ=cool Typ można wykorzystać do innych wiadomości, na stronie użytkownika lub dyskusji. |
Zamiast stylu możliwe jest ustawienie własnego koloru ramki:
kolor-ramki=ff0000 Do ustawienia własnego koloru obramowania. |
Grafiki[edytuj kod]
Grafiki w szablonie można dostosować za pomocą parametrów grafika i grafika-prawo. Grafika po prawej jest ukryta w wersji mobilnej.
Przykłady:
Brak parametru ”grafika”. W takich wypadkach używany jest obrazek przypisany do stylu. |
Typ „zawartość” i grafika = {{ikona|linkwew|35}} |
Parametr typ = styl i grafika = brak. Nie jest używana żadna grafika, a tekst wypełnia całe pole. |
Typ „zawartość”, grafika = {{ikona|linkwew|35}} i grafika prawo = {{ikona|pompytanie|35}} |
Specjały[edytuj kod]
Szablon ombox posiada dodatkowy parametr ”tło”, za pomocą którego można ustawić kolor tła przypisany do stylu lub kolor tła, który wpasuje się w kolor strony dyskusji. Działa on w typach podstawowych. Przykład:
typ - zawartość i tło – tak |
typ - integruj i tło – dyskusja |
typ - dobry i tło – dyskusja. W tym przypadku opcja „dyskusja” jest traktowana, jakby jej nie podano. |
Ponadto, szablon ombox ma specjalne efekty obramowania. Przykład:
typ - poważny i ramka – gruba. Przydatny przy poważnych problemach |
typ - styl i ramka – ambox. |
typ - polecane i ramka – podkreśl. |
Zwijanie tekstu[edytuj kod]
Parametr zwinięte pozwala tekst. Uwaga: w przypadku grafiki po prawej stronie (parametr grafika prawo) opcja zwijania pojawi się obok niej (po lewej)
zwinięte=tak |
zwinięte=nie |
zwinięte=brak |
Opis parametrów[edytuj kod]
Szablon wykorzystywany do projektowania innych szablonów
Parametr | Opis | Typ | Status | |
---|---|---|---|---|
Długość ramki | long | Decyduje o tym, czy szablon ma mieć długość strony czy też zajmować tyle miejsca, co ambox ("nie") czy całą szerokość strony ("tak")
| Ciąg znaków | opcjonalny |
Ramka | ramka | Obramowanie szablonu. Wartości: brak, ambox, podkreśl, gruba, bardzo gruba. Domyślnie cienka ramka.
| Ciąg znaków | sugerowany |
Typ (predefiniowany styl) | typ | Rodzaj komunikatu. Wartości: poważny, zawartość, styl, integruj, ochrona, polecany, tylko, cool, ameliaikuba, wiadomość.
| Ciąg znaków | sugerowany |
Kolor ramki | kolor-ramki | Kolor ramki akceptowany przez HTML, bez znaku #. Nie należy mieszać z ustawieniem 'typ'
| Ciąg znaków | opcjonalny |
Typ (kolor) tła | tło | Określa kolor tła. Wartości: tak, dyskusja, brak, domyślne.
| Ciąg znaków | opcjonalny |
Grafika | grafika | Grafika z lewej strony. Wartości: odpowiednia grafika, "brak" (usuwa grafikę)
| Niezbalansowany wikitekst | sugerowany |
Zwinięcie tekstu | zwinięte | Pozwala zwijać tekst. Uwaga: w przypadku grafiki po prawej stronie (parametr 'grafika prawo') opcja zwijania pojawi się obok niej (po lewej). Wartości: tak, nie, brak
| Ciąg znaków | opcjonalny |
Treść | treść tekst 1 | Treść wyświetlana w szablonie
| Niezbalansowany wikitekst | wymagany |
Grafika po prawej | grafika prawo | Grafika, która ma się pojawić po prawej stronie komunikatu. Niewidoczna w wersji mobilnej wiki
| Niezbalansowany wikitekst | opcjonalny |
Id obiektu | id | Id ustawiane dla obiektu HTML
| Ciąg znaków | opcjonalny |