# Sile

Simon’s Improved Layout Engine

## What is SILE?

SILE is a typesetting system; its job is to produce beautiful printed documents. Conceptually, SILE is similar to TeX—from which it borrows some concepts and even syntax and algorithms—but the similarities end there. Rather than being a derivative of the TeX family SILE is a new typesetting and layout engine written from the ground up using modern technologies and borrowing some ideas from graphical systems such as InDesign.

## What can I do with SILE (that I can’t do with TeX)?

First, have a look at the usage examples gallery. SILE allows you to:

• Produce complex document layouts using frames.

• Easily extend the typesetting system in a high-level programming language (Lua).

• Directly process XML to PDF without the use of XSL stylesheets.

• Typeset text on a grid.

### For macOS

A formula is available for Homebrew that can install either stable or head versions. For the latest prebuilt stable release:

$brew install sile  Or to build and install from the latest git commit: $ brew install sile --HEAD


Note the Homebrew package does not automatically install the default font. The easiest way to install Gentium Plus is through the Homebrew Fonts caskroom:

$brew tap homebrew/cask-fonts$ brew install --cask font-gentium-plus


### For Linux

#### Arch Linux

Arch Linux has a prebuilt SILE package in the official package repository:

$pacman -S sile  The official package uses Lua 5.4. Alternatively, a package that uses LuaJIT may be built manually from the Arch User Repository using sile-luajit. A VCS package is also available as sile-git to build from the latest Git commit. #### NixOS Nix packages are available in both the stable and unstable channels. Because all packages are first made available in the unstable channel and then eventually make their way into the stable channel, to get the latest stable SILE releases we recommend hitting up the unstable channel first. You can use all the usual Nix tricks including launching a new shell with the sile command available or running it directly from any shell: $ nix shell nixos-unstable#sile
$sile <arguments>$ nix run nixos-unstable#sile -- <arguments>


The SILE source repository is also a valid Nix Flake which means you can run any specific version or the latest unreleased development code directly:

$nix run github:sile-typesetter/sile/v0.30.0 -- <sile arguments>$ nix run github:sile-typesetter/sile -- <sile arguments>


Besides of course its use in NixOS, the Nix package manager is also available on most Linux and BSD distributions, macOS, and even for Windows via WSL making it a viable alternative to run SILE on many platforms.

#### Ubuntu

A PPA is available for Ubuntu users with packages of SILE and all the necessary dependencies. We introduced support starting with Bionic (18.04) and maintain packages for all Ubuntu release series since for as long as they are supported by Canonical.

$sudo add-apt-repository ppa:sile-typesetter/sile$ sudo apt-get update
$sudo apt-get install sile  #### Void Linux Void Linux packages are available in the default package manager. #### Other Other Linux distros may install via source, via Linux Brew, or via Nix. ### For BSD Install from OpenBSD ports, via source, or via Nix. ### For Windows There is no installer yet (track the status in issue #410). Nobody is currently maintaining Windows compatibility in SILE and we expect the state to be a bit broken. Users of WSL (Windows Subsytem for Linux) may use the package manager of their choice depending on the system installed, including the respective Arch Linux or Ubuntu packages, Linux Brew, source, or via [Nix][#nixos]. Some early work is present in the repository that should enable builds via CMake and Visual Studio, see discussion in issue #567, but it needs a refresh for current dependencies. Prebuilt Windows binaries are supposed to be generated by the Azure build pipeline and may be downloaded by selecting a build, opening the Windows job, selecting the artifact link from the final stage, and using the download button next to the sile folder. ### Multi-Platform & Containers #### Docker Docker images are available as siletypesetter/sile. Released versions are tagged to match (e.g. v0.10.0), the latest release will be tagged latest, and a master tag is also available with the freshest development build. In order to be useful you need to tell the Docker run command a way to reach your source documents (and hence also to give it a place to write the output) as well as tell it who you are on the host machine so the output generated inside the container can be created with the expected ownership properties. You may find it easiest to run with an alias like this: $ alias sile='docker run -it --volume "$(pwd):/data" --user "$(id -u):$(id -g)" siletypesetter/sile:latest'$ sile input.sil


One notable issue with using SILE from a Docker container is that by default it will not have access to your system’s fonts. To work around this you can map a folder of fonts (in any organization usable by fontconfig) into the container. This could be your system’s default font directory, your user one, a folder with project specific resources, or anything of your choosing. You can see where fonts are found on your system using fc-list. The path of your choosing from the host system should be mounted as a volume on /fonts inside the container like this:

$docker run -it --volume "/usr/share/fonts:/fonts" --volume "$(pwd):/data" --user "$(id -u):$(id -g)" siletypesetter/sile:latest


#### Nix

The nix package manager is available as a standalone package manager on many platforms and is a viable way to run SILE. See usage in the NixOS section.

### From Source

SILE source code can be downloaded from its website or directly from the GitHub releases page.

SILE is written in the Lua programming language, so you will need a working Lua installation on your system (Lua 5.1, 5.2, 5.3, 5.4, and LuaJIT (2.0, 2.1, or OpenResty) are fully supported). It also relies on external libraries to access fonts and write PDF files. Its preferred combination of libraries is Harfbuzz and libtexpdf, a PDF creation library extracted from TeX. Harfbuzz (minimum version 1.1.3) should be available from your operating system's package manager. For Harfbuzz to work you will also need fontconfig installed. SILE also requires the ICU libraries for Unicode handling.

On macOS, ICU can be installed via Homebrew:

$brew install icu4c  After that, you might need to set environment variables. If you try to brew link and you get a series of messages including something like these two lines, you will need to run that export line to correctly set your path: For pkg-config to find icu4c you may need to set: export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig"  Optionally you may install the Lua libraries listed in the rockspec to your system (using either your system's package manager or luarocks (luarocks install --deps-only sile-dev-1.rockspec). By default all the required Lua libraries will be downloaded and bundled alongside the SILE the instalation. If you downloaded a source tarball these dependencies are included, if you are using a git clone of the source repository the build system will require luarocks to fetch them during build. Note that OpenSSL development headers will be required for one of the Lua modules to compile¹. If your system has all the required packages already you may add --with-system-luarocks to the ./configure command to avoid bundling them. ¹ OpenSSL development headers are required to build luasec, please make sure they are setup BEFORE trying to build SILE! If you use your system’s Luarocks packages this will be done for you, otherwise make sure you can compile luasec. You can try just this step in isolation before building SILE using luarocks --tree=/tmp install luasec. If you are building from a a git clone, start by running the script to setup your environment (if you are using the source tarball this is unnecessary): $ ./bootstrap.sh


Once your dependencies are installed, run:

$./configure$ make install


This will place the SILE libraries and executable in a sensible location.

On some systems you may also need to run:

$sudo ldconfig  … before trying to execute sile to make the system aware of the newly installed libraries. ### Default Font Since SILE v0.9.5, the default font has been Gentium Plus which is freely available from SIL’s site. It is not required that you install it, but if this font is not installed on your system, you won't be able to use the examples without modification. (Previously we used Gentium Basic, but that's getting harder to get hold of.) ### Testing If all goes well after installation you should be able to compile a sample documents. Try creating a file test.sil with this content: \begin{document} Hello world! \end{document}  And render it to a PDF like this: $ sile test.sil
SILE v0.12.5 (Lua 5.4)
<test.sil>
[1]


You should now have test.pdf ready for review.

### Use as a CI job

There are actually many ways to run SILE remotely as part of a CI work flow. Because packages are available for many platforms, one way would be to just use your platforms native package installation system to pull them into whatever CI runner environment you already use. Another way is to pull in the prebuilt Docker container and run that.

As a case study, here is how a workflow could be setup in GitHub Actions:

name: SILE
on: [ push, pull_request ]
jobs:
sile:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/[email protected]
- name: Render document with SILE
uses: sile-typesetter/[email protected]
with:
args: my-document.sil


Add to your repository as .github/workflows/sile.yaml. This work flow assumes your project has a source file my-document.sil and will leave behind a my-document.pdf. Note the comments in the section about Docker regarding version tags.

## Contact

Please report bugs and send patches and pull requests at the github repository. For questions and discussion, please join the mailing list.

Open Source Agenda is not affiliated with "Sile" Project. README Source: sile-typesetter/sile
Stars
1,233
Open Issues
329
Last Commit
6 days ago
Repository