Library
core
src
parser
std
rules
$toc
Readme

Lawtext core referencesDocs


Lawtext core references / core/src/parser/std/rules/$toc

core/src/parser/std/rules/$toc

References

default

Renames and re-exports $toc

Variables

$toc

const $toc: WithErrorRule<TOC>

The parser rule for std.TOC. Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.

Defined in

core/src/parser/std/rules/$toc.ts:482 (opens in a new tab)


$tocArticle

const $tocArticle: WithErrorRule<TOCArticle>

Defined in

core/src/parser/std/rules/$toc.ts:296 (opens in a new tab)


$tocArticleGroup

const $tocArticleGroup: WithErrorRule<TOCArticleGroup>

Defined in

core/src/parser/std/rules/$toc.ts:213 (opens in a new tab)


$tocPreambleLabel

const $tocPreambleLabel: WithErrorRule<TOCPreambleLabel>

Defined in

core/src/parser/std/rules/$toc.ts:172 (opens in a new tab)


$tocSupplProvision

const $tocSupplProvision: WithErrorRule<TOCSupplProvision>

Defined in

core/src/parser/std/rules/$toc.ts:366 (opens in a new tab)

Functions

tocItemToLines()

tocItemToLines(el, indentTexts): Line[]

The renderer for std.TOC. Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.

Parameters

el: TOCItem

indentTexts: string[]

Returns

Line[]

Defined in

core/src/parser/std/rules/$toc.ts:23 (opens in a new tab)


tocToLines()

tocToLines(el, indentTexts): Line[]

Parameters

el: TOC

indentTexts: string[]

Returns

Line[]

Defined in

core/src/parser/std/rules/$toc.ts:135 (opens in a new tab)