Skip to content

Commit

Permalink
docs: Small changes to the User Guide and README
Browse files Browse the repository at this point in the history
  • Loading branch information
Didier Willis committed Oct 12, 2024
1 parent 1b123f4 commit 3172cb1
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 39 deletions.
48 changes: 19 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,39 @@
[![Luacheck](https://img.shields.io/github/actions/workflow/status/Omikhleia/resilient.sile/luacheck.yml?branch=main&label=Luacheck&logo=Lua)](https://github.com/Omikhleia/resilient.sile/actions?workflow=Luacheck)
[![Luarocks](https://img.shields.io/luarocks/v/Omikhleia/resilient.sile?label=Luarocks&logo=Lua)](https://luarocks.org/modules/Omikhleia/resilient.sile)

This collection of classes and packages for the [SILE](https://github.com/sile-typesetter/sile)
typesetting system provides advanced book classes and tools.
This collection of classes and packages for the [SILE](https://github.com/sile-typesetter/sile) typesetting system provides advanced classes, packages and tools for streamlining the production of high-quality books and documents.

This collection offers:
- At its core, a challenging and interesting “styling” paradigm, allowing to configure many
styling decisions with a consistent and unified approach, abstracting the complexity.
It offers a wide range of features, including:
- At its core, a challenging and interesting “styling” paradigm, allowing to configure many styling decisions with a consistent and unified approach, abstracting the complexity.
- A “master document” format, for easily combining your content from multiple files into a consistent work.
- A pretty strong “book” class, with:
- A mind-bogling choice of sound page layouts — old-fashioned or modern,
- Almost everything you may expect for such a class: parts, chapters, sections, subsections, subsubsections…
- Highly configurable table of contents, headers, footers, footnotes and sectioning environments,
- And other useful features, from cross-references to advanced captioned figure and table environments, and more…
- A great parity with Markdown, including many Pandoc-like extensions.
- A “master document” format, for easily assembling your content.
- A great parity with Markdown, including many Pandoc-like extensions, and with Djot
- A lightweight “résumé” class, for you to produce a colorful and yet professional-looking _curriculum vitæ_.

Whether you a seasoned typist or a beginner, the _re·sil·ient_ collection aims at making the process of creating beautiful books as simple as possible, from front cover to back cover, using a lightweight markup language for most of the content, if not all of it.

## Installation

These packages require SILE v0.14 or upper.
These packages require SILE v0.14 or upper (recommended: SILE v0.15.5 or upper).

Installation relies on the **luarocks** package manager.
See its installation instructions on the [LuaRocks](https://luarocks.org/) website.

To install the latest version and all its dependencies (see below),
you may use the provided “rockspec”:
To install the latest version and all its dependencies (see below):

```
luarocks install resilient.sile
```

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

## Usage

A complete PDF version of the documentation (but not necessarily always the latest) should be
available [HERE](https://drive.google.com/file/d/1f54qDEGWaN-MFN932x-t0jm3V-5VSHee/view?usp=sharing), or in our [Calaméo bookshelf](https://www.calameo.com/accounts/7349338).
A complete PDF version of the documentation (but not necessarily always the latest) should be available [HERE](https://drive.google.com/file/d/1f54qDEGWaN-MFN932x-t0jm3V-5VSHee/view?usp=sharing), or in our [Calaméo bookshelf](https://www.calameo.com/accounts/7349338).

## See also

Expand All @@ -56,31 +55,22 @@ This collection also imports several modules also provided separately, would you
- [Markdown](https://github.com/Omikhleia/markdown.sile) (support for Markdown, Djot etc.)
- [Pie charts](https://github.com/Omikhleia/piecharts.sile) (support for pie charts)

When used with this collection, the Markdown packages and the fancy table of contents are
leveraged with additional capabilities.
When used with this collection, the Markdown packages and the fancy table of contents are leveraged with additional capabilities.

## Historical note

This collection is the successor of the my “[Omikhleia’s classes & packages for SILE](https://github.com/Omikhleia/omikhleia-sile-packages)”,
fully redesigned for SILE v0.14 or upper, and provided as a separate installable module.
This collection is the successor of “[Omikhleia’s classes & packages for SILE](https://github.com/Omikhleia/omikhleia-sile-packages)”, fully redesigned for SILE v0.14 or upper, and provided as a separate installable module.

Besides all the changes from SILE v0.12 to v0.14, and its new package and class APIs,
the redesign entails many more things, with breaking changes
(consider it as v2.x of the former solution).
Besides all the changes from SILE v0.12 to v0.14, and its new package and class APIs, the redesign entails many more things, with breaking changes.It can be considered as a v2.x of the former solution.

It therefore comes under a new name (also used as a namespace here and there),
**resilient**.
The name is a pun on "SILE" (as, after all, the initial target was always on
redoing a book class that would satisfy my requirements), but there will be a
bit more to it than that, which might become more visible when the collection
expands.
It therefore comes under a new name (also used as a namespace here and there), **resilient**.
The name is a pun on “SILE” (as, after all, the initial target was always on redoing a book class that would satisfy my requirements), but there is a bit more to it than that, which might become more visible when the collection expands.

## License

All code is under the MIT License.

The documentation is under CC-BY-SA 2.0.

The examples (i.e. anythings in the "examples" folder) have varying licenses and some are
used by courtesy of the authors. Please check their respective license or ask, in case of
doubts, for details and exact licensing terms.
The examples (i.e. anythings in the “example” folder) have varying licenses and some are used by courtesy of the authors.
Please check their respective license or ask, in case of doubts, for details and exact licensing terms.
40 changes: 40 additions & 0 deletions examples/sile-resilient-manual-styles.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,46 @@ bookmatter-copyright:
paragraph:
align: "noparindent"

bookmatter-cover-author:
inherit: "bookmatter-coverpage"
origin: "resilient.bookmatters"
style:
font:
size: "16pt"
properties:
case: "upper"

bookmatter-cover-publisher:
inherit: "bookmatter-coverpage"
origin: "resilient.bookmatters"
style:

bookmatter-cover-subtitle:
inherit: "bookmatter-coverpage"
origin: "resilient.bookmatters"
style:
font:
size: "16pt"
paragraph:
after:
skip: "5%fh"

bookmatter-cover-title:
inherit: "bookmatter-coverpage"
origin: "resilient.bookmatters"
style:
font:
size: "20pt"
paragraph:
after:
skip: "5%fh"
before:
skip: "30%fh"

bookmatter-coverpage:
origin: "resilient.bookmatters"
style:

bookmatter-halftitle:
origin: "resilient.bookmatters"
style:
Expand Down
12 changes: 2 additions & 10 deletions examples/sile-resilient-manual.silm
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ metadata:
- book
authors: Didier Willis
publisher: Omikhleia
pubdate: 2024-03-17
pubdate: 2024-10-12
url: https://github.com/Omikhleia/resilient.sile
copyright: © 2021–2024, Didier Willis.
legal: |
Expand All @@ -36,21 +36,13 @@ sile:
layout: division 9
resolution: 300
settings:
textsubsuper.fake: false
textsubsuper.fake: true
autodoc.highlighting: true
document.baselineskip: 1.2em
typesetter.italicCorrection: true # Available in SILE 0.15 (comment out for earlier versions)
packages:
- autodoc-resilient # REQUIRED FOR RESILIENT, do not use regular autodoc
- background # Some of the packages below might not be required...
- lorem
- dropcaps
- resilient.abbr
- framebox
- fancytoc
- printoptions
- qrcode
- couyards
parts:
- content:
- manual-front.sil
Expand Down

0 comments on commit 3172cb1

Please sign in to comment.