On 01/12/2007, Michael Van Canneyt <[EMAIL PROTECTED]> wrote:
>
> I think this is a rather daunting task, the fpdoc engine is tightly
> intertwined with the XML format and data structures. It might be easier
> to do a preprocessing step, to convert <insert your favourite format here>
> to XML as understood by fpdoc. We can integrate this preprocessing in FPDoc
> if you want.

OK, I think you miss understood what I want to do.... The
documentation will still be stored in the same XML files that
'makeskel' generates.  What I want to implement is interchangeable
formatting syntax used in the <short> and <descr> tags

eg:

A current fpDoc description file using Simple HTML for formatting....

<module name="gui_dialogs">
<short>Various <i>dialogs</i> used by fpGUI based applications.</short>
<descr>Here is <b>bold</b> text and <i>italics</i> text.</descr>


I want to be able to support Creole 1.0 wikitext formatting as follows...

<module name="gui_dialogs">
<short>Various //dialogs// used by fpGUI based applications.</short>
<descr>Here is **bold** text and //italics// text.</descr>


See the XML structure stays the same, it's only how you format your
content that changes. This way I can very easily incorporate the loads
of Javascript based WYSIWIG editors with a CGI application, so users
could edit documentation via their web browsers.

Then once 'fpdoc' generates HTML output, this is where the new
parameter will come into play. Or select the current HTML engine or
the Creole wikitext formatting engine to output HTML pages.


Regards,
  - Graeme -


_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net/fpgui/

_________________________________________________________________
     To unsubscribe: mail [EMAIL PROTECTED] with
                "unsubscribe" as the Subject
   archives at http://www.lazarus.freepascal.org/mailarchives

Reply via email to