summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/colorist/README.md
blob: b40c6088b28cae64a6c0520d61dca5aab747050c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<!-- Copyright (C) 2021-2022 by Jinwen XU -->

# `colorist` bundle: write you documents in a colorful way

**The whole series have been rewritten with `expl3`. Please note that the documentations are not yet up-to-date. The syntax of some commands have been changed since the last version, especially the declaration of theorem-like environments by `\CreateTheorem`. For the moment, you can refer to the documentation of the package `create-theorem`.**

## Introduction

`colorist` is a collection of styles and classes that helps you typesetting articles and books
with a colorful design. It mainly consists of two parts.

- Main part:
    - `colorist.sty` : interface of the main style
        - `colorist-fancy.sty` : the fancy style
    - `colorart.cls` : class for typesetting articles
    - `colorbook.cls` : class for typesetting books

    They can be used with any major TeX engine. Currently they have native
    support to English, French, German, Italian, Portuguese
    (European and Brazilian) and Spanish typesetting.


- Derivative part:
    - `lebhart.cls` : enhanced version of `colorart`
    - `beaulivre.cls` : enhanced version of `colorbook`

    They are similar to the main classes, but have unicode support, thus can
    only be used with either XeLaTeX or LuaLaTeX. Currently they have native
    support to Chinese (simplified and traditional), English, French, German,
    Italian, Japanese, Portuguese (European and Brazilian), Russian and Spanish
    typesetting, and also use more beautiful fonts.

### How to get these files
You can get the `.sty` and `.cls` files mentioned above simply by compiling
`colorist.ins`:
```
latex colorist.ins
```
To get the `.tex` source files of the documentation, compile `colorist-doc.ins`:
```
latex colorist-doc.ins
```

## Features

Compared with usual document classes, it has the following features:

- Native multi-language support: Chinese (simplified and traditional), English,
  French, German, Italian, Japanese, Portuguese (European and Brazilian),
  Russian and Spanish
    > In particular, for simplified Chinese, traditional Chinese and Japanese,
    > the fonts of the corresponding glyphs can be automatically switched
- Ready-to-use theorem-like environments, also with multi-language support
- Support both the standard and the AMS writing fashion


# License

This work is released under the LaTeX Project Public License, v1.3c or later.