







![]() |
|
![]() |
This document type is used for orientation topics.
Orientation File Format
Below is an example of an Orientation topic file.
Orientation Topic |
![]() |
---|---|
<?xml version="1.0" encoding="utf-8"?> <topic id="00000000-0000-0000-0000-000000000000" revisionNumber="1"> <developerOrientationDocument 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> <!-- <inThisSection>Optional description of content in this section</inThisSection> --> <!-- <reference>Optional reference section</reference> --> <!-- <relatedSections>Optional related sections info</relatedSections> --> <!-- <externalResources>Optional external resources section</externalResources> --> <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 CodePlex</linkText> <linkAlternateText>Go to CodePlex</linkAlternateText> <linkUri>http://SHFB.CodePlex.com</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> </developerOrientationDocument> </topic> |