[TYPO3-dev] documentation for all system extensions

Stephane Schitter stephane.schitter at free.fr
Thu Aug 24 12:00:18 CEST 2006


Quoting Dmitry Dulepov <typo3 at accio.lv>:

> Hi!
>
> Martin Kutschker wrote:
>> A worthy goal would be to provide docs for all extensions shipped within
>> sysext. Escpecially indexed_search lacks any documentation.
>
> I do not think it should be shipped with typo3. It should be published
> on typo3.org but doc folders for extensions should have README that
> contains URL to the actual doc.
>
> In general docs are not needed on a running system. I really do not like
> when space in production is occupied by things that are never used (like
> CVS/SVN/docs/dat files).

I personally prefer when the docs of extensions (including system  
extensions) are available on the server, so I can read them either via  
OpenOffice, or through the rlmp_extensiondocs extension.

As a general rule, I much prefer when (opensource) software is shipped  
as complete packages with docs, instead of having to go to websites to  
read it. You can still remove it later on if you don't like it, but  
the sxw files are not that big (except tsref, which is not part of the  
sysexts anyway).

Stephane







More information about the TYPO3-dev mailing list