summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/projlib
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-06-06 20:50:59 +0000
committerKarl Berry <karl@freefriends.org>2021-06-06 20:50:59 +0000
commit7b2fd1316c3a4fcb2b48aac74298202b16bdbcb6 (patch)
tree6e378a6dea1a641fe9f809dd40c161eb69cedd2c /Master/texmf-dist/doc/latex/projlib
parentaf93d729e9f975d827a119a26b74de8769391322 (diff)
projlib (6jun21)
git-svn-id: svn://tug.org/texlive/trunk@59495 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/projlib')
-rw-r--r--Master/texmf-dist/doc/latex/projlib/ProjLib-doc-cn.pdfbin223464 -> 226031 bytes
-rw-r--r--Master/texmf-dist/doc/latex/projlib/ProjLib-doc-cn.tex83
-rw-r--r--Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.pdfbin143184 -> 142661 bytes
-rw-r--r--Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.tex92
-rw-r--r--Master/texmf-dist/doc/latex/projlib/README.md19
5 files changed, 113 insertions, 81 deletions
diff --git a/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-cn.pdf b/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-cn.pdf
index 5de46fbd219..0e513e7abdc 100644
--- a/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-cn.pdf
+++ b/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-cn.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-cn.tex b/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-cn.tex
index 32adbf5a854..dfc162bea37 100644
--- a/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-cn.tex
+++ b/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-cn.tex
@@ -1,5 +1,5 @@
%! TEX program = xelatex
-\documentclass[allowbf]{lebhart}
+\documentclass[allowbf,regionalref]{lebhart}
%%================================
%% 引入工具集
@@ -39,23 +39,23 @@
{\setkeys{lst}{columns=fullflexible,keepspaces=true}}{}
%%================================
-%% remind
+%% tip
%%================================
-\newenvironment{remind}[1][提示]{%
+\newenvironment{tip}[1][提示]{%
\begin{tcolorbox}[breakable,
enhanced,
width = \textwidth,
- colback = white, colbacktitle = paper,
+ colback = paper, colbacktitle = paper,
colframe = gray!50, boxrule=0.2mm,
coltitle = black,
fonttitle = \sffamily,
- attach boxed title to top left = {yshift=-\tcboxedtitleheight/2, xshift=\tcboxedtitlewidth/4},
+ attach boxed title to top left = {yshift=-\tcboxedtitleheight/2, xshift=.5cm},
boxed title style = {boxrule=0pt, colframe=paper},
before skip = 0.3cm,
after skip = 0.3cm,
top = 3mm,
bottom = 3mm,
- title={\sffamily #1}]%
+ title={\scshape\sffamily #1}]%
}{\end{tcolorbox}}
%%================================
@@ -78,8 +78,8 @@
\title{\ProjLib{} 工具集\\[.3\baselineskip]\normalsize 使用指南}
\author{许锦文}
-\thanks{对应版本.~~\texttt{\ProjLib{}~2021/05/25}}
-\date{2021年5月,北京}
+\thanks{对应版本.~~\texttt{\ProjLib{}~2021/06/07}}
+\date{2021年6月,北京}
\maketitle
@@ -99,9 +99,9 @@
\usepackage{PJLtoolkit}
\end{code}
-\begin{remind}[注意事项]
+\begin{tip}[注意事项]
由于其内部使用了 \textsf{cleveref},\PJLtoolkit{} 需要放在 \textsf{varioref}、\textsf{hyperref} 的后面。
-\end{remind}
+\end{tip}
\medskip
\subsection{选项}
@@ -162,14 +162,14 @@
\subsection{PJLdate}
-\PJLdatestr{} 提供了 \lstinline|\PJLdate|\meta{yyyy-mm-dd} 命令,以将 \meta{yyyy-mm-dd} 转换为对应语言的日期格式显示。例如,在当前的中文语境下,\lstinline|\PJLdate{2022-04-01}| 会被显示为:\PJLdate{2022-04-01}。
+\PJLdatestr{} 提供了 \lstinline|\PJLdate|\meta{yyyy-mm-dd} 命令,以将 \meta{yyyy-mm-dd} 转换为当前语言的日期格式显示。例如,在当前的中文语境下,\lstinline|\PJLdate{2022-04-01}| 会被显示为“\PJLdate{2022-04-01}”,而在英文语境下则会被显示为“\UseOtherLanguage{English}{\PJLdate{2022-04-01}}”。
关于如何选定语言,请参阅关于 \PJLlang{} 的小节。
\subsection{PJLdraft}
\PJLdraft{} 提供了下列命令:
-\begin{itemize}
+\begin{itemize}\setstretch{1.15}
\item \lstinline|\dnf| 或 \lstinline|\dnf<...>|。效果为:\dnf~或 \dnf<...>。\\其提示文字与当前语言相对应,例如,在法语模式下将会显示为 \UseOtherLanguage{French}{\dnf}。
\item \lstinline|\needgraph| 或 \lstinline|\needgraph<...>|。效果为:\needgraph~或 \needgraph<...>其提示文字与当前语言相对应,例如,在法语模式下将会显示为 \UseOtherLanguage{French}{\needgraph}
\end{itemize}
@@ -191,14 +191,18 @@
\end{itemize}
\meta{language name} 有下列选择 (不区分大小写,如 \texttt{French} 或 \texttt{french} 均可):
-\begin{itemize}
+\begin{itemize}\setstretch{1.15}
\item 简体中文:\texttt{CN}、\texttt{Chinese}、\texttt{SChinese} 或 \texttt{SimplifiedChinese}
\item 繁体中文:\texttt{TC}、\texttt{TChinese} 或 \texttt{TraditionalChinese}
- \item 英文:\texttt{EN} 或 \texttt{English}
- \item 法文:\texttt{FR} 或 \texttt{French}
- \item 德文:\texttt{DE}、\texttt{German} 或 \texttt{ngerman}
- \item 日文:\texttt{JP} 或 \texttt{Japanese}
- \item 俄文:\texttt{RU} 或 \texttt{Russian}
+ \item 英语:\texttt{EN} 或 \texttt{English}
+ \item 法语:\texttt{FR} 或 \texttt{French}
+ \item 德语:\texttt{DE}、\texttt{German} 或 \texttt{ngerman}
+ \item 意大利语:\texttt{IT} 或 \texttt{Italian}
+ \item 葡萄牙语:\texttt{PT} 或 \texttt{Portuguese}
+ \item 巴西葡萄牙语:\texttt{BR} 或 \texttt{Brazilian}
+ \item 西班牙语:\texttt{ES} 或 \texttt{Spanish}
+ \item 日语:\texttt{JP} 或 \texttt{Japanese}
+ \item 俄语:\texttt{RU} 或 \texttt{Russian}
\end{itemize}
另外,还可以通过下面的方式来填加相应语言的设置:
@@ -229,18 +233,23 @@
% \item \lstinline|\huge|:\quad {\huge\ProjLib}
% \item \lstinline|\Huge|:\quad {\Huge\ProjLib}
% \end{itemize}
-% \vspace{-0.5\baselineskip}
-\begin{longtable}{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{longtable}
+
+\vspace{-0.5\baselineskip}
+% \begin{longtable}{ll}
+\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}
+% \end{longtable}
\subsection{PJLpaper}
@@ -277,11 +286,11 @@
\end{itemize}
\end{itemize}
-预设的定理类环境包括:\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{problem}、\texttt{property}、\texttt{proposition}、\texttt{question}、\texttt{remark}、\texttt{theorem},以及相应的带有星号 \lstinline|*| 的无编号版本。这些定理类环境在显示时会依据当前语言而相应变化,例如在中文模式下 \texttt{theorem} 会显示为“定理”,而在英文模式下则会显示为“Theorem”。关于如何选定语言,请参阅关于 \PJLlang{} 的小节。
+预设的定理类环境包括:\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},以及相应带有星号 \lstinline|*| 的无编号版本。它们在显示时会依据当前语言而变化,例如在中文语境下 \texttt{theorem} 会显示为“定理”,而在英文语境下则会显示为“Theorem”。关于如何选定语言,请参阅关于 \PJLlang{} 的小节。
-\begin{remind}
+\begin{tip}
在引用定理类环境时,建议使用智能引用 \lstinline|\cref{|\meta{label}\lstinline|}|。这样就不必每次都写上相应环境的名称了。
-\end{remind}
+\end{tip}
\medskip
% 若需要定义新的定理类环境,首先要定义这个环境在所用语言下的名称 \lstinline|\|\meta{name of environment}\meta{language abbr},其中 \meta{language abbr} 是语言的简写,分别为:
@@ -292,9 +301,9 @@
% \texttt{FR} & 法文 & &\\
% \end{longtable}
-% \begin{remind}
+% \begin{tip}
% 如果要定义名称后带有星号 \lstinline|*| 的环境,那么在上面的 \meta{name of environment} 中不用写星号。
-% \end{remind}
+% \end{tip}
若需要定义新的定理类环境,首先要定义这个环境在所用语言下的名称:
\vspace{-.15\baselineskip}%
\begin{itemize}
@@ -334,9 +343,9 @@
\end{itemize}
\end{itemize}
-\begin{remind}
+\begin{tip}
其内部使用了 \textsf{amsthm},因此传统的 \texttt{theoremstyle} 对其也是适用的,只需在相关定义前标明即可。
-\end{remind}
+\end{tip}
% \def\proofideanameCN{思路}
\NameTheorem[CN]{proofidea}{思路}
diff --git a/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.pdf b/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.pdf
index d040c9b903e..cce553440ac 100644
--- a/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.pdf
+++ b/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.pdf
Binary files differ
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 dd1cff37597..4cbffde7faf 100644
--- a/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.tex
+++ b/Master/texmf-dist/doc/latex/projlib/ProjLib-doc-en.tex
@@ -1,5 +1,5 @@
%! TEX program = xelatex
-\documentclass[allowbf]{lebhart}
+\documentclass[allowbf,regionalref]{lebhart}
%%================================
%% Import toolkit
@@ -37,17 +37,17 @@
{\setkeys{lst}{columns=fullflexible,keepspaces=true}}{}
%%================================
-%% remind
+%% tip
%%================================
-\newenvironment{remind}[1][Remind]{%
+\newenvironment{tip}[1][Tip]{%
\begin{tcolorbox}[breakable,
enhanced,
width = \textwidth,
- colback = white, colbacktitle = paper,
+ colback = paper, colbacktitle = paper,
colframe = gray!50, boxrule=0.2mm,
coltitle = black,
fonttitle = \sffamily,
- attach boxed title to top left = {yshift=-\tcboxedtitleheight/2, xshift=\tcboxedtitlewidth/4},
+ attach boxed title to top left = {yshift=-\tcboxedtitleheight/2, xshift=.5cm},
boxed title style = {boxrule=0pt, colframe=paper},
before skip = 0.3cm,
after skip = 0.3cm,
@@ -74,10 +74,10 @@
%%================================
\begin{document}
-\title{\ProjLib{}~~Toolkit\\[.3\baselineskip]\normalsize User Manual}
+\title{\ProjLib{}~\,Toolkit\\[.3\baselineskip]\normalsize User Manual}
\author{Jinwen Xu}
-\thanks{Corresponding to: \texttt{\ProjLib{}~2021/05/25}}
-\date{May 2021, Beijing}
+\thanks{Corresponding to: \texttt{\ProjLib{}~2021/06/07}}
+\date{June 2021, Beijing}
\maketitle
@@ -97,9 +97,9 @@ Just add the following line to your preamble:
\usepackage{PJLtoolkit}
\end{code}
-\begin{remind}[Attention]
+\begin{tip}[Attention]
Since \textsf{cleveref} is used internally, \PJLtoolkit{} needs to be placed after \textsf{varioref} and \textsf{hyperref}.
-\end{remind}
+\end{tip}
\medskip
\subsection{Options}
@@ -160,7 +160,7 @@ The mutual order of \lstinline|\address|, \lstinline|\curraddr| and \lstinline|\
\subsection{PJLdate}
-\PJLdatestr{} offers the \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|\PJLdate{2022-04-01}| would become: \PJLdate{2022-04-01}.
+\PJLdatestr{} offers the \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|\PJLdate{2022-04-01}| would become ``\PJLdate{2022-04-01}'', while in French context as ``\UseOtherLanguage{French}{\PJLdate{2022-04-01}}''.
For details on how to select a language, please refer to the section on \PJLlang{}.
@@ -190,11 +190,15 @@ For details on how to select a language, please refer to the section on \PJLlang
\item English: \texttt{EN} or \texttt{English}
\item French: \texttt{FR} or \texttt{French}
\item German: \texttt{DE}, \texttt{German} or \texttt{ngerman}
+ \item Italian: \texttt{IT} or \texttt{Italian}
+ \item Portuguese: \texttt{PT} or \texttt{Portuguese}
+ \item Portuguese (Brazilian): \texttt{BR} or \texttt{Brazilian}
+ \item Spanish: \texttt{ES} or \texttt{Spanish}
\item Japanese: \texttt{JP} or \texttt{Japanese}
\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|}|
@@ -223,24 +227,30 @@ For example, \lstinline|\AddLanguageSetting(German){\color{orange}}| can make al
% \item \lstinline|\huge|:\quad {\huge\ProjLib}
% \item \lstinline|\Huge|:\quad {\Huge\ProjLib}
% \end{itemize}
-\bigskip
-\begin{longtable}{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{longtable}
+% \bigskip
+
+% \begin{longtable}{ll}
+\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}
+% \end{longtable}
\clearpage
\subsection{PJLpaper}
\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}
@@ -248,20 +258,22 @@ For example, \lstinline|\AddLanguageSetting(German){\color{orange}}| can make al
\end{itemize}
\item \texttt{yellowpaper}, \texttt{darkpaper}, \texttt{nordpaper}
\begin{itemize}
- \item Set the paper color style. The effect is the same as \texttt{paperstyle} with the corresponding \meta{paper style name} specified.
+ \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 pass these options as global options of the document class. In this way, the paper settings would be clear at a glance.
+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}
\PJLthm{} offers the configuration of theorem-like environments. It has the following option:
+\vspace{-.3\baselineskip}
\begin{itemize}
\item \texttt{nothms}
\begin{itemize}
@@ -273,11 +285,11 @@ It is recommended to pass these options as global options of the document class.
\end{itemize}
\end{itemize}
-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{problem}, \texttt{property}, \texttt{proposition}, \texttt{question}, \texttt{remark}, \texttt{theorem}, and the corresponding unnumbered version with an asterisk \lstinline|*| in the name. The display of these environments will change according to 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{}.
+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{remind}
- When referencing a theorem-like environment, it is recommended to use smart reference \lstinline|\cref{|\meta{label}\texttt{\}}. In this way, there is no need to explicitly write down the name of the corresponding environment every time.
-\end{remind}
+\begin{tip}
+ When referencing a theorem-like environment, it is recommended to use \lstinline|\cref{|\meta{label}\texttt{\}}. In this way, there is no need to explicitly write down the name of the corresponding environment every time.
+\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 used: \lstinline|\|\meta{name of environment}\meta{language abbr}, where \meta{language abbr} is the abbreviation of language, which can be:
@@ -289,18 +301,18 @@ Preset environments include: \texttt{assumption}, \texttt{axiom}, \texttt{conjec
% \texttt{FR} & French & &\\
% \end{longtable}
-% \begin{remind}
+% \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{remind}
+% \end{tip}
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}{...}| .
-
-\clearpage% \medskip
+\medskip
And then define this environment in one of following five ways:
+\vspace{-.3\baselineskip}
\begin{itemize}
\item \lstinline|\CreateTheorem*{|\meta{name of environment}\lstinline|}|
\begin{itemize}
@@ -330,9 +342,9 @@ And then define this environment in one of following five ways:
\end{itemize}
\end{itemize}
-\begin{remind}
- It uses \textsf{amsthm} internally, so the traditional \texttt{theoremstyle} is also applicable to it. One only needs declare the style before the relevant definitions.
-\end{remind}
+\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}
% \def\proofideanameEN{Idea}
\NameTheorem[EN]{proofidea}{Idea}
@@ -361,13 +373,13 @@ defines an unnumbered environment \lstinline|proofidea*| and a numbered environm
\section{Known issues}
\begin{itemize}[itemsep=.6em]
- \item \PJLauthor{} is still in its preliminary stage, and thus its effect is still not as good as the relatively mature \textsf{authblk} in some aspects.
+ \item \PJLauthor{} is still in its preliminary stage, its effect is not as good as the relatively mature \textsf{authblk}.
\item \PJLlang{}: It is still quite problematic with the configuration of \textsf{polyglossia}, so main features are implemented through \textsf{babel} for now.
\item \PJLpaper{}: the \texttt{preview} option is mainly implemented with the help of package \textsf{geometry}, so it does not work quite as well in the \textsc{\textsf{Koma}} document classes.
\item \PJLthm{}: The numbering and theorem-style settings of the theorem-like environments cannot be accessed by the user at present.
\item \PJLthm{}: The localization of \textsf{cleveref} is not yet complete for all supported languages of \PJLlang{}, especially for Chinese, Japanese and Russian.
- \item The error handling mechanism is incomplete: there is no corresponding error prompt when some problems occur.
- \item There are still many things that can be optimized in the code. Some takes too long to run, especially the definition of theorem-like environments in \PJLthm{}.
+ \item Error handling mechanism is incomplete: no corresponding error prompt when some problems occur.
+ \item There are still many things that can be optimized in the code. Some takes too long to run, especially the setup of theorem-like environments in \PJLthm{}.
\end{itemize}
diff --git a/Master/texmf-dist/doc/latex/projlib/README.md b/Master/texmf-dist/doc/latex/projlib/README.md
index d88d15a8750..59d887b3bee 100644
--- a/Master/texmf-dist/doc/latex/projlib/README.md
+++ b/Master/texmf-dist/doc/latex/projlib/README.md
@@ -2,8 +2,13 @@
# ProjLib Toolkit
-A collection of tools that help you write LaTeX document. With `PJLtoolkit` loaded, you no longer need to set up the theorem-like environments nor to manually configure the appropriate multilingual settings. In addition, a series of auxiliary functionalities are introduced.
+> **ProjLib** can be interpreted as "***Proj**ect **Lib**rary*" in English, but I prefer the French interpretation "***Proj**et **Lib**re*".
+## Introduction
+
+`ProjLib` is a collection of tools that help you write LaTeX document. With `PJLtoolkit` loaded, you no longer need to set up the theorem-like environments nor to manually configure the appropriate multilingual settings. In addition, a series of auxiliary functionalities are introduced.
+
+The collection includes:
1. `PJLamssim.sty`
- Simulate some features of `amsart` in the standard classes
1. `PJLauthor.sty`
@@ -16,7 +21,7 @@ A collection of tools that help you write LaTeX document. With `PJLtoolkit` load
1. `PJLlang.sty`
- Multi-language configuration based on `babel` or `polyglossia`
- Offers `\UseLanguage`, `\UseOtherLanguage` and `\AddLanguageSetting`
- - Currently support Chinese (simplified and traditional), English, French, German, Japanese and Russian, *more to be added*
+ - Currently support Chinese (simplified and traditional), English, French, German, Italien, Japanese, Portuguese (European and Brazilian), Russian and Spanish
1. `PJLlogo.sty`
- Draw the ProjLib logo
1. `PJLpaper.sty`
@@ -24,14 +29,20 @@ A collection of tools that help you write LaTeX document. With `PJLtoolkit` load
1. `PJLthm.sty`
- Theorem setup and configuration
- Offers a macro `\CreateTheorem` for creating theorem-like environments with multi-language support
- - Preset environments include: `assumption`, `axiom`, `conjecture`, `convention`, `corollary`, `definition`, `definition-proposition`, `definition-theorem`, `example`, `exercise`, `fact`, `hypothesis`, `lemma`, `notation`, `problem`, `property`, `proposition`, `question`, `remark`, `theorem`, and the corresponding unnumbered version with an asterisk `*` in the name.
+ - Preset environments include: `assumption`, `axiom`, `conjecture`, `convention`, `corollary`, `definition`, `definition-proposition`, `definition-theorem`, `example`, `exercise`, `fact`, `hypothesis`, `lemma`, `notation`, `observation`, `problem`, `property`, `proposition`, `question`, `remark`, `theorem`, and the corresponding unnumbered version with an asterisk `*` in the name.
1. `PJLtoolkit.sty`, *the all-in-one solution*
- A collective interface of ProjLib Toolkit, loading all the packages above
- Provide some pre-defined font configuration
> Since `PJLthm.sty` (and thus `PJLtoolkit.sty`) uses `cleveref`, it should be loaded after `varioref` and `hyperref`.
-Demonstration:
+## How to get these files
+You can get the `.sty` files mentioned above simply by compiling `ProjLib.ins`:
+```
+latex ProjLib.ins
+```
+
+## An example
```latex
\documentclass{amsart}
\usepackage[a4paper,margin=.75in]{geometry}