summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/colorist/colorist-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/colorist/colorist-doc.tex')
-rw-r--r--macros/latex/contrib/colorist/colorist-doc.tex55
1 files changed, 36 insertions, 19 deletions
diff --git a/macros/latex/contrib/colorist/colorist-doc.tex b/macros/latex/contrib/colorist/colorist-doc.tex
index 38db3b3d8c..a6b226644b 100644
--- a/macros/latex/contrib/colorist/colorist-doc.tex
+++ b/macros/latex/contrib/colorist/colorist-doc.tex
@@ -1,5 +1,5 @@
%! TEX program = xelatex
-\documentclass[allowbf,puretext]{colorart}
+\documentclass[English,French,allowbf,puretext]{colorart}
\theoremstyle{basic}
\CreateTheorem{definition}<highest>
@@ -16,7 +16,7 @@
%%================================
%% Import toolkit
%%================================
-\usepackage{PJLtoolkit}
+\usepackage{ProjLib}
\usepackage{longtable} % breakable tables
\usepackage{hologo} % more TeX logo
@@ -44,7 +44,7 @@
}
\providecommand{\meta}[1]{$\langle${\normalfont\itshape#1}$\rangle$}
\lstset{moretexcs=%
- {linenumbers,nolinenumbers,subsection,href,
+ {linenumbers,nolinenumbers,subsection,subsubsection,href,
color,NameTheorem,CreateTheorem,proofideanameEN,cref,dnf,needgraph,UseLanguage,UseOtherLanguage,AddLanguageSetting,maketitle,address,curraddr,email,keywords,subjclass,thanks,dedicatory,PJLdate,ProjLib
}
}
@@ -88,7 +88,7 @@
\title{{\normalfont\textbf{\textsf{colorist}}}, write your articles or books in a colorful way}
\author{Jinwen XU}
-\thanks{Corresponding to: \texttt{\colorist{} 2021/06/07a}}
+\thanks{Corresponding to: \texttt{\colorist{} 2021/06/23}}
\date{June 2021, Beijing}
\maketitle
@@ -143,6 +143,22 @@ And of course, you can also use the default classes \textsf{article} or \textsf{
\begin{itemize}
\item Allow boldface. When this option is enabled, the title, titles of all levels and names of theorem-like environments will be bolded.
\end{itemize}
+ \item \texttt{runin}
+ \begin{itemize}
+ \item Use the ``runin'' style for \lstinline|\subsubsection|
+ \end{itemize}
+ \item \texttt{puretext} or \texttt{nothms}
+ \begin{itemize}
+ \item Pure text mode. Does not load theorem-like environments.
+ \end{itemize}
+ \item \texttt{nothmnum}
+ \begin{itemize}
+ \item Theorem-like environments will not be numbered.
+ \end{itemize}
+ \item The language options \texttt{EN} / \texttt{english} / \texttt{English}, \texttt{FR} / \texttt{french} / \texttt{French}, etc.
+ \begin{itemize}
+ \item For the option names of a specific language, please refer to \meta{language name} in the next section. The first specified language will be used as the default language.
+ \end{itemize}
\end{itemize}
\begin{tip}
@@ -158,10 +174,11 @@ 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}
- \begin{itemize}
- \item Font options. As the name suggest, font with corresponding name will be loaded.
- \end{itemize}
+ \item \texttt{palatino}, \texttt{times}, \texttt{garamond}, \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.
+ \end{itemize}
\end{itemize}
@@ -308,7 +325,6 @@ And then define this environment in one of following five ways:
\begin{itemize}
\item Define a numbered environment \meta{name of environment}, numbered within the \\counter \meta{numbered within}
\end{itemize}
- \clearpage
\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}
@@ -321,7 +337,7 @@ And then define this environment in one of following five ways:
\end{itemize}
\end{itemize}
-\medskip
+% \medskip
\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.
\end{tip}
@@ -331,7 +347,7 @@ And then define this environment in one of following five ways:
\CreateTheorem*{proofidea*}
\CreateTheorem{proofidea}<subsection>
-\bigskip
+\medskip
Here is an example. The following code:
\begin{code}
\NameTheorem[EN]{proofidea}{Idea}
@@ -348,7 +364,7 @@ defines an unnumbered environment \lstinline|proofidea*| and a numbered environm
The \lstinline|proofidea| environment.
\end{proofidea}
-\bigskip
+\smallskip
\subsection{Draft mark}
You can use \lstinline|\dnf| to mark the unfinished part. For example:
@@ -358,10 +374,10 @@ You can use \lstinline|\dnf| to mark the unfinished part. For example:
Similarly, there is \lstinline|\needgraph| :
\begin{itemize}
- \item \lstinline|\needgraph| or \lstinline|\needgraph<...>|. The effect is: \needgraph or \needgraph<...>The prompt text changes according to the current language. For example, in French mode, it will be displayed as \UseOtherLanguage{French}{\needgraph}
+ \item \lstinline|\needgraph| or \lstinline|\needgraph<...>|. The effect is: \vspace{-.3\baselineskip}\needgraph \vspace{-.5\baselineskip} or \vspace{-.5\baselineskip} \needgraph<...>The prompt text changes according to the current language. For example, in French mode, it will be displayed as \UseOtherLanguage{French}{\needgraph}
\end{itemize}
-\clearpage
+% \clearpage
\subsection{On the title, abstract and keywords}
\colorart{} has both the features of standard classes and that of the \AmS{} classes.
@@ -423,7 +439,8 @@ Among them, the mutual order of \lstinline|\address|, \lstinline|\curraddr|, \ls
\item There are still many things that can be optimized in the code.
\end{itemize}
-\clearpage
+% \clearpage
+\medskip
\section{Document templates}
\subsection{The standard way}
@@ -432,7 +449,7 @@ If you want to write in the standard way, you can refer to the following example
\begin{code}
\documentclass{colorart}
-\usepackage{PJLtoolkit} % Load ProjLib toolkit
+\usepackage{ProjLib} % Load ProjLib toolkit
\UseLanguage{French} % Use French from here
@@ -470,7 +487,7 @@ If you wish to switch to the standard class later, just replace the first two li
\documentclass{article}
\usepackage[a4paper,margin=1in]{geometry}
\usepackage[hidelinks]{hyperref}
-\usepackage[palatino]{PJLtoolkit} % Load ProjLib toolkit
+\usepackage[palatino]{ProjLib} % Load ProjLib toolkit
\end{code}
@@ -481,7 +498,7 @@ If you intend to switch to the journal template in the future and thus want to u
\begin{code}
\documentclass{colorart}
-\usepackage{PJLtoolkit} % Load ProjLib toolkit
+\usepackage{ProjLib} % Load ProjLib toolkit
\UseLanguage{French} % Use French from here
@@ -523,7 +540,7 @@ In this way, if you wish to switch to \AmS{} class later, just replace the first
\documentclass{amsart}
\usepackage[a4paper,margin=1in]{geometry}
\usepackage[hidelinks]{hyperref}
-\usepackage[palatino]{PJLtoolkit} % Load ProjLib toolkit
+\usepackage[palatino]{ProjLib} % Load ProjLib toolkit
\end{code}
\end{document}