AutoOutlineElement Class

Definition

Namespace

Sandcastle.Core.PresentationStyle.Transformation.Elements.Html

Assembly

Sandcastle.Core.dll

This is used to handle autoOutline elements in a topic

public class AutoOutlineElement : Element

Inheritance

object

Element

AutoOutlineElement

Examples

<!-- Show only top-level topic titles, default lead-in text, includes related
topics link -->
<autoOutline/>

<!-- Show only top-level topic titles without the related topics link, default
lead-in text -->
<autoOutline excludeRelatedTopics="true"/>

<!-- Add custom lead-in text -->
<autoOutline excludeRelatedTopics="true" lead="Changes in this release" />

<!-- Show top-level titles and titles for one level down, default lead-in text,
includes related topics link -->
<autoOutline>1</autoOutline>

<-- Show top-level titles and titles for one level down, omit the lead-in text
<autoOutline lead="none">1</autoOutline> -->

<-- Show titles from the top down to three levels, default lead-in text, includes
related topics link -->
<autoOutline>3</autoOutline>

Remarks

This element inserts a bullet list of links to the topic's sections or a section's sub-sections with optional support for limiting the expansion down to a specific level. Authors can use the tag directly or specify a token (defined in a token file) in a topic's introduction to get a bullet list of the sections; or in a ddue:section/ddue:content to get a bullet list of the section's sub-sections. If the token is used, the shared content component replaces <token>autoOutline</token> with an <autoOutline/> node that you specify in the token's content. This was the old way of doing it but this version allows it to be specified directly like any other MAML tag.

The excludeRelatedTopics attribute can be set to true to exclude the link to the related topics section if present or set to false to omit it. If not specified, the default is true to include it.

The lead attribute can be included to specify the lead in text. It can be set to "none" to omit the lead in text. If omitted, default lead in text will be used.

Examples:

Constructors

AutoOutlineElement()

Fields

Ddue	The root MAML namespace (Inherited from Element)
NonBreakingSpace	A non-breaking space (Inherited from Element)
Xlink	The XML linking language namespace (Inherited from Element)
XmlSpace	The xml:space name (Inherited from Element)

Properties

Name	This read-only property returns the element name (Inherited from Element)
TopLevelStyleName	This is used to set a style class name on top-level auto-outlines

Methods

Render(TopicTransformationCore, XElement)

Render the element to the topic