Module packages.resilient.fancytoc
Fancy table of contents for re·sil·ient.
Only processes 2 levels, e.g. parts (level 0) and chapters (level 1) and display them as some braced content.
Info:
- Copyright: (c) 2022-2025 Omikhkeia / Didier Willis
- License: MIT
Class packages.resilient.fancytoc
| package:_init (options) | (Constructor) Initialize the package. |
| package:findToc (packages) | Find and read the table of contents. |
| package:registerCommands () | (Override) Register all commands provided by this package. |
| package:registerStyles () | (Override) Register all styles provided by this package. |
Class packages.resilient.fancytoc
The "resilient.fancytoc" package.
Extends packages.resilient.base.
- package:_init (options)
-
(Constructor) Initialize the package.
Parameters:
- options table Package options
- package:findToc (packages)
-
Find and read the table of contents.
This package does not create and maintain a table of contents. It assumes some other adequate module (such as packages.resilient.tableofcontents) was previously loaded for that purpose, exposing a
readToc()method.Parameters:
- packages table Loaded package instances
Returns:
-
table or false
The table of contents, or false if not available
Raises:
If no package exposing areadToc()method is found. - package:registerCommands ()
- (Override) Register all commands provided by this package.
- package:registerStyles ()
- (Override) Register all styles provided by this package.