Overview.aml 3.4 KB

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