Inside TYPO3

< 3.8.12. Overriding LOCAL_LANG values  Table Of Content 3.9.1. The $TCA_DESCR array >

3.9. Context Sensitive Help (CSH)

TYPO3 offers a full API for adding Context Sensitive Help to especially all database tables and fields. This is normally expressed by small comments and an icon linking to a window with a full explanation of a field - or a feature in a module if you choose to use it in that way.

 


In the example above the context sensitive help appears when "Show field descriptions" is enabled.

Basic facts about Context Sensitive Help

These are some basic facts about how CSH works:

  1. Context Sensitive Help (CSH) labels are stored in locallang files inside of extensions, typically in a main file with English and sub-files with the individual languages.

  2. The CSH locallang files are typically named 'locallang_csh_*.php' or "locallang_csh_*.xml"

  3. They are translated as any other locallang file on typo3.org (for "php" versions) or by the backend module in the extension "llxmltranslate" (for the recommended "xml" version)!

  4. CSH labels can override or add themselves to existing values thus allowing for local, customized help. Very flexible.

To top


Valid XHTML 1.0!