Introduction & Basics¶
About Extension Documentation¶
The documentation for all extensions is structured in the same way: The
extension contains a directory
Documentation with at least the following files:
Index.rst: contains text to be rendered on the startpage and the toctree
Includes.txt: some basic definitions for sphinx
These are the same files and general principles that apply to any documentation project. See Directories and Files for more information.
See https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual for an example.
The Documentation may deviate from this recommendation, for example it may consist
of only one
Readme.md. See Additionally Supported Filenames and Formats.
Please note that using this has some drawbacks and it is recommended to use the
files as described in Directories and Files.
About TYPO3 Extensions¶
In TYPO3, basically everything is an extension. There are system extensions and third party extensions:
System extensions (or core extensions) are extensions that are maintained in the TYPO3 source. For a list of system extensions, look in the Extension Manager or in the TYPO3 source, e.g. GitHub: TYPO3.CMS: /typo3/sysext.
Examples for system extensions are:
Note, that if your system has been installed with Composer, not all system extensions may exist
in the system, if each system extension has been required separately as "subtree splitted packages"
typo3/cms). Since TYPO3 9, installation of "subtree splitted packages" is mandatory.
For more information on subtree split, see
System Extension Documentation¶
Find the documentation for a system extension on System extensions.
Not all system extensions have documentation at the moment.
For more information about contributing to system extensions, see Contribute to System Extension in this guide.
See also Documentation Contribution Matrix for an overview of the issues, source and workflow for various kinds of documentation, including system extensions.
Third Party Extensions¶
Third party extensions are extension that can be created by anyone. They are not included in the TYPO3 core codebase and are not officially supported by the TYPO3 core team.
Often, but not necessarily, these extensions are hosted on GitHub.
They can be installed by the TYPO3 Extension Manager or via Composer.
Third Party Extension Documentation¶
Find the documentation on Extensions by extension key.
For more information about contributing to third party extension documentation or for your own extension, see Contribute to Third Party Extension. See How to Start Documentation for Your TYPO3 Extension for information about starting extension documentation from scratch.
See also Documentation Contribution Matrix for an overview of the issues, source and workflow for various kinds of documentation, including third party extensions.