You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by an...@locus.apache.org on 2000/06/23 03:36:47 UTC

cvs commit: xml-xerces/java/docs docs-book.xml faq-general.xml sam-domcount.xml sam-domfilter.xml sam-domwriter.xml sam-treeview.xml samples.xml

andyc       00/06/22 18:36:47

  Modified:    java/docs docs-book.xml faq-general.xml sam-domcount.xml
                        sam-domfilter.xml sam-domwriter.xml
                        sam-treeview.xml samples.xml
  Log:
  Updated documentation.
  
  1) Missing samples pages updated and included (again).
  2) Added download link on jumpbar.
  
  Revision  Changes    Path
  1.6       +10 -0     xml-xerces/java/docs/docs-book.xml
  
  Index: docs-book.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/java/docs/docs-book.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- docs-book.xml	2000/06/01 23:19:45	1.5
  +++ docs-book.xml	2000/06/23 01:36:45	1.6
  @@ -6,10 +6,12 @@
   
     <separator/>
     <document id="index"       label="Readme"       source="readme.xml"      />
  +  <external href="http://xml.apache.org/dist/xerces-j/"  label="Download"/>
     <document id="install"     label="Installation" source="install.xml"     />
   
     <separator/>
     <document id="api"         label="API Docs"     source="api.xml"         />
  +  <!--
     <container id="samples"     label="Samples"      source="samples.xml">
   	<entry  id="domcount"        source="sam-domcount.xml" />
   	<entry  id="domwriter"       source="sam-domwriter.xml"/>
  @@ -18,6 +20,14 @@
   	<entry  id="tree"            source="sam-tree.xml"     />
   	<entry  id="treeview"        source="sam-treeview.xml" />
     </container>
  +  -->
  +  <document id='samples'     label='Samples'      source='samples.xml'/>
  +  <hidden id='domcount' source='sam-domcount.xml'/>
  +  <hidden id="domwriter"       source="sam-domwriter.xml"/>
  +  <hidden id="domfilter"       source="sam-domfilter.xml"/>
  +  <hidden id="iterator"        source="sam-iterator.xml" />
  +  <hidden  id="tree"            source="sam-tree.xml"     />
  +  <hidden  id="treeview"        source="sam-treeview.xml" />
     <document id="schema"      label="Schema"       source="schema.xml"      />
   
     <separator/>
  
  
  
  1.8       +2 -4      xml-xerces/java/docs/faq-general.xml
  
  Index: faq-general.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/java/docs/faq-general.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- faq-general.xml	2000/06/08 18:36:47	1.7
  +++ faq-general.xml	2000/06/23 01:36:46	1.8
  @@ -8,11 +8,9 @@
   		<a>
   			<p>Here are some of the new features in &javaparsername;:</p>
   		     <ul>
  -			     <li>Support for SAX2 final.</li>
   			     <li>Additional support for W3C XML Schema Language.</li>
  -			     <li>Access to DTD information as a DOM Tree.</li>
  -			<li>Inclusion of WML DOM classes.</li>
  -			<li>Support for JAXP.</li>
  +			     <li>DOS filenames no longer work. See Common Problems
  +				section of the FAQ.</li>
   		     </ul>
   	<anchor name="valid"/>
   		</a>
  
  
  
  1.3       +14 -17    xml-xerces/java/docs/sam-domcount.xml
  
  Index: sam-domcount.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/java/docs/sam-domcount.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- sam-domcount.xml	2000/05/23 20:29:00	1.2
  +++ sam-domcount.xml	2000/06/23 01:36:46	1.3
  @@ -30,7 +30,7 @@
   			<li>open up a MS-DOS command line window</li>
   			<li>set the path to the jdk\bin directory</li>
   			<li>change directory to the latest &javaparserdirectory; directory</li>
  -			<li>invoke the <code>SAXCount</code> parser</li>
  +			<li>invoke the <code>SAXCount</code> sample</li>
   		</ol>
   		<p><em>On Windows:</em></p>
   		<p>The easiest way to do this is to create a .bat file using the 
  @@ -38,11 +38,10 @@
   		on the file name or icon. The following command lines assume that 
   		both the jdk and the &javaparserdirectory; directories are located directly below 
   		the c: drive.</p>
  -<source>set path=c:\jdk1.1.8\bin;%PATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;.jar;%CLASSPATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;Samples;%CLASSPATH%
  +<source>set PATH=%PATH%;c:\jdk1.1.8\bin
  +set CLASSPATH=%CLASSPATH%;c:\&javaparserdirectory;\xerces.jar;c:\&javaparserdirectory;\xercesSamples.jar
   cd c:\&javaparserdirectory;
  -java sax.SAXCount data\personal.xml</source>
  +java sax.SAXCount data/personal.xml</source>
   
   		<p><em>Switches:</em></p>
   		<p>SAXCount also allows you to change the default behavior using the 
  @@ -59,10 +58,10 @@
   		<p>Running SAXCount with the default settings is equivalent to 
   		running SAXCount like this (type this in as one long command line): </p>
   <source>java sax.SAXCount -p org.apache.xerces.parsers.SAXParser 
  -    data\personal.xml </source>
  +    data/personal.xml </source>
   		<p>Bringing up the help information: </p>
   <source>java sax.SAXCount -h </source>
  -		<note>Parse your own XML file instead of data\personal.xml</note>
  +		<note>Parse your own XML file instead of data/personal.xml</note>
   	</s2>
   	
   	<s2 title="DOMCount">
  @@ -71,7 +70,7 @@
   			<li>open up a MS-DOS command line window</li>
   			<li>set the path to the jdk\bin directory</li>
   			<li>change directory to the latest &javaparserdirectory; directory</li>
  -			<li>invoke the <code>DOMCount</code> parser</li>
  +			<li>invoke the <code>DOMCount</code> sample</li>
   		</ol>
   		
   		<p><em>On Windows:</em></p>
  @@ -80,33 +79,31 @@
   		on the file name or icon. The following command lines assume that 
   		both the jdk and the &javaparserdirectory; directories are located directly below 
   		the c: dirve.</p>
  -<source>set path=c:\jdk1.1.8\bin;%PATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;.jar;%CLASSPATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;Samples;%CLASSPATH%
  +<source>set PATH=%PATH%;c:\jdk1.1.8\bin
  +set CLASSPATH=%CLASSPATH%;c:\&javaparserdirectory;\xerces.jar;c:\&javaparserdirectory;\xercesSamples.jar
   cd c:\&javaparserdirectory;
  -java dom.DOMCount data\personal.xml</source>
  +java dom.DOMCount data/personal.xml</source>
   
   		<p><em>Switches:</em></p>
   		<p>DOMCount also allows you to change the default behavior via the 
  -		following command line flags (type this in as one long command line): </p>
  +		following command line flags: </p>
   		<ul>
   			<li>-p Specify the parser class to be used.
   			<br/>The available parsers are:</li>
   			<ul>
  -				<li>dom.wrappers.NonValidatingDOMParser</li>
   				<li>dom.wrappers.DOMParser [default parser]</li>
   			</ul>
   			<li>-h Print DOMCount help information. [default is no help]</li>
   		</ul>
   		<p>Running DOMCount with the default settings is equivalent to running 
  -		<code>DOMCount</code> like this: </p>
  +		<code>DOMCount</code> like this (type this in as one long command line): </p>
   
   <source>java dom.DOMCount -p dom.wrappers.DOMParser 
  -    data\personal.xml </source>
  +    data/personal.xml </source>
   		<p>Bringing up the help information: </p>
   <source>java dom.DOMCount -h</source>
   
  -		<note>Parse your own XML file instead of data\personal.xml</note>
  +		<note>Parse your own XML file instead of data/personal.xml</note>
   
   
   	</s2>
  
  
  
  1.3       +8 -10     xml-xerces/java/docs/sam-domfilter.xml
  
  Index: sam-domfilter.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/java/docs/sam-domfilter.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- sam-domfilter.xml	2000/05/23 20:29:01	1.2
  +++ sam-domfilter.xml	2000/06/23 01:36:46	1.3
  @@ -22,7 +22,7 @@
   			<li>open up a MS-DOS command line window</li>
   			<li>set the path to the jdk\bin directory</li>
   			<li>change directory to the latest &javaparserdirectory; directory</li>
  -			<li>invoke the <code>DOMFilter</code> parser</li>
  +			<li>invoke the <code>DOMFilter</code> sample</li>
   		</ol>
   		
   		<p><em>On Windows:</em></p>
  @@ -31,11 +31,10 @@
   		on the file name or icon. The following command lines assume that 
   		both the jdk and the &javaparserdirectory; directories are located directly below 
   		the c: dirve.</p>
  -<source>set path=c:\jdk1.1.8\bin;%PATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;.jar;%CLASSPATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;Samples;%CLASSPATH%
  +<source>set PATH=%PATH%;c:\jdk1.1.8\bin
  +set CLASSPATH=%CLASSPATH%;c:\&javaparserdirectory;\xerces.jar;c:\&javaparserdirectory;\xercesSamples.jar
   cd c:\&javaparserdirectory;
  -java dom.DOMFilter data\personal.xml</source>
  +java dom.DOMFilter data/personal.xml</source>
   
   		<p><em>Switches:</em></p>
   		<p><code>DOMFilter</code> also allows you to change the default behavior using the 
  @@ -44,7 +43,6 @@
   			<li>-p Specify the parser class to be used.
   			<br/>The available parsers are:</li>
   			<ul>
  -				<li>dom.wrappers.NonValidatingDOMParser</li>
   				<li>dom.wrappers.DOMParser [default parser]</li>
   			</ul>
   			<li>-h Print DOMCount help information. [default is no help]</li>
  @@ -58,18 +56,18 @@
   		<code>DOMFilter</code> like this: </p>
   
   <source>java dom.DOMFilter -p dom.wrappers.DOMParser 
  -    data\personal.xml </source>
  +    data/personal.xml </source>
   	
   		<p>Bringing up the help information: </p>
   <source>java dom.DOMFilter -h</source>
   	
   		<p>Searching for elements: </p>
  -<source>java dom.DOMFilter -e family data\personal.xml</source>
  +<source>java dom.DOMFilter -e family data/personal.xml</source>
   	
   		<p>Search for attributes: </p>
  -<source>java dom.DOMFilter -a subordinates data\personal.xml</source>
  +<source>java dom.DOMFilter -a subordinates data/personal.xml</source>
   
  -		<note>Parse your own XML file instead of data\personal.xml</note>
  +		<note>Parse your own XML file instead of data/personal.xml</note>
   
   
   	</s2>
  
  
  
  1.3       +14 -20    xml-xerces/java/docs/sam-domwriter.xml
  
  Index: sam-domwriter.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/java/docs/sam-domwriter.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- sam-domwriter.xml	2000/05/23 20:29:01	1.2
  +++ sam-domwriter.xml	2000/06/23 01:36:46	1.3
  @@ -8,9 +8,6 @@
   		print in a "canonical" XML format so the output can be used to compare 
   		XML documents. SAXWriter and DOMWriter also display any errors or 
   		warnings that occurred during the parse.</p>
  -		<p><code>SAXWriter</code> uses either the validating or non-validating 
  -		SAX parser. <code>DOMWriter</code> uses either the validating or 
  -		non-validating DOM parser. </p>
   		<p><code>DOMWriter</code> provides a -e switch to set the output 
   		Java encoding. </p>
   		<p>The command lines below expect the current directory to be the 
  @@ -33,7 +30,7 @@
   			<li>open up a MS-DOS command line window</li>
   			<li>set the path to the jdk\bin directory</li>
   			<li>change directory to the latest &javaparserdirectory; directory</li>
  -			<li>invoke the <code>SAXWriter</code> parser</li>
  +			<li>invoke the <code>SAXWriter</code> sample</li>
   		</ol>
   		<p><em>On Windows:</em></p>
   		<p>The easiest way to do this is to create a .bat file using the 
  @@ -41,11 +38,10 @@
   		on the file name or icon. The following command lines assume that 
   		both the jdk and the &javaparserdirectory; directories are located directly below 
   		the c: drive.</p>
  -<source>set path=c:\jdk1.1.8\bin;%PATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;.jar;%CLASSPATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;Samples;%CLASSPATH%
  +<source>set PATH=%PATH%;c:\jdk1.1.8\bin
  +set CLASSPATH=%CLASSPATH%;c:\&javaparserdirectory;\xerces.jar;c:\&javaparserdirectory;\xercesSamples.jar
   cd c:\&javaparserdirectory;
  -java sax.SAXWriter data\personal.xml</source>
  +java sax.SAXWriter data/personal.xml</source>
   
   		<p><em>Switches:</em></p>
   		<p>SAXCount also allows you to change the default behavior using the 
  @@ -62,15 +58,15 @@
   		<p>Running <code>SAXWriter</code> with the default settings is equivalent to 
   		running <code>SAXWriter</code> like this (type this in as one long command line): </p>
   <source>java sax.SAXWriter -p org.apache.xerces.parsers.SAXParser 
  -    data\personal.xml </source>
  +    data/personal.xml </source>
   	
   		<p>Bringing up the help information: </p>
   <source>java sax.SAXWriter -h </source>
   
   		<p>Print in canonical format: </p>
  -<source>java sax.SAXWriter -c  data\personal.xml</source>
  +<source>java sax.SAXWriter -c  data/personal.xml</source>
   
  -		<note>Parse your own XML file instead of data\personal.xml</note>
  +		<note>Parse your own XML file instead of data/personal.xml</note>
   	</s2>
   	
   	<s2 title="DOMWriter">
  @@ -79,7 +75,7 @@
   			<li>open up a MS-DOS command line window</li>
   			<li>set the path to the jdk\bin directory</li>
   			<li>change directory to the latest &javaparserdirectory; directory</li>
  -			<li>invoke the <code>DOMWriter</code> parser</li>
  +			<li>invoke the <code>DOMWriter</code> sample</li>
   		</ol>
   		
   		<p><em>On Windows:</em></p>
  @@ -88,11 +84,10 @@
   		on the file name or icon. The following command lines assume that 
   		both the jdk and the &javaparserdirectory; directories are located directly below 
   		the c: dirve.</p>
  -<source>set path=c:\jdk1.1.8\bin;%PATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;.jar;%CLASSPATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;Samples;%CLASSPATH%
  +<source>set PATH=%PATH%;c:\jdk1.1.8\bin
  +set CLASSPATH=%CLASSPATH%;c:\&javaparserdirectory;\xerces.jar;c:\&javaparserdirectory;\xercesSamples.jar
   cd c:\&javaparserdirectory;
  -java dom.DOMWriter data\personal.xml</source>
  +java dom.DOMWriter data/personal.xml</source>
   
   		<p><em>Switches:</em></p>
   		<p>DOMCount also allows you to change the default behavior via the 
  @@ -101,7 +96,6 @@
   			<li>-p Specify the parser class to be used.
   			<br/>The available parsers are:</li>
   			<ul>
  -				<li>dom.wrappers.NonValidatingDOMParser</li>
   				<li>dom.wrappers.DOMParser [default parser]</li>
   			</ul>
   			<li>-h Print DOMWriter help information. [default is no help]</li>
  @@ -112,13 +106,13 @@
   		<code>DOMWriter</code> like this: </p>
   
   <source>java dom.DOMWriter -p dom.wrappers.DOMParser 
  -    data\personal.xml </source>
  +    data/personal.xml </source>
   	
   		<p>Bringing up the help information: </p>
   <source>java dom.DOMWriter -h</source>
   
   		<p>Searching for elements: </p>
  -<source>java dom.DOMWriter -c data\personal.xml</source>
  +<source>java dom.DOMWriter -c data/personal.xml</source>
   
   		<p>Running DOMWriter with the -e switch and no encoding specified 
   		will print out a list of valid encoding names: </p>
  @@ -146,7 +140,7 @@
     MacSymbol MacThai MacTurkish MacUkraine SJIS Unicode 
     UnicodeBig UnicodeLittle UTF8</source>
   
  -		<note>Parse your own XML file instead of data\personal.xml</note>
  +		<note>Parse your own XML file instead of data/personal.xml</note>
   
   
   	</s2>
  
  
  
  1.3       +10 -12    xml-xerces/java/docs/sam-treeview.xml
  
  Index: sam-treeview.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/java/docs/sam-treeview.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- sam-treeview.xml	2000/05/23 20:29:04	1.2
  +++ sam-treeview.xml	2000/06/23 01:36:46	1.3
  @@ -30,7 +30,7 @@
   			<li>open up a MS-DOS command line window</li>
   			<li>set the path to the jdk\bin directory</li>
   			<li>change directory to the latest &javaparserdirectory; directory</li>
  -			<li>invoke the <code>TreeViewer</code> parser</li>
  +			<li>invoke the <code>TreeViewer</code> sample</li>
   		</ol>
   		
   		<p><em>On Windows:</em></p>
  @@ -38,25 +38,23 @@
   		Notepad editor. Then <code>TreeViewer</code> can be invoked by double clicking 
   		on the file name or icon. The following command lines assume that 
   		both the jdk and the &javaparserdirectory; directories are located directly below 
  -		the c: dirve.</p>
  +		the c: drive.</p>
   		
   		<p><em>With jdk1.1.8:</em></p>
  -<source>set path=c:\jdk1.1.8\bin;%PATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;.jar;%CLASSPATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;Samples;%CLASSPATH%;
  -set classpath=c:\Swing-1.1.1\swingall.jar;%CLASSPATH%;
  +<source>set PATH=%PATH%;c:\jdk1.1.8\bin
  +set CLASSPATH=%CLASSPATH%;c:\&javaparserdirectory;\xerces.jar;c:\&javaparserdirectory;\xercesSamples.jar
  +set CLASSPATH=%CLASSPATH%;c:\Swing-1.1.1\swingall.jar
   cd c:\&javaparserdirectory;
  -java dom.TreeViewer data\personal.xml</source>
  +java dom.TreeViewer data/personal.xml</source>
   		
   		<p><em>With jdk1.2.2:</em></p>
   		<p>Swing is included in the Java 2 release and it doesn't required 
   		a separate reference. </p>
  -<source>set path=c:\jdk1.2.2\bin;%PATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;.jar;%CLASSPATH%
  -set classpath=c:\&javaparserdirectory;\&javaparserdirectory;Samples;%CLASSPATH%;
  +<source>set PATH=%PATH%;c:\jdk1.2.2\bin
  +set CLASSPATH=%CLASSPATH%;c:\&javaparserdirectory;\xerces.jar;c:\&javaparserdirectory;\xercesSamples.jar
   cd c:\&javaparserdirectory;
  -java dom.TreeViewer data\personal.xml</source>
  +java dom.TreeViewer data/personal.xml</source>
   
  -		<note>Parse your own XML file instead of data\personal.xml</note>
  +		<note>Parse your own XML file instead of data/personal.xml</note>
   	</s2>
   </s1>
  
  
  
  1.7       +2 -7      xml-xerces/java/docs/samples.xml
  
  Index: samples.xml
  ===================================================================
  RCS file: /home/cvs/xml-xerces/java/docs/samples.xml,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- samples.xml	2000/05/23 20:29:04	1.6
  +++ samples.xml	2000/06/23 01:36:46	1.7
  @@ -3,8 +3,6 @@
   
   <s1 title="Samples">
   	<s2 title="Introduction">
  -		<p>There are two new samples to test and demonstrate the new DOM2 
  -		Traversal implementation: </p>
   		<ul>
   			<li><link idref="domcount">DOMCount</link></li>
   			<li><link idref="domcount">SAXCount</link></li>
  @@ -43,7 +41,6 @@
   		along with counts of elements, attributes, text characters, and ignorable 
   		whitespace characters. DOMCount displays errors and 
   		warnings that occur during parsing.</p>
  -		<p>DOMCount uses either the validating or non-validating DOM parser.</p>
   	</s2>
   	
   	<s2 title="SAXCount Sample">
  @@ -52,7 +49,6 @@
   		along with counts of elements, attributes, text characters, and 
   		ignorable whitespace characters. SAXCount displays errors and 
   		warnings that occur during parsing.</p>
  -		<p>SAXCount uses either the validating or non-validating SAX parser.</p>
   	</s2>
   	
   	<s2 title="DOMWriter Sample">
  @@ -61,7 +57,7 @@
   		The command line option, -c, is used to print files  in 
   		"canonical" XML format, so that two XML documents can be compared. 
   		They also display any errors or warnings that occurred during the 
  -		parse. DOMWriter uses either the validating or non-validating DOM parser. 
  +		parse.
   		DOMWriter also provides a feature to set the output Java encoding 
   		through the -e switch.</p>
   	</s2>
  @@ -71,8 +67,7 @@
   		prints it out in XML format. The command 
   		line option, -c, is used to print files  in "canonical" XML format, 
   		so that two XML documents can be compared. They also display any 
  -		errors or warnings that occurred during the parse. SAXWriter uses 
  -		either the validating or non-validating SAX parser.</p>
  +		errors or warnings that occurred during the parse.</p>
   	</s2>
   	
   	<s2 title="DOMFilter Sample">