Re: Thoughts on <doc/>

Andrew Kohlsmith <[email protected]>
Newsgroups gmane.comp.java.xwt.general
Organization Benshaw Canada
Message-ID <[email protected]>
> <xwt>
>      <doc>
>          <license>LGPL</license>
>          <author name="Bill Gates" mail="[email protected]"
> type="original"/>
>          <author name="Steve Jobs" mail="[email protected]" type="patch"/>
>          <author name="Al Gore" mail="[email protected]"
> type="redesign"/>

What is wrong with following the original DocBook format (I think that's what 
Corey's been working on) --

<xwt>
    <doc>
        @license LGPL
        @author Bill Gates <[email protected]>
        @author Steve Jobs <[email protected]>
        @author Al Gore <[email protected]>

        <description>
            An amazing collaborative effort.  The description can be
            multiple lines without breaking anything, but any <tag>
            elements must be properly formatted XML.</tag>
        </description>
    
... and so on...  One of the things that must be respected is that the people 
writing the documentation are human, and a pure XML format is just way too 
verbose.  By wrapping the documentation in XML tags and using XML for the 
larger parts of the documentation (description, implementation, etc.) I think 
it's a pretty good trade-off between XML purity and human writability.

I mean yeah we can use XSLT to transform a human-readable format to pure XML 
but if you take a look at the XWT templates themselves you see they tend to 
follow a similar format.

Regards,
Andrew

_______________________________________________
http://lists.xwt.org/listinfo/dev
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.