This document type is used for "how to" topics.
Below is an example of a How-To topic file.
<?xml version="1.0" encoding="utf-8"?>
<topic id="00000000-0000-0000-0000-000000000000" revisionNumber="1">
<developerHowToDocument
xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
xmlns:xlink="http://www.w3.org/1999/xlink">
<!--
<summary>
<para>Optional summary abstract</para>
</summary>
-->
<introduction>
<para>Required introduction</para>
</introduction>
<!-- Optional procedures followed by optional code example but must have
at least one procedure or code example -->
<procedure>
<title>Procedure title</title>
<steps class="ordered">
<step>
<content>
<para>First step</para>
</content>
</step>
<step>
<content>
<para>Second step</para>
</content>
</step>
</steps>
<!-- <conclusion>Optional conclusion</conclusion> -->
</procedure>
<!-- <codeExample>Optional code example</codeExample> -->
<!-- <buildInstructions>Optional instructions for building a
code example.</buildInstructions> -->
<!-- <robustProgramming>Optional discussion of error handling and other
issues related to writing solid code.</robustProgramming> -->
<!-- <security>Optional discussion of security issues.</security> -->
<relatedTopics>
<!-- One or more of the following:
- A local link
- An external link
- A code entity reference
<link xlink:href="Other Topic's ID">Link text</link>
<externalLink>
<linkText>Link text</linkText>
<linkAlternateText>Optional alternate link text</linkAlternateText>
<linkUri>URI</linkUri>
</externalLink>
<codeEntityReference>API member ID</codeEntityReference>
Examples:
<link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
<externalLink>
<linkText>Sandcastle Help File Builder on GitHub</linkText>
<linkAlternateText>Go to GitHub</linkAlternateText>
<linkUri>https://GitHub.com/EWSoftware/SHFB</linkUri>
</externalLink>
<codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
<codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
<codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
-->
</relatedTopics>
</developerHowToDocument>
</topic>