Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omikhleia/silex.sile
Extension layer for SILE and resilient
https://github.com/omikhleia/silex.sile
Last synced: 17 days ago
JSON representation
Extension layer for SILE and resilient
- Host: GitHub
- URL: https://github.com/omikhleia/silex.sile
- Owner: Omikhleia
- License: mit
- Created: 2023-08-04T14:24:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-31T16:54:28.000Z (2 months ago)
- Last Synced: 2024-10-13T10:06:02.974Z (about 1 month ago)
- Language: Lua
- Size: 373 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# silex.sile
[](LICENSE)
[](https://github.com/Omikhleia/silex.sile/actions?workflow=Luacheck)
[](https://luarocks.org/modules/Omikhleia/silex.sile)
A silex is a kind of hard stone.
This is **sile·x**, a common layer for [**re·sil·ient**](https://github.com/Omikhleia/resilient.sile) and other modules:
Some common bricks and blocks, compatility features, opinionated hacks, and eXperimental eXpansions, hence the name.
:warning: **sile·x** overrides several SILE internals when fully enabled, and may therefore break some of your packages and classes.
### Installation and removal
Install with [Luarocks](https://luarocks.org/):
```shell
luarocks install silex.sile
```
Uninstall:
```shell
luarocks remove silex.sile
```
Obviously, modules needing it (and therefore also intalling it as a dependency), such as [markdown.sile](https://github.com/Omikhleia/markdown.sile) and [resilient.sile](https://github.com/Omikhleia/resilient.sile) (amongst others) will not work without it.
## Features
**classes** and **typesetters** :warning: Opinionated departure from SILE 0.14.
Modified implementation of the base typesetter and class.
- Cancellation of the multiple package instantiation model in the base class.
See **silex.fork** below for details.
- Propagation of hanged indent from paragraph to paragraph.
_Rationale:_
See [SILE discussion 1742](https://github.com/sile-typesetter/sile/discussions/1742)
- Multi-liners i.e. support for environment spanning multiple lines.
_Rationale:_
Early adoption of SILE PR [1977](https://github.com/sile-typesetter/sile/pull/1977)
**outputters and packages** :warning: In-advance adoption of features.
Modified implementation of the PDF outputter and of several packages depending on it.
_Rationale:_
Early adoption of SILE PR [1853](https://github.com/sile-typesetter/sile/pull/1853)
The corresponding changes are planned to be available in SILE 0.15 (in development).
**silex.lang**
This module overrides the language support in SILE to accept and resolve BCP47 language tags, such as `en-GB`, `es-MX`, `fr-CH`, etc.
In other layman's terms, it changes the behavior of SILE's `\language` command.
This implementation does _not_ change how SILE's `\font[language=...]` command works.
_Rationale:_
See [SILE PR 1641](https://github.com/sile-typesetter/sile/pull/1641) for details and more complete proposal.
We cannot wait forever for SILE to implement this: Markdown and Djot need to be able to support qualified language names, notably for smart quotes to work adequately.
**silex.fixes** :warning: Opinionated departure from SILE 0.14.
This modules implements some additions and changes which should be provided by SILE in my humble opinion...
- More tolerance on uninitialized inputters options (non-breaking)
This fix is planned to be available in SILE 0.15 (in development).
- Greek numbering ("greek") for counters, similar to the existing "alpha" (non-breaking)
_Rationale:_
There are books where one wants to "number" items with Greek letters in sequence (e.g. annotations in biblical material), as α β γ δ ε ζ η θ ι κ λ μ ν ξ ο π ρ σ τ υ φ χ ψ ω. ICU provides _arithmetic_ Greek numbering systems, but this is not what one wants here.
This utility is planned to be available in SILE 0.15 (in development).
- Re-implementation of the centered and ragged environments, to respect margins (a.k.a. left and right skips) when nested (for instance in block quotes) and to honor the paragraph indent (possibly breaking :warning:)
_Rationale:_
The "core" implementation of these environments is broken since its inception.
These features are planned to be available in SILE 0.15 (in development).
- Re-implementation of the `\em` command to support nested emphasis (possibly breaking :warning:)
_Rationale:_
See [SILE issue 1048](https://github.com/sile-typesetter/sile/issues/1048) for context. Djot and Markdown both recognize nested emphasis...
This feature is planned to be available in SILE 0.15 (in development).
**silex.fork** :warning: Opinionated departure from SILE 0.14.
The module cancels the multiple package instantiation model introduced in SILE 0.13-0.14. Packages are no longer re-instantiated when loaded multiple times.
_Rationale:_
I struggled too many times with this issue in August 2021 (initial effort porting my 0.12.5 packages to 0.14.x) and afterwards.
See [SILE issue 1531](https://github.com/sile-typesetter/sile/issues/1531) for some details.
I can't make _any_ sense of this half-baked "feature", which introduces unintended side-effects and problems impossible to decently address, making the life of package and class developers real harder. So I'm moving on and cancelling it.
The _very few_ cases where this could have been interesting can be addressed in other ways...
Some of the issues are supposed to be fixed in SILE 0.15 (in development).
**silex.ast**
A library of common SILE AST utilities.
_Rationale:_
The need for such functions kept popping up in my packages and inputters, so I decided to factor them out, to ease maintenance and avoid code duplication.
In my humble opinion, SILE should eventually provide these functions in the core distribution (and clean up or refactor some of its existing methods on that occasion)...
These utilities are planned to be available in SILE 0.15 (in development).
**silex.compat**
Compatibility layer providing some fixes also proposed to SILE and possibly integrated in a release.
This is obviously not exhaustive, and it only covers issues I backported for my own packages to work with the then-current SILE releases.
_Rationale:_
Official release dates are not predictable, and may moreover take some time to reach the users, but normally you do not need to use this module if you are using the latest SILE release.
**silex.override**
When loaded, this layer enforces using silex-modified versions of some packages and components, overriding the original ones.
## Affected modules
If you use packages or classes from the following modules, some features of **silex** will be loaded globally. Your documents using them may therefore be impacted from that point.
- The packages from [smartquotes.sile](https://github.com/Omikhleia/smartquotes.sile) enable **silex.lang**.
- The packages and inputters from [markdown.sile](https://github.com/Omikhleia/markdown.sile) enable **silex.lang** and **sile.ast**.
- The packages and classes from [resilient.sile](https://github.com/Omikhleia/resilient.sile) enable **all** features.
As noted, some global changes are also introduced in the typesetter and base document class. Side-effects are therefore possible on some workflows.
## Future directions
The plan: SILE + **sile·x** + **re·sil·ient** = SILE as it should be.
Did I say this was opinionated?
Whatever you may think, expect some more breaking changes and furious experiments in the future...
## License
All code is under the MIT License.