diff options
author | Norbert Preining <norbert@preining.info> | 2021-06-20 03:01:22 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2021-06-20 03:01:22 +0000 |
commit | 0b024adf546cd484554e4de5bd1a9919a4fdd03d (patch) | |
tree | f688c8afa79d522868966c9c91e09088f28b5248 /macros/latex/contrib/projlib/ProjLib-doc-en.tex | |
parent | daa6873fe1d06863ffc2980970295b39071f02ba (diff) |
CTAN sync 202106200301
Diffstat (limited to 'macros/latex/contrib/projlib/ProjLib-doc-en.tex')
-rw-r--r-- | macros/latex/contrib/projlib/ProjLib-doc-en.tex | 83 |
1 files changed, 65 insertions, 18 deletions
diff --git a/macros/latex/contrib/projlib/ProjLib-doc-en.tex b/macros/latex/contrib/projlib/ProjLib-doc-en.tex index 707cf5c8d4..1f232fe5e6 100644 --- a/macros/latex/contrib/projlib/ProjLib-doc-en.tex +++ b/macros/latex/contrib/projlib/ProjLib-doc-en.tex @@ -1,5 +1,5 @@ %! TEX program = xelatex -\documentclass[allowbf,regionalref,puretext]{lebhart} +\documentclass[English,French,allowbf,regionalref,puretext]{lebhart} %%================================ %% Import toolkit @@ -30,7 +30,8 @@ } \providecommand{\meta}[1]{$\langle${\normalfont\itshape#1}$\rangle$} \lstset{moretexcs=% - {color,NameTheorem,CreateTheorem,proofideanameEN,cref,dnf,needgraph,UseLanguage,UseOtherLanguage,AddLanguageSetting,maketitle,address,curraddr,email,keywords,subjclass,thanks,dedicatory,PLdate,PJLdate,ProjLib + {color,NameTheorem,CreateTheorem,proofideanameEN,cref,dnf,needgraph,UseLanguage,UseOtherLanguage,AddLanguageSetting,maketitle,address,curraddr,email,keywords,subjclass,thanks,dedicatory,PLdate,PJLdate,ProjLib, + mathfrak,mf,frak,mfA,mathbb,bb,N,Z,Q,R,C,F,A,mathcal,mc,cal,mathscr,ms,scr, } } \lstnewenvironment{code}% @@ -67,6 +68,7 @@ \providecommand{\PJLdraft}{\textsf{PJLdraft}} \providecommand{\PJLlang}{\textsf{PJLlang}} \providecommand{\PJLlogo}{\textsf{PJLlogo}} +\providecommand{\PJLmath}{\textsf{PJLmath}} \providecommand{\PJLpaper}{\textsf{PJLpaper}} \providecommand{\PJLthm}{\textsf{PJLthm}} @@ -77,7 +79,7 @@ \title{\ProjLib{}~\,Toolkit\\[.3\baselineskip]\normalsize User Manual} \author{Jinwen Xu} -\thanks{Corresponding to: \texttt{\ProjLib{}~2021/06/17}} +\thanks{Corresponding to: \texttt{\ProjLib{}~2021/06/19}} \date{June 2021, Beijing} \maketitle @@ -109,13 +111,17 @@ Just add the following line to your preamble: \begin{itemize} \item \texttt{draft} or \texttt{fast} \begin{itemize} - \item Fast mode. The functionality is appropriately reduced to get faster compilation speed, recommended to use during the writing phase. + \item Fast mode. The functionality will be appropriately reduced to get faster compilation speed, recommended to use during the writing phase. \end{itemize} - \item \texttt{palatino}, \texttt{times}, \texttt{garamond}, \texttt{biolinum} $|$ \texttt{useosf} + \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} + \item \texttt{nothms}, \texttt{nothmnum}, \texttt{regionalref} + \begin{itemize} + \item Options from \PJLthm{}, please refer to the section on this package for details. + \end{itemize} \item \texttt{author} \begin{itemize} \item Load \PJLauthor{}. For more information about its functionality, see the section on this package. @@ -124,12 +130,8 @@ Just add the following line to your preamble: \begin{itemize} \item Load \PJLamssim{}. For more information about its functionality, see the section on this package. \end{itemize} - \item \texttt{nothms}, \texttt{regionalref} - \begin{itemize} - \item Options from \PJLthm{}, please refer to the section on this package for details. - \end{itemize} \end{itemize} -In addition, there are also some options of the components that can (and should) be passed as global options of the document class, such as \texttt{paperstyle} and \texttt{preview} of \PJLpaper{}. For more information, please refer to the corresponding section. +In addition, there are also some options of the components that should be passed as global options of your document class, such as the language options \texttt{EN} / \texttt{english} / \texttt{English}, \texttt{FR} / \texttt{french} / \texttt{French} etc.\,of \PJLlang{}, \\and \texttt{paperstyle}, \texttt{preview} of \PJLpaper{}. For more information, please refer to the corresponding sections. \section{The components} @@ -178,13 +180,24 @@ For details on how to select a language, please refer to the section on \PJLlang \subsection{PJLlang} -\PJLlang{} offers multi-language support, including simplified Chinese, traditional Chinese, English, French, German, Japanese, and Russian (among them, Chinese, Japanese, and Russian require appropriate \TeX{} engines and fonts to support). The language can be selected by the following macros: +\PJLlang{} offers multi-language support, including simplified Chinese, traditional Chinese, English, French, German, Japanese, and Russian (among them, Chinese, Japanese, and Russian require appropriate \TeX{} engines and fonts to support). + +\medskip +\PJLlang{} provides language options. The names of these options have three types, which are abbreviations (such as \texttt{EN}), lowercase (such as \texttt{english}), and capital letters (such as \texttt{English}). For the option names of a specific language, please refer to \meta{language name} below. Among them, the first specified language \meta{first language} will be used as the default language, which is equivalent to specifying \lstinline|\UseLanguage{|\meta{first language}\lstinline|}| at the beginning of your document. + +\begin{tip} + It is recommended to use these language options and pass them as global options. In this way, only the specified language is set, thus saving the \TeX{} memory and significantly improving the compilation speed. +\end{tip} + +\medskip +The language can be selected by the following macros: \begin{itemize} \item \lstinline|\UseLanguage{|\meta{language name}\lstinline|}| is used to specify the language. The corresponding setting of the language will be applied after it. It can be used either in the preamble or in the main body. When no language is specified, ``English" is selected by default. \item \lstinline|\UseOtherLanguage{|\meta{language name}\lstinline|}{|\meta{content}\lstinline|}|, which uses the specified language settings to typeset \meta{content}. Compared with \lstinline|\UseLanguage|, it will not modify the line spacing, so line spacing would remain stable when CJK and Western texts are mixed. \end{itemize} +\medskip \meta{language name} can be (it is not case sensitive, for example, \texttt{French} and \texttt{french} have the same effect): \begin{itemize} \item Simplified Chinese: \texttt{CN}, \texttt{Chinese}, \texttt{SChinese} or \texttt{SimplifiedChinese} @@ -200,7 +213,7 @@ For details on how to select a language, please refer to the section on \PJLlang \item Russian: \texttt{RU} or \texttt{Russian} \end{itemize} -% \medskip +\medskip In addition, you can also add new settings to selected language: \begin{itemize} \item \lstinline|\AddLanguageSetting{|\meta{settings}\lstinline|}| @@ -214,7 +227,7 @@ In addition, you can also add new settings to selected language: \end{itemize} For example, \lstinline|\AddLanguageSetting(German){\color{orange}}| can make all German text displayed in orange (of course, one then need to add \lstinline|\AddLanguageSetting{\color{black}}| in order to correct the color of the text in other languages). - +\clearpage \subsection{PJLlogo} \PJLlogo{} offers the \lstinline|\ProjLib| macro to draw the logo, which looks like \ProjLib{}. It is similar to ordinary text macros and can be used with different font size macros: @@ -247,7 +260,34 @@ For example, \lstinline|\AddLanguageSetting(German){\color{orange}}| can make al \end{center} % \end{longtable} -\clearpage +\subsection{PJLmath} + +\PJLmath{} offers the following shortcuts: +\begin{enumerate}[label=\roman*)] + \item \lstinline|\mathfrak{|$\cdot$\lstinline|}| $\longrightarrow$ \lstinline|\mf|$\cdot$ or \lstinline|\frak|$\cdot$ . For example, \lstinline|\mfA| (or \lstinline|\mf{A}|) has the same effect as \lstinline|\mathfrak{A}|. This works for both upper and lower case, producing: + \begin{align*} + \mfa\mfb\mfc\mfd\mfe\mff\mfg\mfh\mfi\mfj\mfk\mfl\mfm\mfn&\mfo\mfp\mfq\mfr\mfs\mft\mfu\mfv\mfw\mfx\mfy\mfz\\ + \mfA\mfB\mfC\mfD\mfE\mfF\mfG\mfH\mfI\mfJ\mfK\mfL\mfM\mfN&\mfO\mfP\mfQ\mfR\mfS\mfT\mfU\mfV\mfW\mfX\mfY\mfZ + \end{align*} + \item \lstinline|\mathbb{|$\cdot$\lstinline|}| \( \longrightarrow \) \lstinline|\bb|$\cdot$ . This only works for uppercase alphabet and the number \( 1 \). + \begin{equation*} + \bbA\bbB\bbC\bbD\bbE\bbF\bbG\bbH\bbI\bbJ\bbK\bbL\bbM\bbN\bbO\bbP\bbQ\bbR\bbS\bbT\bbU\bbV\bbW\bbX\bbY\bbZ\bb1 + \end{equation*} + There are also special command for well-known algebraic structures: \lstinline|\N|, \lstinline|\Z|, \lstinline|\Q|, \lstinline|\R|, \lstinline|\C|, \lstinline|\F|, \lstinline|\A|. + \[ + \N\Z\Q\R\C\F\A + \] + \item \lstinline|\mathcal{|$\cdot$\lstinline|}| \( \longrightarrow \) \lstinline|\mc|$\cdot$ or \lstinline|\cal|$\cdot$ . This only works for uppercase alphabet. + \begin{equation*} + \mcA\mcB\mcC\mcD\mcE\mcF\mcG\mcH\mcI\mcJ\mcK\mcL\mcM\mcN\mcO\mcP\mcQ\mcR\mcS\mcT\mcU\mcV\mcW\mcX\mcY\mcZ + \end{equation*} + \item \lstinline|\mathscr{|$\cdot$\lstinline|}| \( \longrightarrow \) \lstinline|\ms|$\cdot$ or \lstinline|\scr|$\cdot$ . This only works for uppercase alphabet. + \begin{equation*} + \msA\msB\msC\msD\msE\msF\msG\msH\msI\msJ\msK\msL\msM\msN\msO\msP\msQ\msR\msS\msT\msU\msV\msW\msX\msY\msZ + \end{equation*} +\end{enumerate} + +% \clearpage \subsection{PJLpaper} \PJLpaper{} is mainly used to adjust the paper color. It has the following options: @@ -279,14 +319,19 @@ It is recommended to use them as global options of the document class. In this w \begin{itemize} \item \texttt{nothms} \begin{itemize} - \item The theorem-like environments will not be defined. You may use this option if you wish to apply your own theorem styles. + \item Theorem-like environments will not be defined. You may use this option if you wish to apply your own theorem styles. + \end{itemize} + \item \texttt{nothmnum} + \begin{itemize} + \item Theorem-like environments will not be numbered. \end{itemize} \item \texttt{regionalref} \begin{itemize} - \item When referencing, the name of the theorem-like environment changes with the current language (by default, the name will always remain the same; 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''). In \texttt{fast} mode, this option is automatically enabled. + \item When referencing, name of the theorem-like environment will change with the current language (by default, the name will always remain the same; 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''). In \texttt{fast} mode, this option is automatically enabled. \end{itemize} \end{itemize} +\medskip Preset environments include: \texttt{assumption}, \texttt{axiom}, \texttt{conjecture}, \texttt{convention}, \texttt{corollary}, \texttt{definition}, \texttt{definition-proposition}, ~~\texttt{definition-theorem}, ~~\texttt{example}, ~~\texttt{exercise}, ~~\texttt{fact}, ~~\texttt{hypothesis}, ~~\texttt{lemma}, \\\texttt{notation}, \texttt{observation}, \texttt{problem}, \texttt{property}, \texttt{proposition}, \texttt{question}, \texttt{remark}, \texttt{theorem}, and the corresponding unnumbered version with an asterisk \lstinline|*| in the name. The titles will change with the current language. For example, \texttt{theorem} will be displayed as ``Theorem" in English mode and ``Théorème" in French mode. For details on how to select a language, please refer to the section on \PJLlang{}. \begin{tip} @@ -306,13 +351,14 @@ Preset environments include: \texttt{assumption}, \texttt{axiom}, \texttt{conjec % \begin{tip} % If you want to define an environment with an asterisk \lstinline|*| after the name, you don't need to write an asterisk in the \meta{name of environment} above. See the example below. % \end{tip} +\medskip 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 \PJLlang{}. 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 +\bigskip And then define this environment in one of following five ways: \vspace{-.3\baselineskip} \begin{itemize} @@ -332,6 +378,7 @@ 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} @@ -385,7 +432,7 @@ defines an unnumbered environment \lstinline|proofidea*| and a numbered environm \end{itemize} -\medskip % \clearpage +\clearpage \section{Usage example} \subsection{Standard classes} |