Adding XML code example for VerbatimContent ExtendedXmlSerializer#150.

Mike-E-angelo · Mike-E-angelo · commit 890cd5264305 · 2018-01-26T10:26:37.000-05:00
diff --git a/CodeProject.html b/CodeProject.html
@@ -622,15 +622,15 @@ <h2>Auto-Formatting (Attributes)</h2>
     &lt;SubjectWithThreeProperties xmlns=&quot;clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples&quot;&gt;
       &lt;Number&gt;123&lt;/Number&gt;
       &lt;Message&gt;Hello World!&lt;/Message&gt;
-      &lt;Time&gt;2018-01-26T10:18:16.7813081-05:00&lt;/Time&gt;
+      &lt;Time&gt;2018-01-26T10:25:47.6507293-05:00&lt;/Time&gt;
     &lt;/SubjectWithThreeProperties&gt;
 </pre>
 
 <p>Making use of the <code>UseAutoFormatting</code> call will enable all types that have a registered <code>IConverter</code> (convert to string and back) to emit as attributes:</p>
 
 <pre lang="xml">
     &lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
-    &lt;SubjectWithThreeProperties Number=&quot;123&quot; Message=&quot;Hello World!&quot; Time=&quot;2018-01-26T10:18:16.7813081-05:00&quot; xmlns=&quot;clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples&quot; /&gt;
+    &lt;SubjectWithThreeProperties Number=&quot;123&quot; Message=&quot;Hello World!&quot; Time=&quot;2018-01-26T10:25:47.6507293-05:00&quot; xmlns=&quot;clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples&quot; /&gt;
 </pre>
 
 <h2>Verbatim Content (CDATA)</h2>
@@ -647,6 +647,14 @@ <h2>Verbatim Content (CDATA)</h2>
     // ...
 </pre>
 
+
+<pre lang="xml">
+    &lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
+    &lt;Subject xmlns=&quot;clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples&quot;&gt;
+      &lt;Message&gt;&amp;lt;{&quot;Ilegal characters and such&quot;}&amp;gt;&lt;/Message&gt;
+    &lt;/Subject&gt;
+</pre>
+
 <p>You can also denote these fields with an attribute and get the same functionality:</p>
 
 <pre lang="cs">
@@ -726,7 +734,7 @@ <h2>Parameterized Members and Content</h2>
     &lt;ParameterizedSubject xmlns=&quot;clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples&quot;&gt;
       &lt;Message&gt;Hello World!&lt;/Message&gt;
       &lt;Number&gt;123&lt;/Number&gt;
-      &lt;Time&gt;2018-01-26T10:18:16.9318559-05:00&lt;/Time&gt;
+      &lt;Time&gt;2018-01-26T10:25:47.8844816-05:00&lt;/Time&gt;
     &lt;/ParameterizedSubject&gt;
 </pre>
 
diff --git a/docGenerator/ExtendedXmlSerializer.DocGenerator/Program.cs b/docGenerator/ExtendedXmlSerializer.DocGenerator/Program.cs
@@ -180,6 +180,8 @@ static void Main(string[] args)
 			doc.Add("If you have an element with a member that can hold lots of data, or data that has illegal characters, you configure it to be a verbatim field and it will emit a CDATA section around it:");
 			doc.AddCode(@"..\..\..\..\samples\ExtendedXmlSerializer.Samples\Extensibility\VerbatimContent.cs", "Example");
 
+			doc.AddCode(@"..\..\..\..\samples\ExtendedXmlSerializer.Samples\bin\Extensibility.VerbatimContent.xml", CodeFormat.Xml);
+
 			doc.Add("You can also denote these fields with an attribute and get the same functionality:");
 			doc.AddCode(@"..\..\..\..\samples\ExtendedXmlSerializer.Samples\Extensibility\VerbatimContent.cs", "Subject");
 			
diff --git a/docs/get-started/index.rst b/docs/get-started/index.rst
@@ -633,15 +633,15 @@ The default behavior for emitting data in an Xml document is to use elements, wh
     <SubjectWithThreeProperties xmlns="clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples">
       <Number>123</Number>
       <Message>Hello World!</Message>
-      <Time>2018-01-26T10:18:16.7813081-05:00</Time>
+      <Time>2018-01-26T10:25:47.6507293-05:00</Time>
     </SubjectWithThreeProperties>
 
 Making use of the `UseAutoFormatting` call will enable all types that have a registered `IConverter` (convert to string and back) to emit as attributes:
 
 .. sourcecode:: xml
 
     <?xml version="1.0" encoding="utf-8"?>
-    <SubjectWithThreeProperties Number="123" Message="Hello World!" Time="2018-01-26T10:18:16.7813081-05:00" xmlns="clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples" />
+    <SubjectWithThreeProperties Number="123" Message="Hello World!" Time="2018-01-26T10:25:47.6507293-05:00" xmlns="clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples" />
 
 Verbatim Content (CDATA)
 ========================
@@ -658,6 +658,14 @@ If you have an element with a member that can hold lots of data, or data that ha
                 var contents = serializer.Serialize(subject);
     // ...
 
+
+.. sourcecode:: xml
+
+    <?xml version="1.0" encoding="utf-8"?>
+    <Subject xmlns="clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples">
+      <Message>&lt;{"Ilegal characters and such"}&gt;</Message>
+    </Subject>
+
 You can also denote these fields with an attribute and get the same functionality:
 
 .. sourcecode:: csharp
@@ -740,7 +748,7 @@ Taking this concept bit further leads to a favorite feature of ours in `Extended
     <ParameterizedSubject xmlns="clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples">
       <Message>Hello World!</Message>
       <Number>123</Number>
-      <Time>2018-01-26T10:18:16.9318559-05:00</Time>
+      <Time>2018-01-26T10:25:47.8844816-05:00</Time>
     </ParameterizedSubject>
 
 Tuples
diff --git a/readme.rst b/readme.rst
@@ -646,15 +646,15 @@ The default behavior for emitting data in an Xml document is to use elements, wh
     <SubjectWithThreeProperties xmlns="clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples">
       <Number>123</Number>
       <Message>Hello World!</Message>
-      <Time>2018-01-26T10:18:16.7813081-05:00</Time>
+      <Time>2018-01-26T10:25:47.6507293-05:00</Time>
     </SubjectWithThreeProperties>
 
 Making use of the `UseAutoFormatting` call will enable all types that have a registered `IConverter` (convert to string and back) to emit as attributes:
 
 .. sourcecode:: xml
 
     <?xml version="1.0" encoding="utf-8"?>
-    <SubjectWithThreeProperties Number="123" Message="Hello World!" Time="2018-01-26T10:18:16.7813081-05:00" xmlns="clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples" />
+    <SubjectWithThreeProperties Number="123" Message="Hello World!" Time="2018-01-26T10:25:47.6507293-05:00" xmlns="clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples" />
 
 Verbatim Content (CDATA)
 ========================
@@ -671,6 +671,14 @@ If you have an element with a member that can hold lots of data, or data that ha
                 var contents = serializer.Serialize(subject);
     // ...
 
+
+.. sourcecode:: xml
+
+    <?xml version="1.0" encoding="utf-8"?>
+    <Subject xmlns="clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples">
+      <Message>&lt;{"Ilegal characters and such"}&gt;</Message>
+    </Subject>
+
 You can also denote these fields with an attribute and get the same functionality:
 
 .. sourcecode:: csharp
@@ -753,7 +761,7 @@ Taking this concept bit further leads to a favorite feature of ours in `Extended
     <ParameterizedSubject xmlns="clr-namespace:ExtendedXmlSerializer.Samples.Extensibility;assembly=ExtendedXmlSerializer.Samples">
       <Message>Hello World!</Message>
       <Number>123</Number>
-      <Time>2018-01-26T10:18:16.9318559-05:00</Time>
+      <Time>2018-01-26T10:25:47.8844816-05:00</Time>
     </ParameterizedSubject>
 
 Tuples
diff --git a/samples/ExtendedXmlSerializer.Samples/Extensibility/VerbatimContent.cs b/samples/ExtendedXmlSerializer.Samples/Extensibility/VerbatimContent.cs
@@ -4,6 +4,7 @@
 using ExtendedXmlSerializer.ContentModel.Content;
 using ExtendedXmlSerializer.Core;
 using ExtendedXmlSerializer.ExtensionModel.Xml;
+// ReSharper disable UnusedVariable
 
 namespace ExtendedXmlSerializer.Samples.Extensibility
 {
@@ -27,7 +28,7 @@ public void Execute(object parameter)
 
 			var @default = new ConfigurationContainer().Create()
 			                                           .Serialize(new XmlWriterSettings {Indent = true}, subject);
-			File.WriteAllText(@"bin\Extensibility.VerbatimContent.Default.xml", @default);
+			File.WriteAllText(@"bin\Extensibility.VerbatimContent.xml", @default);
 		}
 	}
 
diff --git a/samples/ExtendedXmlSerializer.Samples/Program.cs b/samples/ExtendedXmlSerializer.Samples/Program.cs
@@ -59,6 +59,7 @@ public static void Main(string[] args)
 			AttachedProperties.Default.Execute(null);
 			MarkupExtensions.Default.Execute(null);
 			Example.Default.Execute(null);
+			VerbatimContent.Default.Execute(null);
 
 			SimpleSamples.Run();
 			DictianarySamples.Run();

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`using ExtendedXmlSerializer.ContentModel.Content;`
`5`	`5`	`using ExtendedXmlSerializer.Core;`
`6`	`6`	`using ExtendedXmlSerializer.ExtensionModel.Xml;`
	`7`	`+// ReSharper disable UnusedVariable`
`7`	`8`
`8`	`9`	`namespace ExtendedXmlSerializer.Samples.Extensibility`
`9`	`10`	`{`
`@@ -27,7 +28,7 @@ public void Execute(object parameter)`
`27`	`28`
`28`	`29`	`var @default = new ConfigurationContainer().Create()`
`29`	`30`	`.Serialize(new XmlWriterSettings {Indent = true}, subject);`
`30`		`- File.WriteAllText(@"bin\Extensibility.VerbatimContent.Default.xml", @default);`
	`31`	`+ File.WriteAllText(@"bin\Extensibility.VerbatimContent.xml", @default);`
`31`	`32`	`}`
`32`	`33`	`}`
`33`	`34`