Hi Lukas,

        A Xdoc is a format comming from Anakia Project (if I have a good 
memory).
        This format was used a lot in jakarta projects to write their 
documentations.
        http://jakarta.apache.org/site/jakarta-site2.html
        In fact an xdoc is only a XHTML 1.0 document with some changes to use 
sections/subsections.

        The only problem I saw in the DTD is the tags 
goals/goal/name/description tag which isn't an xdoc tag.
        goals.xml documents aren't xdocs files. They are created by the 
plugin-plugin.
        These files are intermediate files that should be converted in xdoc 
(like changes.xml, ...) or the plugin-plugin should
generate xdoc files directly.
        I never understood why these files are directly transformed in the 
site.jsl but I didn't find the time to change it.

Arnaud
        
        

> 
> Hi everybody,
> 
> As some of you may have noticed, I have recently worked on 
> the validation goal for xdocs in the m1 xdoc plugin. The task 
> is now practically complete, with the validate goal doing 
> what I intended it to do.
> 
> Now I'd like to raise the question in the subject, I am not 
> aware of any normative definition of an xdoc? I have adapted 
> the xhtml1-transitional dtd to include all the elements used 
> in xdoc documents that I am aware of. In the current state, 
> all xdoc sources for all m1 plugins get validated by the 
> xdoc:validate goal (as implemented in the current 
> 1.10-SNAPSHOT m1 xdoc plugin), and AFAICT, the resulting html 
> documents are all valid xhtml1-transitional.
> 
> However, I don't want to take the sole responsibility for 
> defining what an xdoc is... ;) It would be nice if I could 
> get some feedback about whether what I did is sensible, any 
> omissions, extensions, etc. I have put a few notes about xdoc 
> validation here: [1], the maven-xdoc.dtd file can be found in 
> SVN in the src/dtd/ directory of the m1 xdoc plugin.
> 
> Finally, I suppose that in m2 xdocs follow the same format as 
> in m1 and that the validation routines will be implemented 
> following the same rules. If this is the case, then the dtd 
> files should be kept synchronized between the two versions in 
> the future.
> 
> 
> Any comments will be appreciated,
> Lukas
> 
> 
> [1]
> http://people.apache.org/~ltheussl/maven-stage-site/reference/
> plugins/xdoc/reference/xdocs.html#Validation
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [EMAIL PROTECTED] For 
> additional commands, e-mail: [EMAIL PROTECTED]
> 




---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to