On 09/05/06, Mattias Gaertner <[EMAIL PROTECTED]> wrote:
> * 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.
I was thinking in terms of release format for end users. Editing
could be done exactly like the windows help formats. HLP is generated
from a rich text file (RTF). I think CHM is as well. We could
generate our final help file from XML. DocBook also does it that way.
> * In must support Index and keyword search.
At least. Even the wiki already needs more than this. At least searching
multiple keywords.
Yes, a good search feature is very important.
> * 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.
Is LazDoc just a GUI front-end to fpdoc? I really need to read a bit
more on fpdoc!
* 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.
That would be cool. Even just being able to submit a email
referencing a Page & Paragraph containing the error with a small
message from the user would be a start. Having some small button or
something next to each paragraph (something like the Edit in wiki)
that could automatically generate a email with correct page and
paragraph.
* What about translations?
Umm.. What does Windows do regarding this? The Help Viewer would be
a normal GUI (maybe even a console version could be made) so could get
the langauge from the system.
The actual help contents... Well what if the help compiler outputs the
compiled file with the language code at the end. The Help Viewer
would then read the correct file bases on the systems language.
Doesn't Lazarus do something like this?
eg:
myapphelp.help => defaults to English
myapphelp_ru.help => Russian
myapphelp_af.help => Afrikaans
PS:
What does the CHM (as in windows help) stand for? Compressed HTML M???
Regards,
- Graeme -
--
There's no place like 127.0.0.1
_________________________________________________________________
To unsubscribe: mail [EMAIL PROTECTED] with
"unsubscribe" as the Subject
archives at http://www.lazarus.freepascal.org/mailarchives
