[Laszlo-dev] Fwd: [Platform-team] doctools question

Wed Nov 30 16:07:03 PST 2005

Begin forwarded message:

> From: John Sundman <john at wetmachine.com>
> Date: November 30, 2005 6:16:31 PM EST
> To: Platform Team <platform-team at laszlosystems.com>
> Subject: [Platform-team] doctools question
>
> I'm trying to generate a ref page for LzTextFormat.lzx, which is 
> located in /components/extensions/views.  "Ant reference" fails (error 
> message given below).
>
> I think the problem is that the doc tools are creating the wrong kind 
> of xml file because they think LzTextFormat is a tag and not a class.
>
> OVERVIEW
>
> The doctools produce a "hardpage" for the reference  for every 
> "wrapper" file in docs/src/wrappers.  As an intermediate step, the 
> tools create an XML file  by groveling over the source using 
> directives in the associated wrapper file.  The generated XML file is 
> be named in one of three ways, depending on whether the thing  being 
> grovelled --say, "foo.as" or "foo.lzx" -- is an lfc class or a tag :
>
> foo.xml
> tag-foo.xml
> api-foo.xml
>
> I believe that LzTextFormat wants an api-foo.xml file, because it's a 
> class that you can only get to from javascript.  However, the doctools 
> are producing a foo.xml file instead, which leads to suckage.
>
> PARTICULARS
>
> I have edited the library file in /lps/components/extensions, viz:
>
> <!-- used by rngparse.py to determine which extensions to document -->
> <library>
> <include href="extensions/views/richinputtext.lzx" />
> <include href="extensions/views/LzTextFormat.lzx" />
> </library>
>
> here is the wrapper for LzTextFormat   
> (docs/src/wrappers/lztextformat.html):
>
> <html xmlns="http://www.w3.org/1999/xhtml">
> <head>
> <link rel="STYLESHEET" type="text/css" href="./styles.css" /></head>
> <body>
> <lzelement title="LzTextFormat">
>     <lztier>Service</lztier>
>     <lzcategory>Media</lzcategory>
>     <lzshortdesc>
>     Formats rich text
>     </lzshortdesc>
>     <lzapi>extensions/views/lztextformat.xml</lzapi>
> </lzelement>
>
> </body>
> </html>
>
> There is an xml file
>
> docs/src/wrappers/extensions/views/lztextformat.xml
>
> However, when you try to build the reference, you get:
>
> combined-xml:
>      [exec] ERROR: Invalid root node name in 
> wrappers/extensions/views/lztextformat.xml! Must be <api>.
>      [exec] FATAL ERROR:Mistakes were made
>        [if] Error in class net.sf.antcontrib.logic.IfTask
>
> BUILD FAILED
>
>
> Any suggestions welcome.
>
> jrs
>
>
>