Translations
Info
All page names need to be in English.
en da  de  fr  it  ja  km  nl  ru  zh

Introduction (reST)

From TYPO3Wiki
Jump to: navigation, search

First of all, to make it clear, reST stands for reStructuredText.

reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents. reStructuredText is designed for extensibility for specific application domains.

reStructuredText is rendered for TYPO3 documentations with Sphinx. Originally built for Python it can be used to document any language. Syntax highlighting for many languages (PHP, javaScript, ...) and document formats (HTML, YAML, ...) is supported by Pygments. The TYPO3 documentation framework comes also with highlighting of TypoScript.

Status:

  • Since 2011, the TYPO3 documentation team started to investigate on this markup syntax as a better way of dealing with the large amount of documents we have for TYPO3, both as Core and 3rd-party extensions documentation.
  • In June 2012 most official TYPO3 documents were converted to reST.
  • End of November 2012 the Documentation Team proudly presents docs.typo3.org with auto-generated manuals based on reST.

Working with reST files

The reST files are stored in repositories, one repository per manual. In the repositories we hold several files, which are written in ReST Syntax.