Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/omikhleia/couyards.sile

Pendant ornaments (culs-de-lampe) for the SILE typesetting system
https://github.com/omikhleia/couyards.sile

print sile typesetting

Last synced: about 1 month ago
JSON representation

Pendant ornaments (culs-de-lampe) for the SILE typesetting system

Awesome Lists containing this project

README

        

# couyards.sile

[![License](https://img.shields.io/github/license/Omikhleia/couyards.sile?label=License)](LICENSE)
[![Luacheck](https://img.shields.io/github/actions/workflow/status/Omikhleia/couyards.sile/luacheck.yml?branch=main&label=Luacheck&logo=Lua)](https://github.com/Omikhleia/couyards.sile/actions?workflow=Luacheck)
[![Luarocks](https://img.shields.io/luarocks/v/Omikhleia/couyards.sile?label=Luarocks&logo=Lua)](https://luarocks.org/modules/Omikhleia/couyards.sile)

This package for the [SILE](https://github.com/sile-typesetter/sile) typesetting
system provides a few “couyards”, a.k.a. “culs-de-lampe” or, simply, “pendants”.

Typographers of the past relied on a number of ornaments to make their books look nicer.

A _cul-de-lampe_ (plural _culs-de-lampe_) is a typographic ornament, sometimes called a
_pendant_, marking the end of a section of text. The term comes from French, for “bottom of
the lamp” (from the historical shape of the ornament). In French typography, they are also
called _couillards_ or _couyards_ (apparently named, erm… after a body part, really).
It may be a single illustration, often assembled from “fleurons”.

The present package defines a few such ornaments, that book authors might possibly find
interesting to improve the look of their documents, without having to rely on single-character
fleurons provided in fonts. They come as SVG files, and a simple package for easily inserting
them with appropriate options.

![couyards](couyards.png "Pendants, a.k.a. culs-de-lampe, couyards or fleurons")

Note that I am not the designer of the original artworks.
The first seven designs were converted to SVG from drawings by [Tartila](https://fr.freepik.com/vecteurs-libre/diviseurs-fleurs-calligraphiques_10837974.htm), free for personal and commercial usage with proper attribution.
Number 8 and 9 are in the public domain (CC0), from [FreeSVG](https://freesvg.org).

## Installation

This package require SILE v0.14 or upper.

Installation relies on the **luarocks** package manager.

To install the latest version, you may use the provided “rockspec”:

```
luarocks install couyards.sile
```

(Refer to the SILE manual for more detailed 3rd-party package installation information.)

## Usage

Examples are provided in the [examples](./examples) folder.

The in-code package documentation may also be useful.
A readable version of the documentation is included in the User Manual for
the [resilient.sile](https://github.com/Omikhleia/resilient.sile) collection
of classes and packages.

## License

All SILE-related code and samples in this repository are released under the MIT License, (c) 2021-2022 Omikhleia.