Jdoc-Anweisungen

From Joomla! Documentation

This page is a translated version of the page Jdoc statements and the translation is 100% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎فارسی • ‎français • ‎Bahasa Indonesia • ‎Nederlands • ‎русский • ‎中文(台灣)‎

Jdoc-Anweisungen sind in jedem Joomla-Template enthalten und geben an, wo die Ausgabe von anderen Teilen von Joomla oder Erweiterungen in der gesamten Webseite positioniert werden soll. Ein typisches jdoc-Statement sieht so aus: <jdoc:include type="component" />

jdoc:include

Die Anweisung <jdoc:include /> ist eine Template-Methode zur Anzeige von Inhalten, die spezifisch für die betrachtete Seite sind. Es gibt verschiedene <jdoc:include />-Anweisungen, die jeweils einen anderen Teil einer Joomla! Seite zurückgeben. Der Austausch selbst erfolgt über JDocumentHTML::_renderTemplate. Siehe auch _parseTemplate.

Das Typ-Attribut

Das Attribut type gibt die Art des zu rendernden Inhalts anstelle des Elements <jdoc:include /> an. Beispielsweise enthält die Anweisung <jdoc:include type="head" /> das type-Attribut head (type="head"). (Hinweis: Jdoc-Ausdrücke erfordern doppelte Anführungszeichen um die Attribute und funktionieren nicht mit einfachen Anführungszeichen. Das Leerzeichen vor dem abschließenden /> ist ebenfalls obligatorisch.)

Komponente

<jdoc:include type="component" />

Dieses Element sollte nur einmal im <body>-Element des Templates erscheinen, um den Hauptinhalt für die aktuelle Seite darzustellen.

Head

<jdoc:include type="head" />

Dieses Element sollte nur einmal im <head>-Element des Templates erscheinen, um den Inhalt der CSS-, Skript- und Metaelemente der aktuellen Seite darzustellen.

Installation

<jdoc:include type="installation" />

Dieses Element wird nur innerhalb der Joomla! Installer-Vorlage für Joomla Joomla 2.5 und darunter verwendet und ist in einem Frontend oder Backend-Template nicht besonders nützlich. Es ist in etwa gleichbedeutend mit dem Typ "Komponente" und gibt den Hauptinhalt eines Installationsschrittes wieder.

Message

<jdoc:include type="message" />

Dieses Element sollte nur einmal im <body> Element der Vorlage erscheinen, um System- und Fehlermeldungen, die während der Anfrage aufgetreten sind, darzustellen.

CSS-Stile für Systemnachrichten sind hier zu finden: templates\system\css\system.css

Module

<jdoc:include type="module" name="breadcrumbs" title="Breadcrumbs" />
<jdoc:include type="module" name="mainmenu" title="Main Menu" />

Dieses Element rendert ein einzelnes Modul, das durch die Attribute name und title gegeben ist: name sollte mit dem Modultyp übereinstimmen (mod_breadcrumbs und mod_menu in den obigen Beispielen), während title der Modulname des gewünschten Moduls sein sollte. Das betreffende Modul muss für den aktuellen Benutzer veröffentlicht und zugänglich sein, um sichtbar zu werden. Zusätzliche Attribute können bereitgestellt werden, um das Layout und das Aussehen des Moduls zu steuern, falls unterstützt.

Modules

Module werden auf einer Seite mit einem der folgenden Code-Beispiele gerendert. Die Module werden in verschiedene Bereiche einer Vorlage unterteilt, indem die Vorlagenpositionen in der Datei jdoc:include's name="[template position name]" attribute, festgelegt werden. Mit dem Attribut jdoc:include's name="[template position name]"" können die verschiedenen Module an ihren jeweiligen Positionen aufgerufen, gerendert und separat gestaltet werden. Zusätzliche Attribute können bereitgestellt werden, um das Layout und das Aussehen von Modulen zu steuern, falls unterstützt.

Nachfolgend finden Sie einige Beispiele für Modulanweisungen mit Modulpositionen, die von Joomla! Template-Entwicklern häufig verwendet werden.

<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" />

Hinweis: Die Position des name="user3" Moduls wird normalerweise (standardmäßig) für das Top-Menü verwendet.

Das Style-Attribut

Das optionale Attribut style="" ist für die Typen module und module von <jdoc:include /> Anweisungen verfügbar. Der Attributwert bezieht sich auf den Stil chrome, mit dem die vom Modul generierte Ausgabe "umhüllt" wird. Wenn kein Stil angegeben wird, wird standardmäßig der Wert "none" verwendet.

Template-Designer können zusätzliche Chrome-Namen hinzufügen, wie in Applying custom module chrome beschrieben.

Siehe auch