Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

add links to most nested tag lists #266

Merged
merged 2 commits into from

2 participants

@cweiske
Owner
  • add links to most nested tag lists
  • fix docblocks of pearpackagefileset
@mrook
Owner

Sweet, thanks!

@mrook mrook merged commit 32e105c into phingofficial:master
@cweiske cweiske deleted the cweiske:links branch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Feb 28, 2014
  1. @cweiske
Commits on Mar 3, 2014
  1. @cweiske
This page is out of date. Refresh to see the latest.
View
8 classes/phing/types/PearPackageFileSet.php
@@ -71,13 +71,10 @@ class PearPackageFileSet extends FileSet
protected $role = 'php';
/**
- * Prefix to prepend to the file paths in the zip
- */
- protected $prefix;
-
- /**
* Full path to a PEAR config file.
* If none provided, default one is used.
+ *
+ * @var string
*/
protected $config;
@@ -143,6 +140,7 @@ protected function loadPearPackageScanner(Project $p)
/**
* Sets the package.xml filename.
+ * If it is not set, the local pear installation is queried for the package.
*
* @return void
*/
View
5 classes/phing/util/PearPackageScanner.php
@@ -34,10 +34,11 @@ class PearPackageScanner extends DirectoryScanner
protected $packageFile;
/**
- * Sets the file to use for generated package.xml
+ * Sets the package.xml file to read, instead of using the
+ * local pear installation.
*
* @param string $descfile Name of package xml file
-
+ *
* @return void
*/
public function setDescFile($descfile)
View
62 docs/docbook5/en/source/appendixes/coretasks.xml
@@ -196,13 +196,13 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>filelist</literal></para>
+ <para><literal><link linkend="FileList">filelist</link></literal></para>
</listitem>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<listitem>
- <para><literal>filterchain</literal></para>
+ <para><literal><link linkend="app.corefilters">filterchain</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -476,8 +476,8 @@
</table>
</para>
</listitem>
- <listitem><para><literal>fileset</literal></para></listitem>
- <listitem><para><literal>filelist</literal></para></listitem>
+ <listitem><para><literal><link linkend="FileSet">fileset</link></literal></para></listitem>
+ <listitem><para><literal><link linkend="FileList">filelist</link></literal></para></listitem>
<listitem><para><literal>srcfile</literal></para></listitem>
</itemizedlist>
</sect2>
@@ -668,7 +668,7 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -754,7 +754,7 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -964,16 +964,16 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<listitem>
- <para><literal>filelist</literal></para>
+ <para><literal><link linkend="FileList">filelist</link></literal></para>
</listitem>
<listitem>
- <para><literal>filterchain</literal></para>
+ <para><literal><link linkend="app.corefilters">filterchain</link></literal></para>
</listitem>
<listitem>
- <para><literal>mapper</literal></para>
+ <para><literal><link linkend="app.coremappers">mapper</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -1279,7 +1279,7 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -1366,7 +1366,7 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -1733,13 +1733,13 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<listitem>
- <para><literal>filelist</literal></para>
+ <para><literal><link linkend="FileList">filelist</link></literal></para>
</listitem>
<listitem>
- <para><literal>mapper</literal></para>
+ <para><literal><link linkend="app.coremappers">mapper</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -2089,7 +2089,7 @@
<title>Supported Nested Tags:</title>
<itemizedlist>
<listitem>
- <para><literal>filterchain</literal></para>
+ <para><literal><link linkend="app.corefilters">filterchain</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -2261,7 +2261,7 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -2609,7 +2609,7 @@
<title>Supported Nested Tags:</title>
<itemizedlist>
<listitem>
- <para><literal>filterchain</literal></para>
+ <para><literal><link linkend="app.corefilters">filterchain</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -2736,10 +2736,10 @@
<title>Supported Nested Tags:</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<listitem>
- <para><literal>filterchain</literal></para>
+ <para><literal><link linkend="app.corefilters">filterchain</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -2909,7 +2909,7 @@ file defines a task in the format: name=path.to.Task -->
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>classpath</literal></para>
+ <para><literal><link linkend="path">classpath</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -2975,7 +2975,7 @@ file defines a task in the format: name=path.to.Task -->
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -3239,7 +3239,7 @@ Includes the Type named "CustomProject" and makes it available by
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>classpath</literal></para>
+ <para><literal><link linkend="path">classpath</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -3329,13 +3329,13 @@ Includes the Type named "CustomProject" and makes it available by
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>filelist</literal></para>
+ <para><literal><link linkend="FileList">filelist</link></literal></para>
</listitem>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<listitem>
- <para><literal>mapper</literal></para>
+ <para><literal><link linkend="app.coremappers">mapper</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -3413,7 +3413,7 @@ Includes the Type named "CustomProject" and makes it available by
</sect2>
<sect2 role="nestedtags">
<title>Supported Nested Tags</title>
- <para>All conditionals including <literal>and</literal>, <literal>or</literal>,
+ <para>All <link linkend="conditions">conditionals</link> including <literal>and</literal>, <literal>or</literal>,
<literal>not</literal> etc. </para>
</sect2>
</sect1>
@@ -3484,13 +3484,13 @@ Includes the Type named "CustomProject" and makes it available by
&lt;/xslt></programlisting>
</sect2>
<sect2 role="nestedtags">
- <title>Supported Nested Elements</title>
+ <title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>mapper</literal></para>
+ <para><literal><link linkend="app.coremappers">mapper</link></literal></para>
</listitem>
<listitem>
- <para><literal>filterchain</literal></para>
+ <para><literal><link linkend="app.corefilters">filterchain</link></literal></para>
</listitem>
<listitem>
<para><literal>param</literal></para>
View
28 docs/docbook5/en/source/appendixes/coretypes.xml
@@ -15,17 +15,17 @@
<title>Nested tags</title>
<itemizedlist>
<listitem>
- <para>File</para>
+ <para><literal>file</literal></para>
</listitem>
<listitem>
- <para>Class</para>
+ <para><literal>class</literal></para>
</listitem>
<listitem>
- <para>Method</para>
+ <para><literal>method</literal></para>
</listitem>
</itemizedlist>
<table>
- <title> Common attributes for all <literal>File, Class, Method</literal> tags </title>
+ <title> Common attributes for all <literal>file</literal>, <literal>class</literal>, <literal>method</literal> tags </title>
<tgroup cols="5">
<colspec colname="name" colnum="1" colwidth="1.5*"/>
<colspec colname="type" colnum="2" colwidth="0.8*"/>
@@ -46,7 +46,7 @@
<entry><literal>name</literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>The name of the class, method or file. This may also be specified
- as a pattern.</entry>
+ as a <link linkend="patterns">pattern</link>.</entry>
<entry>n/a</entry>
<entry>Yes</entry>
</row>
@@ -133,8 +133,8 @@
<title>FileSet</title>
<para> FileSets offer an easy and straightforward way to include files. The tag supports
- Selectors (see <xref xlink:href="#app.selectors" />) and
- PatternSets (see <xref xlink:href="#PatternSet" />). Additionally, you can include/exclude
+ <link linkend="app.selectors">Selectors</link> and
+ <link linkend="PatternSet">PatternSets</link>. Additionally, you can include/exclude
files in/from a fileset using the
<literal>&lt;include></literal>/<literal>&lt;exclude></literal> tags. In patterns,
one asterisk (<literal>*</literal>) maps to a part of a file/directory name within a
@@ -234,7 +234,7 @@
</tbody>
</tgroup>
</table>
- <sect2>
+ <sect2 xml:id="patterns">
<title>Using wildcards</title>
<itemizedlist>
<listitem>
@@ -275,13 +275,13 @@
<para> The tags that are supported by <literal>Fileset</literal> are:</para>
<itemizedlist>
<listitem>
- <para>include</para>
+ <para><literal>include</literal></para>
</listitem>
<listitem>
- <para>exclude</para>
+ <para><literal>exclude</literal></para>
</listitem>
<listitem>
- <para>patternset</para>
+ <para><literal><link linkend="PatternSet">patternset</link></literal></para>
</listitem>
</itemizedlist>
<para>The <literal>&lt;include></literal> and the <literal>&lt;exclude></literal> tags
@@ -292,7 +292,7 @@
<sect1 role="typedef" xml:id="PatternSet">
<title>PatternSet </title>
<para>The PatternSet data type defines patterns that can be grouped into sets and nested
- into <link xlink:href="#FileSet">FileSets</link>. Patterns can be specified by nested
+ into <link linkend="FileSet">FileSets</link>. Patterns can be specified by nested
&lt;include> or &lt;exclude> elements.</para>
<table>
<title> Attributes for <literal>&lt;patternset></literal> tag </title>
@@ -360,7 +360,7 @@
<para> The <literal>&lt;patternset></literal> tag only supports
<literal>&lt;include></literal> and <literal>&lt;exclude></literal>. The
<literal>&lt;include></literal> and the <literal>&lt;exclude></literal> tags
- must have a <literal>name</literal> attribute that contains the pattern to
+ must have a <literal>name</literal> attribute that contains the <link linkend="patterns">pattern</link> to
include/exclude.</para>
</sect2>
</sect1>
@@ -418,7 +418,7 @@
<sect2 role="nestedtags">
<title>Nested tags</title>
<para> The <literal>&lt;paentry> </literal>tag supports nested
- <literal>&lt;fileset></literal> and <literal>&lt;dirset></literal> tags.</para>
+ <literal><link linkend="FileSet">&lt;fileset></link></literal> and <literal>&lt;dirset></literal> tags.</para>
</sect2>
</sect1>
</appendix>
View
132 docs/docbook5/en/source/appendixes/optionaltasks.xml
@@ -281,7 +281,7 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -321,7 +321,7 @@
<entry>Yes</entry>
</row>
<row>
- <entry><literal>classpath</literal></entry>
+ <entry><literal><link linkend="path">classpath</link></literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>Additional classpath to locate source referenced in the
report</entry>
@@ -467,13 +467,13 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>classpath</literal></para>
+ <para><literal><link linkend="path">classpath</link></literal></para>
</listitem>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<listitem>
- <para><literal>filelist</literal></para>
+ <para><literal><link linkend="FileList">filelist</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -549,10 +549,10 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>classpath</literal></para>
+ <para><literal><link linkend="path">classpath</link></literal></para>
</listitem>
<listitem>
- <para>excludes</para>
+ <para><literal><link linkend="Excludes">excludes</link></literal></para>
</listitem>
</itemizedlist>
<para>Validates an optional code coverage database against the default
@@ -766,7 +766,7 @@
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para>fileset - Files that should be included for parsing</para>
+ <para><literal><link linkend="FileSet">fileset</link></literal> - Files that should be included for parsing</para>
</listitem>
</itemizedlist>
</sect2>
@@ -1201,7 +1201,7 @@ checksum="true" />;</programlisting>
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
<para>The files to deploy</para>
</listitem>
</itemizedlist>
@@ -1994,7 +1994,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -3174,7 +3174,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para>config </para>
+ <para><literal>config</literal></para>
<para>Holds additional config data. See
<link xlink:href="http://pear.php.net/manual/en/package.http.http-request2.config.php"
role="extern">HTTP_Request2 documentation</link>
@@ -3218,7 +3218,7 @@ Note that you can omit both startpoint and track attributes in this case
</table>
</listitem>
<listitem>
- <para>header </para>
+ <para><literal>header</literal></para>
<para> Holds additional header <literal>name</literal> and
<literal>value</literal>.</para>
<table>
@@ -3399,7 +3399,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para>config </para>
+ <para><literal>config</literal></para>
<para>Holds additional config data. See
<link xlink:href="http://pear.php.net/manual/en/package.http.http-request2.config.php"
role="extern">HTTP_Request2 documentation</link>
@@ -3443,7 +3443,7 @@ Note that you can omit both startpoint and track attributes in this case
</table>
</listitem>
<listitem>
- <para>header </para>
+ <para><literal>header</literal></para>
<para> Holds additional header <literal>name</literal> and
<literal>value</literal>.</para>
<table>
@@ -3483,7 +3483,7 @@ Note that you can omit both startpoint and track attributes in this case
</table>
</listitem>
<listitem>
- <para>postparameter </para>
+ <para><literal>postparameter</literal></para>
<para>Used when performing a POST request. Contains <literal>name</literal> and
<literal>value</literal> of a form field.</para>
<table>
@@ -3835,7 +3835,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para>comment </para>
+ <para><literal>comment</literal></para>
<para>Custom text that is added to the start of each encoded file.</para>
</listitem>
</itemizedlist>
@@ -3931,7 +3931,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para>comment </para>
+ <para><literal>comment</literal></para>
<para>Custom text that is added to the start of each encoded file.</para>
</listitem>
</itemizedlist>
@@ -4044,7 +4044,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -4112,7 +4112,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal>
+ <para><literal><link linkend="FileSet">fileset</link></literal>
</para>
<para>JavaScript files to be minified.</para>
</listitem>
@@ -4150,7 +4150,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>Yes</entry>
</row>
<row>
- <entry><literal>classpath</literal></entry>
+ <entry><literal><link linkend="path">classpath</link></literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>Additional classpath entries.</entry>
<entry>n/a</entry>
@@ -4364,7 +4364,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>Yes</entry>
</row>
<row>
- <entry><literal>classpath</literal></entry>
+ <entry><literal><link linkend="path">classpath</link></literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>Additional classpath entries.</entry>
<entry>n/a</entry>
@@ -4488,7 +4488,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>Yes</entry>
</row>
<row>
- <entry><literal>classpath</literal></entry>
+ <entry><literal><link linkend="path">classpath</link></literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>Additional classpath entries.</entry>
<entry>n/a</entry>
@@ -4625,7 +4625,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>Yes</entry>
</row>
<row>
- <entry><literal>classpath</literal></entry>
+ <entry><literal><link linkend="path">classpath</link></literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>Additional classpath entries.</entry>
<entry>n/a</entry>
@@ -4775,7 +4775,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>Yes</entry>
</row>
<row>
- <entry><literal>classpath</literal></entry>
+ <entry><literal><link linkend="path">classpath</link></literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>Additional classpath entries.</entry>
<entry>n/a</entry>
@@ -4909,7 +4909,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>Yes</entry>
</row>
<row>
- <entry><literal>classpath</literal></entry>
+ <entry><literal><link linkend="path">classpath</link></literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>Additional classpath entries.</entry>
<entry>n/a</entry>
@@ -5043,7 +5043,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>Yes</entry>
</row>
<row>
- <entry><literal>classpath</literal></entry>
+ <entry><literal><link linkend="path">classpath</link></literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>Additional classpath entries.</entry>
<entry>n/a</entry>
@@ -5221,7 +5221,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal>
+ <para><literal><link linkend="FileSet">fileset</link></literal>
</para>
<para>Files to be attached.</para>
</listitem>
@@ -5565,12 +5565,12 @@ Note that you can omit both startpoint and track attributes in this case
</table>
</listitem>
<listitem>
- <para><literal>fileset</literal>
+ <para><literal><link linkend="FileSet">fileset</link></literal>
</para>
<para>Files containing SQL statements.</para>
</listitem>
<listitem>
- <para><literal>filelist</literal>
+ <para><literal><link linkend="FileList">filelist</link></literal>
</para>
<para>Files containing SQL statements.</para>
</listitem>
@@ -5765,7 +5765,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<listitem>
<para><literal>option</literal></para>
@@ -5908,7 +5908,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<listitem>
<para><literal>option</literal></para>
@@ -6436,13 +6436,13 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<!--
TODO Describe metadata element.
-->
<listitem>
- <para>metadata </para>
+ <para><literal>metadata</literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -6644,9 +6644,9 @@ Note that you can omit both startpoint and track attributes in this case
<entry><literal>file</literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>The file or folder to check (usually the nested tag
- <literal>fileset</literal> is used instead).</entry>
+ <literal><link linkend="FileSet">fileset</link></literal> is used instead).</entry>
<entry><literal>false</literal></entry>
- <entry>Either this attribute or the nested tag <literal>fileset</literal> is
+ <entry>Either this attribute or the nested tag <literal><link linkend="FileSet">fileset</link></literal> is
required.</entry>
</row>
<row>
@@ -6747,7 +6747,7 @@ Note that you can omit both startpoint and track attributes in this case
format="summary"
file="/path/to/source-files"
allowedFileExtensions="php php5 inc"/></programlisting>
- <para> Checks all matching files in the <literal>fileset</literal> with the
+ <para> Checks all matching files in the <literal><link linkend="FileSet">fileset</link></literal> with the
<literal>Zend</literal> standard, sets the <literal>zend_ca_path</literal>
configuration which may be required by one of the sniffs, prints a list of used
sniffs and prints the <literal>default</literal> report with warnings and the
@@ -6780,7 +6780,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal>
+ <para><literal><link linkend="FileSet">fileset</link></literal>
</para>
<para>Either this nested tag or the attribute <literal>file</literal> is
required.</para>
@@ -6918,7 +6918,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>Path to source file or path</entry>
<entry>n/a</entry>
<entry>Only when there are <emphasis>no</emphasis> nested
- <literal>fileset</literal> elements</entry>
+ <literal><link linkend="FileSet">fileset</link></literal> elements</entry>
</row>
<row>
<entry><literal>minTokens</literal></entry>
@@ -6971,7 +6971,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal>
+ <para><literal><link linkend="FileSet">fileset</link></literal>
</para>
<para>This nested tag is required when the <literal>file</literal> attribute is
not set.</para>
@@ -7129,7 +7129,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -7165,7 +7165,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>Path to source file or path</entry>
<entry>n/a</entry>
<entry>Only when there are <emphasis>no</emphasis> nested
- <literal>fileset</literal> elements</entry>
+ <literal><link linkend="FileSet">fileset</link></literal> elements</entry>
</row>
<row>
<entry><literal>rulesets</literal></entry>
@@ -7231,7 +7231,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal>
+ <para><literal><link linkend="FileSet">fileset</link></literal>
</para>
<para> This nested tag is required when the <literal>file</literal> attribute is
not set.</para>
@@ -7324,7 +7324,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>Path to source file or path</entry>
<entry>n/a</entry>
<entry>Only when there are <emphasis>no</emphasis> nested
- <literal>fileset</literal> elements</entry>
+ <literal><link linkend="FileSet">fileset</link></literal> elements</entry>
</row>
<row>
<entry><literal>configFile</literal></entry>
@@ -7410,7 +7410,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal>
+ <para><literal><link linkend="FileSet">fileset</link></literal>
</para>
<para> This nested tag is required when the <literal>file</literal> attribute is
not set.</para>
@@ -7691,11 +7691,11 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal> - Files that should be included for
+ <para><literal><link linkend="FileSet">fileset</link></literal> - Files that should be included for
parsing</para>
</listitem>
<listitem>
- <para><literal>projdocfileset</literal> - Files that should be treated as
+ <para><literal><link linkend="FileSet">projdocfileset</link></literal> - Files that should be treated as
README/INSTALL/CHANGELOG files</para>
</listitem>
</itemizedlist>
@@ -7778,7 +7778,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para>fileset - Files that should be included for parsing</para>
+ <para><literal><link linkend="FileSet">fileset</link></literal> - Files that should be included for parsing</para>
</listitem>
</itemizedlist>
</sect2>
@@ -7977,7 +7977,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
@@ -8245,7 +8245,7 @@ Note that you can omit both startpoint and track attributes in this case
<entry>No</entry>
</row>
<row>
- <entry><literal>classpath</literal></entry>
+ <entry><literal><link linkend="path">classpath</link></literal></entry>
<entry><literal role="type">String</literal></entry>
<entry>Used to define more paths on which - besides the PHP
include_path - to look for the test files.</entry>
@@ -8311,7 +8311,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -8576,7 +8576,7 @@ Note that you can omit both startpoint and track attributes in this case
&lt;/target>
&lt;/project></programlisting>
<para> Rendering multiple files </para>
- <para> A nested <literal>fileset</literal> tag may be used to specify multiple
+ <para> A nested <literal><link linkend="FileSet">fileset</link></literal> tag may be used to specify multiple
files.</para>
<programlisting language="xml">&lt;?xml version="1.0" encoding="utf-8"?>
&lt;project name="example" basedir="." default="multiple">
@@ -8592,7 +8592,7 @@ Note that you can omit both startpoint and track attributes in this case
&lt;/target>
&lt;/project></programlisting>
<para> Rendering multiple files to another directory </para>
- <para> A nested <literal>mapper</literal> may be used to determine the output file
+ <para> A nested <literal><link linkend="app.coremappers">mapper</link></literal> may be used to determine the output file
names.</para>
<programlisting language="xml">&lt;?xml version="1.0" encoding="utf-8"?>
&lt;project name="example" basedir="." default="multiple">
@@ -8660,13 +8660,13 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<listitem>
- <para><literal>mapper</literal></para>
+ <para><literal><link linkend="app.coremappers">mapper</link></literal></para>
</listitem>
<listitem>
- <para><literal>filterchain</literal></para>
+ <para><literal><link linkend="app.corefilters">filterchain</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -8787,7 +8787,7 @@ Note that you can omit both startpoint and track attributes in this case
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -9006,7 +9006,7 @@ host="webserver" todir="/www/htdocs/project/">
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
<listitem>
<para><literal>sshconfig</literal>
@@ -9432,7 +9432,7 @@ host="webserver" command="ls" /></programlisting>
</table>
</listitem>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
@@ -10667,7 +10667,7 @@ host="webserver" command="ls" /></programlisting>
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -10773,7 +10773,7 @@ host="webserver" command="ls" /></programlisting>
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -10846,7 +10846,7 @@ host="webserver" command="ls" /></programlisting>
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -10910,7 +10910,7 @@ host="webserver" command="ls" /></programlisting>
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -11142,7 +11142,7 @@ host="webserver" command="ls" /></programlisting>
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -11331,7 +11331,7 @@ a2.a3.a4=false</programlisting>
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -11535,7 +11535,7 @@ a2.a3.a4=false</programlisting>
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
@@ -11784,7 +11784,7 @@ a2.a3.a4=false</programlisting>
<title>Supported Nested Tags</title>
<itemizedlist>
<listitem>
- <para><literal>fileset</literal></para>
+ <para><literal><link linkend="FileSet">fileset</link></literal></para>
</listitem>
</itemizedlist>
</sect2>
View
4 docs/docbook5/en/source/appendixes/projcomponents.xml
@@ -6,8 +6,8 @@
<title>Project Components</title>
<para>This file will give you a quick introduction and a reference of the things that you may
- see in a build files besides <xref xlink:href="#app.coretasks"/>tasks and <xref
- xlink:href="#app.coretypes"/>types.</para>
+ see in a build files besides <link linkend="app.coretasks">tasks</link> and
+ <link linkend="app.coretypes">types</link>.</para>
<sect1 xml:id="Project">
<title>Phing Projects</title>
View
6 docs/docbook5/en/source/appendixes/selectors.xml
@@ -358,8 +358,8 @@
<para>The <literal>&lt;present></literal> tag selects files that have an equivalent file in
another directory tree.</para>
- <para>The <literal>&lt;present></literal> tag supports the use of a contained <xref
- xlink:href="#app.coremappers"/>Mapper element to define the location of the file to
+ <para>The <literal>&lt;present></literal> tag supports the use of a contained <link
+ linkend="app.coremappers">mapper</link> element to define the location of the file to
be compared against. If no <literal>mapper</literal> element is specified, the identity
type mapper is used.</para>
@@ -656,7 +656,7 @@
<para>The <literal>&lt;selector></literal> tag is used to create selectors that can be
reused through references. It is the only selector which can be used outside of any
- target, as an element of the <literal>&lt;project></literal> tag. It can contain only
+ target, as an element of the <literal><link linkend="Project">&lt;project></link></literal> tag. It can contain only
one other selector, but of course that selector can be a container.</para>
</sect1>
View
2  docs/docbook5/en/source/chapters/extending.xml
@@ -47,7 +47,7 @@
<title> Mappers </title>
<para>Creating new mappers is also a rare need, since most everything can be handled by
- the <xref xlink:href="#app.coretypes"/>. The Mapper framework does provide a simple
+ the <xref xlink:href="#app.coremappers"/>. The Mapper framework does provide a simple
way for defining your own mappers to use instead, however, and mappers implement a
very simple interface.</para>
</sect2>
View
23 docs/docbook5/en/source/chapters/gettingstarted.xml
@@ -39,15 +39,15 @@
<para>The document prolog</para>
</listitem>
<listitem>
- <para>Exactly one root element called <literal>&lt;project></literal> .</para>
+ <para>Exactly one root element called <literal><link linkend="Project">&lt;project></link></literal> .</para>
</listitem>
<listitem>
<para>Several Phing <literal>type</literal> elements (i.e.
- <literal>&lt;property></literal> , <literal>&lt;fileset></literal> ,
- <literal>&lt;patternset></literal> etc.)</para>
+ <literal><link linkend="PropertyTask">&lt;property></link></literal> , <literal><link linkend="FileSet">&lt;fileset></link></literal> ,
+ <literal><link linkend="PatternSet">&lt;patternset></link></literal> etc.)</para>
</listitem>
<listitem>
- <para>One or more <literal>&lt;target></literal> elements containing built-in or
+ <para>One or more <literal><link linkend="Target">&lt;target></link></literal> elements containing built-in or
user defined Phing <literal>task</literal> elements (i.e.
<literal>&lt;install></literal> , <literal>&lt;bcc></literal> , etc).</para>
</listitem>
@@ -174,6 +174,9 @@
</tbody>
</tgroup>
</table>
+ <para>
+ See <xref xlink:href="#Project"/> for a complete reference.
+ </para>
</sect2>
<sect2>
<title> Target Element </title>
@@ -263,6 +266,9 @@
</tgroup>
</table>
</sect3>
+ <para>
+ See <xref xlink:href="#Target"/> for a complete reference.
+ </para>
</sect2>
<sect2>
@@ -299,8 +305,8 @@
<title> Property Element </title>
<para><literal>Properties</literal> are essentially variables that can be used in the
- buildfile. These might be set in the buildfile by calling the <xref
- xlink:href="#app.coretasks"/>, or might be set outside Phing on the command line
+ buildfile. These might be set in the buildfile by calling the <link linkend="PropertyTask">property</link> task,
+ or might be set outside Phing on the command line
(properties set on the command line always override the ones in the buildfile). A
property has a name and a value only. Properties may be used in the value of task
attributes. This is done by placing the property name between &quot;
@@ -357,8 +363,9 @@
&lt;/project&gt;</programlisting>
<para>This build file first defines some properties with the
- <literal>&lt;property></literal> task call to <literal>PropertyTask</literal>. Then,
- it defines a fileset and two targets. Let us have a quick rundown of this build file.</para>
+ <literal><link linkend="PropertyTask">&lt;property></link></literal> task call to <literal>PropertyTask</literal>. Then,
+ it defines a <link linkend="FileSet">fileset</link> and two <link linkend="Target">targets</link>.
+ Let us have a quick rundown of this build file.</para>
<para> The first five four within the <literal>project</literal> tag define properties. They
appear in the two ways this tag can occur: </para>
View
11 docs/docbook5/en/source/chapters/projcomponents.xml
@@ -215,7 +215,7 @@
<literal>FileSet</literal>
</title>
- <para>FileSets are groups of files. You can include or exclude specific files and
+ <para><link linkend="FileSet">FileSets</link> are groups of files. You can include or exclude specific files and
patterns to/from a FileSet. The use of patterns is explained below. For a start,
look at the following example:</para>
@@ -241,7 +241,7 @@
<title>
<literal>FileList</literal>
</title>
- <para>FileLists, like FileSets, are collections of files; however, a FileList is an
+ <para><link linkend="FileList">FileLists</link>, like FileSets, are collections of files; however, a FileList is an
explicitly defined list of files -- and the files don't necessarily have to exist on
the filesystem.</para>
<para>Besides being able to refer to nonexistent files, another thing that
@@ -259,7 +259,7 @@
<title>
<literal>FilterChains</literal> and Filters </title>
- <para><literal>FilterChains</literal> can be compared to Unix pipes. Unix pipes add a
+ <para><literal><link linkend="app.corefilters">FilterChains</link></literal> can be compared to Unix pipes. Unix pipes add a
great deal of flexibility to command line operations; for example, if you wanted to
copy just those lines that contained the string <literal>blee</literal> from the
first 10 lines of a file called <literal>foo</literal> to a file called
@@ -317,7 +317,8 @@
<title> File Mappers </title>
<para>With <literal>FilterChains</literal> and filters provide a powerful tool for
- changing contents of files, Mappers provide a powerful tool for changing the names
+ changing contents of files, <literal><link linkend="app.coremappers">mappers</link></literal>
+ provide a powerful tool for changing the names
of files.</para>
<para>To use a Mapper, you must specify a pattern to match on and a replacement pattern
@@ -356,7 +357,7 @@
</para>
</sect2>
</sect1>
- <sect1>
+ <sect1 xml:id="conditions">
<title> Conditions </title>
<para> Conditions are nested elements of the <xref xlink:href="#app.coretasks"/> and <xref
Something went wrong with that request. Please try again.