Document sanitizing of text and new skipsanitize attribute

phingofficial · Apr 26, 2023 · bad7358 · bad7358
1 parent 21b1b2c
commit bad7358
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/source/appendixes/coretasks/AppendTask.xml b/source/appendixes/coretasks/AppendTask.xml
@@ -12,6 +12,12 @@
         <literal>${process.outputfile}</literal>. This is a real example from the build file used to generate this book!
     </para>
 
+    <note>
+        <para>By default, whitespace is stripped from text that is appended to a file (matching the way the Concat task works in Ant).
+            This is because adding a nested text element may introduce additional (ignorable) whitespace. If you want to override this behavior,
+            set the <literal>skipsanitize</literal> attribute to <literal>true</literal>.</para>
+    </note>
+
     <table>
         <title>Attributes</title>
         <tgroup cols="5">
@@ -135,6 +141,19 @@
                     <entry>n/a</entry>
                     <entry>No</entry>
                 </row>
+                <row>
+                    <entry>
+                        <literal>skipsanitize</literal>
+                    </entry>
+                    <entry>
+                        <literal role="type">Boolean</literal>
+                    </entry>
+                    <entry>
+                        Specifies whether to skip sanitizing text (i.e., stripping spaces and newlines).
+                    </entry>
+                    <entry>n/a</entry>
+                    <entry>No</entry>
+                </row>
                 <row>
                     <entry>
                         <literal>file</literal>