28. September 2011

Hilfetexte in Extension einbinden – Context Sensitive Help (CSH)

in Extension, myExt, Programming, Tutorial, TYPO3

Um Redakteuren das Leben mit TYPO3 zu vereinfachen bietet es sich an, in selbst entwickelten Extentions Hilfetexte zu den Eingabefeldern zu verfassen. Die Feldbezeichnung selbst, sollte schon Aussagekräftig genug sein, allerdings kann man an dieser Stelle nicht immer ausreichend Informationen hinerlassen.

Um Context Sensitive Help nun aktivieren zu können, sind 2 Schritte nötig.

  1. Es muss eine entsprechende Datei mit den Hilfetexten erstellen werden
  2. Die Datei ext_tables.php der Extension muss modifiziert bzw. erweitert werden

Im Root-Verzeichnis der Extension erstellt man sich eine XML-Datei oder kopiert sich die locallang.xml und benennt diese in „locallang_csh_ExtensionKey_DBTabelle.xml“ um. In diese XML-Datei werden wie gewohnt die verschiedenen Übersetzungen der Sprachen angelegt. Lediglich die META-Angabe unterscheidet sich und sollte in etwa wie folgt aussehen:

<meta type="array">
	<description>CSH for your own table.</description>
	<type>CSH</type>
	<csh_table>tx_meineExtension_DBTabelle</csh_table>
</meta>

Der Index der Label-Tags setzt sich aus dem Tabellenfeld und „.description“ zusammen, z.B.

<label index="subtitle.description">Eine Beschreibung für das Beschreibungsfeld.</label>

Im zweiten Schritt muss die XML-Datei TYPO3 bekannt gemacht werden und dies erfolgt in der Datei ext_tables.php (ebenfalls im Root-Verzeichnis der Extension). Hier wird nun die folgende Zeile (bei mir am Ende der Datei) eingefügt:

t3lib_extMgm::addLLrefForTCAdescr(
  'tx_meineExtension_DBTabelle',
  'EXT:ExtensionKey/locallang_csh_ExtensionKey_DBTabelle.xml'
);

Danach werden die Hilfetexte beim überfahren der Feldbeschriftung mit der Maus nachgeladen. Ich persönlich finde es nicht gerade praktisch, dass es keinen Hinweis in Form eines Icons mehr gibt. Dadurch muss man immer Raten hinter welcher Feldbezeichnung vll. auch eine Beschreibung verborgen ist.

Die genannten 2 Schritte kann man nun für weitere DB-Tabellen wiederholen und somit für jedes Eingabefeld eine entsprechende Beschreibung einbinden.

P.S.: Wer bereits mit Extbase programmiert, muss sich darum nicht mehr kümmern, sofern mit dem Extension Builder gearbeitet wird. Dieser erstellt die CSH-Dateien bereits beim anlegen der Extension unter /Resources/Private/Language/. Insofern braucht man nur noch die Beschreibungstexte tippen und hineinkopieren.

8 Reaktionen zu “Hilfetexte in Extension einbinden – Context Sensitive Help (CSH)”

Kommentare abonnieren (RSS) oder TrackBack URL

Danke für diesen Beitrag! Stimmt es das sich mit 4-6 da auch etwas verändert? Oder bleibt im Bereich CSH alles gleich?

Josef Florian Glatz am 03. Oktober 2011 um 08:15

da bleibt alles beim alten. einziger unterschied zu 4-5 bzgl Übersetzungen: Das ganze wird nun gecached

Georg Ringer am 05. Oktober 2011 um 13:39

Danke Georg für die Info. Da ich die 4-6 noch nicht getestet habe, kann ich dazu leider noch nichts sagen.

Christian Wolfram am 06. Oktober 2011 um 23:34

Ebenso kann man hinzufügen das man nicht nur das „.description“ erstellen kann, sondern auch „.details“

Josef Florian Glatz am 10. November 2011 um 19:29

Danke für die Erweiterung Josef. Habe es eben getestet und es bieten sich dadurch gleich weitere Möglichkeiten für die Beschreibung.

Hat jemand noch eine Idee, wie man das Hilfesymbol wieder vor den Feldnamen bekommt? Habe es selbst in der element_csh.css hinbekommen, aber diese Lösung gefällt mir nicht ganz.

Christian Wolfram am 10. November 2011 um 20:01

ich habe meine erste Extension mit dem Extensionbuilder erstellt. Kann mir jemand genau erklären, wo ich diese Beschreibungstexte hineinkopieren soll. Denn Extbase hat keine xml-dateien automatisch erstellt.

Elizabeth am 13. Juni 2013 um 15:34

Hi, gibts da auch ne Möglichkeit das für Felxformfelder zu realisieren.
Anwendungsfall: Extension, die tt_content mit Hilfe von FlexForms erweitert. Dabei entstehen Felder im BE für eine Beschreibung notwendig wäre.
Jemand ne Idee?

ToBe am 11. Februar 2015 um 09:32

Ich finde da jede Menge Snippets in Google: „flexforms csh“
Bringen die dich vielleicht zum Ziel?

Jousch am 11. Februar 2015 um 10:57

Kategorien

Archiv