TypoScript Syntax

1.3.5. Syntax highlighting and debugging

Syntax highlighting of TypoScript code is done by various analysis applications in TYPO3 like the Template Analyzer for TypoScript Templates or the User Admin module or Page TSconfig function in the Info module. These typically allows you to view the TypoScript in each context highlighted with syntax.

Here is an example from Page TSconfig:

 

 

In the extension "extdeveval" you will also find a tool, "Code highlighting", which can analyse TypoScript code adhoc:

 

There are various modes of display:

 

 

The analytic mode (displayed above) colors all parts of the syntax:

1. Object and property names gets light blue background (#1)

2. Values get a yellow background (#2)

3. Whitespace becomes olive green in the background (#3)

4. Operators are colored with a brown background

 

Another mode is the "Block mode", which simply indents the TypoScript code:

 

 

Finally you will be warned if syntax errors are found and ignored data will also be highlighted in green:

 

Debugging

Debugging TypoScript for syntax errors can be done with this tool and any other place where the syntax highlighter is used. But this will only tell you if something is syntactically wrong with the code - whether you combine objects and properties semantically correctly depends on the context and cannot be told by the TypoScript parser itself.

Currently no tools exist to do semantically checking for either TypoScript Templates, Page TSconfig or User TSconfig (writing summer 2003)

 

 

(This tool for syntax highlighting is available from TYPO3 version 3.6.0)