All notable changes to this project will be documented in this file. See commit-and-tag-version for commit guidelines.
0.15.5 (2024-08-29)
- packages: Support biblatex date field and improve date formatting (5169d67)
- build: Fix distribution of unit tests clean up dist file list (00abf9b)
- classes: Make document state available during class's post init (71336b9)
- cli: Suppress trace info in quiet for warnings but do show errors (e12dcc9)
- packages: Parse and split all bibtex name fields (e3a7dc1), closes #2052
- packages: Use non-breakable space in bibTeX name splitting, not tilde (f4ea4ed)
0.15.4 (2024-06-28)
- build: Add a developer target to test build dist without automake (7bdaf16)
- languages: Add Brazilian Portuguese specific hyphenation points (895c575)
- packages: Biblatex data inheritance and field mapping (646e3a4)
- packages: Support
[@string](https://github.com/string)
syntax in bibTeX bibliography (63083ad), closes #2051 - packages: Support
[@xdata](https://github.com/xdata)
entry type and xdata field in bibTeX bibliography (ca906f0) - packages: Support crossref field in bibTeX bibliography (c4ae919), closes #2021
- tooling: Add developer target to build Rust API docs (384fa46)
- build: Avoid building sile binaries if not using them (bbde8e6)
- build: Avoid the perceived need for an extra automake cycle in dist tarball (f634a60)
- build: Do not distribute main man page, requires Rust tooling (26a6346)
- build: Don't distribute distfiles list with configure option specific output (b9d95fd)
- build: Flag transitive dependency on Git if not using system LuaRocks (ea2d501)
- languages: Always set Fluent locale when setting
document.language
(283fdc3) - packages: Correct handling of ampersands and tildes in bibtex (aaa613f), closes #2050 #1860
- packages: Ignore
[@preamble](https://github.com/preamble)
in bibTeX bibliography (742a0c4), closes #2051
0.15.3 (2024-06-10)
- core: Allow LUA_PATH env var to take effect at runtime (e573c2d)
0.15.2 (2024-06-10)
- build: Bundle all assets in source distribution (5198641)
0.15.1 (2024-06-08)
- build: Distribute vendored compat-5.3.c source file (3c469d6)
- build: Remove Git from configure dependencies (352a125)
- classes: Correct order of operations when paragraphs are ended manually (08f1a7b)
- packages: Change retrograde package so 'target' version works as expected (6ad9b76)
0.15.0 (2024-06-06)
- packages: Lists now respect the input document spacing and normal settings with regard to paragraphs breaks before, after, and inside lists. This is place of overriding the paragraph skip settings to match the list item spacing setting and always forcing paragraph breaks before and after lists.
- classes: Hitherto SILE has cleared the current.parindent setting
as soon as it used it at the beginning of a paragraph. With this
release, the setting is not being cleared until a paragraph is
explicitly ended. This will not have an affect on many documents, but
could completely blow up layout code that implicitly relied on the
effect. Normal paragraphs (e.g. separated by a blank line in the input)
and any use cases that explicitly called far ending a paragraph (e.g. by
calling
\par
) will be unaffected. But anywhere a paragraph break was simulated by adding vertical space, the indentation will not be applied the next start of a line. This means that calling any variant of\skip
inline in a paragraph will result in content beginning on a new line without using the parindent setting.
Fixing this change in behavior requires either explicitly resetting the current.parindent setting after it is initially used or explicitly ending a paragraph before or after placing a vertical skip.
- inputters: Input documents using the SIL language will now retain whitespace more consistently. Whitespace following environment blocks is no longer swallowed in differently than space following command syntax. Consecutive line breaks in the input will consistently trigger new paragraphs no matter what they follow.
Note that this change cannot be patched over via the retrograde package settings because by the time your document could specify what packages to load or settings to set, the input document has already been parsed. To achieve the same rendering results where environments could be ended leaving any amount of blank lines and still joined to the following content as part of the same paragraphs, you will need to remove the extranious whitespace.
- core: Several top level instance creaters of various names have been re-organized under SILE.types.
Specifically SILE.color, SILE.measurement, and SILE.length have the same names, just under SILE.types.. Additionally SILE.nodefactory is now SILE.types.node and SILE.units is not SILE.types.unit.
This brings a little bit of sanity to the naming schemes so that you can guess how to use something from the name, but it also makes room for 3rd party add ons to more easily extend or replace these functions. It also makes it easier to start substituting Rust bits where desired.
reorg
- core: Use SILE.papersize() instead of SILE.paperSizeParser()
- classes: The "center", "raggedleft" and "raggedright" environments formerly reset the margins (left or right skips), meaning they'd take the full frame width. They all cancelled the paragraph indent. The new behavior honors the fixed part of the parent context's margins, meaning that if you have an environment playing with margins such as an epigraph or an indented quote, those margins are not lost. The raggedleft and raggedright environment also now no longer cancel the paragraph indent.
- classes: The \script function was heavily overloaded to have many different functions at once and more targeted tools were introduced in SILE v0.14.0 To load 3rd party modules designed for use with SILE, use \use[module=...] instead of \script[src=...]. To run arbitrary Lua code inline use \lua{}; Lua code may be provided inline or externally via either a require= option to load a regular (non-SILE) Lua module using the Lua module path or src= option to load a file by file path.
- core: For ... reasons ... the default width of spaces in SILE has been a hightly opinionated and non-standard 1.2 spaces. While it can be argued that this makes some fonts and some documents look better, it is a very strange thing to have as a global default. Unfortunately setting it back to a more conventional 1 space is a major change and will cause many/most documents to reflow.
The old default can be recovered either in documents with:
\set[parameter=shaper.spaceenlargementfactor,value=1.2,makedefault=true]
...or even from the CLI when rendering a document:
$ sile -e 'SILE.settings:set("shaper.spaceenlargementfactor", 1.2, true)'
-
core: The previous default paragraph indent was hard coded with a point size (20pt) that did not adapt will to different fonts or page layouts. The new default uses a relative unit that will adjust based on the leading (1bs). This will cause most documents to reflow. To keep them the same the setting may be reset to the old default either in the document:
\set[parameter=document.parindent,value=20pt,makedefault=true]
...or even from the CLI when rendering a document:
$ sile -e 'SILE.settings:set("document.parindent", "20pt", true)'
- utilities: For modules that rely on
SILE.utilities
(SU
), and in particular raw content handling functionssubContent()
,walkContent()
,stripContentPos()
,hasContent()
, andcontentToString()
, these and similar functions have been moved intoSILE.utilities.ast
(SU.ast
). ThesubContent()
implementation also no longer adds id="stuff" attributes to everything. - packages: The default rendering of Ruby readings has changed from
just using a bold weight to using the OpenType +ruby feature. Fonts that
support this should work with no change, but documents rendered in fonts
that do not support it will neet to set the
ruby.opentype
feature tofalse
to get the same rendering method as before. - classes: The former implementation of the "em" command did not support nesting and was just setting the font style to italic. The command now alternates italic and regular when nested.
- packages: The current (pseudo) idempotent behavior when loading a package potentially clobbers anything that has been modified since the last load. Loading a package, then modifying a function it provides, then loading the same package again will clobber the modifiecation. This is good for idempotency but not very good for user experience when you may not be modifying all aspects of a document render pipeline at once, as in when using templates.
This change makes the default behavior to run setting, raw handler, and command registrations only once. An altertanive to :loadpackage() called :reloadpackage() can be used to force all these registrations to be rerun when the goal is to make sure of a specific state.
- classes: Remove obsolete/broken native markdown class
- core: The internal package manager that installed stuff to the system from inside SILE was deprecated back in v0.13.2. It is now completely removed. External 3rd party packages are fully supported using LuaRocks and are much more robust.
- build: Make vendoring Lua sources controllable at build time (773245b)
- build: Set default Lua version to prefer LuaJIT (#1873) (8a8b506)
- classes,outputters,packages: New approach to full bleed printing, cropmarks, background (aa538e2)
- classes: Make text alignment commands honor nesting and margins (7cde8a3)
- classes: Provide a "blockquote" environment in the plain class (75a8bdf)
- classes: Support emphasis nesting (0c1c017)
- cli: Add configure time option to embed Lua resources in binary (9f11100)
- cli: Allow more than one input document (Rust edition) (bdfeecd)
- core: Allow multiple runtime SILE_PATH segments (b329923)
- core: Allow multiple runtime SILE_PATH segments in Lua binary as well as Rust (5e05fa9)
- core: Automatically include project-local lua_modules in module loader path (fd940a9)
- core: Make it easier to add project-specific LuaRocks trees as dependencies (796b344)
- docker: Add all default fonts and package management tooling to container (6bd5dc0)
- docker: Automatically adjust Docker user to owner of mounted data (4ee535f)
- docker: Deploy upcoming major version branches to a
develop
tag on GHCR (bd2c6f3) - docker: Enable data for all provided tools that support system locales (c01203f)
- docker: Make it easier for users to install stuff into the images (71aa6f2)
- inputters: Add formal grammar specification for SIL files (5f78af3)
- inputters: Output source comments in SIL debug info (672226f)
- math: Support numbering display math equations (d2e348f)
- outputters: Add hook system to outputters (b5422a8)
- outputters: Add support for pdf elements to debug outputter (a33e5c7)
- packages: Add package to reset some defaults similar to previous releases (fa8d401)
- packages: Backport default font change from v0.9.5 to retrograde package (6b5f52d)
- packages: Expand retrograde package to handle behavior shims (a549b44)
- packages: Expand retrograde package to shim paragraph indentation changes (bead177)
- packages: Make most package _init() actions run only once (ed3331a)
- packages: PDF links can now span multiple lines (842cb56)
- packages: Remove arbitrary six-level maximum to list nesting (ee76eab)
- packages: Strikethrough and underline can span multiple lines (3eb1a1f)
- packages: Use OpenType +ruby feature for ruby, toggle with setting (624e3a8)
- settings: Add hook callback system for settings (efade76)
- settings: Allow \set with no parameter as a temporary wrapper (59755c9)
- tooling: Add direnv support (a52e6e5)
- tooling: Add DRAFT flag to allow rendering docs without regenerating TOC (f581b54)
- tooling: Add nix builds with various lua versions (c28cd94)
- tooling: Add nix packages building sile with clang (5b30695)
- tooling: Add tooling to generate Lua API documentation from sources (3995e14)
- types: Add __tostring to colors for easier debugging (e1106a7)
- typesetter,shaper: Add automated italic correction heuristics (540b0cf)
- typesetters: Add base typesetter (multi-)liner support (e645dbd)
- utilities: Add Greek alphabetical (non-arithmetic) numbering (34e2e53)
- utilities: Automatically cast anything passed to SU.debug to a string (da80c56)
- utilities: Make it easier to search breadcrumbs excluding the current command (64e8d3b)
- utilities: Refactor and extend AST-handling utilities (fc7e7fb)
- backends: Fix plain text backend to work in LuaJIT/Lua 5.1 (d0a2a1e)
- build: Adjust macfonts module to more robustly import AppKit (c0571be)
- build: Avoid race condition by making sure binary exists before use (d37da35)
- build: Correct configure flag so debug builds are not release mode (d931849)
- build: Fix build configuration for --with-system-libtexpdf (d22ea34)
- build: Move build-time dependency checks out of runtime dep check configure flag (5e587bd)
- build: Stop copying libraries places autotools doesn't normally handle them (68d9008)
- build: Switch from xz to zst compression for official artifacts (685780d)
- classes: Reset current parindent at end of paragraphs, not beginning (84c70fd)
- core: Output makedepends file after class finish and snippets (f59670c)
- core: Use unique function name so static linking doesn't clobber Lua-5.1 (ccdb8a2)
- docker: Use LuaJIT not Lua5.1 for docker builds (7687bf6)
- inputters: Allow empty string as option value in SIL parser (160501c)
- inputters: Correct typo in SIL parser, disallow conflicting commands (923b11e)
- inputters: Make whitespace after envirnomnts behave the same as commands (6d51ee3)
- languages: Handle UTF8 properly in Liang hyphenation (b33c11c)
- languages: Load default en language support if none explicitly requested (#2036) (d02b063)
- packages: Color changes shall not affect other content at page breaks (9d6d409)
- packages: Correct bogus mixup of variable names in package inits (8dfe3c3)
- packages: Fix broken font fallback clear function (2b15de5)
- packages: Use current pagebuilder API not deprecatod one internally (730150f)
- tooling: Add npx to nix' devShell (624137f)
- tooling: Fix Nix build for rustier sile (f53904c)
- tooling: Really ignore all nix symlinks (34b0493)
- typesetters: Debug hbox could show incorrectly offset boxes (c5113b7)
- utilities: Cast empty to default and only ever return a bool from SU.boolean() (ba2e37a)
- utilities: Fix broken breadcrumbs:contains() (f1972bd)
- utilities: Leave tostring() casting to after debug invocations, not before (72965ad)
- classes: Deprecate \script in favor of more explicit options (b738507)
- classes: Remove obsolete/broken native markdown class (133567e)
- core: Change default paragraph indent to 1 baseline skip (542c869)
- core: Change default space width to 1 space (66cdbad)
- core: Deprecate SILE.paperSizeParser() (4486a19)
- core: Remove deprecated package manager (4836a93)
- core: Move assorted classes from oddball names in core to types (8287a0f)
- packages: Stop overriding paragraph handling in and around lists (8b2117c)
0.14.17 (2024-02-07)
- languages: Enable explicit hyphen repetition handling in Croatian (c29545d)
- languages: Enable explicit hyphen repetition handling in Czech (b05d621)
- languages: Enable explicit hyphen repetition handling in Portuguese (2a58d96)
- languages: Enable explicit hyphen repetition handling in Slovak (82640b0)
- languages: Enable explicit hyphen repetition handling in Spanish (8db7f23)
- packages: Add balancing option to makecolums command (#1950) (b5ce8e6)
0.14.16 (2024-01-27)
- tooling: Re-merge so release tag is on master branch (e8eaf11)
0.14.15 (2024-01-27)
- languages: Accommodate alternate Turkish hyphenation guidelines at apostrophes (92904fc)
- typesetters: Support for speaker change introduced by em-dash (2afa4cb)
- languages: Break at ela geminada in Catalan cancels the punt vola (f8c4c1e)
- languages: Break at explicit hyphen in Polish repeats the hyphen (0f8c7aa)
- languages: Remove multiple repetitions of U+00A0 nbsp in French (0356a49)
- languages: U+00A0 nbsp in French causes unexpected word breaks (b93975c)
0.14.14 (2023-12-23)
- cli: Change module load error to suggestion for how to install 3rd party modules (c280050)
- languages: U+00A0 non-breaking space must be stretchable by default (b769a63)
- typesetters: Support U+00AD soft hyphen as discretionary break (285507e)
- backends: Fix plain text backend to work in LuaJIT/Lua 5.1 (b185d49)
- cli: Stop outputting error messages twice on failure to process main file (da5d609)
- core: Use nil-safe and Lua-version-robust table utils (2405b23)
- packages: Adjust dropcap logic for letters with a depth (fd6963d)
0.14.13 (2023-10-30)
- classes: Add landscape option to base class (#1892) (0fb9ade)
- cli: Allow multiple runtime SILE_PATH segments (backport from develop branch) (e7c8fe2)
- frames: Update frame constraints with new frame IDs after \makecolumns (b2d6b4f)
0.14.12 (2023-10-11)
- i18n: Add Portuguese localizations for bibtex package (#1859) (f716c35)
- utilities: Add utility function for console messages without trace info (18526ce)
- build: Make sure vendored luarocks isn't a phony target that runs repeatedly (713434d)
- core: Allocate exactly what we use, not a guess with an extra just in case (640ded0)
- core: Correct usage of HarfBuzz when passing a filtered list of shapers (f488643)
- core: Fixup class loader so cache is all Lua module specs (#1863) (7efff5b)
- packages: Don't warn on TOC content change if not actually used (87c443d)
0.14.11 (2023-08-23)
- core: Leave legacy masterFilename alone but use first input filename internally (29667a7)
- core: Make masterFilename actually a filename (759131e)
- packages: Avoid mix-and-matching indents in fixed-width specimin blocks (de41cac)
- utilities: Use real semver parser for deprecation warnings (5f0fed5)
0.14.10 (2023-07-11)
- cli: Allow more than one input document (d20cbd8)
- i18n: Add localized strings for Cantonese and Chinese (cb67d36)
- packages: Add document class styling in autodoc (e70fa50)
- packages: Provide API for registering raw handlers linked to packages (45cd3ac)
- build: Avoid build artifacts being listed for installation (29c2ccd)
- core: Avoid stack overflow in Harfbuzz module (#1793) (5001efe)
- outputters: Setup --makedeps to play along without explicit --output (6ff2e16)
- packages: Converters package no longer worked after 0.13.0 (433795c)
- packages: Correct chord line height and chord font use (65961c6), closes #1351
0.14.9 (2023-04-11)
- classes: Add Picas unit to cover all units speced in Docbook (88f03fa)
- classes: Implement the
\code
command in the plain class (0d371ba) - cli: Add -q / --quiet flag to reduce output to essential errors (#1759) (f69ed20)
- core: Support initializing fill glues with a width (#1765) (5bc372a)
- packages: Introduce urlstyle hook in the url package (8f6235d)
- packages: New scalebox package for arbitrary box re-scaling (a11f61e)
- packages: Support migrating content in re-wrapped hboxes (da3ab6d)
- typesetters: Implement hbox building logic in the typesetter (0f5bc69)
- build: Distribute SVG and FTL source files in packages (7cef0ea)
- classes: Avoid justification issues with relative parindent (3ffd272)
- classes: Make sure un-numbered chapters make it in the ToC (e5af292)
- classes: Parse bare number and percentage units in docbook images (8b965b9)
- classes: Setting current.hangIndent is a measurement (e213d6e)
- cli: Return success if --help explicitly requested (#1737) (35a229d)
- core,typesetter: Discretionary nodes are incorrectly handled (dd7d05c)
- core: Ensure restoring settings top-level state does not error (fce8447)
- outputters: Update Cairo/Podofo hbox debug API to match libtexpdf (#1703) (607dcf7)
- packages: Correct image aspect preservation logic (6ace5b1)
- packages: Fix output of debug breaks in infonode package (#1725) (c8a1467)
- packages: Make sure pullquotes start in block mode (#1774) (00151bc)
- packages: Strip content position in ToC entries (#1739) (23345ea)
- packages: Text conversion in bookmarks has spacing issues (7ef2bb4)
- typesetter: Account for discretionary dimensions in hbox building (91cb950)
- typesetter: Avoid initializing new line during hbox creation (ae455a1)
- typesetter: New typesetter instances shall not reset settings (16d8a6a)
- typesetter: Skip lines containing only discardables without ignoring next lines (9c3dc65)
- typesetter: Top glues shall be skipped when streching/shrinking a page (8818a24)
- typsetter: Hack around scoping issues for parindent setting (fc85298)
- utilities: Enforce stricter type casts (SU.cast, SU.boolean) (a325eb7)
0.14.8 (2023-01-26)
- build: Pass build time configuration into Lua environment (c5d8789)
- core: Add variations support to font command (a37e7bc)
- shapers: Instantiate variable fonts (d50881f)
- shapers: Support named instances with FontConfig (29119b9)
- shapers: Support named instances with macfonts (39a3242)
- build: Package license file for vendored lunamark fork (#1686) (13df3c1)
- classes: Coerce option values to booleans (#1696) (8368cb4)
- packages: Absolutize parskip heights on use (1ac793f)
- packages: Pass style & weight values to the math font loader (c92712f)
- packages: Quote option values in documentation when necessary (41e47bb)
- tooling: Use
luaEnv
properly (#1679) (a34e1c1)
0.14.7 (2022-12-30)
- build: Allow easy skip of font checks with FCMATCH=true (5c0cef6)
- build: Only check tooling to build manual if really needed (e166e00)
- inputters: Rework SIL input to handle both junk outside of document tag and fragments (4c51c55)
- outputters: Patch up error message when failing to load font (#1671) (771d87f)
- shaper: Correct font-variants using opsz axis (#1666) (a929583)
- shaper: Respect variations when shaping (#1265) (#1662) (f50ae77)
- tooling: Keep all Lua packages in same env for Nix (8fc8670)
- utilities: Tweak breadcrumbs to work under LuaJIT limitations (32f744c)
0.14.6 (2022-12-14)
- build: Add ./configure --enable-developer to ease setup for SILE developers (e8a56ae)
- core: Add SU.collatedSort for language-dependent table sorting with collation (ea7446d)
- core: SU.formatNumber has more options and language support (ed0db29)
- packages: Add package loaded that can later be used to track package dependencies (d48633a)
- packages: Code block environment and raw handler for autodoc (7661330)
- classes: Apply page/framebreak in hmode but warn the user (809cbba)
- cli: Deduplicate Lua module loading paths when adding segments (e0f75b1)
- cli: Escape possible path character in replacement (0161f9a)
- cli: Make user system root not added to resource search path (4305850)
- debug: Correct filename in debug info after includes (#1652) (4990ecc)
- debug: Fix pagebuilder debug functions in absence of luastd (ab46bf7)
- debug: Fix typesetter:debugState() in absence of luastd (42f6b0b)
- inputters: Correct Lua inputter AST expectations to match others (6177b0b)
- inputters: Work around SIL parser returning tags as part of content (ef4efb7)
- languages: Replace custom EN/TR ordinals with ICU (82b6709)
- nodes: Ignore empty node properties when debugging breaks (f034e05)
- packages: Correct content position reporting in inputfilter (bb53d77)
- packages: Don't discard grid makup vboxes at top of new pages (22b899c)
- packages: Fix \cite{key} in bibtex package (#1655) (648bb5d)
- packages: Use casting to restore shaper state after fallbacks (351fc68)
- shapers: Apply tracking settings even in font-fallback shaper (55f0c9c)
- tooling: Exempt LuaJIT from external bit32 library requirement (#1654) (d094f1b)
- typesetter: Ensure being in horizontal mode after pushback (a82b604)
- utilities: Correct logic in AST debugging output, also protect (97c82f0)
- utilities: Protect debug functions so they can't crash SILE (319b96a)
0.14.5 (2022-11-19)
- inputters: Correct false positive detection of STDIN as Lua content (d54946b)
- inputters: Don't duplicate passthrough content in AST (07c8e87)
- inputters: Permit content outside of the document note, e.g. comments or blanks (#1596) (f1a508a)
- inputters: Relax SIL format sniffing to allow valid syntax (43fc4bc)
- languages: Remove superfluous line (848b91f)
- languages: Tidy up variable scope in languages/unicode.lua (78b453d), closes #699
- measurements: Allow redefinition of existing units (#1608) (8d81018)
- packages: Ensure a page switch does not break boustrophedon (#1615) (64abaf9)
0.14.4 (2022-11-05)
- packages: Add boolean noleadingzeros option to counter formatter (e4f8133)
- packages: Add new command \set-multilevel-counter (11578a8)
- classes: Always break out of hmode before processing \chapter headings (0c44d8e)
- core: A typo in a variable prevents using -u with a class (b8f5c40), closes #1569
- languages: Make 'und' an exception to language name canonicalization (52e9b79)
- math: Fix insertion order of MathML children (738e9e6)
- packages: Account for depth when calculating rotation center (289dd2a)
- packages: Avoid forcing mirrored masters in twoside package (#1562) (8cdf6ed)
- packages: Combine
\unichar
'ed chars with same font only (91a8d40) - packages: Correct rotation origin calculation back to pre v0.10.0 (3521936)
- packages: Don't inhibit page breaking after switching masters mid-page (6b20f73)
- packages: Make sure PDF initialized before rotate package directly calls it (449b2a6)
- packages: Rework simple and multilevel counters (1e6e91a)
- packages: Textcase package name typo preventing using methods from code (7f68766), closes #1568
- Revert "docs(packages): Fixup unichar documentation, work around known bug (#1549)" (03d1b11), closes #1549
0.14.3 (2022-09-01)
- languages: Handle hyphenation of inter-word apostrophes in Turkish (50ae936)
- packages: Add \open-spread function with more features that \open-double-page (c2ba579)
- packages: Add ability to select a page in PDF images (a477d94)
- packages: Allow for customized content on otherwise blank filler pages (5ae97bf)
- packages: Provide base directory to packages (#1529) (f9ae994)
- utilities: Return image resolution with libtexpdf backend (a9c11d3)
- cli: Actually apply cli provided class options (505919e)
- cli: Allow CLI option to override document specified class (5232ce8)
- languages: Make Turkish hyphenation less bad around intraword apostrophes (008d4c4)
- nodes: Correct calculating width of postbreak discretionaries (ea7912c)
- nodes: Work around discressionaries being output when not wanted (c7dc439)
- packages: Fix over-aggressive eject in \open-double-page (5620556)
- packages: Homogenize image width and height as measurements (b91cfbb), closes #1506
- packages: Make sure PDF initialized before PDF package does anything (#1550) (ebc3748)
- packages: Resolve src= relative to document for SVG images (b55fc98), closes #1532
- Revert "chore(build): Avoid mktemp during build, breaks opensuse packaging (#1542)" (bca007f), closes #1542
- Revert "chore(cli): Output header before doing anything that might throw warnings" (58da8ad)
0.14.2 (2022-08-11)
- classes: Allow package option declarations to be reset (215e83a)
- classes: Bring back space after subsection numbering (70a3304)
- packages: Check for user supplied commands before setting noops (54b5071)
0.14.1 (2022-08-06)
- cli: Suppress deprecation message for internal shims (b339e27)
- cli: Swap order of new --uses and legacy --include (ef0087e)
- packages: Correct (and improve scope of) exported testcase functions (fd438e9)
- tooling: Make sure Git version detection only picks up semver tags (25d669a)
0.14.0 (2022-08-05)
-
packages: The primary use was probably internal to SILE, but if by chance you have bibtex databases with formatting commands in SIL markup format rather than just plain text content the markup will cease to function and will need to be converted to XML syntax instead.
This enables the use of declarative markup in Fluent localizations.
-
classes: Each SILE package now inherits some interfaces from a common base package. This model allows packages easier access to SILE internals while at the same time tracking what they do so it is easier to enable/disable them. The package knows which document class instance it is attached to, and the document class knows which packages are loaded at any given time. Legacy style packages will continue to work for the time being but will not be tracked in the same way.
-
core: The role of document commands has always been tightly scoped to classes. For example the book class has a
\footnote
command while plain does not—unless you manually load the package and setup the frames. In spite of this obvious functional scope, registering commands has been a global operation that stored them in a global registry. In order to allow SILE to be used more programmatically as a library with potentially more than one document and class being processed at at once, these need to be moved out of the global scope. This will also facilitate things like being able unload packages and revert to previous functionality for anything they over-rood on load. For now the functionality is shimmed, but code using theSILE.registerCommand()
function should switch to the method of the same name on the current class, i.e.class:registerCommand()
. -
core: Some internal files and APIs got renamed with more structured name spaces. In particular the inputter, shaper, and outputter libraries all have a common naming scheme now and sensible inheritance chains. No functionality was harmed, but if you are overriding undocumented internal Lua methods you might have to update your name spaces to match.
-
cli: The
-I
/--include
option was overloaded for more than one purpose and is now deprecated in favor of more specific replacements:-r
/--require
for loading code into SILE before input processing,-p
/--preamble
for processing content prior to a document and-P
/--postamble
for processing content after a document. -
packages: The original package manager POC that used Git to clone packages into the SILE installation directory has been deprecated. It will continue to function for a while, but all new 3rd party packages should use the LuaRocks based installation process. Whether or not they use
luarocks
as a package manager or LuaRocks.org as a distribution channel they should install themselves to any usable the system or user Lua library path under a top level "sile" namespace. -
classes: The shims allowing classes designed for SILE releases v0.12.x and prior have now been removed and documents using them will now throw errors when rendering. Only the refactored class system introduced in SILE v0.13.0 is supported going forward.
-
deps: We previously deprecated all use of stdlib. This release stops providing it entirely. If you use it in your own projects you will now need to provide and require() it directly.
-
build: The C modules compiled as shared libraries (.so files on Linux, .dll on Windows) are now installed to the project root shared directory instead of it's 'core' subdirectory. Distro packages that split the library into its own package will need to adjust this path. People installing from their distro packages or from source should be unaffected, but this will bring us one step closer to being able to install and use SILE as a library.
- classes: Add \use command to help deconflate \script usage (eb298c3)
- classes: Track loaded packages per document class (32bd87b)
- cli: Add CLI argument -E for evaluating Lua code after input (5948aca)
- cli: Add usage hints and cleanup output of errors (cc58824)
- cli: Allow loading custom inputters from
-r
option (a212e83) - cli: Allow passing options to any modules specified from --use (4cdcae7)
- cli: Change --require to --use to match declarative markup (2411328)
- core: Add ability to pass args to modules via \use and other commands that load modules (9e54bad)
- core: Add ability to pass args to modules via \use and other commands that load modules (e64ce0f)
- core: Add inline-escaping in SIL-language (f09b135)
- core: Support loading classes/packages installed with
luarocks
(232e72b) - i18n: Add more Russian localizations (350cf14)
- i18n: Add support for as many languages as possible (da57577)
- i18n: Fallback to messages from 'und' language if no localized (9f47715)
- i18n: Parse XML style SILE commands in Fluent messages (989290b)
- inputters: Allow arbitrary root elements from XML input without a preamble (ad46a92)
- inputters: Allow CLI to mandate inputter used for master document (1b9009f)
- inputters: Promote Lua to first class input filetype, improve input type detection (3540943)
- languages: Add Norwegian localizations (76b8f84)
- languages: Add Norwegian Nynorsk hyphenation exceptions (520cd3f)
- languages: Handle 'nb' code for Norwegian Bokmål, linked to 'no' rules (373bd17)
- math: Add modulus operator support (429b162)
- math: Allow forcing the atom type of an operator (14d384c)
- math: Express lengths in “mu” (math units) (39c7efc)
- math: Macros no longer wrap their replacement into s (d1f24b3)
- math: Print resulting mbox tree to debug log (f2e7c33)
- math: Support relative units in spaces and add standard spaces (4f2bee2)
- packages: Add new method to export package functions to class (07a28a4)
- packages: Allow configuring target folio frame from options (74e3924)
- packages: Provide API for registering commands linked to packages (4875972)
- build: Update Flake to work with Nix >= 2.10 (effb0dc)
- classes: Reset default font direction if document direction changed (11bb0f9)
- cli: Avoid throwing extra error on error without message (0d530a5)
- core: Avoid error when outputting overflow warnings with specific measurements (49ef650), closes #945
- debug: Flatten content if necessary to process and debug location (c753bd2)
- debug: Re-implement option display in trace stacks lost with std (01d2379)
- inputs: Drop Lua path handling duplicated in core (8abb0f2)
- math: Fix caching of getMathMetrics (3332698)
- math: Fix debug logs in TeX-like parsing (a686f90)
- math: Fix spacing before integral operators (bc847b3)
- math: Fix tostring functions in mbox subclasses (7a7c6bc)
- math: Set math elements to inherit hbox node properties (0279556)
- math: Turn font name printing into debug log (068ec4b)
- outputter: Non-RGB colors shall work with the debug outputter (#1469) (e68dee3)
- packages: Correct URL formatting when backend is not libpdftex (fc4212d)
- packages: Ensure grid hook is ineffective when grid is off (b99482b), closes /github.com/sile-typesetter/sile/issues/1174#issuecomment-1173141699
- packages: Make \script command properly initialize packages (#1479) (9723d0d)
- packages: Parse height argument to
\raise
/\lower
as measurement (#1506) (7196fda) - packages: Stop legacy package manager from adding empty paths (cf9b9fa)
- packages: Stricter color parsing and improved color documentation (f7b919a)
- packages: The autodoc package could choke on some inputs (#1491) (c7db5d5)
- utilities: Correct traceback output for SILE.error() to show parent, not itself (16b8900)
- build: Move C modules to same relative location in source directory as installed (55ad795)
- classes: Remove stdlib class shims (c4210da)
- cli: Deprecate CLI argument -I in favor of -r, -p, and -P (d63a484)
- deps: Stop providing Lua stdlib (8a8c0e9)
- packages: Deprecate legacy package manager (b72653c)
- core: Move inputters/shapers/outputters to isolated classes (14329ce)
- core: Move registerCommand() out of global to classes (bc527ea)
- packages: Process bibtex content as XML not SIL (a259b32)
0.13.3 (2022-07-15)
- packages: Add minimal support for usual BibTeX types (bibtex) (292a2f2)
- build: Update Flake to work with Nix >= 2.10 (3d5a18c)
- core: Avoid duplicate paths blocking directory searches (7a7209f)
- core: Avoid error when outputting overflow warnings with specific measurements (cb51ed5), closes #945
- outputter: Non-RGB colors shall work with the debug outputter (#1469) (41fbdf4)
- packages: BibTeX types/tags are case-insensitive, etc (61c1fc6)
- packages: Make \script command properly initialize packages (9ded7e1)
0.13.2 (2022-06-29)
- core: Add presets for some ANSI paper sizes and ArchE variants (0f26756)
- languages: Add full Esperanto language support (b740709)
- packages: Add 'lists' package (bullets and enumerations) (6af3c62)
- packages: Add more options for custom 'lists"' styling (3167410)
- packages: Handle font fallback when glyph named null returned on shape failure (09c0a86)
- packages: Pass through font-specific options to fallback fonts (fb29442)
- classes: Clarify the scopes of
tate
andjplain
(db83e9e) - classes: Fix circular reference in pecha class (4501ec0)
- classes: Fix diglot and triglot class instantiation (71af1a9)
- core: Make paper size parser case insensitive, e.g. 'a4' or 'A4' (af441c8)
- measurements: Move the zenkaku width (zw) unit into core (cfe5060)
- packages: Correct fall-back font processing (d3cc59b)
- packages: Correct package load path for colored dropcaps (41a0c17)
- packages: Fix coding errors in untested corners of bibtex package (804b1a5)
- packages: Fix loading TOC twice resetting pdf links (97797b8)
- shaper: Handle switching between color & fallback shapers in single document (04f2d5d)
- utilities: Raise Lua error instead of manually aborting if inside pcall() (6e70a17)
0.13.1 (2022-06-18)
- build: Update libtexpdf to support new hardware platforms (da1182e)
- packages: Add hrulefill command to the "rules" package (ccd3371)
- packages: Add strikethrough command to the rules package (#1422) (f230a3a)
- packages: Use new strikethrough when rendering Panndoc's SILE writer (20d19eb)
- build: Make sure i18n/ dir is actually distributed (#1445) (61ed8e1)
- packages: Add more props to keep CJK from tipping over, per #1245 (381b9f1)
- packages: Leaders shall be an explicit (non-discardable) glue (631ba21)
- packages: The fullrule now extends over a full standalone line (8fe57c8)
0.13.0 (2022-06-09)
-
settings: All the functions under
SILE.settings.*()
should now be called using the instance notationSILE.settings:*()
. Usage should be shimmed with a warning for now.Changing this in your code is relatively easy with a search and replace. As an example with a project in Git, you could use perl like this:
funcs="pushState|popState|declare|reset|toplevelState|get|set|temporarily|wrap" git ls-files | xargs -n1 perl -i -pne "s#(SILE\.settings)\.($funcs)#\1:\2#g"
-
typesetter: Making a new instance of the typesetter should now be done by calling
SILE.defaultTypesetter()
instead of copying the object. It has been changed from a std.object to a Penlight class. As such the correct initialization function is also now_init()
instead ofinit()
. A shim is in place to catch legacy usage, but this will be removed in the future. -
deps: All calls to the Lua default string library have been using a version monkey-patched by stdlib. This has created all sorts of issues including not being able to properly use some of Lua's default features and conflicts with out explicit meta methods. Also we're busy dropping dependency stdlib altogether.
If you were relying on it for any of your string operations, replace
string.func()
withstd.string.func()
. For nowstd
is being provided by SILE, but if you use it in your projects please add it as a direct dependency yourself since that will eventually be removed as well.By the way in case anything ever
git bisect
s back to here, one way to test if your problem is related to this change or not (especially if you have downstream code that might have built on the assumption SILE's Lua strings were monkey patched) is to load it manually yourself:$ sile -e 'require("std.string").monkey_patch()' your_file.sil
-
classes: This changes the way classes are represented as Lua objects and the mechanism used for inheritance. While shims will be in place to catch most cases that use old syntax it is not possible to grantee 100% API compatibility. If you have classes that do anything remotely fancy (i.e. not just copy/paste from SILE examples) they may or may not work at all; and even if they do they should be updated to explicitly use the new API.
- classes: Add hook system for more versatile packages (9287721)
- languages: Add \ftl command to make adding fluent localizations easy (b331456)
- languages: Add fluent() command to output translations (ad87995)
- languages: Validate languages against CLDR database (f96a331)
- backends: Add Pango shaper when selecting Cairo backend (bbc2817)
- backends: Always output pdf on finish() even if no content (3af7a94)
- backends: Correct image sizing in Cairo and Podofo backends (f2785ad)
- core: Avoid throwing deprecation errors when just inspecting SILE's internals (b303059)
- core: Justify lines with ligatures (workaround) (cf2cb3a)
- core: Patch Penlight 1.9.0 compatibility issue (092fbd3)
- languages: Correct bogus usage of resource loading / error catching (fb1fd7f)
- packages: An hrule with depth shall not affect current baseline (c759892)
- packages: Don't destroy frames when defining masters, only when switching to one (b7de7ca)
- packages: Fix autodoc parsing, typeset string not series of bytes (14f6126)
- deps: Drop std.string.monkey_patch() (e8b2bdf)
- classes: Convert class inheritance from stdlib to Penlight (f7dafe0)
- settings: Change settings object to be self referential (dd97d05)
- typesetter: Change typesetter instancing to Penlight model (a9400ad)
0.12.5 (2022-04-18)
- build: Catch and complete unfinished library builds (91ff438)
- build: Use BSD compatible scripting in
make selfcheck
(319e0c5) - build: Use POSIX compatible shell syntax in configure (55e64ab)
- deps: Correct include to work with current LuaRocks packages (#1357) (b584be5)
- languages: French punctuation spacing must honor current font options (724daf4)
- packages: Better TOC title extraction for PDF bookmark (#1029) (5a65701)
- packages: The dotfill must stretch as an hfill (#1343) (c94a4b5)
0.12.4 (2022-03-03)
- docker: Fix GHCR → Docker Hub copy used when releasing (e5d83d0)
- packages: Avoid infinite loop when re-enabling BiDi (b4d691b)
0.12.3 (2022-03-02)
- frames: Inherit class direction setting in new frames (35c8a25)
- packages: Make boxaround respect shrink/strech (rules package) (9d8f708)
- packages: Make underline respect shrink/strech (rules package) (a5d99f0)
- typesetter: Enable bidi for default typesetter on package load (6a8d7f4)
0.12.2 (2022-01-28)
0.12.1 (2022-01-12)
- build: Accommodate SOURCE_DATE_EPOCH for reproducible builds (16c81a8)
- classes: Add \noop function for versatile SILE.call() use (2b04507)
- core: Add OpenType post (v1) table parser (a985aed)
- core: Implement Knuth's hangAfter and hangIndent (5417189)
- core: Implement paragraph duration hanging indent settings (18ee23b)
- core: Implement paragraph shaping (parshape) (c2c0235)
- packages: Add dropcaps package (cb9105a)
- packages: Add shift, raise, and size options to dropcaps (0a88948)
- packages: Implement color option for dropcaps (d042bcf)
- packages: Use font's post table to determine underline position (ae1b929)
- backends: Move Lua 5.1 macro so covers whole file (9b40772)
- classes: Reset state when calling running headers (ec0a7b8)
- classes: Unnumbered book sections shall not display a number in running headers (4afde42)
- Fixes name of accented math symbol, eliminates duplicate newStandardHspace assignment (4c38f1a), closes #1274
- languages: Correct hyphenation after apostrophe in French and Catalan (4c93891)
- languages: Correct synchronisation between indexes in French word breaking (94ca931)
- languages: Repair broken French hyphenation patterns (c25d9d7)
- packages: Add \pdf:metadata support for dates (1b87305)
- packages: Apply OpenType x and y offsets to color fonts (d66dc5f), closes #1147
- packages: Correct rebox to not output duplicate content (2802d9b)
- packages: Don't over-isolate functions run in Pandoc imports (#1254) (84507a5)
- utilities: Fix UTF-16 encode/decode utility functions (7180081), closes #1280
- utilities: Set language of roman numerals to Latin to avoid casing issues (#1253) (95c4e2c)
0.12.0 (2021-09-22)
- packages: Previous to this release footnote and folio frames took their font settings from a new typesetter with default settings. With this release the settings are now derived from the typesetter in the default frame, hence inheriting font family, size, leading, and other settings. Values can still be set using the same functions, but relative values such as font sizes are based on a different base.
- core: Add MATH variants table parser (b6c554e)
- core: Add OpenType MATH table parser (835da21)
- math: Add ‘debug’ option to math command (58cc9dc)
- math: Add “big operator” support (5b9a150)
- math: Add fixes to support less complete fonts (1c22af3)
- math: Add italic correction to superscript; correct subscript size (d81fdee)
- math: Add math.font.filename setting (522d70b)
- math: Add math.font.size setting (5077d1c)
- math: Add operator defaults (14bdf1a)
- math: Add parameter to draw debug boxes around math components (2458d18)
- math: Add parameters and support mathvariant param for mi tag (869dca8)
- math: Add plain text support (3a09e9d)
- math: Add subscript and superscript; add math constants (0489c04)
- math: Add support for “symbol macros”, expanding to strings (27658f5)
- math: Add support for fractions (6f4fc24)
- math: Add tags for some mathematical symbols (b9fd771)
- math: Add tex-like math parser (edceaf7)
- math: Allow vertical stacking of top-level ‘mrow’s (56b553c)
- math: Center display math neatly (8951378)
- math: Implement and use munder and mover (61eac7a)
- math: Implement generic bbox shaper (9c86aff)
- math: Output error if rending with non-math font (c79617b)
- math: Replace leading
-
with−
in numbers (f8d490c) - math: Support double-struck identifiers (29674bf)
- math: Support for simple macros (5b4ecf7)
- math: Support italic (c9b2884)
- math: Support more integral-like operators (90a6c44)
- math: Support of UTF-8 in texmath, support of mo, mi and mn in-grammar (959d1cc)
- math: Turn "-" (hyphen) into "−" (minus) in math (fbed523)
- packages: Add border style and color to hyperlinks (bb880be)
- packages: Add function to remove last added fallback font (acf987b)
- packages: Add linking support to toc entries (e589cb9)
- packages: Add toc depth option and hooks for showing section numbers (c48fcde)
- packages: Allow URLs to have many breakpoints (#1233) (b145605)
- packages: Warn if toc contents have changed (5b6eed8)
- tooling: Enable use as a Nix flake (8b503bb)
- classes: Don't increment counters on unnumbered book sections (6cfca4d)
- core: Correct --help output to reflect required values (da487ec)
- languages: Add test 704 for French punctuations, fix expected 621 and 702 results (8e9b056)
- languages: Correct Armenian support to use ISO 639 code ‘hy’ (ffafbe6)
- languages: Correct punctuation rules for French (95c2398)
- languages: Don't initialize Japanese unless actually called for (3aba931)
- languages: Shortcut ICU soft breaks in French (ed8734c)
- math: Fix underover error with sub wider than base but no sup (bc87393)
- packages: Don't replace shaper unless actually initializing color-fonts package (269ca59)
- packages: Fix deprecation warning command in package docs (a69d774)
- packages: Reset footnote and folio settings top level state (3795a4e)
- shaper: Fix memory leak in Harfbuzz library (#1243) (035dcc8)
0.11.1 (2021-09-03)
- build: Avoid implied line continuation in makefile (f2af48f)
- build: Require Git even building tarballs, used by package manager (aba8662)
- languages: Update deprecated syntax in language options (3fb1719)
0.11.0 (2021-09-01)
-
packages: Previous to this release any and all leading between paragraphs (as set with document.parskip) –even a 0 height skip– would result in the skip of one full empty grid space — as if parskip had been set to something approximating a full line height. This change corrects the calculation so if a 0 height skip is added and everything fits, the next line or paragraph will continue uninterrupted in the next grid slot. To get the previous layout behavior back, document.parskip must be explicitly set to be something larger than 0. Even a minimal 1pt skip will result in paragraph spacing that includes one full grid height left blank as before:
\set[parameter=document.parskip,value=1lh]
-
utilities: Previous return value for breadcrumbs:contains() was just an depth index with -1 indicating no match. This made sense when I wrote it, but coming back to it for a new project I expected a boolean return value. Returning two values seems like the best option, but given the function naming it seemed to make sense to return the boolean first, hence the API breakage.