[TYPO3-english] Manual for your own extension

Xavier Perseguers xavier at typo3.org
Mon Jul 28 11:34:17 CEST 2014


> I regularly see brand new extensions being uploaded to TER with an
> OpenOffice manual. Although I personally value much more an extension
> coming with a manual - even if not yet complete - as one without any
> info, I cannot stress enough that OpenOffice manual is considered
> "legacy practice".

Some statistics I just computed by combining the list of available
manuals with their format (OOo / reST / ...) [1] and the list of
extensions compatible with a given TYPO3 branch [2] and [3]:

TYPO3 4.5 LTS
-------------

- Sphinx project:  6.8%
  - w/ PDF:        2.1% of all extensions => 23% of Sphinx projects
- README.rst:      0.8%
- OpenOffice:     66.9%
- No manual:      25.5%


TYPO3 6.2 LTS
-------------

- Sphinx project: 19.0%
  - w/ PDF:        4.9% of all extensions => 25% of Sphinx projects
- README.rst:      1.4%
- OpenOffice:     51.9%
- No manual:      27.7%


It is clear that Sphinx is gaining popularity for extensions compatible
with TYPO3 6.2.

I'm missing the percentage of "old" extensions having migrated from
OpenOffice to Sphinx but it must be +/- equal to the percentage of
Sphinx-based manuals in 4.5.


[1] http://docs.typo3.org/typo3cms/extensions/manuals.json
[2] https://www.causal.ch/?eID=extensions&route=typo3/4.5
[3] https://www.causal.ch/?eID=extensions&route=typo3/6.2

-- 
Xavier Perseguers
TYPO3 CMS Team Member

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org



More information about the TYPO3-english mailing list