Skip to content

Commit

Permalink
[FEATURE] TypoScript module renamed: Document for TypoScript debugging (
Browse files Browse the repository at this point in the history
#1321)

Depends on #1319 which should be merged first

Related: TYPO3-Documentation/Changelog-To-Doc#136
Releases: main, 12.4
  • Loading branch information
linawolf authored Sep 9, 2024
1 parent 7626095 commit 5afde5d
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 30 deletions.
Binary file not shown.

This file was deleted.

Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 31 additions & 23 deletions Documentation/UsingSetting/Debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,46 +14,54 @@ to find errors within TypoScript.
.. index::
TypoScript; Constants debugging
Constants; debugging
.. _typoscript-debugging-constants:

Analyzing defined constants
===========================

The *TypoScript Object Browser* provides an tree view to all defined constants
on the currently active page.
.. versionchanged:: 12.0
The TypoScript management tools are now found in backend module
:guilabel:`Site Management > TypoScript`. It was formerly found in
"Page > Template".

.. include:: /Images/AutomaticScreenshots/TemplatesModul/TemplatesConstants.rst.txt
The submodule :guilabel:`Active TypoScript` was renamed from
"TypoScript Object Browser".

The backend submodule :guilabel:`Site Management > TypoScript > Active TypoScript`
provides a tree view to all defined TypoScript Constants on the currently active page.

.. figure:: /Images/ManualScreenshots/TypoScriptModule/ConstantsDisplayActiveTypoScript.png
:alt: A Screenshot showing the "Constants" section of the "Active TypoScript" submodule.

Analyzing defined TypoScript Constants in the :guilabel:`Active TypoScript` submodule.

.. index:: TypoScript; Syntax errors
.. _typoscript-syntax-finding-errors:

Finding errors
==============

There are no tools that will tell whether the given TypoScript code is 100%
correct. The :guilabel:`TypoScript object browser` will warn about syntax errors though:
.. versionchanged:: 12.0
The TypoScript management tools are now found in backend module
:guilabel:`Site Management > TypoScript`. It was formerly found in
"Page > Template".

.. figure:: /Images/ManualScreenshots/Templates/SyntaxError.png
:alt: The TypoScript Object Browser showing a syntax error
:class: with-shadow
The submodule :guilabel:`Active TypoScript` was renamed from
"TypoScript Object Browser". It does not display syntax warnings anymore,
those are displayed in the submodule :guilabel:`Included TypoScript` only.

Errors will also appear in the :guilabel:`template analyzer`, when viewing the content of a
given template. It is also possible to see the full TypoScript code by clicking
on the :guilabel:`View the complete TS listing` button at the bottom of the template
analyzer:
The submodule :guilabel:`Included TypoScript` was renamed from
"TypoScript Analyzer".

.. include:: /Images/AutomaticScreenshots/TemplatesModul/TemplatesViewFullListingButton.rst.txt

The result is a long listing with all compiled line numbers, which makes it
possible to find the error reported by the :guilabel:`TypoScript object browser`.

.. figure:: /Images/ManualScreenshots/Templates/FullListing.png
:alt: The TypoScript Object Browser showing a syntax error
:class: with-shadow
There are no tools that will tell whether the given TypoScript code is 100%
correct. The :guilabel:`Included TypoScript` will warn about syntax errors though:

In the frontend, the :guilabel:`admin panel` is another possibility to debug TypoScript; use
its section called :guilabel:`TypoScript`. It shows selected rendered (configuration)
values, SQL queries, error messages and more.
.. figure:: /Images/ManualScreenshots/TypoScriptModule/IncludedTypoScriptWarnings.png
:alt: The submodule 'Included TypoScript' showing a syntax warning

In the frontend, the :composer:`typo3/cms-adminpanel` is another possibility
to debug TypoScript: use its section called :guilabel:`TypoScript`. It shows
selected rendered (configuration) values, SQL queries, error messages and more.

.. index::
TypoScript; Debugging stdWrap
Expand Down

0 comments on commit 5afde5d

Please sign in to comment.