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

Real or fake superscripts and subscripts for the SILE typesetting system
https://github.com/omikhleia/textsubsuper.sile

print sile typesetting typography

Last synced: about 1 month ago
JSON representation

Real or fake superscripts and subscripts for the SILE typesetting system

• Host: GitHub
• URL: https://github.com/omikhleia/textsubsuper.sile
• Owner: Omikhleia
• License: mit
• Created: 2022-08-19T15:40:07.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-29T19:22:22.000Z (3 months ago)
• Last Synced: 2024-08-29T21:38:31.545Z (3 months ago)
• Topics: print, sile, typesetting, typography
• Language: Lua
• Homepage:
• Size: 57.6 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# textsubsuper.sile

[![license](https://img.shields.io/github/license/Omikhleia/textsubsuper.sile?label=License)](LICENSE)

[![Luacheck](https://img.shields.io/github/actions/workflow/status/Omikhleia/textsubsuper.sile/luacheck.yml?branch=main&label=Luacheck&logo=Lua)](https://github.com/Omikhleia/textsubsuper.sile/actions?workflow=Luacheck)

[![Luarocks](https://img.shields.io/luarocks/v/Omikhleia/textsubsuper.sile?label=Luarocks&logo=Lua)](https://luarocks.org/modules/Omikhleia/textsubsuper.sile)

This package for the [SILE](https://github.com/sile-typesetter/sile) typesetting

system provides ways to typeset superscripted or subscripted text properly,

using real (i.e. based on OpênType font properties) or fake (scaled

and raised) characters, with several tuning options.

As it names imply, it is not a general-purpose super/subscript package, but it

operates on text:

- Detecting and using, when available, OpenType font features for “real” superscripts

  or subscripts;

- Scaling and raising (or lowering) characters in the “fake” case, with special

  provisions for digits and character weight.

In other words, it aims at providing a standardized way to get a “decent typographical”

output for superscripted or subscripted text, with appropriate fallbacks.

![superscripts and subscripts](textsubsuper.png "Superscripts and subscripts")

## Installation

This package require SILE v0.14.13 or upper.

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

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

```

luarocks install textsubsuper.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-2023 Omikhleia.