Module packages.resilient.base
Base class for style-enabled packages in re·sil·ient.
It provides a base class for packages that want to use styles, and a few convenience methods hide the internals.
Info:
- Copyright: (c) 2023-2025 Omikhleia / Didier Willis
- License: MIT
Class packages.resilient.base
| package:_init (options) | (Constructor) Initialize the package. |
| package:registerStyle (name, opts, styledef) | Register a style. |
| package:resolveStyle (name[, discardable]) | Resolve a style name into a style definition. |
| package:hasStyle (name) | Check if a style is defined. |
| package:registerStyles () | (Abstract) Register all styles. |
Class packages.resilient.base
Base class for style-enabled packages.
Extends SILE's packages.base.
- package:_init (options)
-
(Constructor) Initialize the package.
It ensures the
packages;resilient.stylespackage is loaded, and calls the registerStyles method, which is a convenient hook to register all styles for subclasses.Parameters:
- options table Package options
- package:registerStyle (name, opts, styledef)
-
Register a style.
Parameters:
- package:resolveStyle (name[, discardable])
-
Resolve a style name into a style definition.
Parameters:
- name string Style name
- discardable boolean If true, do not raise an error if the style is not found (optional)
Returns:
-
table or nil
Style definition
- package:hasStyle (name)
-
Check if a style is defined.
Parameters:
- name string Style name
Returns:
-
boolean
True if the style is defined
- package:registerStyles ()
-
(Abstract) Register all styles.
For overriding in any package subclass, as a convenient hook where to register all styles.