/Main/Source/SandcastleMAMLGuide/ConceptualTemplates/Conceptual.aml

 1<?xml version="1.0" encoding="utf-8"?>
 2<topic id="00000000-0000-0000-0000-000000000000" revisionNumber="1">
 3  <developerConceptualDocument
 4    xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
 5    xmlns:xlink="http://www.w3.org/1999/xlink">
 6
 7    <!--
 8    <summary>
 9      <para>Optional summary abstract</para>
10    </summary>
11    -->
12
13    <introduction>
14      <!-- Uncomment this to generate an outline of the section and sub-section
15           titles.  Specify a numeric value as the inner text to limit it to
16           a specific number of sub-topics when creating the outline.  Specify
17           zero (0) to limit it to top-level sections only.  -->
18      <!-- <autoOutline /> -->
19
20      <para>Required introduction</para>
21    </introduction>
22
23    <!-- Add one or more top-level section elements.  These are collapsible.
24         If using <autoOutline />, add an address attribute to identify it
25         and specify a title so that it can be jumped to with a hyperlink. -->
26    <section address="Section1">
27      <title>Optional section title</title>
28      <content>
29        <!-- Uncomment this to create a sub-section outline
30        <autoOutline /> -->
31        <para>Add one or more sections with content</para>
32      </content>
33      <!-- If a section contains a sections element, its content creates
34           sub-sections.  These are not collapsible.
35      <sections>
36          <section address="SubSection1">
37              <title>Sub-section 1</title>
38              <content>
39                  <para>Sub-section content.</para>
40              </content>
41          </section>
42          <section address="SubSection2">
43              <title>Sub-section 2</title>
44              <content>
45                  <para>Sub-section content.</para>
46              </content>
47          </section>
48      </sections> -->
49    </section>
50
51    <relatedTopics>
52      <!-- One or more of the following:
53           - A local link
54           - An external link
55           - A code entity reference
56
57      <link xlink:href="Other Topic's ID"/>
58      <link xlink:href="Other Topic's ID">Link inner text</link>
59
60      <externalLink>
61          <linkText>Link text</linkText>
62          <linkAlternateText>Optional alternate link text</linkAlternateText>
63          <linkUri>URI</linkUri>
64      </externalLink>
65
66      <codeEntityReference>API member ID</codeEntityReference>
67
68      Examples:
69
70      <link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8270" />
71      <link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
72
73      <externalLink>
74          <linkText>Sandcastle Styles on CodePlex</linkText>
75          <linkAlternateText>Go to CodePlex</linkAlternateText>
76          <linkUri>http://www.codeplex.com/SandcastleStyles</linkUri>
77      </externalLink>
78
79      <codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
80      <codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
81      <codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
82      <codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
83      <codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
84      <codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
85      <codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
86      -->
87    </relatedTopics>
88  </developerConceptualDocument>
89</topic>