xsddoc/xdocs examples.xml,NONE,1.1 usage-ant.xml,NONE,1.1 build.xml,NONE,1.1 install-ant.xml,NONE,1.1 navigation.xml,NONE,1.1 compatibility.xml,NONE,1.1 index.xml,NONE,1.1 navigation-pdf.xml,NONE,1.1 install-console.xml,NONE,1.1 news.xml,NONE,1.1 usage-console.xml,NONE,1.1
Kurt Riede <[email protected]>
| Newsgroups | gmane.text.xml.xframe.xsddoc.devel |
|---|---|
| Message-ID | <[email protected]> |
Update of /cvsroot/xframe/xsddoc/xdocs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv26652/xdocs
Added Files:
examples.xml usage-ant.xml build.xml install-ant.xml
navigation.xml compatibility.xml index.xml navigation-pdf.xml
install-console.xml news.xml usage-console.xml
Log Message:
preparations for oncoming release 0.6-beta, switch to build with Apache Maven
--- NEW FILE: index.xml ---
<?xml version="1.0"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<document>
<properties>
<title>xsddoc</title>
<author email="[email protected]">Kurt Riede</author>
</properties>
<body>
<section name="Goal">
<p>The xsddoc subproject is a XML Schema documentation generator for W3C XML Schemas.</p>
</section>
<section name="Motivation">
<p>We started this project out of several reasons:</p>
<ul>
<li>If we want to implement schema processing software, we must be able to document what we want to process.</li>
<li>We didn't find any appropriate open source documentation tool for W3C XML Schema.</li>
<li>With the documentation tool we want to do our first steps in learning about problems that a schema processor must solve.</li>
<li>It might be useful to the open source community, as a part or independent of xframe.</li>
</ul>
</section>
<section name="Requirements">
<p>The XML Schema documentation tool should meet the following requirements:</p>
<ul>
<li>full conformance to W3C XMLSchema and Namespaces</li>
<li>platform independent</li>
<li>multiple cross linked html pages similar to JavaDoc</li>
<li>clickable type hierarchy</li>
<li>usage cross reference</li>
<li>clickable type model for each component</li>
<li>offer Apache Ant task</li>
</ul>
</section>
<section name="Status">
<p>The latest version of <code>xsddoc</code> is release 0.6 beta.</p>
<p>This release contains fixes for many bugs reported by the
community since the previous release and improved documentation for
nested element declarations.</p>
<p>The future plan is to release <code>xsddoc-RC-1</code> (Release Candidate) in
September 2004. This release should include all open tasks and hopefully fixes for
all bugs reported to <code>xsddoc-0.5-beta</code>.
</p>
<p>You can download <code>xsddoc</code>
<a target="_bank" href="http://sourceforge.net/project/showfiles.php?group_id=48863&amp;package_id=42075">here</a>.</p>
<p>If you have Apache XalanJ installed, you can download the standard
distribution file <code>xsddoc-0.6-beta.zip</code>. Only in case you
don't have Apache XalanJ, you should download the distribution file
<code>xsddoc-0.6-beta-full.zip</code> in order to have all files
necessary to run xsddoc. All distribution files contain the full source
code of the project.</p>
<p>For Unix or Linux users, there are two corresponding distribution
files packed as <code>.tar.gz</code>.</p>
</section>
</body>
</document>
--- NEW FILE: build.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<document>
<properties>
<author email="[email protected]">Kurt Riede</author>
<title>xframe - xsddoc - documentation tool for W3C XML Schemas</title>
</properties>
<meta name="keyword" content="XML, XML Schema, XSLT, DOM, GUI, SWT, Swing, Documentation, Generator, schema based programming, applicatio, business model, mapping, sourceforge, automatic, independent, standard, development, Java, Kurt Riede"/>
<body>
<section name="Building xsddoc">
<section name="Build with Apache Ant">
<p>If you want to build <code>xsddoc</code> by your self, you must download and
install Apache Ant from here:</p>
<p><code>http://ant.apache.org</code></p>
<p>Now download a distribution and extract it to your local harddisc
or checkout xsddoc from CVS from this location:</p>
<p><code>pserver:[email protected]:/cvsroot/xframe</code></p>
<p>Now open a console and move to the <code>xsddoc</code> folder where the file
<code>build.xml</code> is and type:</p>
<p><code>ant dist</code></p>
</section>
<section name="Build with Apache Ant">
<p>If you want to build <code>xsddoc</code> with Apache maven, you must download and
install Apache Maven from here:</p>
<p><code>http://maven.apache.org</code></p>
<p>Now download a distribution and extract it to your local harddisc
or checkout xsddoc from CVS from this location:</p>
<p><code>pserver:[email protected]:/cvsroot/xframe</code></p>
<p>Now open a console and move to the <code>xsddoc</code> folder where the file
<code>project.xml</code> is and type:</p>
<pre>maven test
maven site:generate
maven pdf</pre>
</section>
</section>
</body>
</document>
--- NEW FILE: navigation.xml ---
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<project name="xsddoc">
<title>xsddoc</title>
<body>
<links>
<item name="PDF Documentation" href="/xsddoc.pdf" img="/images/pdf.gif"/>
</links>
<menu name="Overview">
<item name="About" href="index.html"/>
<item name="News and Status" href="news.html"/>
<item name="Compatibiliy" href="compatibility.html"/>
<item name="Download" href="http://sourceforge.net/project/showfiles.php?group_id=48863&package_id=42075"/>
<item name="Build" href="build.html"/>
<item name="Installation" href="install-console.html">
<item name="Console" href="install-console.html"/>
<item name="Ant" href="install-ant.html"/>
</item>
<item name="Usage" href="usage-console.html">
<item name="Console" href="usage-console.html"/>
<item name="Ant" href="usage-ant.html"/>
</item>
<item name="Examples" href="examples.html"/>
</menu>
</body>
</project>
--- NEW FILE: install-ant.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<document>
<properties>
<author email="[email protected]">Kurt Riede</author>
<title>xframe - xsddoc - documentation tool for W3C XML Schemas</title>
</properties>
<meta name="keyword" content="XML, XML Schema, XSLT, DOM, GUI, SWT, Swing, Documentation, Generator, schema based programming, applicatio, business model, mapping, sourceforge, automatic, independent, standard, development, Java, Kurt Riede"/>
<body>
<section name="Installation of xsddoc for Apache Ant">
<p>All you have to do is to copy the file <code>xsddoc.jar</code> to the lib folder
of your ant installation.</p>
</section>
</body>
</document>
--- NEW FILE: examples.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<document>
<properties>
<author email="[email protected]">Kurt Riede</author>
<title>xframe - xsddoc - documentation tool for W3C XML Schemas</title>
</properties>
<meta name="keyword" content="XML, XML Schema, XSLT, DOM, GUI, SWT, Swing, Documentation, Generator, schema based programming, applicatio, business model, mapping, sourceforge, automatic, independent, standard, development, Java, Kurt Riede"/>
<body>
<section name="Examples">
<p>We created several sample documentation to test and demonstrate the results. Some
of them can be viewed online:</p>
<ul>
<li><a target="_blank" href="http://xframe.sourceforge.net/xml-schema/doc/index.html">XML Schema for XML Schema</a></li>
<li><a target="_blank" href="http://xframe.sourceforge.net/xsddoc/samples/xhtml/html/index.html">XHTML 1.0 (Second Edition) Strict</a></li>
<li><a target="_blank" href="http://xframe.sourceforge.net/soap/envelope/doc/index.html">SOAP Envelope</a></li>
<li><a target="_blank" href="http://xframe.sourceforge.net/xsddoc/samples/stress/html/index.html">Stress tests</a></li>
<li><a target="_blank" href="http://xframe.sourceforge.net/xsddoc/samples/xsddoc/html/index.html">Schema of xsddoc</a></li>
</ul>
</section>
</body>
</document>
--- NEW FILE: usage-console.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<document>
<properties>
<author email="[email protected]">Kurt Riede</author>
<title>xframe - xsddoc - documentation tool for W3C XML Schemas</title>
</properties>
<meta name="keyword" content="XML, XML Schema, XSLT, DOM, GUI, SWT, Swing, Documentation, Generator, schema based programming, applicatio, business model, mapping, sourceforge, automatic, independent, standard, development, Java, Kurt Riede"/>
<body>
<section name="Usage from the command line">
<pre> Usage: xsddoc [-option] schema
(to document a schema)
where options include:
-o -out <folder> Set the output folder
-t -doctitle <title> Set the documentation title
-h -header <header> Set the documentation header
-f -footer <footer> Set the documentation footer
-b -bottom <bottom> Set the documentation bottom
-s -hideSubTypes hide sub types references
-l -hideSubLocalUsage hide show local usage references
-p -hideTypes hide types in overview pages
-g -hideGroups hide groups in overview pages
-a -hideAttributes hide attributes in overview pages
-xml output components as XML instead of HTML (testing purpose only)
-v -verbose Output messages about what xsddoc is doing
-q -quiet Be quiet about what xsddoc is doing
-d -debug Output debug messages
-? -help Print this help message</pre>
</section>
</body>
</document>
--- NEW FILE: navigation-pdf.xml ---
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<project name="xsddoc">
<title>xsddoc</title>
<body>
<menu name="Overview">
<item name="About" href="index.html"/>
<item name="News and Status" href="news.html"/>
<item name="Compatibiliy" href="compatibility.html"/>
<item name="Download" href="http://sourceforge.net/project/showfiles.php?group_id=48863&package_id=42075"/>
<item name="Build" href="build.html"/>
<item name="Installation" href="install-console.html">
<item name="Console" href="install-console.html"/>
<item name="Ant" href="install-ant.html"/>
</item>
<item name="Usage" href="usage-console.html">
<item name="Console" href="usage-console.html"/>
<item name="Ant" href="usage-ant.html"/>
</item>
<item name="Examples" href="examples.html"/>
</menu>
</body>
</project>
--- NEW FILE: news.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<document>
<properties>
<author email="[email protected]">Kurt Riede</author>
<title>xframe - xsddoc - documentation tool for W3C XML Schemas</title>
</properties>
<meta name="keyword" content="XML, XML Schema, XSLT, DOM, GUI, SWT, Swing, Documentation, Generator, schema based programming, applicatio, business model, mapping, sourceforge, automatic, independent, standard, development, Java, Kurt Riede"/>
<body>
<section name="News and Status">
<section name="Jun. 20, 2004 - xsddoc 0.5 beta released">
<p>The xframe team is pleased to announce the release 0.5-beta
of the sub project xsddoc.</p>
<p>The xsddoc subproject of xframe is an Open Source documentation tool
for W3C XML Schema based on XSLT and XalanJ. With xsddoc you can
generate documentation of your XML Schema in a JavaDoc like visualisation.</p>
<p>This Announcement notes the significant changes in Release 0.5-beta
compared to Release to 0.4-beta:</p>
<p>Fixes for the following bugs:</p>
<ul>
<li>972508 simpleType link vs. complexType link</li>
<li>972042 DOS line feeds in UNIX shell scripts</li>
<li>972041 type: XSDOC_HOME instead of XSDDOC_HOME</li>
<li>970755 Multiple links to elements</li>
<li>965887 TransformerEx.: ElemTemplateElement-Error: namespaceFolder</li>
<li>957268 circular import</li>
<li>954796 attributes detail: Form unqualified1</li>
<li>949282 Duplicate global variable declaration exception</li>
<li>943687 local Attr. decl. within complexContent missing in model doc</li>
<li>942908 incomplete overview if targetNamespace empty</li>
<li>939335 Missing details in the "Attribute Detail" sections</li>
<li>939137 include external schema</li>
<li>939135 warnings when building the stress sample</li>
<li>937584 xsddoc: elements don't appear</li>
<li>937583 typo (nit)</li>
<li>936225 model documentation of local simple type attributes</li>
</ul>
</section>
<section name="Apr. 21, 2004 - new xsddoc Sample: XHTML 1.0 (Second Edition) Strict">
<p><a target="_blank" href="http://xframe.sourceforge.net/xsddoc/samples/xhtml/html/index.html">XHTML 1.0 (Second Edition) Strict</a>.</p>
</section>
<section name="Apr. 1, 2004 - xsddoc 0.4 beta released">
<p>The xframe team is pleased to announce the first beta release
of the sub project xsddoc, a documentation tool for W3C XML Schema.</p>
<p>This Announcement notes the significant changes in Release 0.4-beta
compared to Release to 0.3-beta:</p>
<ul>
<li>Support multiple schemas</li>
<li>Content model and attributes documentation</li>
<li>Fixes for all bugs reported until 31.03.2004</li>
</ul>
<p>xsddoc-0.3-alpha can be downloaded from
<a target="_blank" href="https://sourceforge.net/project/showfiles.php?group_id=48863">here</a>.</p>
</section>
<section name="Dec. 1, 2003 - xsddoc 0.3 alpha released">
<p>The xframe team is pleased to announce the third alpha release
of the sub project xsddoc, a documentation tool for W3C XML Schema.</p>
<p>This Announcement notes the significant changes in Release 0.3
compared to Release to 0.2:</p>
<ul>
<li>Bugfix: Command line utitliy idependent of Apache Ant </li>
<li>Many bugfixes regarding references between schema components</li>
<li>Bugfix for schemas using default namespace as targetNamespace.</li>
<li>Intermediate XML format in component processing introduced</li>
<li>Revised documentation on our <a href="http://xframe.sourceforge.net/xsddoc.html">xsddoc page</a></li>
</ul>
<p>We expected this release to be the first beta release, but due to the
many changes we decided to keep alpha status till end of this year.
We need more time for exhaustive test on several operating systems as
well as with different JDK's and different version of XalanJ, maby also
with other XSLT processors. As soon as we have a reached a consistent
state without any major open bugs, we will got to beta phase</p>
<p>xsddoc-0.3-alpha can be downloaded from
<a target="_blank" href="https://sourceforge.net/project/showfiles.php?group_id=48863">here</a>.</p>
</section>
<section name="Nov. 5, 2003 - xsddoc 0.2 alpha released">
<p>The xframe team is pleased to announce the second alpha release
of the sub project xsddoc, a documentation tool for W3C XML Schema.</p>
<p>This Announcement notes the significant changes in Release 0.2
compared to Release to 0.1:</p>
<ul>
<li>Apache Ant Task for xsddoc</li>
<li>xslt files as resource</li>
<li>simplified installation</li>
<li>a first brief documentation on our <a href="http://xframe.sourceforge.net/xsddoc.html">xsddoc page</a></li>
<li>several bugs fixed like "file not found" and simmilar configuration problems</li>
</ul>
<p>xsddoc-0.2-alpha can be downloaded from
<a target="_blank" href="https://sourceforge.net/project/showfiles.php?group_id=48863">here</a>.</p>
</section>
<section name="Oct. 20, 2003 - xsddoc 0.1 alpha released">
<p>The xframe team is pleased to announce the first alpha release of
the sub project xsddoca, W3C XML Schema documentation tool.</p>
<p>This Announcement notes the significant changes in 0.1 compared to 0.0.3.</p>
<ul>
<li>full unix support</li>
<li>command line interface</li>
<li>Apache Ant replaced by a small java class</li>
<li>and much better performance by caching all xml and xslt files</li>
</ul>
<p>xsddoc-0.1-alpha can be downloaded from <a target="_blank" href="http://prdownloads.sourceforge.net/xframe/xsddoc-0-1.zip">here</a></p>
</section>
<section name="Oct. 20, 2003 - release 0.0.3 of the xsddoc subproject">
<p>We are getting close to a quite stable alpha version of the xsddoc subproject,
our XML-Schema documentation tool. We have changed the layout to the look and feel
of JavaDoc and included many fixes and extensions on sub- and super-types and
cross-references. The tool is currently fully based on Apache ant and XSLT.
Before we move to alpha status, we want to do some more testing on Linux and Mac,
also with other important schemas like SOAP, WSDL, UDDI and more.</p>
</section>
<section name="Oct. 16, 2003 - xsddoc-0-0-2 releasedt">
<p>generated xml and html files reorganised, also super- and sub-types are shown in context.</p>
</section>
<section name="Oct. 13, 2003 - xsddoc-0-0-1 release">
<p>following the mantra of Open Source software, we decided to release
early and often, so
<a target="_blank" href="http://sourceforge.net/project/showfiles.php?group_id=48863">here</a>
you can download our first pre-alpha release of xsddoc, a Tool to create
documentation for XML Schemas. Currently xsddoc is based on Apache Ant
to create multiple output pages.</p>
</section>
</section>
</body>
</document>
--- NEW FILE: compatibility.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<document>
<properties>
<author email="[email protected]">Kurt Riede</author>
<title>xframe - xsddoc - documentation tool for W3C XML Schemas</title>
</properties>
<meta name="keyword" content="XML, XML Schema, XSLT, DOM, GUI, SWT, Swing, Documentation, Generator, schema based programming, applicatio, business model, mapping, sourceforge, automatic, independent, standard, development, Java, Kurt Riede"/>
<body>
<section name="Compatibility">
<p>xsddoc is compatible and tested with the following Java versions.
We expect it to work with JDK 1.3 or higher:</p>
<ul>
<li>JDK 1.3.1_07</li>
<li>JDK 1.4.2</li>
</ul>
<p>xsddoc is compatible and tested with the following versions of Apache XalanJ:</p>
<ul>
<li>XalanJ 2.4.1</li>
<li>XalanJ 2.5.2</li>
<li>XalanJ 2.6.0 or higher</li>
</ul>
<p>Many XSLT processors either do not support the full W3C recommendation or
have minor bugs. Even XalanJ has bugs with the keys in release 2.5.1.</p>
<p>unfortunately so far we cannot guarantee <code>xsddoc</code> to work with other
XSLT processors or other versions of XalanJ than listed above. Maybe we
will try to rewrite the scripts to be more independent of the XSLT processor.
Post us your feedback, if you need <code>xsddoc</code> to work with another processor.</p>
</section>
</body>
</document>
--- NEW FILE: usage-ant.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<document>
<properties>
<author email="[email protected]">Kurt Riede</author>
<title>xframe - xsddoc - documentation tool for W3C XML Schemas</title>
</properties>
<meta name="keyword" content="XML, XML Schema, XSLT, DOM, GUI, SWT, Swing, Documentation, Generator, schema based programming, applicatio, business model, mapping, sourceforge, automatic, independent, standard, development, Java, Kurt Riede"/>
<body>
<section name="Usage as an Apache Ant task">
<p>At first you should define the xsddoc task in your ant script like this:</p>
<pre><taskdef name="xsddoc" classname="net.sf.xframe.xsddoc.Task"/></pre>
<p>Attributes of the xsddoc task:</p>
<ul>
<li><strong>file</strong> path to location of schema</li>
<li><strong>dir</strong> folder of schemas</li>
<li><strong>out</strong> optional, path to output folder (default: .) </li>
<li><strong>doctitle</strong> optional, descriptibe title of schema </li>
<li><strong>header</strong> Include header text for each page (html-code) (default: no)</li>
<li><strong>footer</strong> Include footer text for each page (html-code) (default: no)</li>
<li><strong>bottom </strong> Include bottom text for each page (html-code) (default: no)</li>
<li><strong>failonerror</strong> Log a warning message, but do not stop the build,
when the file to copy does not exist or one of the
nested filesets points to a directory that doesn't
exist or an error occurs while copying. (default: no)</li>
<li><strong>debug</strong> optional boolean, debug output (default: false)</li>
<li><strong>verbose</strong> optional boolean, verbose output (default: false)</li>
<li><strong>xml</strong> optional boolean, if XML should be generated instead of html for schema components (default: false)</li>
<li><strong>hideSubTypes</strong> optional boolean, if sub types reference should be hidden (default: false)</li>
<li><strong>hideLocalUsage</strong> optional boolean, if local usage reference should be hidden (default: false)</li>
<li><strong>hideTypes</strong> optional boolean, if types should be hidden in overview pages (default: false)</li>
<li><strong>hideGroups</strong> optional boolean, if groups should be hidden in overview pages (default: false)</li>
<li><strong>hideAttributes</strong> optional boolean, if attributes should be hidden in overview pages (default: false)</li>
</ul>
<p>Parameters specified as nested elements:</p>
<p><strong>fileset</strong></p>
<p><a target="_blank" href="http://ant.apache.org/manual/CoreTypes/fileset.html">FileSets</a>
are used to select sets of files to process. Use it instead of the file attribute.</p>
<p><strong>doctitle</strong></p>
<p>Same as the <tt>doctitle</tt> attribute, but you can nest text
inside the element this way.</p>
<p><strong>header</strong></p>
<p>Similar to <tt><doctitle></tt>.</p>
<p><strong>footer</strong></p>
<p>Similar to <tt><doctitle></tt>.</p>
<p><strong>bottom</strong></p>
<p>Similar to <tt><doctitle></tt>.</p>
<p><strong>Example</strong></p>
<pre><target name="xsddocSample">
<mkdir dir="samples/xsddoc/html"/>
<xsddoc file="samples/xsddoc/xsddoc.xsd"
out="samples/xsddoc/html"
doctitle="XML Schema for XML documentation generated by xsddoc"
verbose="true"/>
</target></pre>
</section>
</body>
</document>
--- NEW FILE: install-console.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
This file is part of the xframe software package
hosted at http://xframe.sourceforge.net
Copyright (c) 2003 Kurt Riede.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-->
<document>
<properties>
<author email="[email protected]">Kurt Riede</author>
<title>xframe - xsddoc - documentation tool for W3C XML Schemas</title>
</properties>
<meta name="keyword" content="XML, XML Schema, XSLT, DOM, GUI, SWT, Swing, Documentation, Generator, schema based programming, applicatio, business model, mapping, sourceforge, automatic, independent, standard, development, Java, Kurt Riede"/>
<body>
<section name="Installation of xsddoc as command line tool">
<p>1. extract the <code>xsddoc</code> distribution file to a folder of your
choice.</p>
<p>2. declare an environment variable <code>XSDDOC_HOME</code> and set it to the folder
where you have extracted xsddoc.</p>
<p>3. add the <code>bin</code> folder of <code>xsddoc</code> to your systems path.</p>
<p>Example on UNIX (bash):</p>
<pre>> export XSDDOC_HOME=/usr/local/xsddoc
> export PATH=${XSDDOC_HOME}/bin: ${PATH}</pre>
<p>Example on UNIX (csh):</p>
<pre>> setenv XSDDOC_HOME /usr/local/xsddoc
> set path=( $XSDDOC_HOME/bin $path ) </pre>
<p>Example on Win32:</p>
<pre>> set XSDDOC_HOME=C:\Programs\xframe\xsddoc
> set PATH=%XSDDOC_HOME%;%PATH%</pre>
<p>4. try to build the sample that comes with xsddoc:</p>
<pre>> cd sample/XMLSchems
> mkdir doc
> xsddoc -t "XML Schema for XML Schema" -o doc -verbose XMLSchema.xsd</pre>
</section>
</body>
</document>
-------------------------------------------------------
This SF.Net email is sponsored by: thawte's Crypto Challenge Vl
Crack the code and win a Sony DCRHC40 MiniDV Digital Handycam
Camcorder. More prizes in the weekly Lunch Hour Challenge.
Sign up NOW http://ad.doubleclick.net/clk;10740251;10262165;m