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

ReST for extension manuals

From TYPO3Wiki
Jump to navigation Jump to search

notice - Newer documentation available

notice - This information is outdated

This page belongs to the Documentation Team (category DocTeam)

This page is meant to provide the current status about using reStructured Text for writing the manuals of TYPO3 CMS extensions. It lists what works and what doesn't.

Current limitations

  • No communication/trigger between TER and
  • A cron job fetches the list of all extensions every 2 hours, compares with the locally stored list of extensions and renders documentation for new and modified ones. The script is able to deal with
    • Sphinx-based documentation (incl. multilingual)
    • README.rst at root
    • OpenOffice-based documentation (it is first converted to Sphinx and then rendered as usual)