TocItem

toc~ TocItem

Class representing an item of the table of contents.

Constructor

new TocItem(a, toc)

Source:

Create a table of contents item object.

Parameters:
Name Type Description
a object
toc object
Throws:
Array.<(string|Element)>

Members

Source:

Section link jQuery element.

Type:

$text :external:jQuery

Source:

Section text jQuery element (including the title, number, and other possible additions).

Type:

Methods

replaceText($headline)

Source:

For internal use. Generate HTML to use it in the TOC for the section. Only a limited number of HTML elements is allowed in TOC.

Parameters:
Name Type Description
$headline external:jQuery

updateSubscriptionState(subscriptionStatenullable)

Source:

Add/remove a subscription mark to the section's TOC link according to its subscription state and update the title attribute.

Parameters:
Name Type Attributes Description
subscriptionState boolean <nullable>