TYPO3 Explained

Version:6.2 Language:en Description:Reference to the Core APIs of TYPO3, e.g. main classes, Extension API, RTE API. Keywords:tsref, typoscript, reference, forDevelopers, forAdvanced Copyright:2000-2014 Author:Documentation Team Email:documentation@typo3.org License:Open Content License available from www.opencontent.org/opl.shtml

The content of this document is related to TYPO3 CMS, a GNU/GPL CMS/Framework available from www.typo3.org

Official Documentation

This document is included as part of the official TYPO3 documentation. It has been approved by the TYPO3 Documentation Team following a peer- review process. The reader should expect the information in this document to be accurate - please report discrepancies to the Documentation Team (documentation@typo3.org). Official documents are kept up-to-date to the best of the Documentation Team’s abilities.

Core Manual

This document is a Core Manual. Core Manuals address the built in functionality of TYPO3 CMS and are designed to provide the reader with in- depth information. Each Core Manual addresses a particular process or function and how it is implemented within the TYPO3 source code. These may include information on available APIs, specific configuration options, etc.

Core Manuals are written as reference manuals. The reader should rely on the Table of Contents to identify what particular section will best address the task at hand.

Table of Contents

• Introduction
• Extension Architecture
  • Introduction
  • Files and locations
  • System, Global and Local extensions
  • Choosing an extension key
  • Naming conventions
  • Installing extensions
  • Declaration file
  • Configuration files
  • Configuration options
  • The Extension Manager (EM)
  • Creating a new extension
  • Creating a new distribution
  • Adding documentation
  • Other resources
• TYPO3 API overview
  • Namespaces
  • Autoloading
  • Bootstrapping
  • Main classes and methods
    • High priority functions
    • Functions typically used and nice to know
  • Variables and Constants
    • Constants
    • Global variables
  • Backend User Object
  • TYPO3 Core Engine (TCE)
    • Database: TCEmain basics
    • Using TCEmain in scripts
    • The “tce_db.php” API
    • File functions basics
    • The “tce_file.php” API
  • Programming with workspaces in mind
  • Using the system log
  • Logging with TYPO3
    • Logger
    • Configuration of the Logging system
    • The LogRecord model
    • Log Writers
    • Log Processors
  • Using the system registry
  • Mail API
  • Form protection tool
  • Flash messages
  • TypoScript Syntax
    • What Is TypoScript?
    • Syntax
      • Introduction
      • Contexts
      • TypoScript syntax
      • Conditions
      • Includes
    • Sorting out Details
      • Parsing, Storing and Executing TypoScript
      • Myths, FAQ and Acknowledgements
    • The TypoScript Parser API
      • Introduction
      • Parsing Custom TypoScript
  • System categories
  • System collections
  • HTTP request library
  • Hooks
    • The concept of “hooks”
    • Hook configuration
    • Creating hooks
  • Extending classes (XCLASSes)
  • Various examples
    • Rendering page trees
    • Accessing the clipboard
    • Context-Sensitive Menus
    • Parsing HTML
    • Links to edit records
    • Support for custom tables in the Page module
    • Adding elements to the Content Element Wizard
    • Using custom permission options
• Coding Guidelines
  • Introduction
  • File system conventions
    • TYPO3 directory structure
    • TYPO3 files and user files
    • Extension directory structure
    • File names
  • PHP file formatting
    • General requirements for PHP files
    • File structure
    • PHP syntax formatting
    • Using phpDoc
  • PHP architecture
    • Modeling Cross Cutting Concerns
      • Static methods, static classes, utility classes
      • Traits
      • Services
    • Working with exceptions
    • General links
  • Coding: Best practices
    • Accessing the database
    • Singletons
    • Static methods
    • Localization
    • Unit tests
    • Handling deprecation
    • Namespaces and class names of user files
• JavaScript in TYPO3
  • AJAX in the TYPO3 Backend
    • In-depth presentation
    • Developing with AJAX in the TYPO3 Backend
  • Using ExtJS
    • Loading ExtJS
    • Ext.Direct
    • Backend Viewport
    • Page tree
    • Context-sensitive menus
• Caching framework
  • Quick start for Integrators
  • Configuration
  • Caching framework architecture
  • Cache frontends
  • Cache backends
  • Developer information
• Internationalization
  • Introduction to XLIFF
  • Migration to XLIFF and compatibility issues
  • Translating XLIFF files
• Page types
• User Settings Configuration
  • [‘ctrl’] section
  • [‘columns’] section
  • [‘showitem’] section
  • Extending the User Settings
  • Checking the configuration
• Rich Text Editors (RTE)
  • Rich Text Editors in the TYPO3 backend
    • Plugging a RTE
    • API for Rich Text Editors
  • Transformations
    • Introduction
    • Process illustration
    • Transformation overview
    • Page TSconfig
    • Custom transformations API
• Error and Exception Handling
  • Screenshots
  • Configuration
    • Error Handler
    • Production Exception Handler
    • Debug Exception Handler
    • Examples
    • Extending the error and exception handling
• Data Formats
  • <T3DataStructure>
    • Elements
    • Sheet references
    • Syntax highlighting of a Data Structure
    • Parsing a Data Structure
  • <T3locallang>
    • Elements
• Next Steps
• Appendices
  • Appendix A: Historical perspective on RTE transformations
    • Properties and transformations
    • RTE transformations in Content Elements