Kırlent

Kırlent [1] is a collection of utilities for managing educational content. The idea is to generate small units of content which can then be composed into larger units. A unit can contain actual content, or it can also be a collection that consists of other content units.

Getting started

You can install Kırlent using pip:

pip install kirlent

If you plan to author slides using Kırlent you should enable the slides extra during install:

pip install kirlent[slides]

Kırlent uses reStructuredText as its markup language for source files. The recommended structure all content units as folders under a main folder. Every document should have the language code as a prefix to its file extension:

content
|- expressions
|  |- slides.en.rst
|  `- slides.tr.rst
`- statements

The output folders for generated items will replicate this hierarchy, as in:

_build
|- expressions
|  |- slides.en.pdf
|  `- slides.tr.pdf
`- statement

Kırlent is built on the doit tool which makes it very easy to support incremental builds. That is, Kırlent will build an output again only if any of the relevant input files have changed.

Getting help

The online documentation is available on: https://kirlent.readthedocs.io/

The source code can be obtained from: https://gitlab.com/tekir/kirlent

License

Copyright (C) 2017-2019 H. Turgut Uyar <uyar@tekir.org>

Kırlent is released under the GPL license, version 3 or later. Read the included LICENSE.txt for details.

[1]“Kırlent” is a Turkish word which means a decorative pillow. It originates from the Italian word “ghirlanda”. It’s also the name of this beauty.

Indices and tables