Extension Konstanten im Template Editor

Irgendwann reichts - das, was der Extension Builder in die setup und constants schreibt ist ja eine zeitlang ganz nett anzusehen, aber spätestens wenn ich die Konstanten im Template Editor einstellen will, bekomme ich regelmäßig das Gruseln ... Klare Bezeichnungen, eine individuelle Struktur - fehlanzeige. So hab ich mal die Doku durchwühlt und siehe da, es geht doch ...

Konstanten für TYPO3 Extension sollten bis auf wenige Ausnahmen über den Konstanten Editor im Template Bereich editiert werden können. Damit können elegant die direkten TypoScript Bandwurm-Einträge wie plugin.myExtension_pi1.template.fieldWarp = blabla für die Extension im Setup entfallen, zumal diese Funktionen erst in der Dokumentation ersichtlich werden.

Dies geht ja über die Setup und Constant Datei in der Extension auch relativ einfach. Will man die labels und Eingabefelder im Konstanten Editor gezielt beeinfllussen, muss man zunächst die Zusammenhänge verstehen:

Category Auswahl, Feld A

Im Selectfeld des Constant Editors in den TYPO3 Template Tools steht nach Einbindung der CSS Styled Content die Auswahlmöglichkeiten CONTENT und ADVANCED zur Verfügung.

Unsere Extension ergänzt die Auswahl normalerweise mit Einträgen wie "PLUGIN. TX_MYEXTENSION" oder "MODUL.TX_MYEXTENSION. Wurde ein Frontend Plugin und ein Backendmodul angelegt, werde womöglich hier beide Einträge angezeigt.

Ja nachdem wie unsere Extension benannt ist, stehen hier also nichtssagende Extensionskeys. Mit dem ersten Eintrag hinter #cat= können wir diese Bezeichnung frei festlegen. Doch Vorsicht, gerade wenn die Extension frei verfügbar ist, sollte der Name eindeutig und klar der Extension zuordbar sein. Einige Namen werden vom System genutzt und sollten nur mit bedacht ergänzt werden:

- basic
- menu
- content
- page
- advanced
- all

Die Konstanten Kategorien, Feld B

Hiermit können die Konstanten sinnvoll gruppiert werden. Diesen Kategorieübersichriften sind nicht ganz so felxibel. Es gibt eine Hand voll standard Werte, siehe nachstehende Liste, diese kann aber bei Bedarf per TypoScript ergänzt werden.

Dazu reicht ein Eintrag analog der 2. Zeile im Constant Listing.
#customsubcategory = myVariable = myKategorieName
Die Variable wird dann hinter Feld A gesetzt, im Konstanten Editor erschein der zugeordnete Text. Dieser kann durchaus aus dem Language File kommen, z.B. LLL:EXT:myExtension/Resources/Private/Language/locallang.xml:constantsubkat1. Zu beachten ist - wie im Listing - das die Zeile mit '#' auskommentiert sein muss.

TYPO3 bringt folgende Kategorieüberschriften mit, die nicht extra deklariert werden müssen:

- enable
- dims
- file
- typo
- color
- links
- language
- others

Feldlabel und weitere Beschreibung, Feld C

Eine der wichtigsten Felder und leider am wenigsten benutzten. Ein Doppelpunk wirkt hier Wunder, dieser teilt nämlich die Überschrift von der darunter stehenden Textzeile.

label = Überschrift : weitere Beschreibungszeile

Wer es mehrsprachig braucht, auch hier können LLL Daten herangezogen werden.

Variabel Format und standard Wert, Feld D

Mit type = ... legen wir das zulässige Eingabeformat fest. Hier ist überraschender weise eine Vielzahl definiert. Hinter unserer eigentlichen Variable die wir im Setup aufrufen (pink Unterstrichen) können wir einen Standardwert definieren.

Die möglichen type Angaben:
- string
- int: Ganzzahlen, auch negative
- int+: Ganzzahlen, nur positive Werte erlaubt
- offset: x und y Offset Werte, z.B. 20, 30
- color: Hexadezimalwert für Farben ffffff
- wrap: <p>|</p>
- options: dropdown, die Options werden in eckigen Klammern definiert,
   zum Beispiel label= options[blau, grün, gelb]
- boolean: checkbox
- file, zulässige Formate in Klammern, z.B. file[jpg, gif{
- small: ein kurzes string Feld

So, ziemlich viel Text für ein paar Konstanten ;) Aber gerade bei größeren Extensions lohnt sich hier etwas Zeit zu investieren. Schließlich ist das die Stelle mit dem der Extensionnutzer als erstes in Kontakt kommt ...

Empfehlenswerte Lektüre:

TURN AROUND

... wenn Projekte kopfstehen und klassisches Projektmanagement versagt. Projekte laufen aus der Spur oder scheitern völlig, das ist grade bei Programmentwicklungen in Zusammenarbeit mit noch so großen Agenturen leider die Realität. Wie sagte schon Churchill: "If you are going through hell, keep going." Dises Buch liefert einen erfrischen anderen Ansatz und ändert die Geisteshaltung.

Weitere Artikel zu diesem Thema:

Kommentare

keine Kommentare vorhanden


Kommentar verfassen

Die Email Adresse wird nicht veröffentlicht.