summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/colorist/colorist-doc.tex')
-rw-r--r--Master/texmf-dist/doc/latex/colorist/colorist-doc.tex32
1 files changed, 14 insertions, 18 deletions
diff --git a/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex b/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex
index f8bea775a17..e17a0ba2079 100644
--- a/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex
+++ b/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex
@@ -1,16 +1,4 @@
-\documentclass[English,Chinese,French,allowbf,puretext]{colorart}
-
-\theoremstyle{basic}
-\CreateTheorem{definition}<highest>
-\CreateTheorem{theorem}[definition]
-\CreateTheorem{conjecture}[definition]
-\CreateTheorem*{example*}
-\CreateTheorem{problem}[definition]
-
-\theoremstyle{emphasis}
-\CreateTheorem{remark}<highest>
-
-\theoremstyle{simple}
+\documentclass[English,Chinese,French,allowbf]{colorart}
%%================================
%% Import toolkit
@@ -105,7 +93,7 @@
\title{\colorist{}, write your articles or books in a colorful way}
\author{Jinwen XU}
-\thanks{Corresponding to: \texttt{\colorist{} 2021/07/27}}
+\thanks{Corresponding to: \texttt{\colorist{} 2021/07/30}}
\email{\href{mailto:ProjLib@outlook.com}{ProjLib@outlook.com}}
\date{July 2021, Beijing}
@@ -322,6 +310,7 @@ If you like the current document class, but want a more ``plain'' style, then yo
\end{code}
\end{tip}
+\vspace{1.5\baselineskip}
\LevelTwoTitle{Example - \colorbook}
Now let's look at an example of \colorbook{} (the same works for \beaulivre{}).
@@ -366,6 +355,7 @@ There is no much differences with \colorart{}, only that the title and author in
In the next section, we will go through the options available.
+\clearpage
\LevelOneTitle{The options}
\colorist{} offers the following options:
@@ -400,9 +390,14 @@ In the next section, we will go through the options available.
\begin{itemize}
\item Pure text mode. Does not load theorem-like environments.
\end{itemize}
- \item \texttt{nothmnum}
+ \item \texttt{nothmnum}, \texttt{thmnum} or \texttt{thmnum=}\meta{counter}
\begin{itemize}
- \item Theorem-like environments will not be numbered.
+ \item Theorem-like environments will not be numbered / numbered in order 1, 2, 3... / numbered within \meta{counter}. Here, \meta{counter} should be a built-in counter (such as \texttt{subsection}) or a custom counter defined in the preamble. If no option is used, they will be numbered within \texttt{chapter} (book) or \texttt{section} (article).
+ \end{itemize}
+ \item \texttt{regionalref}, \texttt{originalref}
+ \begin{itemize}
+ \item When referencing, whether the name of the theorem-like environment changes with the current language. The default is \texttt{regionalref}, \emph{i.e.}, the name corresponding to the current language is used; for example, when referencing a theorem-like environment in English context, the names "Theorem, Definition..." will be used no matter which language context the original environment is in. If \texttt{originalref} is enabled, then the name will always remain the same as the original place; for example, when referencing a theorem written in the French context, even if one is currently in the English context, it will still be displayed as ``Théorème''.
+ \item In \texttt{fast} mode, the option \texttt{originalref} will have no effect.
\end{itemize}
\end{itemize}
@@ -412,7 +407,7 @@ Additionally, \colorart{} and \colorbook{} offers the following options:
\begin{itemize}
\item Optional paper size. The default paper size is 8.5in $\times$ 11in.
\end{itemize}
- \item \texttt{palatino}, \texttt{times}, \texttt{garamond}, \texttt{biolinum} ~$|$~ \texttt{useosf}
+ \item \texttt{palatino}, \texttt{times}, \texttt{garamond}, \texttt{noto}, \texttt{biolinum} ~$|$~ \texttt{useosf}
\begin{itemize}
\item Font options. As the name suggest, font with corresponding name will be loaded.
\item The \texttt{useosf} option is used to enable the old-style figures.
@@ -488,7 +483,7 @@ After using \lstinline|\UseLanguage{French}|, a theorem will be displayed as:
Un théorème en français.
\end{theorem}
-By default, when referenced, the name of the theorem always matches the language of the context in which the theorem is located. For example, the definition above is still displayed in English in the current French mode: \cref{def: strange} and \cref{thm}. If you want the name of the theorem to match the current context when referencing, you can add \texttt{regionalref} to the global options.
+By default, when referenced, the name of the theorem matches the current context. For example, the definition above will be displayed in French in the current French context: \cref{def: strange,thm}. If you want the name of the theorem to always match the language of the context in which the theorem is located, you can add \texttt{originalref} to the global options.
\end{tip}
\UseLanguage{English}
@@ -535,6 +530,7 @@ If you need to define a new theorem-like environment, you must first define the
\begin{itemize}
\item \lstinline|\NameTheorem[|\meta{language name}\lstinline|]{|\meta{name of environment}\lstinline|}{|\meta{name string}\lstinline|}|
\end{itemize}
+
For \meta{language name}, please refer to the section on language configuration. When \meta{language name} is not specified, the name will be set for all supported languages. In addition, environments with or without asterisk share the same name, therefore, \lstinline|\NameTheorem{envname*}{...}| has the same effect as \lstinline|\NameTheorem{envname}{...}| .
\medskip