ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hol...@apache.org
Subject cvs commit: jakarta-ant/docs/manual/CoreTypes filterset.html
Date Mon, 25 Mar 2002 20:21:11 GMT
holtdl      02/03/25 12:21:11

  Modified:    docs/manual/CoreTypes filterset.html
  Log:
  Fix examples so they don't get filtered when we gen the
  release (PR #7450).  Other minor edits.
  
  Revision  Changes    Path
  1.6       +35 -28    jakarta-ant/docs/manual/CoreTypes/filterset.html
  
  Index: filterset.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTypes/filterset.html,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- filterset.html	3 Feb 2002 22:11:39 -0000	1.5
  +++ filterset.html	25 Mar 2002 20:21:11 -0000	1.6
  @@ -6,14 +6,19 @@
   </HEAD>
   
   <BODY>
  -<H2><A name="fileset">Filterset</A></H2>
  +<H2><A name="filterset">FilterSet</A></H2>
   
  -<P>FilterSets are groups of filters. Filters can be defined as token value pairs

  +<P>FilterSets are groups of filters. Filters can be defined as token-value
  +pairs 
   or be read in from a file. FilterSets can appear inside tasks that support this 
  -feature or at the same level as <CODE>target</CODE> - i.e., as children of

  -<CODE>project</CODE>.</P>In addition, Filtersets can have begintoken
and/or 
  -endtoken attributes to define what to match. <BR>Filtersets are used for doing 
  -replacements in tasks like copy etc.<BR>
  +feature or at the same level as <CODE>&lt;target&gt;</CODE> - i.e.,
as
  +children of 
  +<CODE>&lt;project&gt;</CODE>.</P>
  +<p>In addition, FilterSets can specify
  +<code>begintoken</code> and/or 
  +<code>endtoken</code> attributes to define what to match.</p>
  +<p>Filtersets are used for doing 
  +replacements in tasks such as <code>&lt;copy&gt;</code>, etc.</p>
   
   <H2>Filterset</H2>
   
  @@ -26,15 +31,15 @@
     </TR>
     <TR>
       <TD vAlign=top>begintoken</TD>
  -    <TD vAlign=top>The string marking the beginning of a token. eg 
  -      <STRONG>@</STRONG>Date@</TD>
  +    <TD vAlign=top>The string marking the beginning of a token (eg.,
  +      <code>@date@</code>).</TD>
       <TD vAlign=top>@</TD>
       <TD vAlign=top align="center">No</TD>
     </TR>
     <TR>
       <TD vAlign=top>endtoken</TD>
  -    <TD vAlign=top>The string marking the end of a token. eg 
  -      @Date<STRONG>@</STRONG></TD>
  +    <TD vAlign=top>The string marking the end of a token (eg.,
  +      <code>@date@</code>).</TD>
       <TD vAlign=top>@</TD>
       <TD vAlign=top align="center">No</TD>
     </TR>
  @@ -49,12 +54,13 @@
     </TR>
     <TR>
       <TD vAlign=top>token</TD>
  -    <TD vAlign=top>The token to replace eg @<STRONG>Date</STRONG>@</TD>
  +    <TD vAlign=top>The token to replace (eg., <code>@date@</code>)</TD>
       <TD vAlign=top align="center">Yes</TD>
     </TR>
     <TR>
       <TD vAlign=top>value</TD>
  -    <TD vAlign=top>The value to replace it with eg Thursday, April 26, 2001</TD>
  +    <TD vAlign=top>The value to replace it with
  +     (eg., <code>Thursday, April 26, 2001</code>).</TD>
       <TD vAlign=top align="center">Yes</TD>
     </TR>
   </TABLE>
  @@ -68,48 +74,49 @@
     </TR>
     <TR>
       <TD vAlign=top>file</TD>
  -    <TD vAlign=top>The file to load tokens from should be a properties file of 
  -      name value pairs.</TD>
  +    <TD vAlign=top>A properties file of 
  +      name-value pairs from which to load the tokens.</TD>
       <TD vAlign=top align="center">Yes</TD>
     </TR>
   </TABLE>
   
   <H4>Examples</H4>
   
  -<p>You are copying the version.txt file to the dist directory from the build directory

  -but wish to replace the token @DATE@ with todays date.</p>
  +<p>You are copying the <code>version.txt</code> file to the <code>dist</code>
  +directory from the <code>build</code> directory 
  +but wish to replace the token <code>@date@</code> with today's date.</p>
   <BLOCKQUOTE><PRE>
  -&lt;copy file=&quot;${build.home}/version.txt&quot; toFile=&quot;${dist.home}/version.txt&quot;&gt;
  +&lt;copy file=&quot;${build.dir}/version.txt&quot; toFile=&quot;${dist.dir}/version.txt&quot;&gt;
     &lt;filterset&gt;
  -    &lt;filter token=&quot;DATE&quot; value=&quot;${DATE}&quot;/&gt;
  +    &lt;filter token=&quot;date&quot; value=&quot;${TODAY}&quot;/&gt;
     &lt;/filterset&gt;
   &lt;/copy&gt;
   </PRE></BLOCKQUOTE>
   
  -<p>You are copying the version.txt file to the dist directory from the build directory

  -but wish to replace the token %DATE* with todays date.</p>
  +<p>You are copying the <code>version.txt</code> file to the <code>dist</code>
  +directory from the build directory 
  +but wish to replace the token <code>%date*</code> with today's date.</p>
   <BLOCKQUOTE><PRE>
  -&lt;copy file=&quot;${build.home}/version.txt&quot; toFile=&quot;${dist.home}/version.txt&quot;&gt;
  +&lt;copy file=&quot;${build.dir}/version.txt&quot; toFile=&quot;${dist.dir}/version.txt&quot;&gt;
     &lt;filterset begintoken=&quot;%&quot; endtoken=&quot;*&quot;&gt;
  -    &lt;filter token=&quot;DATE&quot; value=&quot;${DATE}&quot;/&gt;
  +    &lt;filter token=&quot;date&quot; value=&quot;${TODAY}&quot;/&gt;
     &lt;/filterset&gt;
   &lt;/copy&gt;
   </PRE></BLOCKQUOTE>
   
   <p>Copy all the docs but change all dates and appropriate notices as stored in a
file.</p>
   <BLOCKQUOTE><PRE>
  -&lt;copy toDir=&quot;${dist.home}/docs&quot; &gt;
  -  &lt;fileset dir=&quot;${build.home}/docs&quot;&gt;
  +&lt;copy toDir=&quot;${dist.dir}/docs&quot; &gt;
  +  &lt;fileset dir=&quot;${build.dir}/docs&quot;&gt;
       &lt;include name=&quot;**/*.html&quot;&gt;
     &lt;/fileset&gt;
     &lt;filterset begintoken=&quot;%&quot; endtoken=&quot;*&quot;&gt;
  -    &lt;filter token=&quot;DATE&quot; value=&quot;${DATE}&quot;/&gt;
  -    &lt;filtersfile file=&quot;${user.home}/dist.properties&quot;/&gt;
  +    &lt;filtersfile file=&quot;${user.dir}/dist.properties&quot;/&gt;
     &lt;/filterset&gt;
   &lt;/copy&gt;
   </PRE></BLOCKQUOTE>
   
   <HR>
   
  -<P align=center>Copyright &copy; 2001 Apache Software Foundation. All rights

  -Reserved.</P></BODY></HTML>
  +<P align=center>Copyright &copy; 2001-2002 Apache Software Foundation.
  +All rights Reserved.</P></BODY></HTML>
  
  
  

--
To unsubscribe, e-mail:   <mailto:ant-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:ant-dev-help@jakarta.apache.org>


Mime
View raw message