[TYPO3-dev] A few thoughts about extension manuals.

Stephen Bungert stephenbungert at yahoo.de
Fri Feb 19 10:59:37 CET 2010


I have just updated one of my extensions and also updated the manual. It 
took a lot of time to do, and quite disappointed with the rendered result 
(especially on the template and local language token sections)!

I assume that the OOo doc is turned in to one big text field in some record 
somwhere and split into pages on h1 tags.

Since you have to provide your login information to upload to the ter why 
not allow users (who all know how to use TYPO3 anyway) to login and edit the 
document directly (or even via FE editing). This would stop the need for 
document rendering which takes time anyway, and would stop the rendered 
manual look like 5h!t. If you really then need an open cross platform 
offline manual included with the template the ter could generate a static 
html file for the whole manual (complete with images).

Also when small changes need to be made you wouldn't need to upload a whole 
new version of the extension.

Stephen. 






More information about the TYPO3-dev mailing list