summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/colorist
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-08-08 20:56:35 +0000
committerKarl Berry <karl@freefriends.org>2021-08-08 20:56:35 +0000
commit3de8aad561c3a6fb16971dc6c7f68c189e8c4dc1 (patch)
tree463ca75a088513e81c3b28923ab24b24df4db0e8 /Master/texmf-dist/doc/latex/colorist
parentf03a7a678fbbe006c2272f28b48465f049327d40 (diff)
jxu (8aug21)
git-svn-id: svn://tug.org/texlive/trunk@60195 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/colorist')
-rw-r--r--Master/texmf-dist/doc/latex/colorist/README.md30
-rw-r--r--Master/texmf-dist/doc/latex/colorist/colorist-doc.pdfbin95143 -> 94096 bytes
-rw-r--r--Master/texmf-dist/doc/latex/colorist/colorist-doc.tex13
3 files changed, 33 insertions, 10 deletions
diff --git a/Master/texmf-dist/doc/latex/colorist/README.md b/Master/texmf-dist/doc/latex/colorist/README.md
index 05164cf1d0b..2b54c97fa2a 100644
--- a/Master/texmf-dist/doc/latex/colorist/README.md
+++ b/Master/texmf-dist/doc/latex/colorist/README.md
@@ -2,7 +2,9 @@
# `colorist` bundle: write you documents in a colorful way
-A collection of styles and classes that helps you typesetting articles and books
+## 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:
@@ -15,7 +17,7 @@ with a colorful design. It mainly consists of two parts.
(European and Brazilian) and Spanish typesetting.
-- Derivative part (they have separate pages on CTAN):
+- Derivative part:
- `lebhart.cls` : enhanced version of `colorart`
- `beaulivre.cls` : enhanced version of `colorbook`
@@ -25,6 +27,30 @@ with a colorful design. It mainly consists of two parts.
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.
diff --git a/Master/texmf-dist/doc/latex/colorist/colorist-doc.pdf b/Master/texmf-dist/doc/latex/colorist/colorist-doc.pdf
index 56badd7b1f9..365d097b77f 100644
--- a/Master/texmf-dist/doc/latex/colorist/colorist-doc.pdf
+++ b/Master/texmf-dist/doc/latex/colorist/colorist-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex b/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex
index e17a0ba2079..d0782450d0e 100644
--- a/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex
+++ b/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex
@@ -93,9 +93,9 @@
\title{\colorist{}, write your articles or books in a colorful way}
\author{Jinwen XU}
-\thanks{Corresponding to: \texttt{\colorist{} 2021/07/30}}
+\thanks{Corresponding to: \texttt{\colorist{} 2021/08/08}}
\email{\href{mailto:ProjLib@outlook.com}{ProjLib@outlook.com}}
-\date{July 2021, Beijing}
+\date{August 2021, Beijing}
\maketitle
@@ -116,6 +116,7 @@
In order to use the package or classes described here, you need to:
\begin{itemize}
\item install TeX Live or MikTeX of the latest possible version, and make sure that \texttt{colorist} and \texttt{projlib} are correctly installed in your \TeX{} system.
+ \item download and install the required fonts if needed.
\item be familiar with the basic usage of \LaTeX{}, and knows how to compile your document with \hologo{pdfLaTeX}, \hologo{XeLaTeX} or \hologo{LuaLaTeX}.
\end{itemize}
@@ -189,7 +190,6 @@ If you find this example a little complicated, don't worry. Let's now look at th
\LevelThreeTitle{Initialization}
-\medskip
\begin{code}
\documentclass{colorart}
\usepackage{ProjLib}
@@ -199,7 +199,6 @@ Initialization is straightforward. The first line loads the document class \colo
\LevelThreeTitle{Set the language}
-\medskip
\begin{code}
\UseLanguage{French}
\end{code}
@@ -212,7 +211,6 @@ For detailed description of this command and more related commands, please refer
\LevelThreeTitle{Title, author information, abstract and keywords}
-\medskip
\begin{code}
\title{(*\meta{title}*)}
\author{(*\meta{author}*)}
@@ -262,7 +260,6 @@ In addition, you may also write in the \AmS{} fashion, i.e.:
\LevelThreeTitle{Draft marks}
-\medskip
\begin{code}
\dnf<(*\meta{some hint}*)>
\end{code}
@@ -271,7 +268,6 @@ When you have some places that have not yet been finished yet, you can mark them
\LevelThreeTitle{Theorem-like environments}
-\medskip
\begin{code}
\begin{theorem}\label{thm:abc}
Ceci est un théorème.
@@ -488,7 +484,6 @@ By default, when referenced, the name of the theorem matches the current context
\UseLanguage{English}
-\bigskip
The following are the main styles of theorem-like environments:
\begin{theorem}
Theorem style: theorem, proposition, lemma, corollary, ...
@@ -656,10 +651,12 @@ The author information can contain multiple groups, written as:
Among them, the mutual order of \lstinline|\address|, \lstinline|\curraddr|, \lstinline|\email| is not important.
+\clearpage
\LevelOneTitle{Known issues}
\begin{itemize}[itemsep=.6em]
\item The font settings are still not perfect.
+ \item The TOC design does not look very nice.
\item Since many features are based on the \ProjLib{} toolkit, \colorist{} (and hence \colorart{}, \lebhart{} and \colorbook{}, \beaulivre{}) inherits all its problems. For details, please refer to the ``Known Issues'' section of the \ProjLib{} documentation.
\item The error handling mechanism is incomplete: there is no corresponding error prompt when some problems occur.
\item There are still many things that can be optimized in the code.