--=REKLAMA=--

Instrukcje jdoc

Z Joomla!WikiPL

Wersja Zwiastun (dyskusja | edycje) z dnia 10:55, 21 wrz 2013

(różn.) ← poprzednia wersja | przejdź do aktualnej wersji (różn.) | następna wersja → (różn.)
jdoc 
w kodzie szablonów Joomla! instrukcja sterująca umieszczeniem w dokumencie www generowanych dynamicznie treści witryny - treści głównej (komponentu) oraz treści towarzyszących (modułów). Prosta instrukcja jdoc wygląda jak ten kod: <jdoc:include type="component" />.

jdoc:include

Instrukcja <jdoc:include /> jest w szablonie Joomla! metodą wywołującą w miejscach, w których zostały umieszczone, treść generowaną przez Joomla! albo jego rozszerzenia. Są różne zmienne instrukcji <jdoc:include />, każda zwraca różne części strony Joomla!.

Typy atrybutów

Atrybut type określa rodzaj zawartości wyświetlanej w miejscu użycia instrukcji <jdoc:include type="rodzaj" />. Na przykład <jdoc:include type="head" />.
Uwaga: rodzaj atrybutu należy umieszczać w cudzysłowie, nie między apostrofami.

Head

<jdoc:include type="head" />

Ten element również może być zastosowany tylko jeden raz, aby przetworzyć treści nagłówka zawierające style, skrypty i metadane związane z aktualną stroną.

Installation

<jdoc:include type="installation" />

Ten element stosowany jest jedynie wewnątrz szablonu instalatora Joomla! i nie odgrywa żadnej szczególnej roli ani w szablonach witryny, ani w szablonach zaplecza. Jest w pewnym sensie równoważny typowi "component", przetwarzając treść główną etapu (kroku) instalacji.

Message

<jdoc:include type="message" />

Ten element również może być użyty jeden raz wewnątrz elementu <body> do przetwarzania komunikatów systemowych i komunikatów o błędach, które wystąpiły podczas wykonywania żądań.

Style CSS dla komunikatów systemowych znajdziesz w pliku templates\system\css\system.css.

Module

<jdoc:include type="module" name="breadcrumbs" />
<jdoc:include type="module" name="menu" />
<jdoc:include type="module" name="submenu" style="rounded" id="submenu-box" />

Ten element umieszcza na stronie pojedynczy moduł określony przez atrybut name. Moduł musi być opublikowany i dostępny dla użytkownika odwiedzającego aktualnie stronę. Argumenty instrukcji mogą precyzować dodatkowe właściwości modułu, by kontrolować szablon i wygląd modułu, jeśli są obsługiwane przez CSS szablonu.

Modules

Do przetwarzania modułów na stronie korzystamy z kodu z poniższych przykładów. Moduły są przydzielane do różnych obszarów strony, określonych przez pozycje modułów w pliku templatedetails.xml. Używając instrukcji jdoc:include z atrybutem name="[nazwa pozycji w szablonie]", różne moduły w poszczególnych pozycjach mogą być wywoływane, przetwarzane i oddzielnie stylizowane. Dodatkowe atrybuty mogą być dodane, aby kontrolować szablon i wygląd modułu, jeśli są obsługiwane przez CSS szablonu.

Poniżej znajdują się przykładowe instrukcje z typowymi pozycjami modułów stosowanymi przez projektantów:

<jdoc:include type="modules" name="debug" />
<jdoc:include type="modules" name="icon" />
<jdoc:include type="modules" name="left" style="rounded" />
<jdoc:include type="modules" name="left" style="xhtml" />
<jdoc:include type="modules" name="right" style="xhtml" />
<jdoc:include type="modules" name="status"  />
<jdoc:include type="modules" name="syndicate" />
<jdoc:include type="modules" name="title" />
<jdoc:include type="modules" name="toolbar" />
<jdoc:include type="modules" name="top" />
<jdoc:include type="modules" name="top" style="xhtml" />
<jdoc:include type="modules" name="user1" style="xhtml" />
<jdoc:include type="modules" name="user2" style="xhtml" />
<jdoc:include type="modules" name="user3" />
<jdoc:include type="modules" name="user4" />

Uwaga: Pozycja modułu name="user3" jest wykorzystywana zwykle (domyślnie) na prezentację górnego menu. (Przeczytaj też Pozycje modułów.)

Atrybuty stylów

W przypadku obu typów instrukcji <jdoc:include />: module oraz modules dostępny jest nieobowiązkowy atrybut style="", który określa szablon ramki generowanej przez moduł. Jeśli nie jest określony żaden styl, domyślnie zostanie użyta wartość "none"

Projektanci szablonu mogą dodawać nazwy własnych ramek, jak opisano w artykule Własna ramka modułu.

Dziękujemy za wkład

» Stefan Wajda [zwiastun],