Click or drag to resize
Topic Metadata
Parameters

id

  • a string value that will be used in links to the topic. If no value is specified, a unique identifier will be assigned based on the topic file name.

legacy_id

  • a GUID value that will be used during conversion to MAML. If no value is specified, a new identifier will be assigned.

title

  • a string value that will be rendered as the topic's title. If no value is specified, the topic header text will be used.

tocTitle

  • a string value that will be rendered as the link text in the Table of Contents. If no value is specified, the topic title will be used.

linkText

  • a string value that will be rendered as the link text in internal links to the topic. If no value is specified, the topic title will be used.

hidden

  • a Boolean value indicating whether the topic will be excluded from the Table of Contents. If no value is specified, the topic will be visible.

topics

  • child topics. This value determines the order in which the topic links will be rendered in the Table of Contents.

See Also