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

[Stephen Bungert]

"Dmitry Dulepov" <dmitry.dulepov+t3ml at gmail.com> schrieb im Newsbeitrag 
news:mailman.1.1266735888.9352.typo3-dev at lists.typo3.org...
> Hi!
>
> On 2010-02-19 11:59:37 +0200, Stephen Bungert said:
>> 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.
>
> Did you use the official template for this?

Ye , I did.


>
>> 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).
>
> Do you want to you implement that for typo3.org? If you do, remember that 
> manual must also come with the extension in a readable format.

I don't work for typo3.org, I was just making some comments about the 
process of creating manuals - they were comments not commands, no one has to 
do it! I did also say that if an open readable format was required it would 
quite easy to get the ter to export the content of the manual as html with 
images. No css. just plain html. Can't get more open and accessable than 
that. At present you have to have OOo installed to read the manual... does 
anyone every actually do that by the way? Something my network admin has 
restricted. I have to rely on HTML manuals while at work.

Stephen.