Introduction

What does it do?

This extension contains a lot of code samples that are used throughout the TYPO3 Core Documentation. The goals are two-fold:

1. Provide an easy way for users to gain access to these examples for their own use.
2. Store all code examples and content elements in a central place, so that it is easier for documentation maintainers to reproduce the examples from the documentation, in particular when refreshing the screenshots.

The usage of these examples is not explained in this manual. It is explained in the relevant documentation.

Not all code examples from the Core Documentation will be moved here as it is a rather huge task. Whenever possible code samples are taken from the TYPO3 Core itself. Furthermore priority is given to those code samples that are related to screenshots.

Backend Module

The extension introduces a backend module with different pages that introduce one concept each:

• Flash messages
• Logging Framework: Log Writers and Logger
• Page tree display
• Accessing the clipboard
• Edit links: Backend edit links and Usage of View Helpers in the Backend Creating HTML/XML tags using the TagBasedViewHelper
• File references

Page Tree

The extension initializes a page tree with custom content elements that introduce further concepts. Currently it contains only one dummy page, but should in perspective contain all custom pages and content needed for the documentation and not provided by other official TYPO3 distributions like EXT:introduction or EXT:styleguide. The latter are not primarily used for documentation.

An export preset “Examples Export Preset” is included in the dataset to export the page tree repeatedly during the development of the distribution, i.e. when having added a new page or content element. Read the manual “Creating a new distribution” for more information on how to reliably export page trees.

Page Tree Examples

• Additional context menu item Context-Sensitive Menus
• Additional page type Create new Page Type

Content element example

• Example of a custom content element being added: Creating a custom content element

Data processor examples

• Examples using all Core data processors are provided as content elements. They are used in Extended example: Extend tt_content and use data processing and dataProcessing
• Example using a custom data processor, used in Custom data processors

RTE Configuration

• RTE Transformations: RTE Transformations

Extending TCA

• Field of type=user in fe-user: Example 1: Extending the fe_users table and Examples
• Additional field tx_examples_noprint in table tt_content ref:t3coreapi:extending-examples-ttcontent.

Credits

Some of the examples were originally created by Kasper Skårhøj.