← Back to branch summary

~mandel/ubuntuone-windows-installer/fix_null_pointer_start

« back to all changes in this revision

Viewing changes to tools/Nant/doc/help/filters/replacetokens.html

  • Committer: Manuel de la Pena
  • Date: 2010-07-08 13:22:59 UTC
  • Revision ID: mandel@themacaque.com-20100708132259-y1jgyuyqfe9stt8u
Updated build script to run tests and added all the required tools so far.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/Nant/doc/help/filters/replacetokens.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
  <!-- Documenting T:NAnt.Core.Filters.ReplaceTokens-->
 
4
  <head>
 
5
    <meta http-equiv="Content-Language" content="en-ca" />
 
6
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
7
    <link rel="stylesheet" type="text/css" href="../style.css" />
 
8
    <title>&lt;replacetokens&gt; Filter</title>
 
9
  </head>
 
10
  <body>
 
11
    <table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
 
12
      <tr>
 
13
        <td class="NavBar-Cell">
 
14
          <a href="http://nant.sourceforge.net">
 
15
            <b>NAnt</b>
 
16
          </a>
 
17
          <img alt="-&gt;" src="../images/arrow.gif" />
 
18
          <a href="../index.html">Help</a>
 
19
          <img alt="-&gt;" src="../images/arrow.gif" />
 
20
          <a href="../filters/index.html">Filter Reference</a>
 
21
          <img alt="-&gt;" src="../images/arrow.gif" /> &lt;replacetokens&gt;</td>
 
22
        <td class="NavBar-Cell" align="right">
 
23
                        v0.90</td>
 
24
      </tr>
 
25
    </table>
 
26
    <h1>&lt;replacetokens&gt;</h1>
 
27
    <p> Replaces tokens in the original input with user-supplied values. </p>
 
28
    <p> This filter replaces all token surrounded by a beginning and ending token. The default beginning and ending tokens both default to '@'. The optional <code>begintoken</code> and <code>endtoken</code> attributes can be specified to change either token. By default string comparisons are case sensitive but this can be changed by setting the optional <code>ignorecase</code> attribute to <b>true</b>. </p>
 
29
    <p> Tokens are specified by using the <a href="../elements/NAnt.Core.Types.Token.html">Token</a> element. It is possible to specify from 1 to n tokens and replacement values. Values can be any valid NAnt expression. </p>
 
30
    <p> Filters are intended to be used as a element of a <a href="../types/filterchain.html">&lt;filterchain&gt;</a>. </p>
 
31
    <h3>Parameters</h3>
 
32
    <div class="table">
 
33
      <table>
 
34
        <tr>
 
35
          <th>Attribute</th>
 
36
          <th style="text-align: center;">Type</th>
 
37
          <th>Description</th>
 
38
          <th style="text-align: center;">Required</th>
 
39
        </tr>
 
40
        <tr>
 
41
          <td valign="top">begintoken</td>
 
42
          <td style="text-align: center;">char</td>
 
43
          <td> Marks the beginning of a token. The default is "@". </td>
 
44
          <td style="text-align: center;">False</td>
 
45
        </tr>
 
46
        <tr>
 
47
          <td valign="top">endtoken</td>
 
48
          <td style="text-align: center;">char</td>
 
49
          <td> Marks the end of a token. The default is "@". </td>
 
50
          <td style="text-align: center;">False</td>
 
51
        </tr>
 
52
        <tr>
 
53
          <td valign="top">ignorecase</td>
 
54
          <td style="text-align: center;">bool</td>
 
55
          <td> Determines if case will be ignored. The default is <b>false</b>. </td>
 
56
          <td style="text-align: center;">False</td>
 
57
        </tr>
 
58
        <tr>
 
59
          <td valign="top">if</td>
 
60
          <td style="text-align: center;">bool</td>
 
61
          <td> If <b>true</b> then the filter will be used; otherwise, skipped. The default is <b>true</b>. </td>
 
62
          <td style="text-align: center;">False</td>
 
63
        </tr>
 
64
        <tr>
 
65
          <td valign="top">unless</td>
 
66
          <td style="text-align: center;">bool</td>
 
67
          <td> Opposite of <code>if</code>. If <b>false</b> then the filter will be executed; otherwise, skipped. The default is <b>false</b>. </td>
 
68
          <td style="text-align: center;">False</td>
 
69
        </tr>
 
70
      </table>
 
71
    </div>
 
72
    <h3>Nested Elements:</h3>
 
73
    <!--Array-->
 
74
    <!--NestedElementArray=T:NAnt.Core.Types.Token-->
 
75
    <h4>
 
76
      <a id="token">
 
77
      </a>
 
78
                    &lt;token&gt;
 
79
                </h4>
 
80
    <div class="nested-element"> Tokens and replacement values. <p> ReplaceTokens filter token. </p><h3>Parameters</h3><div class="table"><table><tr><th>Attribute</th><th style="text-align: center;">Type</th><th>Description</th><th style="text-align: center;">Required</th></tr><tr><td valign="top" class="required">key</td><td style="text-align: center;">string</td><td> Token to be replaced. </td><td style="text-align: center;">True</td></tr><tr><td valign="top" class="required">value</td><td style="text-align: center;">string</td><td> New value of token. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the token should be used to replace values. If <b>true</b> then the token will be used; otherwise, not. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Indicates if the token should not be used to replace values. If <b>false</b> then the token will be used; otherwise, not. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
 
81
    <h4>
 
82
      <a id="token">
 
83
      </a>
 
84
                    &lt;/token&gt;
 
85
                </h4>
 
86
    <h3>Examples</h3>
 
87
    <ul class="examples">
 
88
      <li>
 
89
        <p> Replace all occurrences of the string @DATE@ with the value of property "TODAY". </p>
 
90
        <pre class="code">
 
91
&lt;replacetokens&gt;
 
92
    &lt;token key="DATE" value="${TODAY}" /&gt;
 
93
&lt;/replacetokens&gt;
 
94
    </pre>
 
95
      </li>
 
96
      <li>
 
97
        <p> Replace all occurrences of the string &lt;DATE&gt; with the value of property "TODAY". </p>
 
98
        <pre class="code">
 
99
&lt;replacetokens begintoken="&amp;lt;" endtoken="&amp;gt;"&gt;
 
100
    &lt;token key="DATE" value="${TODAY}" /&gt;
 
101
&lt;/replacetokens&gt;
 
102
    </pre>
 
103
      </li>
 
104
    </ul>
 
105
    <h3>Requirements</h3>
 
106
    <div style="margin-left: 20px;">
 
107
      <b>Assembly:</b> NAnt.Core (0.90.3780.0)
 
108
            </div>
 
109
  </body>
 
110
</html>
 
 
b'\\ No newline at end of file'