summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/einfart/einfart-doc-cn.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-07-13 20:09:08 +0000
committerKarl Berry <karl@freefriends.org>2021-07-13 20:09:08 +0000
commit70913b0b6d5f98d188b67ed45facb70914de8fcc (patch)
tree11873032dc20dab21cedc5490cec99677b5c56b6 /Master/texmf-dist/doc/latex/einfart/einfart-doc-cn.tex
parentcdf5616cb0197dbd6acad760f46c9cc81e34664e (diff)
jxu (13jul21)
git-svn-id: svn://tug.org/texlive/trunk@59923 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/einfart/einfart-doc-cn.tex')
-rw-r--r--Master/texmf-dist/doc/latex/einfart/einfart-doc-cn.tex411
1 files changed, 238 insertions, 173 deletions
diff --git a/Master/texmf-dist/doc/latex/einfart/einfart-doc-cn.tex b/Master/texmf-dist/doc/latex/einfart/einfart-doc-cn.tex
index b4cee345830..a8620ea2f2b 100644
--- a/Master/texmf-dist/doc/latex/einfart/einfart-doc-cn.tex
+++ b/Master/texmf-dist/doc/latex/einfart/einfart-doc-cn.tex
@@ -1,22 +1,24 @@
-%! TEX program = xelatex
-\documentclass[Chinese,English,French,puretext]{einfart}
+\documentclass[English,Chinese,French,puretext]{einfart}
\CreateTheorem{definition}<highest>
-\CreateTheorem{theorem}<highest>
+\CreateTheorem{theorem}[definition]
-\linenumbers % 开启行号
+\linenumbers % Enable line numbers
%%================================
-%% 引入工具集
+%% Import toolkit
%%================================
\usepackage{ProjLib}
\usepackage{longtable} % breakable tables
\usepackage{hologo} % more TeX logo
+\usetikzlibrary{calc}
+
+\usepackage{blindtext}
\UseLanguage{Chinese}
%%================================
-%% 排版代码
+%% For typesetting code
%%================================
\usepackage{listings}
\definecolor{maintheme}{RGB}{70,130,180}
@@ -35,19 +37,24 @@
escapeinside={(*}{*)},
% numbers=left,
numberstyle=\scriptsize, stepnumber=1, numbersep=5pt,
- firstnumber=last,
-}
+ % firstnumber=last,
+}
\providecommand{\meta}[1]{$\langle${\normalfont\itshape#1}$\rangle$}
\lstset{moretexcs=%
- {linenumbers,nolinenumbers,subsection,subsubsection,href,
- color,NameTheorem,CreateTheorem,proofideanameCN,cref,dnf,needgraph,UseLanguage,UseOtherLanguage,AddLanguageSetting,maketitle,address,curraddr,email,keywords,subjclass,thanks,dedicatory,PLdate,ProjLib,qedhere
+ {linenumbers,nolinenumbers,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
}
}
-\lstnewenvironment{code}%
+\lstnewenvironment{code}%
{\setstretch{1.07}\LocallyStopLineNumbers%
\setkeys{lst}{columns=fullflexible,keepspaces=true}%
}
{\ResumeLineNumbers}
+\lstnewenvironment{code*}%
+{\setstretch{1.07}\LocallyStopLineNumbers%
+\setkeys{lst}{numbers=left,columns=fullflexible,keepspaces=true}%
+}
+{\ResumeLineNumbers}
%%================================
%% tip
@@ -68,11 +75,11 @@
after skip = 0.3cm,
top = 3mm,
bottom = 3mm,
- title={\sffamily #1}]%
+ title={\scshape\sffamily #1}]%
}{\end{tcolorbox}\ResumeLineNumbers}
%%================================
-%% 名称
+%% Names
%%================================
\providecommand{\minimalist}{\textsf{minimalist}}
\providecommand{\minimart}{\textsf{minimart}}
@@ -81,13 +88,21 @@
\providecommand{\simplivre}{\textsf{simplivre}}
%%================================
-%% 正文
+%% Titles
+%%================================
+\let\LevelOneTitle\section
+\let\LevelTwoTitle\subsection
+\let\LevelThreeTitle\subsubsection
+
+%%================================
+%% Main text
%%================================
\begin{document}
\title{\einfart{},以极简主义风格排版你的文章}
\author{许锦文}
-\thanks{对应版本. \texttt{\einfart{} 2021/07/05}}
+\thanks{对应版本. \texttt{\einfart{} 2021/07/13}}
+\email{\href{mailto:ProjLib@outlook.com}{ProjLib@outlook.com}}
\date{2021年7月,北京}
\maketitle
@@ -96,22 +111,27 @@
\einfart{} 是 \minimalist{} 文档类系列的成员之一,其名称取自于德文的 einfach (``简约''),并取了 artikel (``文章'') 的前三个字母组合而成。整个 \minimalist{} 系列包含用于排版文章的 \minimart{}、\einfart{} 以及用于排版书的 \minimbook{}、\simplivre{}。我设计这一系列的初衷是为了撰写草稿与笔记,使之看上去简朴而不简陋。
\einfart{} 支持英语、法语、德语、意大利语、葡萄牙语、巴西葡萄牙语、西班牙语、简体中文、繁体中文、日文、俄文,并且同一篇文档中这些语言可以很好地协调。由于采用了自定义字体,需要用 \hologo{XeLaTeX} 或 \hologo{LuaLaTeX} 引擎进行编译。
-
+
这篇说明文档即是用 \einfart{} 排版的,你可以把它看作一份简短的说明与演示。
\end{abstract}
-\tableofcontents
-% \bigskip
-\vspace{-.3\baselineskip}
-\begin{tip}
- 多语言支持、定理类环境、未完成标记等功能是由 \ProjLib{} 工具箱提供的,这里只给出了将其与本文档类搭配使用的要点。如需获取更详细的信息,可以参阅 \ProjLib{} 的说明文档。
-\end{tip}
+\setcounter{tocdepth}{2}
+{\setstretch{1.07}\tableofcontents}
-\clearpage
-\section{初始化}
-\subsection{如何载入}
+\medskip
+\LevelOneTitle*{开始之前}
+为了使用这篇文档中提到的文档类,你需要:
+\begin{itemize}
+ \item 安装一个尽可能新版本的 TeX Live 或 MikTeX 套装,并确保 \texttt{minimalist} 和 \texttt{projlib} 被正确安装在你的 \TeX 封装中。
+ \item 熟悉 \LaTeX{} 的基本使用方式,并且知道如何用 \hologo{pdfLaTeX}、\hologo{XeLaTeX} 或 \hologo{LuaLaTeX} 编译你的文档。
+\end{itemize}
+
+
+\LevelOneTitle{使用示例}
+
+\LevelTwoTitle{如何加载}
只需要在第一行写:
@@ -121,7 +141,174 @@
即可使用 \einfart{} 文档类。请注意,要使用 \hologo{XeLaTeX} 或 \hologo{LuaLaTeX} 引擎才能编译。
-\subsection{选项}
+\LevelTwoTitle{一篇完整的文档示例}
+
+首先来看一段完整的示例。
+
+\begin{code*}
+\documentclass{einfart}
+\usepackage{ProjLib}
+
+\UseLanguage{French}
+
+\begin{document}
+
+\title{(*\meta{title}*)}
+\author{(*\meta{author}*)}
+\date{\PLdate{2022-04-01}}
+
+\maketitle
+
+\begin{abstract}
+ Ceci est un résumé. \dnf<Plus de contenu est nécessaire.>
+\end{abstract}
+\begin{keyword}
+ AAA, BBB, CCC, DDD, EEE
+\end{keyword}
+
+\section{Un théorème}
+
+\begin{theorem}\label{thm:abc}
+ Ceci est un théorème.
+\end{theorem}
+Référence du théorème: \cref{thm:abc}
+
+\end{document}
+\end{code*}
+
+
+如果你觉得这个例子有些复杂,不要担心。现在我们来一点点地观察这个例子。
+
+\clearpage
+\LevelThreeTitle{初始化部分}
+
+\medskip
+\begin{code}
+\documentclass{einfart}
+\usepackage{ProjLib}
+\end{code}
+
+初始化部分很简单:第一行加载文档类 \einfart{},第二行加载 \ProjLib{} 工具箱,以便使用一些附加功能。
+
+\LevelThreeTitle{设定语言}
+
+\medskip
+\begin{code}
+\UseLanguage{French}
+\end{code}
+
+这一行表明文档中将使用法语(如果你的文章中只出现英语,那么可以不需要设定语言)。你也可以在文章中间用同样的方式再次切换语言。支持的语言包括简体中文、繁体中文、日文、英语、法语、德语、西班牙语、葡萄牙语、巴西葡萄牙语、俄语。
+
+对于这一命令的详细说明以及更多相关命令,可以参考后面关于多语言支持的小节。
+
+\LevelThreeTitle{标题,作者信息,摘要与关键词}
+
+\medskip
+\begin{code}
+\title{(*\meta{title}*)}
+\author{(*\meta{author}*)}
+\date{\PLdate{2022-04-01}}
+\maketitle
+
+\begin{abstract}
+ (*\meta{abstract}*)
+\end{abstract}
+\begin{keyword}
+ (*\meta{keywords}*)
+\end{keyword}
+\end{code}
+
+开头部分是标题和作者信息块。这个例子中给出的是最基本的形式,事实上你还可以这样写:
+
+\begin{code}
+\author{(*\meta{author 1}*)}
+\address{(*\meta{address 1}*)}
+\email{(*\meta{email 1}*)}
+\author{(*\meta{author 2}*)}
+\address{(*\meta{address 2}*)}
+\email{(*\meta{email 2}*)}
+...
+\end{code}
+
+另外,你还可以采用 \AmS{} 文档类的写法:
+
+\begin{code}
+\title{(*\meta{title}*)}
+\author{(*\meta{author 1}*)}
+\address{(*\meta{address 1}*)}
+\email{(*\meta{email 1}*)}
+\author{(*\meta{author 2}*)}
+\address{(*\meta{address 2}*)}
+\email{(*\meta{email 2}*)}
+\date{\PLdate{2022-04-01}}
+\subjclass{*****}
+\keywords{(*\meta{keywords}*)}
+
+\begin{abstract}
+ (*\meta{abstract}*)
+\end{abstract}
+
+\maketitle
+\end{code}
+
+\LevelThreeTitle{未完成标记}
+
+\medskip
+\begin{code}
+\dnf<(*\meta{some hint}*)>
+\end{code}
+当你有一些地方尚未完成的时候,可以用这条指令标记出来,它在草稿阶段格外有用。
+
+\LevelThreeTitle{定理类环境}
+
+\medskip
+\begin{code}
+\begin{theorem}\label{thm:abc}
+ Ceci est un théorème.
+\end{theorem}
+Référence du théorème: \cref{thm:abc}
+\end{code}
+
+常见的定理类环境可以直接使用。在引用的时候,建议采用智能引用 \lstinline|\cref{|\meta{label}\lstinline|}|——这样就不必每次都写上相应环境的名称了。
+
+\begin{tip}
+如果你之后想要切换到标准文档类,只需要把前两行换为:
+
+\begin{code}
+\documentclass{article}
+\usepackage[a4paper,margin=1in]{geometry}
+\usepackage[hidelinks]{hyperref}
+\usepackage[palatino,amsfashion]{ProjLib}
+\end{code}
+
+或者使用 \AmS{} 文档类:
+
+\begin{code}
+\documentclass{amsart}
+\usepackage[a4paper,margin=1in]{geometry}
+\usepackage[hidelinks]{hyperref}
+\usepackage[palatino]{ProjLib}
+\end{code}
+
+\end{tip}
+
+\begin{tip}
+如果你喜欢这个文档类,但又希望使用一种更加中规中矩的样式,那么不妨使用 \texttt{classical} 选项,就像这样:
+
+\begin{code}
+\documentclass[classical]{einfart}
+\end{code}
+\end{tip}
+
+
+\LevelOneTitle{关于默认字体}
+\einfart{} 默认使用 Palatino Linotype 作为英文字体,方正悠宋、悠黑GBK作为中文字体,并部分使用了 Neo Euler 作为数学字体。其中,Neo Euler可以在 \url{https://github.com/khaledhosny/euler-otf} 下载。其他字体不是免费字体,需要自行购买使用。可以在方正字库网站查询详细资料:\url{https://www.foundertype.com}。
+
+
+在没有安装相应的字体时,将采用TeX Live中自带的字体来代替,效果可能会有所折扣。
+
+
+\LevelOneTitle{选项}
\einfart{} 文档类有下面几个选项:
@@ -129,6 +316,7 @@
\item 语言选项 \texttt{EN} / \texttt{english} / \texttt{English}、\texttt{FR} / \texttt{french} / \texttt{French},等等
\begin{itemize}
\item 具体选项名称可参见下一节的 \meta{language name}。第一个指定的语言将作为默认语言。
+ \item 语言选项不是必需的,其主要用途是提高编译速度。不添加语言选项时效果是一样的,只是会更慢一些。
\end{itemize}
\item \texttt{draft} 或 \texttt{fast}
\begin{itemize}
@@ -139,9 +327,9 @@
\item 启用 \ProjLib{} 工具箱的快速模式。
\end{itemize}
\end{itemize}
-\begin{tip}
- 在文章的撰写阶段,建议使用 \verb|fast| 选项以加快编译速度,改善写作时的流畅度。使用 \verb|fast| 模式时会有“DRAFT”字样的水印,以提示目前处于草稿阶段。
-\end{tip}
+ \begin{tip}
+ 在文章的撰写阶段,建议使用 \verb|fast| 选项以加快编译速度,改善写作时的流畅度。使用 \verb|fast| 模式时会有“DRAFT”字样的水印,以提示目前处于草稿阶段。
+ \end{tip}
\item \texttt{a4paper} 或 \texttt{b5paper}
\begin{itemize}
\item 可选的纸张大小。默认的纸张大小为 7in $\times$ 10in。
@@ -151,6 +339,7 @@
\item 字体选项。顾名思义,会加载相应名称的字体。
\item \texttt{useosf} 选项用来启用“旧式”数字。
\end{itemize}
+\clearpage
\item \texttt{allowbf}
\begin{itemize}
\item 允许加粗。启用这一选项时,题目、各级标题、定理类环境名称会被加粗。
@@ -159,19 +348,18 @@
\begin{itemize}
\item 经典模式。启用这一选项时,样式会变得更加中规中矩:段落呈首行缩进样式、各类下划线减少、标题样式改变、定理类环境的样式也会更贴近常见的设置。
\end{itemize}
-\begin{tip}
- 如果你喜欢更加传统的样式,\texttt{allowbf} + \texttt{classical} 是一个不错的搭配。
-\end{tip}
+ \begin{tip}
+ 如果你喜欢更加传统的样式,\texttt{allowbf} + \texttt{classical} 是一个不错的搭配。
+ \end{tip}
\item \texttt{useindent}
\begin{itemize}
\item 采用段首缩进而不是段间间距。
\end{itemize}
- \clearpage
\item \texttt{runin}
\begin{itemize}
\item \lstinline|\subsubsection| 采用 ``runin'' 风格。
\end{itemize}
- \item \texttt{puretext} or \texttt{nothms}
+ \item \texttt{puretext} 或 \texttt{nothms}
\begin{itemize}
\item 纯文本模式,不加载定理类环境。
\end{itemize}
@@ -181,24 +369,9 @@
\end{itemize}
\end{itemize}
+\LevelOneTitle{具体说明}
-\section{关于默认字体}
-\einfart{} 默认使用 Palatino Linotype 作为英文字体,方正悠宋、悠黑GBK作为中文字体,并部分使用了 Neo Euler 作为数学字体。其中,Neo Euler可以在 \url{https://github.com/khaledhosny/euler-otf} 下载。其他字体不是免费字体,需要自行购买使用。可以在方正字库网站查询详细资料:\url{https://www.foundertype.com}。
-
-% \begin{itemize}
-% \item English main font. \textsf{English sans serif font}.
-% \item 中文主要字体,\textsf{中文无衬线字体}
-% \item 数学示例: \( \alpha, \beta, \gamma, \delta, 1,2,3,4, a,b,c,d \), \[\mathrm{li}(x)\coloneqq \int_2^{\infty} \frac{1}{\log t}\,\mathrm{d}t \]
-% \end{itemize}
-
-在没有安装相应的字体时,将采用TeX Live中自带的字体来代替,效果可能会有所折扣。
-
-
-\section{使用说明}
-
-接下来介绍的许多功能是由 \ProjLib{} 工具箱提供的。这里只介绍了基本使用方法,更多细节可以直接参阅其用户文档。
-
-\subsection{语言设置}
+\LevelTwoTitle{语言设置}
\einfart{} 提供了多语言支持,包括英语、法语、德语、意大利语、葡萄牙语、巴西葡萄牙语、西班牙语、简体中文、繁体中文、日文、俄文。可以通过下列命令来选定语言:
\begin{itemize}
@@ -240,8 +413,7 @@
\end{itemize}
例如,\lstinline|\AddLanguageSetting(German){\color{orange}}| 可以让所有德语以橙色显示(当然,还需要再加上 \lstinline|\AddLanguageSetting{\color{black}}| 来修正其他语言的颜色)。
-
-\subsection{定理类环境及其引用}
+\LevelTwoTitle{定理类环境及其引用}
定义、定理等环境已经被预定义,可以直接使用。
@@ -275,15 +447,12 @@
\UseLanguage{Chinese}
-\clearpage
-\subsection{定义新的定理型环境}
+\LevelTwoTitle{定义新的定理型环境}
若需要定义新的定理类环境,首先要定义这个环境在所用语言下的名称:
-% \vspace{-.15\baselineskip}%
\begin{itemize}
\item \lstinline|\NameTheorem[|\meta{language name}\lstinline|]{|\meta{name of environment}\lstinline|}{|\meta{name string}\lstinline|}|
\end{itemize}
-% \vspace{-.15\baselineskip}%
其中,\meta{language name} 可参阅关于语言设置的小节。当不指定 \meta{language name}时,则会将该名称设置为所有支持语言下的名称。另外,带星号与不带星号的同名环境共用一个名称,因此 \lstinline|\NameTheorem{envname*}{...}| 与 \lstinline|\NameTheorem{envname}{...}| 效果相同。
然后用下面五种方式之一定义这一环境:
@@ -320,7 +489,6 @@
其内部使用了 \textsf{amsthm},因此传统的 \texttt{theoremstyle} 对其也是适用的,只需在相关定义前标明即可。
\end{tip}
-% \def\proofideanameCN{思路}
\NameTheorem[CN]{proofidea}{思路}
\CreateTheorem*{proofidea*}
\CreateTheorem{proofidea}<subsection>
@@ -345,7 +513,8 @@
\lstinline|proofidea| 环境。
\end{proofidea}
-\subsection{未完成标记}
+\clearpage
+\LevelTwoTitle{未完成标记}
你可以通过 \lstinline|\dnf| 来标记尚未完成的部分。例如:
\begin{itemize}
@@ -357,10 +526,8 @@
\item \lstinline|\needgraph| 或 \lstinline|\needgraph<...>|。效果为:\needgraph~或 \needgraph<...>其提示文字与当前语言相对应,例如,在法语模式下将会显示为 \UseOtherLanguage{French}{\needgraph}
\end{itemize}
+\LevelTwoTitle{文章标题、摘要与关键词}
-\subsection{关于文章标题、摘要与关键词}
-
-% 由于引入了 \ProjLib{} 工具箱的 \textsf{PJLamssim} 组件,
\einfart{} 同时具有标准文档类与\AmS{} 文档类的一些特性。
因此,文章的标题部分既可以按照标准文档类 \textsf{article} 的写法来写:
@@ -409,10 +576,12 @@
其中 \lstinline|\address|、\lstinline|\curraddr|、\lstinline|\email| 的相互顺序是不重要的。
-\subsection{关于行号}
+\LevelTwoTitle{其他}
+
+\LevelThreeTitle{关于行号}
行号可以随时开启和关闭。\lstinline|\linenumbers| 用来开启行号,\lstinline|\nolinenumbers| 用来关闭行号。标题、目录、索引等位置为了美观,不进行编号。
-\subsection{关于标题中的脚注}
+\LevelThreeTitle{关于标题中的脚注}
在 \lstinline|\section| 或 \lstinline|\subsection| 中,如果想使用脚注,只能:
\begin{itemize}
\item 先写 \lstinline|\mbox{\protect\footnotemark}|,
@@ -420,11 +589,10 @@
\end{itemize}
这是标题使用下划线装饰之后带来的一个缺点。
-\subsection{关于QED符号}
+\LevelThreeTitle{关于QED符号}
由于定理类环境中的字体和正文字体是一样的,为了方便看出定理类环境在哪里结束,在其结尾处放置了一个空心的QED符号。然而,如果你的定理是由公式或者列表结尾的,这个符号就无法自动地放在正确的位置。这时,你需要手动在公式或列表最后一个条目的后面加上 \lstinline|\qedhere|,以让QED符号显示到这一行的最后。
-
-\section{目前存在的问题}
+\LevelOneTitle{目前存在的问题}
\begin{itemize}[itemsep=.6em]
\item 对于字体的设置仍然不够完善。
@@ -434,110 +602,7 @@
\end{itemize}
-
-\UseLanguage{English}
-
-\clearpage
-\section{文档示例}
-
-\subsection{标准文档类写法}
-
-如果想采用标准文档类中的写法,可以参考下面的例子:
-
-\begin{code}
-\documentclass{einfart}
-\usepackage{ProjLib} % Load ProjLib toolkit
-
-\UseLanguage{French} % Use French from here
-
-\begin{document}
-
-\title{Le Titre}
-\author{Auteur}
-\date{\PLdate{2022-04-01}}
-
-\maketitle
-
-\begin{abstract}
- Ceci est un résumé. \dnf<Plus de contenu est nécessaire.>
-\end{abstract}
-\begin{keyword}
- AAA, BBB, CCC, DDD, EEE
-\end{keyword}
-
-\section{Un théorème}
-
-%% Theorem-like environments can be used directly
-\begin{theorem}\label{thm:abc}
- Ceci est un théorème.
-\end{theorem}
-
-Référence du théorème: \cref{thm:abc}
- % It is recommended to use clever reference
-
-\end{document}
-\end{code}
-
-如果以后想切换到标准文档类,只需要将前两行换为:
-
-\begin{code}
-\documentclass{article}
-\usepackage[a4paper,margin=1in]{geometry}
-\usepackage[hidelinks]{hyperref}
-\usepackage[palatino]{ProjLib} % Load ProjLib toolkit
-\end{code}
-
-
-\clearpage
-\subsection{\texorpdfstring{\AmS{}}{AMS} 文档类写法}
-
-如果日后有意切换到期刊模版,想采用 \AmS{} 文档类中的写法,可以参考下面的例子:
-
-\begin{code}
-\documentclass{einfart}
-\usepackage{ProjLib} % Load ProjLib toolkit
-
-\UseLanguage{French} % Use French from here
-
-\begin{document}
-
-\title{Le Titre}
-\author{Auteur 1}
-\address{Adresse 1}
-\email{\href{Courriel 1}{Courriel 1}}
-\author{Auteur 1}
-\address{Adresse 1}
-\email{\href{Courriel 2}{Courriel 2}}
-\date{\PLdate{2022-04-01}}
-\subjclass{*****}
-\keywords{...}
-
-\begin{abstract}
- Ceci est un résumé. \dnf<Plus de contenu est nécessaire.>
-\end{abstract}
-
-\maketitle
-
-\section{Première section}
-
-%% Theorem-like environments can be used directly
-\begin{theorem}\label{thm:abc}
- Ceci est un théorème.
-\end{theorem}
-
-Référence du théorème: \cref{thm:abc}
- % It is recommended to use clever reference
-
-\end{document}
-\end{code}
-
-这样,若想切换到 \AmS{} 文档类,只需要将前两行换为:
-
-\begin{code}
-\documentclass{amsart}
-\usepackage[a4paper,margin=1in]{geometry}
-\usepackage[hidelinks]{hyperref}
-\usepackage[palatino]{ProjLib} % Load ProjLib toolkit
-\end{code}
-
\end{document}
+\endinput
+%%
+%% End of file `einfart/einfart-doc-cn.tex'.