Module classes.resilient.book
The re·sil·ient book document class.
Following the re·sil·ient styling paradigm, and providing way more features then SILE's default "book" class.
Info:
- Copyright: (c) 2021-2025 Omikhleia / Didier Willis
- License: MIT
Class classes.resilient.book
| class:_init (options) | (Constructor) Initialize the book class. |
| class:declareOptions () | (Override) Declare class options. |
| class:setOptions (options) | (Override) Set class options. |
| class:registerStyles () | (Override) Register class styles. |
| class:endPage () | (Override) End-of-page custom hook. |
| class:declareSettings () | (Override) Declare class settings. |
| class:registerCommands () | (Override) Register class commands. |
Class classes.resilient.book
Extends classes.resilient.base.
- class:_init (options)
-
(Constructor) Initialize the book class.
Besides initializing the parent class and loading all needed packages, it also sets some sane defaults for certain settings, overrides some commands from standard SILE packages to make them style-aware, registers some Djot pre-defined symbols, etc.
Parameters:
- options table Class options
- class:declareOptions ()
-
(Override) Declare class options.
The options specific to the resilient book class are:
- layout: page layout
- offset: binding offset
- headers: type of headers (novel, technical, none)
- class:setOptions (options)
-
(Override) Set class options.
Sets the default options (layout to "division", no binding offset, and "technical" headers). All other options are processed by the base class.
The framesets are then defined according to the layout and offset.
Parameters:
- options table Class options
- class:registerStyles ()
-
(Override) Register class styles.
Registers the styles specific to the resilient book class.
- class:endPage ()
-
(Override) End-of-page custom hook.
Outputs the running header according to the page type (odd or even).
- class:declareSettings ()
-
(Override) Declare class settings.
Declares the settings specific to the resilient book class.
- class:registerCommands ()
-
(Override) Register class commands.
Registers the commands specific to the resilient book class.