Christian Ulrich wrote:
It would be very nice if people could edit documentation in a
convenient way such as a wiki; this is an improvement over sending
.xml help file patches. On the other hand it is also important that
the documentation is correct and coherent, particularly in its role as
a 'contract'. Merging into the documentation changes that can be made
by just anybody, might need more checking.
I think the fcl,rtl,lcl documentation schould stay in the xml files but
an general help and reference and ide help schould
stay in the wiki and automatically merged in the nigthy builds at
example and in the installations.
I agree that the IDE documentation, as well as the Object Pascal language
reference, are indeed good candidates for a wiki-based help system.
It seems your wiki export tool can be of great help here. Actually we [i.e. at
the office] use a similar script, in php, for the documentation of one of our
products as well. It is very useful when one wants to remove wiki-specific
functionality (edit, discussion, versions), add custom things like
automagically generated navigation links, and to make it suitable for offline
viewing.
BTW our tool fetches the pages from the wiki recursively and parses it with a
standard XHTML parser. Manipulations are done on the DOM (Document Object
Model). It also replaces the CSS and Javascript stuff. For syntax highlighting,
we integrated GeSHi into MediaWiki (so the highlighting is both in the wiki and
in the export). I can't share the source with you I'm afraid, but off course
you are free to borrow ideas ;)
Note: MediaWiki makes it very easy to create hooks, e.g. for the CODE tag to add syntax
highlighting. I believe adding custom tags like <NOTE>, <WARNING>, <TIP> etc.
shouldn't be too much of a problem too, though we used some CSS for that.
Regards,
Bram
_________________________________________________________________
To unsubscribe: mail [EMAIL PROTECTED] with
"unsubscribe" as the Subject
archives at http://www.lazarus.freepascal.org/mailarchives
