.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _introduction:

Introduction
------------


.. _introduction-what:

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:

#. provide an easy way for users to gain access to these examples for
   their own use.

#. store all code examples 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:

Backend Module
^^^^^^^^^^^^^^

The extension introduces a Backend Module with different Pages that introduce one concept each:

- Flash messages
- Logging Framework: :ref:`t3coreapi:logging-writers` and :ref:`t3coreapi:logging-logger`
- Page tree display
- Accessing the clipboard
- Edit links: Backend edit links and Usage of View Helpers in the Backend :ref:`t3extbasebook:creating-html-tags-using-tagbasedviewhelper`
- File references

.. _page_tree_examples

Page Tree Examples
^^^^^^^^^^^^^^^^^^

- Additional context menu item :ref:`t3coreapi:context-menu`
- Additional page type :ref:`t3coreapi:page-types-example`

RTE Configuration
^^^^^^^^^^^^^^^^^^

- RTE Transformations: :ref:`t3coreapi:transformations-custom`

.. _introduction-credits:

Credits
^^^^^^^

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