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.tex114
1 files changed, 22 insertions, 92 deletions
diff --git a/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex b/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex
index 560dcb2796e..98804ad9b38 100644
--- a/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex
+++ b/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex
@@ -1,7 +1,7 @@
-\documentclass[English,Chinese,French,allowbf]{colorart}
+\documentclass[English,Chinese,French,use boldface,simple name]{colorart}
\setsansfont{texgyreheros}[
- Scale=MatchLowercase,
+ Scale=MatchUppercase,
UprightFont=*-regular,
BoldFont=*-bold,
ItalicFont=*-italic,
@@ -45,7 +45,7 @@
\providecommand{\meta}[1]{$\langle${\normalfont\itshape#1}$\rangle$}
\lstset{moretexcs=%
{part,parttext,chapter,section,subsection,subsubsection,frontmatter,mainmatter,backmatter,tableofcontents,href,
- color,NameTheorem,CreateTheorem,proofideanameEN,cref,dnf,needgraph,UseLanguage,UseOtherLanguage,AddLanguageSetting,maketitle,address,curraddr,email,keywords,subjclass,thanks,dedicatory,PLdate,ProjLib,qedhere
+ color,NameTheorem,CreateTheorem,cref,dnf,needgraph,UseLanguage,UseOtherLanguage,AddLanguageSetting,maketitle,address,curraddr,email,keywords,subjclass,thanks,dedicatory,TheDate,ProjLib,qedhere
}
}
\lstnewenvironment{code}%
@@ -99,11 +99,13 @@
%%================================
\begin{document}
-\title{{\normalfont\bfseries\color{maintext}\colorist{}}\\write your articles or books in a colorful way}
+\def\PackageVersion{2022/03/19}
+
+\title{{\normalfont\bfseries\color{main-text}\colorist{}}\\write your articles or books in a colorful way}
\author{Jinwen XU}
-\thanks{Corresponding to: \texttt{\colorist{} 2021/12/16}}
+\thanks{Corresponding to: \texttt{\colorist{} \PackageVersion}}
\email{\href{mailto:ProjLib@outlook.com}{ProjLib@outlook.com}}
-\date{December 2021, in Paris}
+\date{\TheDate{\PackageVersion}[only-year-month], in Paris}
\maketitle
@@ -114,6 +116,10 @@
\end{abstract}
+\begin{tip}
+ This documentation has not been fully up-to-date with the new \texttt{expl3} version of this class series. Some options or commands introduced here might be obsolete.
+\end{tip}
+
\setcounter{tocdepth}{2}
\tableofcontents
@@ -125,7 +131,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}.
+ \item be familiar with the basic usage of \LaTeX{}, and know how to compile your document with \hologo{pdfLaTeX}, \hologo{XeLaTeX} or \hologo{LuaLaTeX}.
\end{itemize}
\LevelOneTitle{Introduction}
@@ -172,7 +178,7 @@ Let's first look at a complete example of \colorart{} (the same works for \lebha
\title{(*\meta{title}*)}
\author{(*\meta{author}*)}
-\date{\PLdate{2022-04-01}}
+\date{\TheDate{2022-04-01}}
\maketitle
@@ -222,7 +228,7 @@ For detailed description of this command and more related commands, please refer
\begin{code}
\title{(*\meta{title}*)}
\author{(*\meta{author}*)}
-\date{\PLdate{2022-04-01}}
+\date{\TheDate{2022-04-01}}
\maketitle
\begin{abstract}
@@ -255,7 +261,7 @@ In addition, you may also write in the \AmS{} fashion, i.e.:
\author{(*\meta{author 2}*)}
\address{(*\meta{address 2}*)}
\email{(*\meta{email 2}*)}
-\date{\PLdate{2022-04-01}}
+\date{\TheDate{2022-04-01}}
\subjclass{*****}
\keywords{(*\meta{keywords}*)}
@@ -359,7 +365,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
+% \clearpage
\LevelOneTitle{The options}
\colorist{} offers the following options:
@@ -390,17 +396,13 @@ In the next section, we will go through the options available.
\begin{itemize}
\item Use the ``runin'' style for \lstinline|\subsubsection|
\end{itemize}
- \item \texttt{puretext} or \texttt{nothms}
+ \item \texttt{nothms}
\begin{itemize}
\item Pure text mode. Do not load theorem-like environments.
\end{itemize}
- \item \texttt{delaythms}
- \begin{itemize}
- \item Defer the definition of theorem-like environments to the end of the preamble. Use this option if you want the theorem-like environments to be numbered within a custom counter.
- \end{itemize}
\item \texttt{nothmnum}, \texttt{thmnum} or \texttt{thmnum=}\meta{counter}
\begin{itemize}
- \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 (with the option \texttt{delaythms} enabled). If no option is used, they will be numbered within \texttt{chapter} (book) or \texttt{section} (article).
+ \item Theorem-like environments will not be numbered / numbered in order 1, 2, 3... / numbered within \meta{counter}. 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}
@@ -530,75 +532,10 @@ For aesthetics, adjacent definitions will be connected together automatically:
Second definition.
\end{definition}
-\LevelTwoTitle{Define a new theorem-like environment}
-
-If you need to define a new theorem-like environment, you must first define the name of the environment in the language to use:
-\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
-And then define this environment in one of following five ways:
-\begin{itemize}
- \item \lstinline|\CreateTheorem*{|\meta{name of environment}\lstinline|}|
- \begin{itemize}
- \item Define an unnumbered environment \meta{name of environment}
- \end{itemize}
- \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}|
- \begin{itemize}
- \item Define a numbered environment \meta{name of environment}, numbered in order 1,2,3,\dots
- \end{itemize}
- \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}[|\meta{numbered like}\lstinline|]|
- \begin{itemize}
- \item Define a numbered environment \meta{name of environment}, which shares the counter \meta{numbered like}
- \end{itemize}
- \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}<|\meta{numbered within}\lstinline|>|
- \begin{itemize}
- \item Define a numbered environment \meta{name of environment}, numbered within the counter \meta{numbered within}
- \end{itemize}
- \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}(|\meta{existed environment}\lstinline|)|\\
- \lstinline|\CreateTheorem*{|\meta{name of environment}\lstinline|}(|\meta{existed environment}\lstinline|)|
- \begin{itemize}
- \item Identify \meta{name of environment} with \meta{existed environment} or \meta{existed environment}\lstinline|*|.
- \item This method is usually useful in the following two situations:
- \begin{enumerate}
- \item To use a more concise name. For example, with \lstinline|\CreateTheorem{thm}(theorem)|, one can then use the name \texttt{thm} to write theorem.
- \item To remove the numbering of some environments. For example, one can remove the numbering of the \texttt{remark} environment with \lstinline|\CreateTheorem{remark}(remark*)|.
- \end{enumerate}
- \end{itemize}
-\end{itemize}
-
\begin{tip}
- This macro utilizes the feature of \textsf{amsthm} internally, so the traditional \texttt{theoremstyle} is also applicable to it. One only needs declare the style before the relevant definitions.
+ Please refer to the documentation of the package \textsf{create-theorem} to see how to declare new theorem-like environments.
\end{tip}
-\NameTheorem[EN]{proofidea}{Idea}
-\CreateTheorem*{proofidea*}
-\CreateTheorem{proofidea}<subsection>
-
-\bigskip
-Here is an example. The following code:
-
-\begin{code}
-\NameTheorem[EN]{proofidea}{Idea}
-\CreateTheorem*{proofidea*}
-\CreateTheorem{proofidea}<subsection>
-\end{code}
-defines an unnumbered environment \lstinline|proofidea*| and a numbered environment \lstinline|proofidea| (numbered within subsection) respectively. They can be used in English context.
-The effect is as follows:
-
-\vspace{-0.3\baselineskip}
-\begin{proofidea*}
- The \lstinline|proofidea*| environment.
-\end{proofidea*}
-
-\vspace{-\baselineskip}
-\begin{proofidea}
- The \lstinline|proofidea| environment.
-\end{proofidea}
-
\LevelTwoTitle{Draft mark}
You can use \lstinline|\dnf| to mark the unfinished part. For example:
@@ -606,13 +543,6 @@ You can use \lstinline|\dnf| to mark the unfinished part. For example:
\item \lstinline|\dnf| or \lstinline|\dnf<...>|. The effect is: \dnf~ or \dnf<...>. \\The prompt text changes according to the current language. For example, it will be displayed as \UseOtherLanguage{French}{\dnf} in French mode.
\end{itemize}
-Similarly, there is \lstinline|\needgraph| :
-\begin{itemize}
- \item \lstinline|\needgraph| or \lstinline|\needgraph<...>|. The effect is: \needgraph or \needgraph<...>
-\clearpage
- The prompt text changes according to the current language. For example, in French mode, it will be displayed as \UseOtherLanguage{French}{\needgraph}
-\end{itemize}
-
\LevelTwoTitle{Title, abstract and keywords}
\colorart{} has both the features of standard classes and that of the \AmS{} classes.
@@ -664,10 +594,10 @@ The author information can contain multiple groups, written as:
Among them, the mutual order of \lstinline|\address|, \lstinline|\curraddr|, \lstinline|\email| is not important.
\bigskip
-\clearpage
+% \clearpage
\LevelOneTitle{Known issues}
-\begin{itemize}[itemsep=.6em]
+\begin{itemize}
\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.