[oXygen-user] XSLT Documentation: Cool Stuff

[George Cristian Bina]

Thanks Eliot, hi Syd,

We designed a simple language for annotations. The main advantages are:

- simple, just a few tags
- allows to easily add documentation for parameters
- flexible support for links
    * you can link to a component specifying its type and name.
    * you can define an ID in the annotation and then link to that 
specifying the stylesheet if the ID is in an included/imported file
Here it is an example

     <xd:doc xmlns:xd="http://www.oxygenxml.com/ns/doc/xsl" id="thisDoc">
         <xd:desc>
             <xd:p>
                 <xd:ref name="test" type="variable">My test 
variable</xd:ref>
                 <xd:a docid="thisDoc">Link to this documentation, see 
the the id="thisDoc" above</xd:a>
                 <xd:a docid="otherDocID" href="included.xsl">Link to 
otherDocID defined in included.xsl</xd:a>
             </xd:p>
         </xd:desc>
     </xd:doc>
- oXygen adds documentation stubs in this format

It is possible to use also TEI but you need to add support for 
converting the TEI elements that you use to XHTML. The scenarios will be 
to create a stylesheet that includes the default one oXygen uses and add 
the TEI to XHTML conversions. Now the default stylesheet is inside 
oxygen.jar but we will make that available inside the oXygen frameworks 
(you can still include it now using a jar URL).

Best Regards,
George
-- 
George Cristian Bina
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com

Syd Bauman wrote:
>> Just tried the XSLT documentation generation--dudes, that is awesome!
>> Thanks for that.
> 
> +1
> 
> I hadn't tried it yet, but if Eliot likes it, I said to myself, it is
> worth checking out. Wow!
> 
> What sold me are the "Used by" and "References" field.
> 
> I hope to start investigating annotation languages soon enough. (Can
> I use TEI? :-)
> _______________________________________________
> oXygen-user mailing list
> 
> http://www.oxygenxml.com/mailman/listinfo/oxygen-user