EXT: MR-Quote (Zitat Erweiterung) Version 0.0.1 Stand: 30.05.09
Bei der Typo3 Extension "MR-Quote" handelt es sich um eine Eigenentwicklung für die Darstellung von Zitaten mit Bild und Link auf der Webseite. Die Zitate können in einem Systemordner abgelegt werden. Zur Anzeige wird jeweils ein zufälliges Zitat aus den gewählten Daten dargestellt. Durch die Kontrolle des Cache Zeitraums einer einzelnen Webseite kann man auch die Wechselgeschwindigkeit des Zitates beeinflussen.
Das Plugin entstand am 27.09.08 und die erste funktionsfähige Version hat erstaunlicherweise gerade mal einen halben Tag gedauert (inklusive Einlesen in die Typo3 Extension Programmierung).
Ich möchte an dieser Stelle eine Art Dokumentation und die ein oder andere Hilfestellung in Form von Code Snippets bereitstellen.
Es existiert an dieser Stelle absichtlich keine Frage-/Antwort-Möglichkeit. Dafür ist das Formular ganz unten gedacht.
Eins noch: der Link zur TER Seite für dieses Plugin
Update 29.09.08:
Option für das Ausschalten der Indizierung (indexed_search) des Zitates hinzugefügt.
Update 01.10.08:
Extension Icons hinzugefügt und meinen Nachnamen fürs TER umgeschrieben.
Update 30.05.09:
Aus dem umschließenden DIV Container wurde ein BLOCKQUOTE gemacht. Gleichzeitig wurde dieser in eine "wrap" Option für das TypoScript Setup umgewandelt und standardmäßig eingebunden.
Weiterhin kamen noch ein paar xHTML und CSS Verbesserungen dazu.
TypoScript für das Root Template
Immer gern genommen sind fertige TypoScript Snippets für die einfache Konfiguration eines Plugins. Deshalb habe ich mir an dieser Stelle etwas Mühe gegeben. Für das allererste Plugin finde ich es schon ganz ansehnlich, oder?! ;-)
plugin.tx_mrquote_pi1 {
# disable or enable features
showQuote = 1
showImage = 1
showAuthor = 1
showAuthorAddon = 1
showAuthorDates = 1
wrap = <blockquote class="tx-mrquote-pi1">|</blockquote>
# insert links (@ image and author name)
setLinks = 1
# inserts an '<br/>' before the authors year dates
breakBeforeDates = 1
# specify the template file
templateFile = EXT:mr_quote/template.html
# disable the standard css definitions (in case you'll use your own)
#_CSS_DEFAULT_STYLE =
}
Einfach in das Setup Feld des ROOT Templates kopieren und nach eigenen Wünschen anpassen. An anderer Stelle habe ich auch noch eine Template Datei zum runterladen verknüpft. Diese dann am besten irgendwo ins fileadmin Verzeichnis kopieren (z.B. "fileadmin/templates/mr-quote")
Typo3 Buch Tips
TS: "templateFile"
Mit diesem Parameter kann eine eigene HTML Vorlage angegeben werden.
Diese eigene Datei sollte sich an der Ursprungs "template.html" Datei orientieren. Zu finden ist diese im Plugin Verzeichnis von MR-Quote.
Standardmäßig wird auch auf diese Originaldatei verwiesen. Um eine eigene Datei einzubinden einfach folgenden Code (angepasst an die eigenen Ordner) angeben:
# specify my own template file
templateFile = fileadmin/templates/mr-quote/template.html
In dieser Datei gibt es eine kleine, überschaubare und gut dokumentierte Anzahl an sogenannten Containern (Abschnitte) und Markern (Platzhalter).
Wünsche, Fehlermeldungen, Danksagungen?
Wichtig!
MR-Quote beinhaltet eine statische Template Datei, welche im Root Template (an der gleichen Stelle wie CSS Styled Content) mit eingebunden werden muss.
TS: "wrap"
Dies ist für die Kapselung der Zitatinhalte vorgesehen. Es wird standardmäßig mit einem "blockquote" Element, der korrekten HTML Auszeichnung für Zitate, umgeben. Die CSS Klasse wird bereits schon an dieser Stelle vergeben. Man kann dies nach eigenen Wünschen abändern und sogar eine ID vergeben, wenn man mag.
TS: "showImage"
Hiermit kann die Bilddarstellung für alle Zitate ein- und ausgeschaltet werden.
Einfach mit dem Wert 1 oder 0 ausstatten.
TS: "showAuthor"
Steht dieser Wert auf 0 wird der gesamte Autor Bereich inklusive der zusätzlichen Informationen und Jahresangaben ausgeblendet. Der Standard ist 1.
TS: "showAuthorAddon"
Dieser Parameter steuert die Anzeige der zusätzlichen Autor Informationen. Bei dem Wert 1 werden diese angezeigt - bei 0 nicht.
Dieser Wert wird ignoriert, wenn die Anzeige der Autor Daten generell deaktiviert ist.
TS: "showAuthorDates"
Hiermit wird die Anzeige der Jahresangaben zum Autor gesteuert (an = 1 / aus = 0).
Sollte die generelle Anzeige des Autors deaktiviert sein, so wird dieser Wert ignoriert.
Mit dem zusätzlichen Parameter "breakBeforeDates" kann bei einem Wert von 1 vor den Jahresangaben ein HTML Umbruch (<br/>) gesetzt werden.
TS: "showQuote"
Dieser Parameter steuert die Anzeige des Zitattextes.
Einfach auf 1 stellen und man sieht den Text. Bei 0 nicht.
Ich habe ihn eigentlich nur zur Vollständigkeit mit hinzugefügt, denn ich kann mir ehrlich gesagt gerade garnicht vorstellen, warum jemand ausgerechnet die Anzeige des Zitats selber ausschalten wollte?!
Aber was solls - damit gehts.
TS: "setLinks"
Diese Option kann die Generierung von Links um das Bild und den Autornamen deaktivieren, wenn sie auf 0 gesetzt wird. Standardmäßig ist er aktiviert, also auf 1 gestellt.
ToDo Liste
- Optionaler Ausschluss aus der Such-Indizierung [erledigt]
- Erstellung eines Icons [erledigt]
- Bereitstellen im Typo3 Extension Repository (TER) [erledigt]
- Steuerung der Anzahl der ausgegebenen Zitate
- Einführung von Kategorien oder Schlagwörtern
- semantisch korrekte Auszeichnung des Zitates [erledigt]


