[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-devel
Subject:    Re: DocBook DTD/ KDE 2.0 documentation
From:       Christian Esken <c.esken () cityweb ! de>
Date:       1999-03-31 21:23:51
[Download RAW message or body]

OK, hereīs my input:

1) Make the stuff easy to use (otherwise nobody will use it)
Developers will more likely write docu, when a reasobable and not too
complicated syntax is used.
Translators should be able to translate the text without having to wade
through tons of tags.
In the optimal case one will write the docu with a special editor or with
xemacs in a special KDE-docu mode.


2) Links
I would like to be able to link to "everything" from the documentation.
Standard links and mailto: links are normal, but having an "execute program"
link or "open folder" link would be nice, too. AFAIK these are not available
in HTML, but well - you asked for my wishes. :)


3) Tags
Sections should be automatically "tagged" - and you should be able to place
tags at other objects (pictures, paragraphs) too. These tags should mark special
topics.
The program should then be able to say: showHelp( topic );
And then the help browser opens at the place where tag = topic.


OK, thatīs it for today

Good night,
     Christian

[prev in list] [next in list] [prev in thread] [next in thread]