Login / Status
developer.Resource
Home . Documentation . Document Library . Core Documentation
Sponsors
hosted by punkt.deTYPO3 and Open Source Magazine

Chapter 1. TYPO3 Coding Guidelines

Extension Key: doc_core_cgl

Language: en

Keywords: cgl, development, reference, forDevelopers, forAdvanced

Copyright 2000-2008, TYPO3 Core Development Team, <info@typo3.org>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.org

1.1. About this document

This document defines coding guidelines for the TYPO3 project. Following these guidelines is mandatory for TYPO3 core developers and contributors to the TYPO3 core.

Extension authors are strongly encouraged to follow these guidelines when developing extensions for TYPO3. Following these guidelines makes it easier to read the code, analyze it for learning or perform code reviews. These guidelines also help to prevent typical errors in the TYPO3 code.

This document defines how TYPO3 code, files and directories should be structured and formatted. It does not teach how to program for TYPO3 and does not provide technical information about TYPO3.

Page numbers in this document refer to its printable version (available from the typo3.org web site).

Conventions used in this document

Monospace font is used for:

  1. File names and directories. Directories have slash (/) in the end of the directory name.

  2. Code examples

  3. TYPO3 module names

  4. Extension keys

  5. TYPO3 namespaces (see page 5)

TYPO3 Frontend and Backend are spelled with the first letter in the uppercase because they are seen as subsystems.

Credits

The original TYPO3 coding guidelines document was written by Kasper Skårhøj. This document is written from scratch and based on the discussion between developers held at TYPO3 Developer Days in May 2008.

The information for this document was collected by Ingo Renner (TYPO3 core team member, release manager for TYPO3 4.2). The initial draft was produced by Dmitry Dulepov (TYPO3 core team member). The document is approved by the TYPO3 Core Team.