Hi all,

File taglib_docu.xml (within etc directory) is used to
generate the dbforms.tld using a simple stylesheet.
Within taglib_docu.xml there are also attributes containing
comments about dbforms tags and attributes. So why not bring it 
into a more human readable form? 

So I'd like to contribute first versions of 2 small 
other xsl stylesheets that can be used to generate HTML 
and PDF documentation out of taglib_docu.xml. If we use 
them we would always have the reference documentation up to date.

Some sections within the result might still look a bit ugly,
some may even not appear, but I think as a beginning it 
is quite usable. I welcome each help. 

You may have a look at the 

- resulting HTML file at

   http://www.uni-kiel.de/rz/datenbanken/dbforms/DbFormsTags.html

- resulting PDF file at 

   http://www.uni-kiel.de/rz/datenbanken/dbforms/DbFormsTags.pdf

  It contains a toc at the beginning and a tag and attribute index
  with page numbers at the end.

I'd suggest to upload both stylesheets (together with a README)
to the etc directory. We may consider to add an ant tasks to generate
the HTML and PDF documents. 

However, some sections within current taglib_docu.xml need
minor corrections, I'd like to do that now. I will just
touch existing <summary> and <info> tags, even if you are
currently working with the file, these should be handled 
by cvs. Please reply if you expect problems....

Regards

Dirk

Dont't want to post the stylesheets here, but here is at least
the contents of the README file:
----------------------------------------------------------------------------

README              : this file
taglib_docu.xml     : the source of taglibrary documentation

tld.xsl             : xslt stylesheet to create a tag library description
                      file out of taglib_docu.xml
tldoc2html.xsl      : xslt stylesheet to create HTML documentation
                      out of taglib_docu.xml
tldoc2xml-fo.xsl    : xslt stylesheet for creating xml-fo file
                      out of taglib_docu.xml


- You need a  XSLT processor to apply the stylesheets to the
  sourcefile. If you use Xalan-Java, which can be found at 

    http://xml.apache.org/xalan-j/index.html
  
  you have to 

  1) include Xalan lib (xalan.jar?) in your classpath

  2) java org.apache.xalan.xslt.Process 
        -in taglib_docu.xml 
        -xsl <name-of-stylesheet> 
        -out <name-of-output-file>

  See xalan documentation for details.

- To generate the tag library tld out of source file you simply 
  apply tld.xsl:

    java org.apache.xalan.xslt.Process 
      -in taglib_docu.xml -xsl tld.xsl -out dbforms.tld

- To generate the tag library HTML documentation you simply
  apply tldoc2html.xsl:

    java org.apache.xalan.xslt.Process 
      -in taglib_docu.xml -xsl tldoc2html.xsl -out taglib_docu.html

- To generate PDF documentation you first have to generate
  a file containing xml-fo by applying the stylesheet:

    java org.apache.xalan.xslt.Process 
     -in taglib_docu.xml -xsl tldoc2xml-fo.xsl -out taglib_docu.fo

  Then  you need a formatter that creates something like ps or
  pdf out of that file. You can use Apache FOP, which can be found at

     http://xml.apache.org/fop/index.html

  I used Version FOP-0.20.3, older versions may make some problems
  because some attributes seem to be renamed. 

  FOP comes with a shell script and a win bat file, see FOP docs
  for details. After installation you can create a pdf file out of
  the fo file by 

    fop.sh taglib_docu.fo taglib_docu.pdf


-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
_______________________________________________
DbForms Mailing List

http://www.wap-force.net/dbforms

Reply via email to