summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/colorist/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-01-06 21:59:09 +0000
committerKarl Berry <karl@freefriends.org>2023-01-06 21:59:09 +0000
commit0492ea456b7eb88005d12623552eb08bdcaaeee9 (patch)
tree8a03db43b92f81942f8fedb4ae5be0dd569c0054 /Master/texmf-dist/doc/latex/colorist/README.md
parent4dbe788ef60909b4540d038a5bd5ce450b3ba868 (diff)
jxu (6jan23)
git-svn-id: svn://tug.org/texlive/trunk@65475 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/colorist/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/colorist/README.md29
1 files changed, 15 insertions, 14 deletions
diff --git a/Master/texmf-dist/doc/latex/colorist/README.md b/Master/texmf-dist/doc/latex/colorist/README.md
index fbfd1cd0be2..8e281b3e90f 100644
--- a/Master/texmf-dist/doc/latex/colorist/README.md
+++ b/Master/texmf-dist/doc/latex/colorist/README.md
@@ -2,16 +2,18 @@
# `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`.** -->
+> **New documentations are being written and are expected to be completed by the end of 2023. In the meantime, only the core code would be included in TeX Live 2023 coming this April (old documentations have been removed from the distribution).**
## 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.
+`colorist` is a collection of styles and classes that helps you to typeset 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
+ - `colorist-fancy.sty` : the style "fancy"
+ - ... and more styles to come (currently on schedule: "plain", "classical", "modern", "simple", "elegant", "flow", "stream")
- `colorart.cls` : class for typesetting articles
- `colorbook.cls` : class for typesetting books
@@ -24,13 +26,13 @@ with a colorful design. It mainly consists of two parts.
- `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
+ 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
+### How to get these files
You can get the `.sty` and `.cls` files mentioned above simply by compiling
`colorist.ins`:
```
@@ -39,19 +41,18 @@ 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
+- Several carefully designed styles
+- 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, with clever referencing support
- Support both the standard and the AMS writing fashion
+- ... and so much more...
# License