On Tue, 9 May 2006 09:24:33 +0200
"Graeme Geldenhuys" <[EMAIL PROTECTED]> wrote:
> Has anybody put some thought into creating a cross platform help file
> format that Lazarus could use in the IDE and in applications created
> with Lazarus?
It was discussed several times on the lists and 10 people gave 10 different
ideas. That's why I finally implemented a help interface for the IDE with
abstract database, viewers, selection and TOC. So people can start
implementing backends to whatever help format they like.
> Just a quick list of ideas. Please add your own ideas or comments.
> Once we have a good spec, maybe we can move all the ideas to the wiki
> until implemented.
>
> * I single help file, instead of loads of files like html would be
> preferred. eg: .chm or .hlp files compared to .html file. Maybe
> something like what OpenOffice.org did with their file format would
> work. A single zipped file with xml and images inside.
Good for releases, bad for editing the help.
> * Maybe use a better compression algorythm like 7zip which is
> excellent on text compared to normal zip for a single file compresion.
>
> * In must support Index and keyword search.
At least. Even the wiki already needs more than this. At least searching
multiple keywords.
> * Image maps will be nice as well, using the png file format.
>
> * We would need a help file compiler, that packs everything and
> generates updated indexes and keywords.
>
> * A help editor would be needed, except if we can piggy-back on LazDoc
> and use that instead. If using LazDoc, it would need to be improved.
The fpdoc is maintained, it is written in fpc, the developers are willing to
improve it and patches are welcome.
> * Bookmark feature would be great.
* Editing features and a format, that can be used to create patches would be
great. To extend the help and send us a patch should be as easy as changing
a lazarus pascal example. Maybe as easy as the wiki.
* What about translations?
Mattias
_________________________________________________________________
To unsubscribe: mail [EMAIL PROTECTED] with
"unsubscribe" as the Subject
archives at http://www.lazarus.freepascal.org/mailarchives
