[TYPO3-hci] a newcomer's introduction and TSref

[Johannes Reichardt]

Hi there,
> Sounds very interesting and promising, Silke. I like it!
>
> But it also sounds like a lot of work, and also some extension
> programming on the typo3.org part.
>
> Also keep in mind that current version of TSref is just a online version
> of an OpenOffice document, just as any other documentation in TYPO3. So
> everything that you improve in TSref will also affect and might be used
> on ALL documents that you can read on typo3.org (even all extension
> documentation). So while this sounds a great idea, you have to cope with
> the limitations of the OpenOffice format, which is layouted as HTML by
> some extensions at typo3.org.
>   
Maybe it would be better to have a nice system to add documentary on 
typo3.org online and leave it to the community to make other docs of it? 
Also the online help (if done well) is the most practial thing. You 
wouldn´t read a description of every php function before starting 
programming - would you?

So i´d vote for a basically online-only documentation that makes it easy 
for the doc-team, typo3-core / ext developers and "normal" developers to 
access and read through that.

- Johannes
>   
>> links: all "keywords" (objects, properties...) are displayed as links -
>> leading to the definition and basic description of the term
>>
>> colours and symbols: display objects, properties, functions etc.
>> each in a specific colour and add a specific letter, each time they
>> are mentionend (the latter to allow for specific search and for
>> further use in terms of accessibility)
>> (...)
>>     
>
> I think there had been some discussions of moving from OpenOffice to
> DocBook format, but I don't know the progress of that. But I also think
> there is a need to improve the current formatting possibilities. For
> example, one thing in my eyes would be to drop the "property tables" as
> they are very inflexible in formatting for online AND for print. I would
> just use normal heading and indented paragraph for a list of properties.
>
>
> Cheers,
> Ernesto
>
>
>
> First of all I will paste your answer, Elmar here, to be able to refer to all aspects that belong together:
>
> Hi Ernesto,
>
> DocBook has been accepted on some occasion to be the future format. TER2
> already uses it internally to prepare the transit.
>
> Ernesto Baschny [cron IT] wrote:
>   
>> I think there had been some discussions of moving from OpenOffice to
>> DocBook format, but I don't know the progress of that. But I also think
>> there is a need to improve the current formatting possibilities. For
>> example, one thing in my eyes would be to drop the "property tables" as
>> they are very inflexible in formatting for online AND for print. I would
>> just use normal heading and indented paragraph for a list of properties.
>>     
>
> Regards
>
> Elmar
>
>
>
> Is it just because I don't know Typo3 well enough yet, or why should one not use Typo3 itself for the TSref?
>
> The need of extension programming is obvious. On the other hand, I would need that for my organization system anyways. And  it would be a prominent example of what you can do with Typo3 - instead of using a different software and thereby stating, Typo3 is not capable of handling this task or at least for this purpose it is not the first choice.
>
> Please, help me to understand the problem with using Typo3 here.
>
> Kind regards,
>
> Silke
> _______________________________________________
> TYPO3-team-hci mailing list
> TYPO3-team-hci at lists.netfielders.de
> http://lists.netfielders.de/cgi-bin/mailman/listinfo/typo3-team-hci
>
>