From ebd1d6e28dc25750b80e810c6411ddcef1906e00 Mon Sep 17 00:00:00 2001 From: Peter Reilly Date: Thu, 10 Mar 2005 13:01:55 +0000 Subject: [PATCH] some fixes to align examples git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@277869 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/CoreTasks/echo.html | 2 +- docs/manual/CoreTasks/genkey.html | 13 ++++++----- docs/manual/CoreTasks/java.html | 9 +++++--- docs/manual/CoreTasks/mail.html | 32 ++++++++++++++++---------- docs/manual/CoreTasks/style.html | 21 +++++++++++------ docs/manual/CoreTasks/tar.html | 20 ++++++++++------- docs/manual/CoreTasks/unzip.html | 35 +++++++++++++---------------- docs/manual/CoreTasks/waitfor.html | 36 +++++++++++++++--------------- 8 files changed, 93 insertions(+), 75 deletions(-) diff --git a/docs/manual/CoreTasks/echo.html b/docs/manual/CoreTasks/echo.html index 6e80645c1..8f4303c26 100644 --- a/docs/manual/CoreTasks/echo.html +++ b/docs/manual/CoreTasks/echo.html @@ -86,7 +86,7 @@ A message which appears even in -quiet mode. 
<echo file="runner.csh" append="false">#\!/bin/tcsh
 java-1.3.1 -mx1024m ${project.entrypoint} $$*
-
+</echo> Generate a shell script by echoing to a file. Note the use of a double $ symbol to stop Ant filtering out the single $ during variable expansion diff --git a/docs/manual/CoreTasks/genkey.html b/docs/manual/CoreTasks/genkey.html index dcd349ce7..3095d44ce 100644 --- a/docs/manual/CoreTasks/genkey.html +++ b/docs/manual/CoreTasks/genkey.html @@ -86,20 +86,21 @@ with "\,".

The following two examples are identical:

Examples

-
-

<genkey alias="apache-group" storepass="secret" - dname="CN=Ant Group, OU=Jakarta Division, O=Apache.org, C=US"/>

-
+
+<genkey alias="apache-group" storepass="secret" 
+  dname="CN=Ant Group, OU=Jakarta Division, O=Apache.org, C=US"/>
+
- 
<genkey alias="apache-group" storepass="secret" >
+  
+<genkey alias="apache-group" storepass="secret" >
   <dname>
     <param name="CN" value="Ant Group"/>
     <param name="OU" value="Jakarta Division"/>
     <param name="O"  value="Apache.Org"/>
     <param name="C"  value="US"/>
   </dname>
-</genkey>

+</genkey>

Copyright © 2000-2001,2003,2005 Apache Software Foundation. All rights diff --git a/docs/manual/CoreTasks/java.html b/docs/manual/CoreTasks/java.html index 672535640..7f6d85ffb 100644 --- a/docs/manual/CoreTasks/java.html +++ b/docs/manual/CoreTasks/java.html @@ -302,7 +302,8 @@ to the JAR file. Run a class in this JVM with a new jar on the classpath -

        <java jar="dist/test.jar"
+
+       <java jar="dist/test.jar"
            fork="true"
            failonerror="true"
            maxmemory="128m"
@@ -318,7 +319,8 @@ Run the JAR test.jar in this project's dist/lib directory.
 using the manifest supplied entry point, forking (as required),
 and with a maximum memory of 128MB. Any non zero return code breaks the build.
 
-
        <java
+
+       <java
            dir="${exec.dir}"
            jar="${exec.dir}/dist/test.jar"
            fork="true"
@@ -339,7 +341,8 @@ is to start up.
 
 
 
  <java classname="test.Main"/>

-
  <java classname="test.Main"
+
+  <java classname="test.Main"
         fork="yes" >
     <sysproperty key="DEBUG" value="true"/>
     <arg value="-h"/>
diff --git a/docs/manual/CoreTasks/mail.html b/docs/manual/CoreTasks/mail.html
index acf23fcae..11a66dd7e 100644
--- a/docs/manual/CoreTasks/mail.html
+++ b/docs/manual/CoreTasks/mail.html
@@ -10,18 +10,26 @@
 
 
Mail

 
Description

-
A task to send SMTP email.




-This task can send mail using either plain
-text, UU encoding, or MIME format mail, depending on what is available.




-

-SMTP auth and SSL/TLS require JavaMail and are only available in MIME format.




-Attachments may be sent using nested
-fileset elements.

-
Note: This task may depend on external libraries
-that are not included
-in the Ant distribution.  See 
-Library Dependencies for more information.
-

+  

+    A task to send SMTP email.
+  

+  

+    This task can send mail using either plain
+    text, UU encoding, or MIME format mail, depending on what is available.
+  

+  

+    SMTP auth and SSL/TLS require JavaMail and are only available in MIME format.
+  

+  

+    Attachments may be sent using nested
+    fileset elements.
+  

+  

+    Note: This task may depend on external libraries
+    that are not included in the Ant distribution. 
+    See Library Dependencies
+    for more information.
+  

 
 
Parameters

 
diff --git a/docs/manual/CoreTasks/style.html b/docs/manual/CoreTasks/style.html
index 8e54191c6..2c64baa74 100644
--- a/docs/manual/CoreTasks/style.html
+++ b/docs/manual/CoreTasks/style.html
@@ -306,7 +306,8 @@ attribute.

 <style basedir="doc" destdir="build/doc"
        extension=".html" style="style/apache.xsl"/>
Using an xmlcatalog

-  
<xslt basedir="doc" destdir="build/doc"
+  
+<xslt basedir="doc" destdir="build/doc"
       extension=".html" style="style/apache.xsl">
   <xmlcatalog refid="mycatalog"/>
 </xslt>
@@ -318,9 +319,11 @@ attribute.

          publicId="-//ArielPartners//DTD XML Article V1.0//EN"
          location="com/arielpartners/knowledgebase/dtd/article.dtd"/>
    </xmlcatalog>
-</xslt>

+</xslt>
+
Using XSL parameters

-
<xslt basedir="doc" destdir="build/doc"
+
+<xslt basedir="doc" destdir="build/doc"
       extension=".html" style="style/apache.xsl">
   <param name="date" expression="07-01-2000"/>
 </xslt>

@@ -331,16 +334,19 @@ attribute.

   

 
   
Using output properties

-
<xslt in="doc.xml" out="build/doc/output.xml"
+
+<xslt in="doc.xml" out="build/doc/output.xml"
       style="style/apache.xsl">
   <outputproperty name="method" value="xml";/>
   <outputproperty name="standalone" value="yes"/>
   <outputproperty name="encoding" value="iso8859_1"/>
   <outputproperty name="indent" value="yes"/>
-</xslt>

+</xslt>
+

 
   
Using factory settings

-
<xslt in="doc.xml" out="build/doc/output.xml"
+
+<xslt in="doc.xml" out="build/doc/output.xml"
       style="style/apache.xsl">
   <factory name="org.apache.xalan.processor.TransformerFactoryImpl">
     <attribute name="http://xml.apache.org/xalan/features/optimize" value="true"/>
@@ -348,7 +354,8 @@ attribute.

 </xslt>

 
   
Using a mapper

-
<xslt basedir="in" destdir="out"
+
+<xslt basedir="in" destdir="out"
       style="style/apache.xsl">
   <mapper type="glob" from="*.xml.en" to="*.html.en"/>
 </xslt>

diff --git a/docs/manual/CoreTasks/tar.html b/docs/manual/CoreTasks/tar.html
index 56256f592..d9554ee07 100644
--- a/docs/manual/CoreTasks/tar.html
+++ b/docs/manual/CoreTasks/tar.html
@@ -182,15 +182,17 @@ attributes
 

   
   

 
 
Examples

-
  <tar tarfile="${dist}/manual.tar" basedir="htdocs/manual"/>
-  <gzip zipfile="${dist}/manual.tar.gz" src="${dist}/manual.tar"/>

+
+<tar tarfile="${dist}/manual.tar" basedir="htdocs/manual"/>
+<gzip zipfile="${dist}/manual.tar.gz" src="${dist}/manual.tar"/>

 
tars all files in the htdocs/manual directory into a file called manual.tar
 in the ${dist}  directory, then applies the gzip task to compress
 it.

-
  <tar destfile="${dist}/manual.tar"
-       basedir="htdocs/manual"
-       excludes="mydocs/**, **/todo.html"
-  />

+
+<tar destfile="${dist}/manual.tar"
+      basedir="htdocs/manual"
+      excludes="mydocs/**, **/todo.html"
+/>

 
tars all files in the htdocs/manual directory into a file called manual.tar
 in the ${dist} directory. Files in the directory mydocs,
 or files with the name todo.html are excluded.

@@ -219,7 +221,8 @@ or files with the name todo.html are excluded.

 

 
 
-
<tar longfile="gnu"
+
+<tar longfile="gnu"
      destfile="${dist.base}/${dist.name}-src.tar" >
   <tarfileset dir="${dist.name}/.." mode="755" username="ant" group="ant">
     <include name="${dist.name}/bootstrap.sh"/>
@@ -230,7 +233,8 @@ or files with the name todo.html are excluded.

     <exclude name="${dist.name}/bootstrap.sh"/>
     <exclude name="${dist.name}/build.sh"/>
   </tarfileset>
-</tar> 

+</tar>
+

 
 
This example shows building a tar which uses the GNU extensions for long paths and
 where some files need to be marked as executable (mode 755)
diff --git a/docs/manual/CoreTasks/unzip.html b/docs/manual/CoreTasks/unzip.html
index 0c798354e..6b6144c1b 100644
--- a/docs/manual/CoreTasks/unzip.html
+++ b/docs/manual/CoreTasks/unzip.html
@@ -70,17 +70,15 @@ to perform unarchival upon.
 
 
 
Examples

-

-  
<unzip src="${tomcat_src}/tools-src.zip" dest="${tools.home}"/>

-

-

-  

-<gunzip src="tools.tar.gz"/>

+
+<unzip src="${tomcat_src}/tools-src.zip" dest="${tools.home}"/>
+

+

+
+<gunzip src="tools.tar.gz"/>
 <untar src="tools.tar" dest="${tools.home}"/>
-

-

-

-
+

+
 <unzip src="${tomcat_src}/tools-src.zip"
        dest="${tools.home}">
     <patternset>
@@ -88,10 +86,9 @@ to perform unarchival upon.
         <exclude name="**/Test*.java"/>
     </patternset>
 </unzip>
-

-

-

-
+

+

+
 <unzip dest="${tools.home}">
     <patternset>
         <include name="**/*.java"/>
@@ -102,18 +99,16 @@ to perform unarchival upon.
         <exclude name="**/tmp*.zip"/>
     </fileset>
 </unzip>
-

-

-

-
+

+

+
 <unzip src="apache-ant-bin.zip" dest="${tools.home}">
     <patternset>
         <include name="apache-ant/lib/ant.jar"/>
     </patternset>
     <mapper type="flatten"/>
 </unzip>
-

-

+

 

 
Copyright © 2000-2005 The Apache Software Foundation. All rights
 Reserved.

diff --git a/docs/manual/CoreTasks/waitfor.html b/docs/manual/CoreTasks/waitfor.html
index 700d57456..e03a379a4 100644
--- a/docs/manual/CoreTasks/waitfor.html
+++ b/docs/manual/CoreTasks/waitfor.html
@@ -86,27 +86,27 @@ true within the specified time.

 here for the full list.

 
 
Examples

-

-  
<waitfor maxwait="30" maxwaitunit="second">

-        <available file="errors.log"/>

-    </waitfor>

-

+
+<waitfor maxwait="30" maxwaitunit="second">
+        <available file="errors.log"/>
+</waitfor>
+

 
waits up to 30 seconds for a file called errors.log to appear.

-

-  
<waitfor maxwait="3" maxwaitunit="minute" checkevery="500">

-        <http url="http://localhost/myapp/index.html"/>

-    </waitfor>

-

+
+<waitfor maxwait="3" maxwaitunit="minute" checkevery="500">
+        <http url="http://localhost/myapp/index.html"/>
+</waitfor>
+

 
waits up to 3 minutes (and checks every 500 milliseconds) for a web server on localhost
   to serve up the specified URL.

-

-  
<waitfor maxwait="10" maxwait="second">

-        <and>

-            <socket server="dbserver" port="1521"/>

-            <http url="http://webserver/mypage.html"/>

-        </and>

-    </waitfor>

-

+
+<waitfor maxwait="10" maxwait="second">
+        <and>
+            <socket server="dbserver" port="1521"/>
+            <http url="http://webserver/mypage.html"/>
+        </and>
+</waitfor>
+

 
waits up to 10 seconds for a server on the dbserver machine to begin listening
   on port 1521 and for the http://webserver/mypage.html web page
   to become available.