relatedTopics

This element is used to define a list of links to other topics that may be of interest to the reader.

Usage

Enter the element in the topic and specify one or more local links, external links, or code entity references.

  Note

In topics in which this element appears, it is a required element. However, if the topic has no links of interest, you can leave it empty and the related topics section will not be included in the topic.

The links within the element can appear in any order. They will be grouped by type when the topic is built.

Controlling Link Grouping

When used in a relatedTopics element, an optional topicType_id attribute can be added to link elements that specifies a GUID value used to classify the link type so that it is grouped with other similar links. If not specified, the links will be placed in the "Other Resources" group. The GUID values correspond to the various MAML topic file types and are as follows:

Topic Type

GUID Value

Group Section

Conceptual

1FE70836-AA7D-4515-B54B-E10C4B516E50

Concepts

Code Entity

4A273212-0AC8-4D72-8349-EC11CD2FF8CD

Other Resources

Error Message

A635375F-98C2-4241-94E7-E427B47C20B6

Reference

Glossary

A689E19C-2687-4881-8CE1-652FF60CF46C

Other Resources

How-To

DAC3A6A0-C863-4E5B-8F65-79EFC6A4BA09

Tasks

Orientation

B137C930-7BF7-48A2-A329-3ADCAEF8868E

Other Resources

Reference Without Syntax

F9205737-4DEC-4A58-AA69-0E621B1236BD

Reference

Reference With Syntax

95DADC4C-A2A6-447A-AA36-B6BE3A4F8DEC

Reference

Sample

069EFD88-412D-4E2F-8848-2D5C3AD56BDE

Tasks

SDK Technology Overview Architecture

68F07632-C4C5-4645-8DFA-AC87DCB4BD54

Concepts

SDK Technology Overview Code Directory

4BBAAF90-0E5F-4C86-9D31-A5CAEE35A416

Concepts

SDK Technology Overview Orientation

CDB8C120-888F-447B-8AF8-F9540562E7CA

Other Resources

SDK Technology Overview Scenarios

356C57C4-384D-4AF2-A637-FDD6F088A033

Concepts

SDK Technology Overview Technology Summary

19F1BB0E-F32A-4D5F-80A9-211D92A8A715

Concepts

Troubleshooting

38C8E0D1-D601-4DBA-AE1B-5BEC16CD9B01

Tasks

UI Reference

B8ED9F21-39A4-4967-928D-160CD2ED9DCE

Reference

Walkthrough

4779DD54-5D0C-4CC3-9DB3-BF1C90B721B3

Tasks

Whitepaper

56DB00EC-28BA-4C0D-8694-28E8B244E236

Other Resources

XML Reference

3272D745-2FFC-48C4-9E9D-CF2B2B784D5F

Reference

Example

 
<relatedTopics>
  <link topicType_id="1FE70836-AA7D-4515-B54B-E10C4B516E50"
    xlink:href="b32a73b8-fc26-4c98-912c-d595fc1a17c2" />
  <link topicType_id="1FE70836-AA7D-4515-B54B-E10C4B516E50"
    xlink:href="bc490dbf-7d46-432d-a816-3ae16ab6af54" />
  <link topicType_id="1FE70836-AA7D-4515-B54B-E10C4B516E50"
    xlink:href="d0c9ce6d-115b-4c70-891c-69b4af944dea" />
  <link topicType_id="1FE70836-AA7D-4515-B54B-E10C4B516E50"
    xlink:href="53a2b7c6-a269-4916-9313-bdc301ee9398" />

  <externalLink>
    <linkText>Sandcastle Help File Builder</linkText>
    <linkUri>https://GitHub.com/EWSoftware/SHFB</linkUri>
    <linkTarget>_blank</linkTarget>
  </externalLink>

  <codeEntityReference qualifyHint="true">T:System.IO.FileStream</codeEntityReference>
  <codeEntityReference qualifyHint="true" autoUpgrade="true">
  M:System.IO.FileStream.#ctor(System.String,System.IO.FileMode)
  </codeEntityReference>
  <codeEntityReference qualifyHint="true" autoUpgrade="true">
  M:System.IO.FileStream.Write(System.Byte[],System.Int32,System.Int32)
  </codeEntityReference>
  <codeEntityReference qualifyHint="false">P:System.IO.FileStream.Length
  </codeEntityReference>
  <codeEntityReference qualifyHint="false" autoUpgrade="true">
  M:System.IO.FileStream.Flush</codeEntityReference>
</relatedTopics>

Example Output

See below.

See Also