Changeset 59 for branches/2.2/docs
- Timestamp:
- 04/28/06 14:49:47 (3 years ago)
- Files:
-
- branches/2.2/docs/phing_guide/book/chapters/appendixes/AppendixB-CoreTasks.html (modified) (5 diffs)
- branches/2.2/docs/phing_guide/book/chapters/appendixes/AppendixC-OptionalTasks.html (modified) (3 diffs)
- branches/2.2/docs/phing_guide/book/toc/FrameToC.html (modified) (3 diffs)
- branches/2.2/docs/phing_guide/book/toc/ToC.html (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
branches/2.2/docs/phing_guide/book/chapters/appendixes/AppendixB-CoreTasks.html
r44 r59 135 135 <ul> 136 136 <li>FileList</li> 137 <li>FileSet</li> 137 138 <li>FilterChain</li> 138 139 </ul> … … 517 518 <h2><a name="EchoTask"></a>EchoTask</h2> 518 519 <p> 519 This task simply verboses a string. 520 </p> 521 <h3>Example</h3> 520 Echoes a message to the current loggers and listeners which means standard out unless overridden. 521 A level can be specified, which controls at what logging level the message is filtered at. </p> 522 523 <p> 524 The task can also echo to a file, in which case the option to append rather than overwrite the file is available, and the level option is ignored 525 </p> 526 <h3>Examples</h3> 522 527 <pre><echo msg="Phing rocks!" /> 523 528 524 529 <echo message="Binarycloud, too." /> 525 530 526 <echo>And don't forget Propel.</echo></pre> 531 <echo>And don't forget Propel.</echo> 532 533 <echo file="test.txt" append="false">This is a test message</echo></pre> 527 534 <h3>Attributes</h3> 528 535 <table> … … 554 561 <td>n/a</td> 555 562 <td>Yes</td> 563 </tr> 564 <tr> 565 <td>file</td> 566 <td>String</td> 567 <td>The file to write the message to. 568 </td> 569 <td>n/a</td> 570 <td>No</td> 571 </tr> 572 <tr> 573 <td>append</td> 574 <td>Boolean</td> 575 <td>Append to an existing file? 576 </td> 577 <td>false</td> 578 <td>No</td> 579 </tr> 580 <tr> 581 <td>level</td> 582 <td>String</td> 583 <td>Control the level at which this message is reported. One of <em>error</em>, <em>warning</em>, <em>info</em>, <em>verbose</em>, <em>debug</em>. 584 </td> 585 <td><em>warning</em></td> 586 <td>No</td> 556 587 </tr> 557 588 </tbody> … … 946 977 </td> 947 978 <td>n/a</td> 979 <td>No</td> 980 </tr> 981 <tr> 982 <td>haltonfailure</td> 983 <td>Boolean</td> 984 <td>If true, fail the build process when the called build fails</td> 985 <td>false</td> 948 986 <td>No</td> 949 987 </tr> … … 1325 1363 </table> 1326 1364 1365 <h2><a name="TstampTask"></a>TstampTask</h2> 1366 <p> 1367 Sets the DSTAMP, TSTAMP, and TODAY properties in the current project. 1368 By default, the DSTAMP property is in the format "%Y%m%d", TSTAMP is in the format "%H%M", and TODAY is in the format "%B %d %Y". 1369 Use the nested <format> element to specify a different format.</p> 1370 1371 <p> 1372 These properties can be used in the build-file, for instance, to create time-stamped filenames, or used to replace placeholder tags inside documents to indicate, for example, the release date. The best place for this task is probably in an initialization target. 1373 </p> 1374 1375 <h3>Examples</h3> 1376 <pre><tstamp/></pre> 1377 1378 <p>sets the standard DSTAMP, TSTAMP, and TODAY properties according to the default formats.</p> 1379 1380 <pre><tstamp> 1381 <format property="DATE" pattern="%c" locale="nl_NL"/> 1382 </tstamp></pre> 1383 1384 <p>sets the standard properties as well as the property DATE with the date/time pattern "%c" using the Dutch locale.</p> 1385 1386 <pre><tstamp prefix="start"/></pre> 1387 1388 <p>sets three properties with the standard formats, prefixed with "start.": start.DSTAMP, start.TSTAMP, and start.TODAY.</p> 1389 1390 <h3>Attributes</h3> 1391 <table> 1392 <thead> 1393 <tr> 1394 <th>Name</th> 1395 <th>Type</th> 1396 <th>Description</th> 1397 <th>Default</th> 1398 <th>Required</th> 1399 </tr> 1400 </thead> 1401 <tbody> 1402 <tr> 1403 <td>prefix</td> 1404 <td>String</td> 1405 <td>Prefix used for all properties set. 1406 </td> 1407 <td>n/a</td> 1408 <td>No</td> 1409 </tr> 1410 </tbody> 1411 </table> 1412 1413 <h3>Supported Nested Tags</h3> 1414 <ul> 1415 <li>format 1416 <p>The Tstamp task supports a <format> nested element that allows a property to be set to the current date and time in a given format. 1417 The date/time patterns are as defined in the PHP strftime() function.</p> 1418 <h3>Attributes</h3> 1419 <table> 1420 <thead> 1421 <tr> 1422 <th>Name</th> 1423 <th>Type</th> 1424 <th>Description</th> 1425 <th>Default</th> 1426 <th>Required</th> 1427 </tr> 1428 </thead> 1429 <tbody> 1430 <tr> 1431 <td>property</td> 1432 <td>String</td> 1433 <td>The property to receive the date/time string in the given pattern. </td> 1434 <td>n/a</td> 1435 <td>Yes</td> 1436 </tr> 1437 <tr> 1438 <td>classname</td> 1439 <td>String</td> 1440 <td>The date/time pattern to be used. The values are as defined by the PHP strftime() function.</td> 1441 <td>n/a</td> 1442 <td>Yes</td> 1443 </tr> 1444 <tr> 1445 <td>locale</td> 1446 <td>String</td> 1447 <td>The locale used to create date/time string. For more information see the PHP setlocale() function.</td> 1448 <td>n/a</td> 1449 <td>No</td> 1450 </tr> 1451 </tbody> 1452 </table> 1453 </li> 1454 </ul> 1455 1327 1456 <h2><a name="TypedefTask"></a>TypedefTask</h2> 1328 1457 <p> branches/2.2/docs/phing_guide/book/chapters/appendixes/AppendixC-OptionalTasks.html
r52 r59 23 23 implement the tasks. So if you are searching for the reference to the <code><copy></code> 24 24 tag, for example, you will want to look at the reference of CopyTask. </p> 25 26 <h2><a name="CoverageMergerTask"></a>CoverageMergerTask</h2> 27 <p>The CoverageMergerTask merges code coverage information from external sources with an existing code coverage database.</p> 28 29 <p>The format of the code coverage files is expected to be identical to: 30 31 <pre> 32 file_put_contents('/www/live/testcases/coverage.data', serialize(xdebug_get_code_coverage)); 33 </pre> 34 35 <h3>Supported Nested Tags</h3> 36 <ul> 37 <li>fileset</li> 38 </ul> 39 40 <h3>Example</h3> 41 <pre> 42 <coverage-merger> 43 <fileset dir="/www/live/testcases"> 44 <include name="**/*.data"/> 45 </fileset> 46 </coverage-merger> 47 </pre> 48 25 49 <h2><a name="CoverageReportTask"></a>CoverageReportTask</h2> 26 50 <p>The CoverageReportTask formats a coverage database into a framed HTML report using XSLT. … … 117 141 <h3>Supported Nested Tags</h3> 118 142 <ul> 143 <li>classpath</li> 119 144 <li>fileset</li> 120 145 </ul> … … 872 897 </ul> 873 898 899 <h2><a name="XmlLintTask"></a>XmlLintTask</h2> 900 <p>The <em>XmlLintTask</em> checks syntax (lint) one or more XML files against an XML Schema Definition.</p> 901 902 <h3>Attributes</h3> 903 <table> 904 <thead> 905 <tr> 906 <th>Name</th> 907 <th>Type</th> 908 <th>Description</th> 909 <th>Default</th> 910 <th>Required</th> 911 </tr> 912 </thead> 913 <tbody> 914 <tr> 915 <td>schema</td> 916 <td>String</td> 917 <td>Path to XSD file</td> 918 <td>n/a</td> 919 <td>Yes</td> 920 </tr> 921 <tr> 922 <td>file</td> 923 <td>String</td> 924 <td>Path to XML file</td> 925 <td>n/a</td> 926 <td>No</td> 927 </tr> 928 </tbody> 929 </table> 930 931 <h3>Supported Nested Tags</h3> 932 <ul> 933 <li>fileset</li> 934 </ul> 935 936 <h3>Example</h3> 937 <pre> 938 <xmllint schema="schema.xsd" file="config.xml"/> 939 </pre> 940 <p>Validate one XML file against one XSD file.</p> 941 <pre> 942 <xmllint schema="schema.xsd"> 943 <fileset dir="."> 944 <include name="**/config.xml"/> 945 </fileset> 946 </xmllint> 947 </pre> 948 <p>Validate more XML files against one XSD file.</p> 949 874 950 <h2><a name="ZipTask"></a>ZipTask</h2> 875 951 <p> The <em>ZipTask</em> creates a .zip archive from a fileset or directory.</p> branches/2.2/docs/phing_guide/book/toc/FrameToC.html
r44 r59 109 109 <li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#TaskdefTask" target="Content">TaskdefTask</a></li> 110 110 <li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#TouchTask" target="Content">TouchTask</a></li> 111 <li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#TstampTask" target="Content">TstampTask</a></li> 111 112 <li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#TypedefTask" target="Content">TypedefTask</a></li> 112 113 <li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#UpToDateTask" target="Content">UpToDateTask</a></li> … … 117 118 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html" target="Content">Appendix C: Optional Tasks</a></li> 118 119 <ul> 120 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#CoverageMergerTask" target="Content">CoverageMergerTask</a></li> 119 121 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#CoverageReportTask" target="Content">CoverageReportTask</a></li> 120 122 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#CoverageSetupTask" target="Content">CoverageSetupTask</a></li> … … 129 131 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#SvnLastRevisionTask" target="Content">SvnLastRevisionTask</a></li> 130 132 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#TarTask" target="Content">TarTask</a></li> 133 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#XmlLintTask" target="Content">XmlLintTask</a></li> 131 134 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#ZipTask" target="Content">ZipTask</a></li> 132 135 </ul> branches/2.2/docs/phing_guide/book/toc/ToC.html
r22 r59 94 94 <li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#TaskdefTask">TaskdefTask</a></li> 95 95 <li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#TouchTask">TouchTask</a></li> 96 <li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#TstampTask">TstampTask</a></li> 96 97 <li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#TypedefTask">TypedefTask</a></li> 97 98 <li><a href="../chapters/appendixes/AppendixB-CoreTasks.html#UpToDateTask">UpToDateTask</a></li> … … 102 103 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html">Appendix C: Optional Tasks</a></li> 103 104 <ul> 105 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#CoverageMergerTask">CoverageMergerTask</a></li> 104 106 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#CoverageReportTask">CoverageReportTask</a></li> 105 107 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#CoverageSetupTask">CoverageSetupTask</a></li> … … 114 116 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#SvnLastRevisionTask">SvnLastRevisionTask</a></li> 115 117 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#TarTask">TarTask</a></li> 118 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#XmlLintTask">XmlLintTask</a></li> 116 119 <li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#ZipTask">ZipTask</a></li> 117 120 </ul>
