[bvalid-codewatch] SF.net SVN: bvalid: [21] trunk
Status: Beta
Brought to you by:
cwilper
Menu
▾
▴
[bvalid-codewatch] SF.net SVN: bvalid: [21] trunk
|
From: <cw...@us...> - 2006-05-01 12:15:21
|
Revision: 21 Author: cwilper Date: 2006-05-01 05:15:11 -0700 (Mon, 01 May 2006) ViewCVS: http://svn.sourceforge.net/bvalid/?rev=21&view=rev Log Message: ----------- added doc target + docs Modified Paths: -------------- trunk/build.xml Added Paths: ----------- trunk/src/doc/ trunk/src/doc/index.html trunk/src/doc/style.css Modified: trunk/build.xml =================================================================== --- trunk/build.xml 2006-05-01 10:17:53 UTC (rev 20) +++ trunk/build.xml 2006-05-01 12:15:11 UTC (rev 21) @@ -96,13 +96,16 @@ <target name="doc" depends="prep" description="Build the documentation in dist/doc"> - <javadoc packagenames="net.sf.bvalid.*" + <copy todir="dist/doc"> + <fileset dir="src/doc"/> + </copy> + <javadoc packagenames="net.sf.bvalid, net.sf.bvalid.locator, net.sf.bvalid.catalog, net.sf.bvalid.util" classpathref="compile.path" sourcepath="src/java" defaultexcludes="yes" destdir="dist/doc/api" - windowtitle="BValid Javadocs"> - <doctitle><![CDATA[<h1>BValid Javadocs</h1>]]></doctitle> + windowtitle="BValid Java API"> + <doctitle><![CDATA[<h1>BValid Java API</h1>]]></doctitle> </javadoc> </target> Added: trunk/src/doc/index.html =================================================================== --- trunk/src/doc/index.html (rev 0) +++ trunk/src/doc/index.html 2006-05-01 12:15:11 UTC (rev 21) @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US" lang="en-US"> +<head> + <title>BValid XML Validation API</title> + <link rel="stylesheet" type="text/css" href="style.css" /> +</head> + +<body> +<div id="header"> + <div id="title"> + <h2>BValid XML Validation API</h2> + <h2>User Guide</h2> + </div> +</div> + +<div class="toc"> + <h2>Contents</h2> + <div class="tocbox"> + + <ol> + <li><a href="#intro">Introduction</a></li> + <li><a href="#api">The Java API</a></li> + <li><a href="#cmdline">The Unix/Windows Command-Line Utility</a></li> + </ol> + </div> +</div> + +<div class="sec2"> + <h2><a name="intro">1. Introduction</a></h2> + <p> + BValid is a Java API designed for high-performance validation of XML documents. + It defines and implements several interfaces to make validation flexible + and consistent across schema languages. + </p> +<!-- <div class="code"><pre>C:\fedora-2.1.1><b> fedora-setup no-ssl-authenticate-apim</b></pre></div> --> +</div> + +<div class="sec2"> + <h2><a name="api">2. The Java API</a></h2> + <p> + The main interface you work with is the <code>Validator</code>. + </p> +</div> + +<div class="sec2"> + <h2><a name="cmdline">3. The Unix/Windows Command-Line Utility</a></h2> + <p> + The <code>bvalid</code> command-line utility is a simple application of the API that + can be used for validating a single XML document at a time. + </p> + <div class="code"><pre>Usage: bvalid [OPTIONS] LANG XMLFILE + Or: bvalid --version + Or: bvalid --help + +Where: + LANG a supported schema language, such as xsd + XMLFILE the path to the instance file to validate + +Options: + -cf, --cache-files Cache schema files locally + -co, --cache-objects Cache parsed grammar objects in memory + -am, --allow-missing Allow missing referenced schemas. If the instance + includes references to schemas that can't be found, + this will skip them rather than failing validation. + --repeat=n Repeat the validation n times (for testing) + --schema=file Use the given schema file (url or filename) + -v, --version Print version and exit (exclusive option) + -h, --help Print help and exit (exclusive option)</pre></div> +</div> + +<div id="footer"> + <div id="copyright"> + Copyright © 2006 + </div> + + <div id="lastModified"> + Last Modified <script type="text/javascript"> + //<![CDATA[ + var cvsDate = "$Date: 2006/05/01 01:11:27 $"; + var parts = cvsDate.split(" "); + var modifiedDate = parts[1]; + document.write(modifiedDate); + //]]> + </script> + </div> +</div> +</body> +</html> Property changes on: trunk/src/doc/index.html ___________________________________________________________________ Name: svn:executable + * Added: trunk/src/doc/style.css =================================================================== --- trunk/src/doc/style.css (rev 0) +++ trunk/src/doc/style.css 2006-05-01 12:15:11 UTC (rev 21) @@ -0,0 +1,183 @@ +/* + * Stylesheet for documentation. + */ + +body { + background-color: #ffffff; + margin: 20px; + font-family: Arial, Helvetica, sans-serif; + font-size: 12pt; + line-height: 15pt; + color: #000000; +} + +#header { + border-bottom: 1px solid; + clear: both; + margin-bottom: 10px; + min-height: 70px; + width: 100%; +} + +#logo { + background-image: url(images/logo_44x60.gif); + background-repeat: no-repeat; + background-position: top left; + + float: left; + height: 60px; + width: 44px; + visibility: visible; +} + +#title { + text-align: center; +} + +#toc { + width: 50%; + margin-bottom: 10px; +} + +#tocbox { + border: 1px solid; + padding-left: 4px; + padding-right: 4px; +} + +#tocbox ol { + list-style: decimal outside none; +} + +#tocbox ol ol { + list-style: upper-alpha outside none; +} + +#tocbox ol ol ol{ + list-style: decimal outside none; +} + +#introduction, #references, .sect { + margin-bottom: 5px; +} + +.sect .subsect { + margin-left: 20px; + margin-bottom: 5px; +} + +#references dl { + margin-left: 20px; + margin-right: 20px; +} + +#references dt { + margin-top: 10px; +} + +#footer { + border-top: 1px solid; + margin-top: 20px; + padding-top: 8px; +} + +#footer #copyright, #lastModified { + color: #4C7C8E; +} + +#footer #copyright { + float: left; +} + +#footer #lastModified { + float: right; +} + +/* FIXME: Make these sort of match the Category4 stuff, + but still be appropriate for documentation */ + +h1, h2, h3 { + color: #4C7C8E; + margin-top: 4px; + margin-bottom: 4px; +} + +h4, h5 { + color: #4C7C8E; + margin-top: 2px; + margin-bottom: 2px; + text-decoration: underline; +} + +h1 { + font-size: 24pt; + line-height: 110%; + padding-top: 8px; + padding-bottom: 4px; +} + +h2 { + font-size: 18pt; +} + +h3 { + font-size: 14pt; +} + +h4 { + font-size: 13pt; +} + +h5 { + font-size: 12pt; +} + +h2, h3, h4, h5 { + padding-top: 4px; + padding-bottom: 4px; +} + +p { + padding-top: 4px; + padding-bottom: 4px; + margin: 0px; +} + +.code { + background: #ddddff; + border: thin solid #000000; + font-family: Lucida Console, Courier New, Courier, monospace; + margin: 5px 5px 5px 5px; + min-width: 600px; + padding: 5px; + white-space: pre; +} + +.reference { + text-decoration: none; +} + + + +#relnotes ol { + margin-left: 20px; + padding-left: 0px; +} + +#relnotes ol li { + margin-top: 10px; + color: #4C7C8E; + font-size: 18pt; +} + +#relnotes ol li p { + color: #000000; + font-size: 12pt; +} + +#relnotes ol li ul li { + margin-top: 2px; + color: #000000; + font-size: 12pt; +} + Property changes on: trunk/src/doc/style.css ___________________________________________________________________ Name: svn:executable + * This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
