Inhaltsverzeichnis Element (bit3/contao-toc-element): Unterschied zwischen den Versionen

Aus Contao Community Documentation

(Beschreibung)
Zeile 18: Zeile 18:
 
Inhaltsverzeichnisse sind bei längeren Texten oft vorteilhaft. Wikipedia setzt diese bspw. sehr häufig ein.
 
Inhaltsverzeichnisse sind bei längeren Texten oft vorteilhaft. Wikipedia setzt diese bspw. sehr häufig ein.
  
[[Datei:toc-element-wikipedia.png|miniatur|Wikipedia Beispiel]]
+
[[Datei:TOC Element - Wikipedia Beispiel.png|miniatur|Wikipedia Beispiel]]
  
 
Dieses Element erzeugt ebenfalls ein Inhaltsverzeichnis, basierend auf den Inhaltselementen und Artikeln.
 
Dieses Element erzeugt ebenfalls ein Inhaltsverzeichnis, basierend auf den Inhaltselementen und Artikeln.
 +
 +
== Anleitung ==
 +
 +
Das Inhaltsverzeichnis wird auf Basis der Inhaltselemente erzeugt, die sowohl eine '''Überschrift''', als auch eine '''CSS-ID''' besitzen.
 +
 +
[[Datei:TOC Element - Element bearbeiten.png|miniatur|Element bearbeiten]]
 +
[[Datei:TOC Element - Überschrift und CSS-ID vergeben.png|miniatur|Überschrift und CSS-ID vergeben]]
 +
 +
Hat man allen Elementen die im Inhaltsverzeichnis aufgelistet werden sollen eine '''Überschrift''' und '''CSS-ID''' vergeben, kann man jetzt das Inhaltsverzeichnis anlegen.
 +
 +
[[Datei:TOC Element - Element hinzufügen.png|miniatur|Element hinzufügen]]
 +
[[Datei:TOC Element - Element-Typ auswählen.png|miniatur|Element-Typ auswählen]]
 +
[[Datei:TOC Element - Element konfigurieren.png|miniatur|Element konfigurieren]]
 +
 +
Es wird sofort aus den Inhaltselementen ein Inhaltsverzeichnis erzeugt. Dabei ist die hierarchische Struktur h1-h6 ausschlaggebend für die Verschachtelung.
 +
 +
{{Hinweis|Eine unvollständige Hierarchie wird automatisch reduziert. Fehlt bspw. zwischen der h1 und h3 die h2 Ebene, wird die h3 Ebene "nach oben" geschoben.}}
 +
 +
Wenn gewünscht, können sogar die Artikel in die Struktur eingezogen werden.
 +
 +
[[Datei:TOC Element - Artikel einbeziehen.png|miniatur|Artikel einbeziehen]]
 +
 +
Außerdem kann bestimmt werden, bis zu welcher Ebene das Inhaltsverzeichnis überhaupt dargestellt werden soll. Dabei ist zu beachten dass die erzeugte Strukturtiefe und nicht die über h1-h6 definierte Strukturtiefe ausschlaggebend ist.
 +
 +
Außerdem gibt es Unterschiede im Verhalten zwischen '''Minimale Ebene''' und '''Maximale Ebene'''. Während die Begrenzung der '''Maximalen Ebene''' tatsächlich die Elemente abschnidet, wird bei '''Minimale Ebene''' lediglich die Verknüpfungen ausgeblendet, die Navigationsebene <code>&lt;ul&gt;</code> bleibt aber erhalten, was viel mehr Möglichkeiten für die Gestaltung lässt.
 +
 +
[[Datei:TOC Element - 1. Ebene ausblenden.png|miniatur|1. Ebene ausblenden]]
 +
 +
Mit nur wenig (S)CSS Code, lässt sich diese "leere" Ebene aber auch sehr einfach "ausblenden".
 +
 +
<source lang="css">
 +
.ce_table-of-contents {
 +
li {
 +
list-style-type: decimal;
 +
 +
&.hide-link {
 +
list-style-type: none;
 +
 +
> ul {
 +
padding-left: 0;
 +
}
 +
}
 +
}
 +
}
 +
</source>
 +
 +
[[Datei:TOC Element - Formatiert.png|miniatur|Formatiert]]

Version vom 9. Juni 2014, 12:31 Uhr


Inhaltsverzeichnis über die Inhalte einer oder mehrerer Artikel.


Hinweis.png Hinweis: Diese Erweiterung ist der offizielle Nachfolger von der ce_navigation Erweiterung.


Erweiterungs-Übersicht
Name des Entwicklers Tristan Lins
Entwickler Webseite http://bit3.de
Link zum Extension Repository https://packagist.org/packages/bit3/contao-toc-element
Link zum Tracker https://github.com/bit3/contao-toc-element


Beschreibung

Inhaltsverzeichnisse sind bei längeren Texten oft vorteilhaft. Wikipedia setzt diese bspw. sehr häufig ein.

Wikipedia Beispiel

Dieses Element erzeugt ebenfalls ein Inhaltsverzeichnis, basierend auf den Inhaltselementen und Artikeln.

Anleitung

Das Inhaltsverzeichnis wird auf Basis der Inhaltselemente erzeugt, die sowohl eine Überschrift, als auch eine CSS-ID besitzen.

Element bearbeiten
Überschrift und CSS-ID vergeben

Hat man allen Elementen die im Inhaltsverzeichnis aufgelistet werden sollen eine Überschrift und CSS-ID vergeben, kann man jetzt das Inhaltsverzeichnis anlegen.

Element hinzufügen
Element-Typ auswählen
Element konfigurieren

Es wird sofort aus den Inhaltselementen ein Inhaltsverzeichnis erzeugt. Dabei ist die hierarchische Struktur h1-h6 ausschlaggebend für die Verschachtelung.


Hinweis.png Hinweis: Eine unvollständige Hierarchie wird automatisch reduziert. Fehlt bspw. zwischen der h1 und h3 die h2 Ebene, wird die h3 Ebene "nach oben" geschoben.


Wenn gewünscht, können sogar die Artikel in die Struktur eingezogen werden.

Artikel einbeziehen

Außerdem kann bestimmt werden, bis zu welcher Ebene das Inhaltsverzeichnis überhaupt dargestellt werden soll. Dabei ist zu beachten dass die erzeugte Strukturtiefe und nicht die über h1-h6 definierte Strukturtiefe ausschlaggebend ist.

Außerdem gibt es Unterschiede im Verhalten zwischen Minimale Ebene und Maximale Ebene. Während die Begrenzung der Maximalen Ebene tatsächlich die Elemente abschnidet, wird bei Minimale Ebene lediglich die Verknüpfungen ausgeblendet, die Navigationsebene <ul> bleibt aber erhalten, was viel mehr Möglichkeiten für die Gestaltung lässt.

1. Ebene ausblenden

Mit nur wenig (S)CSS Code, lässt sich diese "leere" Ebene aber auch sehr einfach "ausblenden".

.ce_table-of-contents {
	li {
		list-style-type: decimal;
 
		&.hide-link {
			list-style-type: none;
 
			> ul {
				padding-left: 0;
			}
		}
	}
}
Formatiert
Ansichten
Meine Werkzeuge

Contao Community Documentation

Fork die Wand an!

Tristan Lins
Navigation
Verstehen
Verwenden
Entwickeln
Verschiedenes
Werkzeuge