From 47ec57c5cd0e56f8e3dd17da69e0f10f7cb87bfc Mon Sep 17 00:00:00 2001
From: Iwein Fuld <iwein@fuld.net>
Date: Tue, 14 Oct 2008 09:42:13 +0000
Subject: [PATCH] Polishing file documentation

---
 spring-integration-reference/src/file.xml     | 25 +++++++------------
 .../src/spring-integration-reference.xml      |  1 +
 2 files changed, 10 insertions(+), 16 deletions(-)

diff --git a/spring-integration-reference/src/file.xml b/spring-integration-reference/src/file.xml
index ebf39cad55..e94c4d95b0 100644
--- a/spring-integration-reference/src/file.xml
+++ b/spring-integration-reference/src/file.xml
@@ -15,18 +15,11 @@
 			transform files into strings or byte arrays. 
     </para>
 		<para>
-			This section will explain the workings of
-			<classname>PollableFileSource</classname>
-			,
-			<classname>FileWritingMessageConsumer
-			</classname>
-			and how to configure them as
-			<emphasis>beans</emphasis>
-			. Also the support for dealing with files through file specific
-			implementations of
-			<interfacename>Transformer</interfacename>
-			will be discussed. Finally the file specific namespace will be
-			discussed.
+			This section will explain the workings of<classname>PollableFileSource</classname>,
+			<classname>FileWritingMessageConsumer</classname> and how to configure them as
+			<emphasis>beans</emphasis>. Also the support for dealing with files through file specific
+			implementations of <interfacename>Transformer</interfacename> will be discussed. Finally 
+			the file specific namespace will be explained.
 		</para>
 	</section>
 
@@ -101,10 +94,10 @@
 	       directory="file:${input.directory.property}"/> 					(1)
 	<file:inbound-channel-adapter id="filesIn"
 	       directory="file:${input.directory.property}" 
-	       filter="customFilterBean" />										(2)
+	       filter="customFilterBean" />							(2)
 	<file:inbound-channel-adapter id="filesIn"
 	       directory="file:${input.directory.property}" 
-	       filename-pattern="^test.*$" /> 									(3)
+	       filename-pattern="^test.*$" /> 							(3)
 	]]>
 			</programlisting>
 			Where (1) is relying on the default filter that just prevents
@@ -179,12 +172,12 @@
 		</para>
 		<para>
 			<classname>FileToStringTransformer</classname>
-			will convert files to Strings as the name suggests.
+			will convert Files to Strings as the name suggests. This is mainly useful for debugging.
 		</para>
 		<para>
 			To configure File specific transformers you can use the appropriate
 			elements from the file namespace.
-			<programlisting language="xml"><![CDATA[<file-to-bytes-transformer input-channel="intput" output-channel="output" delete-files="true"/>]]></programlisting>
+			<programlisting language="xml"><![CDATA[	<file-to-bytes-transformer input-channel="intput" output-channel="output" delete-files="true"/>]]></programlisting>
 			The
 			<emphasis>delete-files</emphasis>
 			option signals the transformer to delete the File after the
diff --git a/spring-integration-reference/src/spring-integration-reference.xml b/spring-integration-reference/src/spring-integration-reference.xml
index 0db766d77d..63db1f8465 100644
--- a/spring-integration-reference/src/spring-integration-reference.xml
+++ b/spring-integration-reference/src/spring-integration-reference.xml
@@ -35,6 +35,7 @@
   <xi:include href="./overview.xml"/>
   <xi:include href="./core-api.xml"/>
   <xi:include href="./adapters.xml"/>
+  <xi:include href="./file.xml"/> 
   <xi:include href="./configuration.xml"/>
   <xi:include href="./samples.xml"/>
   <xi:include href="./resources.xml"/>