Configuration of the rendering - guides.xml

Can be used to set the code-language that should be used for code-blocks if no language is set.

We advice to set the language to be used in each code-block however.

Limits the main menu to a certain amount of levels. As level creation is one of the main bottle-necks that can slow down rendering it can be helpful to limit the levels in the menu in some use cases.

The project tag contains the title of the project and is displayed in the left sidebar (desktop) or the top (mobile) of the theme and in the title meta tag.

For TYPO3 extensions we suggest to use the extension name in a readable format:

• Import / Export tool
• News
• Mask

Common values are in the official TYPO3 manuals

1. <Topic> Guide, e.g. "Frontend Localization Guide", for collections of articles on a specific topic
2. <Topic> Reference, e.g. "TSconfig Reference", for a complete reference
3. <Topic> Tutorial, e.g. "Editors Tutorial", for collections of tutorials on a specific topic

When documentation is rendered in the GitHub action for deployment onto https://docs.typo3.org the version is set automatically to the extension's version derived from the Git tag. Setting the version in the guides.xml only affects local rendering.

You can set the release property to the release number of your document and output this value using |release| within your text if you desire to. Usually it is not used.

The copyright attribute contains the copyright claim of the project. It is displayed in the footer as "© Copyright <copyright>" and has in most use cases in the TYPO3 world the values:

1. since <creation-year> by the TYPO3 contributors, for example "since 1999 by the TYPO3 contributors" (official TYPO3 manuals and TYPO3 system extensions)
2. since <creation-year> by <vendor> & contributors, for example "since 1999 by John Doe & contributors" (third-party TYPO3 extensions)

The github_repository and github_branch attributes should be set to provide the "Edit on GitHub" button, which allows the reader to jump from the currently viewed documentation directly to the associated GitHub repository and edit the page file.

If the project is hosted on GitHub and public contributions are welcome, these attributes should be set accordingly:

1. <user>/<repository>, for example to "TYPO3-Documentation/TYPO3CMS-Reference-TCA" or "FriendsOfTYPO3/extension_builder".
2. <branch>, for example on "main" or "10.x".

For example:

<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
           edit-on-github-branch="main"
           edit-on-github="TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument"
/>

If this configuration is set, a button "Edit on GitHub" is displayed on each page of the manual.

The branch that should be used for the "Edit on GitHub" button.

The directory in which the documentation can be found. The GitHub render action currently does not support using other directories then Documentation/.

This setting is used exclusively for system extension manuals as the TYPO3 Core is kept in a mono repository on GitHub.

The interlink shortcode will be displayed in the "Reference this headline" dialog when users click on the link symbol beside a headline or other linkable element.

These references can be used to link to your manual from other documents rendered with the TYPO3 theme. However they will only work if you follow these rules:

• TYPO3 third-party extensions: Composer name, example: georgringer/news
• System extensions: Composer name, example: typo3/cms-adminpanel
• A shortcode supported by the theme: Available default inventories

The project_<topic> attributes provide all links with the name "<Topic>" in the footer of the documentation that guide the user to other aspects of the project than the documentation, for example to the project page in the TYPO3 Extension Repository (TER):

is set to the homepage URL of the project. For official TYPO3 manuals this is the public base URL at docs.typo3.org, for public TYPO3 extensions this is the associated TER page or a custom project website, for example

• https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ or
• https://extensions.typo3.org/extension/news.

is usually set to an email address or Slack channel URL of the team behind the project, for example

• mailto:documentation\@typo3.org or
• https://typo3.slack.com/archives/C028JEPJL.

is set to the repository of the project's VCS, for example

• https://github.com/FriendsOfTYPO3/extension_builder.

is set to the location where project issues are to be created and edited, for example

• https://github.com/FriendsOfTYPO3/extension_builder/issues

is used in the rare case that project-related discussions take place in locations other than those defined by the project_contact and project_issues attributes, for example

• https://github.com/FriendsOfTYPO3/extension_builder/discussions.

none

Disable the "Report issue" button

/SomePath/MyIssueReport

Link to this page in your documentation.

https://github.com/MyVendor/MyProject/issues/new

Open issue on GitHub

https://gitlab.com/myvendor/myproject/-/issues/new

Open issue on GitLab

https://forge.typo3.org/projects/typo3cms-core/issues/new

Open issue on Forge (System extensions only)

For security reasons arbitrary URLs are not allowed. If you use a private Gitlab or another issue tool, Make an internal page and link it like /SomePath/MyIssueReport.

You can set the preferred TYPO3 Core version. This version is used to determine the desired version for links to other manuals and system extensions.

<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
           typo3-core-preferred="stable" />

If no preferred version is set it defaults to stable. Possible values are:

main, stable (latest LTS), oldstable (old LTS) or an explicit LTS / eLTS version like 12.4 or 8.7.