Skip to content

Instantly share code, notes, and snippets.

@alerque
Forked from simoncozens/0.10.0 release notes
Last active January 14, 2020 05:30
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save alerque/4adfee5951800100eecade24383e4c2d to your computer and use it in GitHub Desktop.
Save alerque/4adfee5951800100eecade24383e4c2d to your computer and use it in GitHub Desktop.
## [0.10.0](https://github.com/sile-typesetter/sile/compare/v0.9.5...v0.10.0) (2020-01-13)
### ⚠ BREAKING CHANGES
* This removes the auto-guessing file extension mechanism that allowed *.sil files to be loaded without specifying the full file name with extensions.
A command like `sile test` will no longer find and build sile.sil, you must
run `sile test.sil`. The mechanism that was doing this was a hack than only
worked in some scenarios anyway, and dropping it instead of trying to cover
all the edge cases will make it that much easier to use and document.
Importantly it avoids edge cases where both *.xml, *.sil, and/or *.lua files
all have the same name and the loader really has so idea which one you mean.
Note that _packages_ may still be loaded with no file extension, this
does not affect the `require()` mechanism that looks for *.lua and
various other incantations by default.
* Many internal classes have been renamed or deprecated, and the default class model has changed from `std` to `penlight`. Old methods should still be available, but those developing external Lua packages and classes will want to check the [wiki](https://github.com/sile-typesetter/sile/wiki) for instructions on how to update their code.
### Bug Fixes and Improvements
Most of the many, many improvements in this release are under the hood - the build and test systems have been significantly overhauled, the release process has been streamlined and partially automated, continuous integration now tests code quality and commit messages, and there has been an enormous amount of code refactoring. All of these things make for a more readable codebase and a more reliable and maintainable development environment, which we hope will facilitate SILE development in the future.
There are also some user-facing improvements:
* Installation is made easier, as SILE will now download and bundle the Lua modules that it requires. For those who have their own Lua installation and *wish* to make use of dependent modules installed with `luarocks` or their system's package manager, use the `--with-system-luarocks` argument to `./configure`.
* Error and warning reporting has been improved; SILE will now tell you where in the document any errors occurred and (with the `--trace` option) the stack of commands it took to get there.
* Language support: fixes to hyphenation in Danish, Greek, Finnish, and Ukranian. French punctuation conventions are followed, with (optional) non-breaking spaces before high punctuation marks. Numbers can now be formatted as ordinals (at least for English and Turkish), by using the counter display type `nth`, and as words using the `string` display type.
* A new `text` backend is available to dump a text-only version of the rendering process. This can much more accurate that extracting text versions from a PDF later for search indexing or similar purposes.
* Improvements to tracking/letterspacing.
* Boustrophedon, grid, and simpletable packages now work again.
* Temporarily switching away from fonts specified by filename into a verbatim environment won't crash any more.
* Dependency system: `sile -m` will output a Makefile snippet showing all the files required to build a SILE document.
* Adding the `toc=false` option to a book section or subsection will cause it not to be added to the table of contents.
* Added a man page for quick reference of CLI options.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment