TopicTransformationCore.CreateSection Method

Definition

Namespace

Sandcastle.Core.PresentationStyle.Transformation

Assembly

Sandcastle.Core.dll

Create a topic section with a title

public abstract (XElement Title, XElement Content) CreateSection(string uniqueId, bool localizedTitle, string title, string linkId)

Parameters

uniqueId string

A unique ID that can be used to identify the section

localizedTitle bool

True if title is a localized include item, false if it is literal title text.

title string

The item id if localizedTitle is true, or the literal title text if it is false.

linkId string

An optional link ID for the section. If there is no title, this will be ignored.

Returns

(XElement Title, XElement Content)

A tuple containing a reference to the title element if a title was created, null if not, and a reference to the content element into which any additional content can be rendered or null if it should be rendered into the current topic element. Both elements should be added to the topic if created.