Module packages.resilient.styles
A style package for re·sil·ient.
Info:
- Copyright: (c) 2021-2025 Omikhkeia / Didier Willis
- License: MIT
Class packages.resilient.styles
| package:_init (options) | (Constructor) Initialize the package. |
| package:readStyles () | (Override) Register all styles provided by this package. |
| package.writeStyles () | Write the styles to a YAML file, if there are new styles. |
| package:defineStyle (name, opts, styledef[, origin]) | Programmatically define a style. |
| package:resolveStyle (name[, discardable]) | Resolve a style (incl. |
| package:hasStyle (name) | Check whether a style is defined. |
| package:resolveParagraphStyle (name[, discardable]) | Resolve a paragraph style, applying defaults to missing fields. |
| package:freezeStyles () | Freeze the styles, preventing further modification. |
| package:registerCommands () | (Override) Register all commands provided by this package. |
Class packages.resilient.styles
The "resilient.styles" package.
Extends packages.base.
- package:_init (options)
-
(Constructor) Initialize the package.
Parameters:
- options table Package options
- package:readStyles ()
- (Override) Register all styles provided by this package.
- package.writeStyles ()
- Write the styles to a YAML file, if there are new styles.
- package:defineStyle (name, opts, styledef[, origin])
-
Programmatically define a style.
Optional origin allows tracking e.g which package declared that style and just used for debugging after styles are 'frozen', we can still define new styles but not override existing styles.
Parameters:
- package:resolveStyle (name[, discardable])
-
Resolve a style (incl. inherited fields)
NOTE: an optimization could be to cache the results...
Parameters:
- name string Style name
- discardable boolean If true, do not raise an error if the style is not found (optional)
- package:hasStyle (name)
-
Check whether a style is defined.
Parameters:
- name string Style name
Returns:
-
boolean
True if the style is defined
- package:resolveParagraphStyle (name[, discardable])
-
Resolve a paragraph style, applying defaults to missing fields.
Parameters:
- name string Style name
- discardable boolean If true, do not raise an error if the style is not found (optional)
Returns:
-
table
The resolved style definition
- package:freezeStyles ()
- Freeze the styles, preventing further modification.
- package:registerCommands ()
- (Override) Register all commands provided by this package.