projlib (7aug21)

git-svn-id: svn://tug.org/texlive/trunk@60184 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 106 insertions, 102 deletions

diff --git a/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.tex b/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.tex
index b751afdaa55..a9d1a2569ce 100644
--- a/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.tex
+++ b/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.tex
@@ -86,9 +86,9 @@
 
 \title{\ProjLib{}~\,Toolkit\\[.3\baselineskip]\normalsize User Manual}
 \author{Jinwen XU}
-\thanks{Corresponding to: \texttt{\ProjLib{}~2021/07/30}}
+\thanks{Corresponding to: \texttt{\ProjLib{}~2021/08/07}}
 \email{\href{mailto:ProjLib@outlook.com}{ProjLib@outlook.com}}
-\date{July 2021, Beijing}
+\date{August 2021, Beijing}
 
 \maketitle
 
@@ -281,7 +281,9 @@ In addition, there are also some options of the components that should be passed
 
 \section{The components}
 
-\subsection{PJLauthor: enhanced author block}
+\subsection{Main function}
+
+\subsubsection{PJLauthor: enhanced author block}
 
 \PJLauthor{} offers \lstinline|\address|, \lstinline|\curraddr| and \lstinline|\email|, and allows you to enter multiple groups of author information. The standard usage is like this:
 \begin{code}
@@ -307,23 +309,7 @@ In addition, you can use the option \texttt{amsfashion} to enable the \AmS{} fas
     These modifications would only take place in standard classes. In the \AmS{} classes, \PJLauthor{} does not have any effect.
 \end{tip}
 
-\subsection{PJLdate: date-time processing}
-
-\PJLdatePackage{} offers the \lstinline|\PLdate|\meta{yyyy-mm-dd} (or \lstinline|\PJLdate|\meta{yyyy-mm-dd}) macro to convert \meta{yyyy-mm-dd} into the date format of the currently selected language. For example, in current English context, \lstinline|\PLdate{2022-04-01}| would become ``\PLdate{2022-04-01}'', while in French context as ``\UseOtherLanguage{French}{\PLdate{2022-04-01}}''.
-
-For details on how to select a language, please refer to the section on \PJLlang{}.
-
-\subsection{PJLdraft: draft marks}
-
-\PJLdraft{} offers the following macros:
-\begin{itemize}
-    \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.
-    \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}
-\end{itemize}
-
-For details on how to select a language, please refer to the section on \PJLlang{}.
-
-\subsection{PJLlang: multi-language support}
+\subsubsection{PJLlang: multi-language support}
 
 \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).
 
@@ -372,87 +358,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).
 
-\subsection{PJLlogo: the logo \texorpdfstring{\ProjLib}{ProjLib}}
-
-\PJLlogo{} offers the macro \lstinline|\ProjLib| to draw the logo, which looks like \ProjLib{}. It is similar to ordinary text macros and can be used with different font size macros:
-
-\begin{center}
-    \begin{tabular}{ll}
-        \lstinline|\tiny|:& {\tiny\ProjLib}\\
-        \lstinline|\scriptsize|:& {\scriptsize\ProjLib}\\
-        \lstinline|\footnotesize|:& {\footnotesize\ProjLib}\\
-        \lstinline|\normalsize|:& {\normalsize\ProjLib}\\
-        \lstinline|\large|:& {\large\ProjLib}\\
-        \lstinline|\Large|:& {\Large\ProjLib}\\
-        \lstinline|\LARGE|:& {\LARGE\ProjLib}\\
-        \lstinline|\huge|:& {\huge\ProjLib}\\
-        \lstinline|\Huge|:& {\Huge\ProjLib}
-    \end{tabular}
-\end{center}
-
-\medskip
-\subsection{PJLmath: math symbols and shortcuts}
-
-\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}
-
-In addition, \PJLmath{} also provides some math symbols that are not by default included in \LaTeX{}.
-
-\begin{longtable}[l]{ p{4cm} p{6cm} p{6cm}}
-\lstinline|\abs| & \lstinline|\abs{a}| $\rightarrow \abs{a}$ & absolute value symbol \\
-\lstinline|\norm| & \lstinline|\norm{a}| $\rightarrow \norm{a}$ & norm symbol \\
-\lstinline|\injection| & \lstinline|\injection| $\rightarrow ~\injection$ & arrow symbol for injection \\
-\lstinline|\surjection| & \lstinline|\surjection| $\rightarrow ~\surjection$ & arrow symbol for surjection \\
-\lstinline|\bijection| & \lstinline|\bijection| $\rightarrow ~\bijection$ & arrow symbol for bijection \\
-\end{longtable}
-
-\clearpage
-\subsection{PJLpaper: paper configuration}
-
-\PJLpaper{} is mainly used to adjust the paper color. It has the following options:
-
-\vspace{-.3\baselineskip}
-\begin{itemize}
-    \item \texttt{paperstyle = \meta{paper style name}}
-        \begin{itemize}
-            \item Set the paper color style. The options available for \meta{paper style name} are: \texttt{yellow}, \texttt{dark} and \texttt{nord}.
-        \end{itemize}
-    \item \texttt{yellowpaper}, \texttt{darkpaper}, \texttt{nordpaper}
-        \begin{itemize}
-            \item Same as \texttt{paperstyle} with the corresponding \meta{paper style name} specified.
-        \end{itemize}
-    \item \texttt{preview}
-        \begin{itemize}
-            \item Preview mode. Crop the white edges of pdf file for the convenience of reading.
-        \end{itemize}
-\end{itemize}
-\vspace{-.3\baselineskip}
-
-It is recommended to use them as global options of the document class. In this way, the paper settings would be clear at a glance.
-
-\subsection{PJLthm: theorem-like environments with clever reference and multilingual support}
+\subsubsection{PJLthm: theorem-like environments with clever reference and multilingual support}
 
 \PJLthm{} offers the configuration of theorem-like environments. It has the following option:
 
@@ -488,7 +394,6 @@ If you need to define a new theorem-like environment, you must first define the
 \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}{...}| .
 
-\clearpage
 And then define this environment in one of following five ways:
 \vspace{-.3\baselineskip}
 \begin{itemize}
@@ -545,6 +450,105 @@ defines an unnumbered environment \lstinline|proofidea*| and a numbered environm
     The \lstinline|proofidea| environment.
 \end{proofidea}
 
+\bigskip
+
+\subsection{Secondary function}
+
+\subsubsection{PJLdate: date-time processing}
+
+\PJLdatePackage{} offers the \lstinline|\PLdate|\meta{yyyy-mm-dd} (or \lstinline|\PJLdate|\meta{yyyy-mm-dd}) macro to convert \meta{yyyy-mm-dd} into the date format of the currently selected language. For example, in current English context, \lstinline|\PLdate{2022-04-01}| would become ``\PLdate{2022-04-01}'', while in French context as ``\UseOtherLanguage{French}{\PLdate{2022-04-01}}''.
+
+For details on how to select a language, please refer to the section on \PJLlang{}.
+
+\subsubsection{PJLdraft: draft marks}
+
+\PJLdraft{} offers the following macros:
+\begin{itemize}
+    \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.
+    \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}
+\end{itemize}
+
+For details on how to select a language, please refer to the section on \PJLlang{}.
+
+\subsubsection{PJLlogo: the logo \texorpdfstring{\ProjLib}{ProjLib}}
+
+\PJLlogo{} offers the macro \lstinline|\ProjLib| to draw the logo, which looks like \ProjLib{}. It is similar to ordinary text macros and can be used with different font size macros:
+
+\begin{center}
+    \begin{tabular}{ll}
+        \lstinline|\tiny|:& {\tiny\ProjLib}\\
+        \lstinline|\scriptsize|:& {\scriptsize\ProjLib}\\
+        \lstinline|\footnotesize|:& {\footnotesize\ProjLib}\\
+        \lstinline|\normalsize|:& {\normalsize\ProjLib}\\
+        \lstinline|\large|:& {\large\ProjLib}\\
+        \lstinline|\Large|:& {\Large\ProjLib}\\
+        \lstinline|\LARGE|:& {\LARGE\ProjLib}\\
+        \lstinline|\huge|:& {\huge\ProjLib}\\
+        \lstinline|\Huge|:& {\Huge\ProjLib}
+    \end{tabular}
+\end{center}
+
+\medskip
+\subsubsection{PJLmath: math symbols and shortcuts}
+
+\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}
+
+In addition, \PJLmath{} also provides some math symbols that are not by default included in \LaTeX{}.
+
+\begin{longtable}[l]{ p{4cm} p{6cm} p{6cm}}
+\lstinline|\abs| & \lstinline|\abs{a}| $\rightarrow \abs{a}$ & absolute value symbol \\
+\lstinline|\norm| & \lstinline|\norm{a}| $\rightarrow \norm{a}$ & norm symbol \\
+\lstinline|\injection| & \lstinline|\injection| $\rightarrow ~\injection$ & arrow symbol for injection \\
+\lstinline|\surjection| & \lstinline|\surjection| $\rightarrow ~\surjection$ & arrow symbol for surjection \\
+\lstinline|\bijection| & \lstinline|\bijection| $\rightarrow ~\bijection$ & arrow symbol for bijection \\
+\end{longtable}
+
+\subsubsection{PJLpaper: paper configuration}
+
+\PJLpaper{} is mainly used to adjust the paper color. It has the following options:
+
+\vspace{-.3\baselineskip}
+\begin{itemize}
+    \item \texttt{paperstyle = \meta{paper style name}}
+        \begin{itemize}
+            \item Set the paper color style. The options available for \meta{paper style name} are: \texttt{yellow}, \texttt{dark} and \texttt{nord}.
+        \end{itemize}
+    \item \texttt{yellowpaper}, \texttt{darkpaper}, \texttt{nordpaper}
+        \begin{itemize}
+            \item Same as \texttt{paperstyle} with the corresponding \meta{paper style name} specified.
+        \end{itemize}
+    \item \texttt{preview}
+        \begin{itemize}
+            \item Preview mode. Crop the white edges of pdf file for the convenience of reading.
+        \end{itemize}
+\end{itemize}
+\vspace{-.3\baselineskip}
+
+It is recommended to use them as global options of the document class. In this way, the paper settings would be clear at a glance.
+
 \clearpage
 
 \section{Known issues}