.. include:: /Includes.rst.txt
.. _start:
.. index:: ! Writing documentation
=====================
Writing documentation
=====================
:Version:
|release|
:Language:
en
:Author:
TYPO3 contributors
:License:
This document is published under the
`Creative Commons BY 4.0 `__
license.
:Rendered:
|today|
----
This guide contains information about contributing to TYPO3 documentation,
writing documentation for TYPO3 extensions and formatting with
reST and Sphinx.
----
.. container:: row m-0 p-0
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: `Extension Documentation `__
.. container:: card-body
This chapter explains how to write documentation for a new extension.
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: `TYPO3 Documentation `__
.. container:: card-body
Explains how you can contribute and help improve TYPO3's documentation.
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: `System Extensions `__
.. container:: card-body
The chapter contains information on how you can make changes to system extension documentation.
.. container:: col-md-6 pl-0 pr-3 py-3 m-0
.. container:: card px-0 h-100
.. rst-class:: card-header h3
.. rubric:: `Third-party Extensions `__
.. container:: card-body
This chapter explains how you can about making changes to third-party extension documentation.
Did you know?
=============
- 2019-03-17 :ref:`tip-edit-me-on-github` (Extension Authors)
:ref:`FAQ for extension authors ... `
.. uncomment this, when there are new general tips
:ref:`More general Tips ... ` | :ref:`More tips for extension authors ... `
What's new in this guide?
=========================
- :ref:`PlantUML-diagrams`
- `Automatic screenshot generation `__
.. toctree::
:hidden:
:caption: BASICS
About
HowToGetHelp
BasicPrinciples
GeneralConventions/Index
WritingReST/Index
.. toctree::
:hidden:
:caption: HOWTOS
WritingDocForExtension/Index
WritingDocsOfficial/Index
RenderingDocs/Index
.. toctree::
:hidden:
:caption: ADVANCED
HowToAddTranslation/Index
GeneralConventions/ReviewInformation
.. toctree::
:hidden:
:caption: MAINTAINERS
Maintainers/Index
.. Meta Menu
.. toctree::
:hidden:
Sitemap
genindex