diff options
Diffstat (limited to 'macros/unicodetex/latex')
14 files changed, 1972 insertions, 803 deletions
diff --git a/macros/unicodetex/latex/einfart/einfart-doc-cn.pdf b/macros/unicodetex/latex/einfart/einfart-doc-cn.pdf Binary files differindex 2a9a66a48f..93a9dc97ee 100644 --- a/macros/unicodetex/latex/einfart/einfart-doc-cn.pdf +++ b/macros/unicodetex/latex/einfart/einfart-doc-cn.pdf diff --git a/macros/unicodetex/latex/einfart/einfart-doc-cn.tex b/macros/unicodetex/latex/einfart/einfart-doc-cn.tex index b4cee34583..a8620ea2f2 100644 --- a/macros/unicodetex/latex/einfart/einfart-doc-cn.tex +++ b/macros/unicodetex/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'. diff --git a/macros/unicodetex/latex/einfart/einfart-doc-en.pdf b/macros/unicodetex/latex/einfart/einfart-doc-en.pdf Binary files differindex bbf036b4a8..16a81383da 100644 --- a/macros/unicodetex/latex/einfart/einfart-doc-en.pdf +++ b/macros/unicodetex/latex/einfart/einfart-doc-en.pdf diff --git a/macros/unicodetex/latex/einfart/einfart-doc-en.tex b/macros/unicodetex/latex/einfart/einfart-doc-en.tex index 277de1fade..9fa383a533 100644 --- a/macros/unicodetex/latex/einfart/einfart-doc-en.tex +++ b/macros/unicodetex/latex/einfart/einfart-doc-en.tex @@ -1,11 +1,7 @@ -%! TEX program = xelatex -\documentclass[English,French,puretext]{einfart} +\documentclass[English,Chinese,French,puretext]{einfart} \CreateTheorem{definition}<highest> -\CreateTheorem{theorem}<highest> - -% \setlist{nosep} -% \UseLanguage{English} +\CreateTheorem{theorem}[definition] \linenumbers % Enable line numbers @@ -15,9 +11,14 @@ \usepackage{ProjLib} \usepackage{longtable} % breakable tables \usepackage{hologo} % more TeX logo +\usetikzlibrary{calc} + +\usepackage{blindtext} + +\UseLanguage{English} %%================================ -%% For typestting code +%% For typesetting code %%================================ \usepackage{listings} \definecolor{maintheme}{RGB}{70,130,180} @@ -36,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, + {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}% -{\LocallyStopLineNumbers% +\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 @@ -73,7 +79,7 @@ }{\end{tcolorbox}\ResumeLineNumbers} %%================================ -%% 名称 +%% Names %%================================ \providecommand{\minimalist}{\textsf{minimalist}} \providecommand{\minimart}{\textsf{minimart}} @@ -82,13 +88,21 @@ \providecommand{\simplivre}{\textsf{simplivre}} %%================================ +%% Titles +%%================================ +\let\LevelOneTitle\section +\let\LevelTwoTitle\subsection +\let\LevelThreeTitle\subsubsection + +%%================================ %% Main text %%================================ \begin{document} \title{\einfart{}, write your articles in a simple and clear way} \author{Jinwen XU} -\thanks{Corresponding to: \texttt{\einfart{} 2021/07/05}} +\thanks{Corresponding to: \texttt{\einfart{} 2021/07/13}} +\email{\href{mailto:ProjLib@outlook.com}{ProjLib@outlook.com}} \date{July 2021, Beijing} \maketitle @@ -97,21 +111,28 @@ \einfart{} is part of the \minimalist{} class series, whose name is taken from German word ``einfach'' (``simple''), combined with the first three letters of ``artikel'' (``article''). The entire collection includes \minimart{} and \einfart{} for typesetting articles, and \minimbook{} and \simplivre{} for typesetting books. My original intention in designing them was to write drafts and notes that look simple yet not shabby. \einfart{} has multi-language support, including Chinese (simplified and traditional), English, French, German, Italian, Japanese, Portuguese (European and Brazilian), Russian and Spanish. These languages can be switched seamlessly in a single document. Due to the usage of custom fonts, \einfart{} requires \hologo{XeLaTeX} or \hologo{LuaLaTeX} to compile. - + This documentation is typeset using \einfart{}. You can think of it as a short introduction and demonstration. \end{abstract} + +\setcounter{tocdepth}{2} \tableofcontents -\bigskip -\begin{tip} - Multi-language support, theorem-like environments, draft marks and some other features are provided by the \ProjLib{} toolkit. Here we only briefly discuss how to use it with this document class. For more detailed information, you can refer to the documentation of \ProjLib{}. -\end{tip} -\clearpage -\section{Initialization} +\medskip +\LevelOneTitle*{Before you start} +\addcontentsline{toc}{section}{Before you start} +In order to use the package or classes described here, you need to: +\begin{itemize} + \item install TeX Live or MikTeX of the latest possible version, and make sure that \texttt{minimalist} and \texttt{projlib} are correctly installed in your \TeX{} system. + \item be familiar with the basic usage of \LaTeX{}, and knows how to compile your document with \hologo{pdfLaTeX}, \hologo{XeLaTeX} or \hologo{LuaLaTeX}. +\end{itemize} -\subsection{How to load it} + +\LevelOneTitle{Usage and examples} + +\LevelTwoTitle{How to load it} One only needs to put @@ -120,36 +141,206 @@ One only needs to put \end{code} as the first line to use the \einfart{} class. Please note that you need to use either \hologo{XeLaTeX} or \hologo{LuaLaTeX} engine to compile. -\subsection{Options} +\LevelTwoTitle{Example - A complete document} + +Let's first look at a complete document. + +\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*} + + +If you find this example a little complicated, don't worry. Let's now look at this example piece by piece. + +\clearpage +\LevelThreeTitle{Initialization} + +\medskip +\begin{code} +\documentclass{einfart} +\usepackage{ProjLib} +\end{code} + +Initialization is straightforward. The first line loads the document class \einfart{}, and the second line loads the \ProjLib{} toolkit to obtain some additional functionalities. + +\LevelThreeTitle{Set the language} + +\medskip +\begin{code} +\UseLanguage{French} +\end{code} + +This line indicates that French will be used in the document (by the way, if only English appears in your article, then there is no need to set the language). You can also switch the language in the same way later in the middle of the text. Supported languages include Simplified Chinese, Traditional Chinese, Japanese, English, French, German, Spanish, Portuguese, Brazilian Portuguese and Russian% +.% + +For detailed description of this command and more related commands, please refer to the section on the multi-language support. + +\LevelThreeTitle{Title, author information, abstract and keywords} + +\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} + +This part begins with the title and author information block. The example shows the basic usage, but in fact, you can also write: + +\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} + +In addition, you may also write in the \AmS{} fashion, i.e.: + +\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{Draft marks} + +\medskip +\begin{code} +\dnf<(*\meta{some hint}*)> +\end{code} + +When you have some places that have not yet been finished yet, you can mark them with this command, which is especially useful during the draft stage. + +\LevelThreeTitle{Theorem-like environments} + +\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} + +Commonly used theorem-like environments have been pre-defined. Also, 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. + +\begin{tip} +If you wish to switch to the standard class later, just replace the first two lines with: + +\begin{code} +\documentclass{article} +\usepackage[a4paper,margin=1in]{geometry} +\usepackage[hidelinks]{hyperref} +\usepackage[palatino,amsfashion]{ProjLib} +\end{code} + +or to use the \AmS{} class: -\einfart{} offers the following options: +\begin{code} +\documentclass{amsart} +\usepackage[a4paper,margin=1in]{geometry} +\usepackage[hidelinks]{hyperref} +\usepackage[palatino]{ProjLib} +\end{code} + +\end{tip} + +\begin{tip} +If you like the current document class, but want a more ``plain'' style, then you can use the option \texttt{classical}, like this: + +\begin{code} +\documentclass[classical]{einfart} +\end{code} +\end{tip} + + +\LevelOneTitle{On the default fonts} +By default, \einfart{} uses Palatino Linotype as the English font, FounderType's YouSong and YouHei GBK as the Chinese fonts\footnote{For detail, pleaser visit FounderType's website: \url{https://www.foundertype.com}.}, and partially uses Neo Euler as the math font. Among them, Neo Euler can be downloaded at \url{https://github.com/khaledhosny/euler-otf}. The other fonts are not free, you need to purchase and install them on your own. + + +When the corresponding font is not installed, fonts that comes with TeX Live will be used instead. In this case, the experience might be reduced. + +\LevelOneTitle{The options} + +\einfart{} offers the following options: \begin{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. + \item The language options are optional, mainly for increasing the compilation speed. Without them the result would be the same, only slower. \end{itemize} \item \texttt{draft} or \texttt{fast} \begin{itemize} \item The option \verb|fast| enables a faster but slightly rougher style, main differences are: \begin{itemize} - \item Use simpler math font configuration; - \item Do not use \textsf{hyperref}; + \item Use simpler math font configuration; + \item Do not use \textsf{hyperref}; \item Enable the fast mode of \ProjLib{} toolkit. \end{itemize} \end{itemize} -\begin{tip} - During the draft stage, it is recommended to use the \verb|fast| option to speed up compilation. When in \verb|fast| mode, there will be a watermark ``DRAFT'' to indicate that you are currently in the draft mode. -\end{tip} + \begin{tip} + During the draft stage, it is recommended to use the \verb|fast| option to speed up compilation. When in \verb|fast| mode, there will be a watermark ``DRAFT'' to indicate that you are currently in the draft mode. + \end{tip} \item \texttt{a4paper} or \texttt{b5paper} \begin{itemize} - \item Optional paper size. The default paper size is 7in $\times$ 10in. + \item Paper size options. The default paper size is 7in $\times$ 10in. \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 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} +\clearpage \item \texttt{allowbf} \begin{itemize} \item Allow boldface. When this option is enabled, the main title, the titles of all levels and the names of theorem-like environments will be bolded. @@ -158,9 +349,9 @@ as the first line to use the \einfart{} class. Please note that you need to use \begin{itemize} \item Classic mode. When this option is enabled, the style will become more regular: paragraphs are indented, the use of underlines are reduced, heading styles are changed, and the theorem styles will be much closer to common styles. \end{itemize} -\begin{tip} - \texttt{allowbf} + \texttt{classical} is probably a good choice if you prefer traditional style. -\end{tip} + \begin{tip} + \texttt{allowbf} + \texttt{classical} is probably a good choice if you prefer traditional style. + \end{tip} \item \texttt{useindent} \begin{itemize} \item Use paragraph indentation instead of inter-paragraph spacing. @@ -179,22 +370,10 @@ as the first line to use the \einfart{} class. Please note that you need to use \end{itemize} \end{itemize} -\section{On the default fonts} -By default, \einfart{} uses Palatino Linotype as the English font, FounderType's YouSong and YouHei GBK as the Chinese fonts, and partially uses Neo Euler as the math font. Among them, Neo Euler can be downloaded at \url{https://github.com/khaledhosny/euler-otf}. The other fonts are not free, you need to purchase and install them on your own. (For the Chinese fonts, visit FounderType's website for detail: \url{https://www.foundertype.com} ). - -% \begin{itemize} -% \item English main font. \textsf{English sans serif font}. -% \item 中文主要字体, \textsf{中文无衬线字体} -% \item Math demonstration: \( \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} - -When the corresponding font is not installed, fonts that comes with TeX Live will be used instead. In this case, the experience might be reduced. -\section{Instructions} +\LevelOneTitle{Instructions by topic} -Many of the features described next are provided by the \ProjLib{} toolkit. Only the basic usage is mentioned here. For more details, please refer to its user documentation. - -\subsection{Language configuration} +\LevelTwoTitle{Language configuration} \einfart{} has multi-language support, including Chinese (simplified and traditional), English, French, German, Italian, Japanese, Portuguese (European and Brazilian), Russian and Spanish. The language can be selected by the following macros: @@ -232,12 +411,11 @@ 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). +\LevelTwoTitle{Theorems and how to reference them} -\subsection{Theorems and how to reference them} - -Environments such as \texttt{definition} and \texttt{theorem} have been pre-defined and can be used directly. +Environments such as \texttt{definition} and \texttt{theorem} have been preset and can be used directly. -More specifically, preset environments include: +More specifically, 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. 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. @@ -266,16 +444,15 @@ By default, when referenced, the name of the theorem always matches the language \UseLanguage{English} -\clearpage -\subsection{Define a new theorem-like environment} +\LevelTwoTitle{Define a new theorem-like environment} If you need to define a new theorem-like environment, you must first define the name of the environment in the language to use: -\vspace{-0.3\baselineskip} \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 language configuration. 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 And then define this environment in one of following five ways: \begin{itemize} \item \lstinline|\CreateTheorem*{|\meta{name of environment}\lstinline|}| @@ -292,7 +469,7 @@ And then define this environment in one of following five ways: \end{itemize} \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}<|\meta{numbered within}\lstinline|>| \begin{itemize} - \item Define a numbered environment \meta{name of environment}, numbered within the \\counter \meta{numbered within} + \item Define a numbered environment \meta{name of environment}, numbered within the counter \meta{numbered within} \end{itemize} \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}(|\meta{existed environment}\lstinline|)|\\ \lstinline|\CreateTheorem*{|\meta{name of environment}\lstinline|}(|\meta{existed environment}\lstinline|)| @@ -300,8 +477,8 @@ And then define this environment in one of following five ways: \item Identify \meta{name of environment} with \meta{existed environment} or \meta{existed environment}\lstinline|*|. \item This method is usually useful in the following two situations: \begin{enumerate} - \item To use a more concise name. For example, with \lstinline|\CreateTheorem{thm}|\\\lstinline|(theorem)|, one can then use the name \texttt{thm} to write theorem. - \item To remove the numbering. For example, one can remove the numbering of the \texttt{remark} environment with \lstinline|\CreateTheorem{remark}(remark*)|. + \item To use a more concise name. For example, with \lstinline|\CreateTheorem{thm}(theorem)|, one can then use the name \texttt{thm} to write theorem. + \item To remove the numbering of some environments. For example, one can remove the numbering of the \texttt{remark} environment with \lstinline|\CreateTheorem{remark}(remark*)|. \end{enumerate} \end{itemize} \end{itemize} @@ -310,7 +487,6 @@ And then define this environment in one of following five ways: 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} \CreateTheorem*{proofidea*} \CreateTheorem{proofidea}<subsection> @@ -324,7 +500,8 @@ Here is an example. The following code: \CreateTheorem{proofidea}<subsection> \end{code} -defines an unnumbered environment \lstinline|proofidea*| and a numbered environment \lstinline|proofidea| (numbered within subsection) respectively. They can be used in English context. The effect is as follows: +defines an unnumbered environment \lstinline|proofidea*| and a numbered environment \lstinline|proofidea| (numbered within subsection) respectively. They can be used in English context. +The effect is as follows: \vspace{-0.3\baselineskip} \begin{proofidea*} @@ -336,20 +513,19 @@ defines an unnumbered environment \lstinline|proofidea*| and a numbered environm The \lstinline|proofidea| environment. \end{proofidea} -\subsection{Draft mark} +\LevelTwoTitle{Draft mark} You can use \lstinline|\dnf| to mark the unfinished part. For example: \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. \end{itemize} -Similarly, there is \lstinline|\needgraph| : +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} \end{itemize} - -\subsection{On the title, abstract and keywords} +\LevelTwoTitle{Title, abstract and keywords} \einfart{} has both the features of standard classes and that of the \AmS{} classes. @@ -385,7 +561,6 @@ or written in the way of \AmS{} classes: \maketitle \end{code} -\medskip The author information can contain multiple groups, written as: \begin{code} @@ -400,132 +575,33 @@ The author information can contain multiple groups, written as: Among them, the mutual order of \lstinline|\address|, \lstinline|\curraddr|, \lstinline|\email| is not important. +\LevelTwoTitle{Miscellaneous} -\subsection{On the line numbers} +\LevelThreeTitle{On the line numbers} Line numbers can be turned on and off at any time. \lstinline|\linenumbers| is used to enable the line numbers, and \lstinline|\nolinenumbers| is used to disable them. For the sake of beauty, the title, table of contents, index and some other elements are not numbered. -\subsection{On the footnotes in the title} +\LevelThreeTitle{On the footnotes in the title} In \lstinline|\section| or \lstinline|\subsection| , if you wish to add footnotes, you can only: \begin{itemize} - \item first write \lstinline|\mbox{\protect\footnotemark}|, - \item then add \lstinline|\footnotetext{...}| afterwards. + \item first write \lstinline|\mbox{\protect\footnotemark}|, + \item then add \lstinline|\footnotetext{...}| afterwards. \end{itemize} This is a disadvantage brought about by the underline decoration of the title. -\subsection{On the QED symbols} +\LevelThreeTitle{On the QED symbols} Since the font in the theorem-like environments is the same as that of the main text, in order to indicate where the environments end, a hollow QED symbol \simpleqedsymbol{} is placed at the end of the theorem-like environments. However, if your theorem ends with an equation or list (itemize, enumerate, description, etc.), this symbol cannot be automatically placed in the correct position. In this case, you need to manually add a \lstinline|\qedhere| at the end of your equation or the last entry of your list to make the QED symbol appear at the end of the line. - -\section{Known issues} +\LevelOneTitle{Known issues} \begin{itemize}[itemsep=.6em] \item The font settings are still not perfect. - \item Since many features are based on the \ProjLib{} toolkit, \einfart{} inherits all its problems. For details, please refer to the "Known Issues" section of the \ProjLib{} documentation. + \item Since many features are based on the \ProjLib{} toolkit, \minimalist{} (and hence \minimart{}, \einfart{} and \minimbook{}, \simplivre{}) inherits all its problems. For details, please refer to the ``Known Issues'' section of the \ProjLib{} documentation. \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. \end{itemize} -\clearpage -\section{Document templates} - -\subsection{The standard way} - -If you want to write in the standard way, you can refer to the following example: - -\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} - -If you wish to switch to the standard class later, just replace the first two lines with: - -\begin{code} -\documentclass{article} -\usepackage[a4paper,margin=1in]{geometry} -\usepackage[hidelinks]{hyperref} -\usepackage[palatino]{ProjLib} % Load ProjLib toolkit -\end{code} - - -\clearpage -\subsection{The \texorpdfstring{\AmS{}}{AMS} way} - -If you intend to switch to the journal template in the future and thus want to use the writing style as in the \AmS{} classes, you can refer to the following example: - -\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} - -In this way, if you wish to switch to \AmS{} class later, just replace the first two lines with: - -\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-en.tex'. diff --git a/macros/unicodetex/latex/einfart/einfart-doc-fr.pdf b/macros/unicodetex/latex/einfart/einfart-doc-fr.pdf Binary files differnew file mode 100644 index 0000000000..1685bbabba --- /dev/null +++ b/macros/unicodetex/latex/einfart/einfart-doc-fr.pdf diff --git a/macros/unicodetex/latex/einfart/einfart-doc-fr.tex b/macros/unicodetex/latex/einfart/einfart-doc-fr.tex new file mode 100644 index 0000000000..bc3b2870bc --- /dev/null +++ b/macros/unicodetex/latex/einfart/einfart-doc-fr.tex @@ -0,0 +1,604 @@ +\documentclass[English,Chinese,French,puretext]{einfart} + +\CreateTheorem{definition}<highest> +\CreateTheorem{theorem}[definition] + +\linenumbers % Enable line numbers + +%%================================ +%% Import toolkit +%%================================ +\usepackage{ProjLib} +\usepackage{longtable} % breakable tables +\usepackage{hologo} % more TeX logo +\usetikzlibrary{calc} + +\usepackage{blindtext} + +\UseLanguage{French} + +%%================================ +%% For typesetting code +%%================================ +\usepackage{listings} +\definecolor{maintheme}{RGB}{70,130,180} +\definecolor{forestgreen}{RGB}{21,122,81} +\definecolor{lightergray}{gray}{0.99} +\lstset{language=[LaTeX]TeX, + keywordstyle=\color{maintheme}, + basicstyle=\ttfamily, + commentstyle=\color{forestgreen}\ttfamily, + stringstyle=\rmfamily, + showstringspaces=false, + breaklines=true, + frame=lines, + backgroundcolor=\color{lightergray}, + flexiblecolumns=true, + escapeinside={(*}{*)}, + % numbers=left, + numberstyle=\scriptsize, stepnumber=1, numbersep=5pt, + % firstnumber=last, +} +\providecommand{\meta}[1]{$\langle${\normalfont\itshape#1}$\rangle$} +\lstset{moretexcs=% + {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}% +{\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 +%%================================ +\usepackage[many]{tcolorbox} +\newenvironment{tip}[1][Astuce]{% + \LocallyStopLineNumbers% + \begin{tcolorbox}[breakable, + enhanced, + width = \textwidth, + colback = paper, colbacktitle = paper, + colframe = gray!50, boxrule=0.2mm, + coltitle = black, + fonttitle = \sffamily, + 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={\scshape\sffamily #1}]% +}{\end{tcolorbox}\ResumeLineNumbers} + +%%================================ +%% Names +%%================================ +\providecommand{\minimalist}{\textsf{minimalist}} +\providecommand{\minimart}{\textsf{minimart}} +\providecommand{\minimbook}{\textsf{minimbook}} +\providecommand{\einfart}{\textsf{einfart}} +\providecommand{\simplivre}{\textsf{simplivre}} + +%%================================ +%% Titles +%%================================ +\let\LevelOneTitle\section +\let\LevelTwoTitle\subsection +\let\LevelThreeTitle\subsubsection + +%%================================ +%% Main text +%%================================ +\begin{document} + +\title{\einfart{}, écrivez vos articles de manière simple et claire} +\author{Jinwen XU} +\thanks{Correspondant à : \texttt{\einfart{} 2021/07/13}} +\email{\href{mailto:ProjLib@outlook.com}{ProjLib@outlook.com}} +\date{juillet 2021, à Pékin} + +\maketitle + +\begin{abstract} + \einfart{} fait partie de la série de classes \minimalist{}, dont le nom est tiré du mot allemand « einfach » (simple), combiné avec les trois premières lettres de « artikel » (article) . L'ensemble de la collection comprend \minimart{} et \einfart{} pour la composition d'articles, et \minimbook{} et \simplivre{} pour celle des livres. Mon intention initiale en les concevant était d'écrire des brouillons et des notes qui semblent simples mais pas grossières. + + \einfart{} prend en charge plusieurs langues, notamment le chinois (simplifié et traditionnel), l'anglais, le français, l'allemand, l'italien, le japonais, le portugais (européen et brésilien), le russe et l'espagnol. Ces langues peuvent être commutées de manière transparente dans un seul document. En raison de l'utilisation de polices personnalisées, \einfart{} demande soit \hologo{XeLaTeX} soit \hologo{LuaLaTeX} pour la compilation. + + Cette documentation est composée à l'aide de \einfart{}. Vous pouvez le considérer comme une courte introduction et une démonstration. +\end{abstract} + + +\setcounter{tocdepth}{2} +\tableofcontents + + +\LevelOneTitle*{Avant de commencer} +\addcontentsline{toc}{section}{Avant de commencer} + +Pour utiliser les classes de documents décrites ici, vous devez : +\begin{itemize} + \item installer TeX Live ou MikTeX de la dernière version possible, et vous assurer que \texttt{minimalist} et \texttt{projlib} sont correctement installés dans votre système \TeX{}. + \item être familiarisé avec l'utilisation de base de \LaTeX{}, et savoir comment compiler vos documents avec \hologo{pdfLaTeX}, \hologo{XeLaTeX} ou \hologo{LuaLaTeX}. +\end{itemize} + + +\LevelOneTitle{Utilisation et exemples} + +\LevelTwoTitle{Comment l'ajouter} + +Il suffit simplement de mettre + +\begin{code} + \documentclass{einfart} +\end{code} + +comme première ligne pour utiliser la classe \einfart{}. Veuillez noter que vous devez utiliser le moteur \hologo{XeLaTeX} ou \hologo{LuaLaTeX} pour compiler. + +\LevelTwoTitle{Exemple - Un document complet} + +Regardons d'abord un document complet. + +\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*} + + +Si vous trouvez cela un peu compliqué, ne vous inquiétez pas. Examinons maintenant cet exemple pièce par pièce. + +\clearpage +\LevelThreeTitle{Initialisation} + +\medskip +\begin{code} +\documentclass{einfart} +\usepackage{ProjLib} +\end{code} + +L'initialisation est simple. La première ligne ajoute la classe de document \einfart{}, et la deuxième ligne ajoute la boîte à outils \ProjLib{} pour obtenir des fonctionnalités supplémentaires. + +\LevelThreeTitle{Choisir la langue} + +\medskip +\begin{code} +\UseLanguage{French} +\end{code} + +Cette ligne indique que le français sera utilisé dans le document (d'ailleurs, si seul l'anglais apparaît dans votre article, alors il n'est pas nécessaire de choisir la langue). Vous pouvez également changer de langue de la même manière plus tard au milieu du texte. Les langues prises en charge sont les suivantes : chinois simplifié, chinois traditionnel, japonais, anglais, français, allemand, espagnol, portugais, portugais brésilien et russe. + +Pour une description détaillée de cette commande et d'autres commandes associées, veuillez vous référer à la section sur le support multilingue. + +\LevelThreeTitle{Titre, informations sur l'auteur, résumé et mots-clés} + +\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} + +Cette partie commence par le titre et le bloc d'informations sur l'auteur. L'exemple montre l'utilisation de base, mais en fait, vous pouvez également écrire comme : + +\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} + +De plus, vous pouvez également écrire à la manière \AmS{}, c'est-à-dire : + +\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{Marques de brouillon} + +\medskip +\begin{code} +\dnf<(*\meta{some hint}*)> +\end{code} +Lorsque vous avez des endroits qui ne sont pas encore finis, vous pouvez les marquer avec cette commande, ce qui est particulièrement utile lors de la phase de brouillon. + +\LevelThreeTitle{Environnements de type théorème} + +\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} + +Les environnements de type théorème couramment utilisés ont été prédéfinis. De plus, lors du référencement d'un environnement de type théorème, il est recommandé d'utiliser \lstinline|\cref{|\meta{label}\texttt{\}} --- de cette manière, il ne serait pas nécessaire d'écrire explicitement le nom de l'environnement correspondant à chaque fois. + +\begin{tip} +Si vous souhaitez utiliser la classe standard à la place plus tard, remplacez simplement les deux premières lignes par : + +\begin{code} +\documentclass{article} +\usepackage[a4paper,margin=1in]{geometry} +\usepackage[hidelinks]{hyperref} +\usepackage[palatino,amsfashion]{ProjLib} +\end{code} + +ou utilisez la classe \AmS{} : + +\begin{code} +\documentclass{amsart} +\usepackage[a4paper,margin=1in]{geometry} +\usepackage[hidelinks]{hyperref} +\usepackage[palatino]{ProjLib} +\end{code} +\vspace{-.5\baselineskip} +\end{tip} + +\begin{tip} +Si vous aimez la classe de document actuelle, mais que vous souhaitez un style plus « simple », vous pouvez utiliser l'option \texttt{classical}, comme ceci : + +\begin{code} +\documentclass[classical]{einfart} +\end{code} +\vspace{-.5\baselineskip} +\end{tip} + + +\LevelOneTitle{À propos des polices par défaut} +Par défaut, cette classe de document utilise Palatino Linotype comme police anglaise, YouSong et YouHei GBK de FounderType comme polices chinoises\footnote{Pour plus de détails, veuillez visiter le site Web de FounderType : \url{https://www.foundertype.com}.}, et utilise partiellement Neo Euler comme police mathématique. Parmi eux, Neo Euler peut être téléchargé sur \url{https://github.com/khaledhosny/euler-otf}. Les autres polices ne sont pas gratuites, vous devez les acheter et les installer vous-même. + + +Lorsque la police correspondante n'est pas installée, les polices fournies avec TeX Live seront utilisées à la place. Dans ce cas, l'expérience peut être réduite. + + +\LevelOneTitle{Les options} + + +\begin{itemize} + \item Les options de langue \texttt{EN} / \texttt{english} / \texttt{English}, \texttt{FR} / \texttt{french} / \texttt{French}, etc. + \begin{itemize} + \item Pour les noms d'options d'une langue spécifique, veuillez vous référer à \meta{language name} dans la section suivante. La première langue spécifiée sera considérée comme la langue par défaut. + \item Les options de langue ne sont pas nécessaires, elles servent principalement à augmenter la vitesse de compilation. Sans eux, le résultat serait le même, justement plus lent. + \end{itemize} + \item \texttt{draft} ou \texttt{fast} + \begin{itemize} + \item L'option \verb|fast| permet un style plus rapide mais légèrement plus rugueux, les principales différences sont : + \begin{itemize} + \item Utilisez une configuration de police mathématique plus simple ; + \item N'utilisez pas \textsf{hyperref} ; + \item Activez le mode rapide de la boîte à outils \ProjLib{}. + \end{itemize} + \end{itemize} + \begin{tip} + Pendant la phase de brouillon, il est recommandé d'utiliser le \verb|fast| option pour accélérer la compilation. Quand dans \verb|fast| mode, il y aura un filigrane ``DRAFT'' pour indiquer que vous êtes actuellement en mode brouillon. + \end{tip} + \item \texttt{a4paper} ou \texttt{b5paper} + \begin{itemize} + \item Options de format de papier. Le format de papier par défaut est 7 pouces $\times$ 10 pouces. + \end{itemize} + \item \texttt{palatino}, \texttt{times}, \texttt{garamond}, \texttt{biolinum} ~$|$~ \texttt{useosf} + \begin{itemize} + \item Options de police. Comme son nom l'indique, la police avec le nom correspondant sera utilisée. + \item L'option \texttt{useosf} est pour activer les chiffres à l'ancienne. + \end{itemize} + \item \texttt{allowbf} + \begin{itemize} + \item Pour activer les titres en gras. Lorsque cette option est utilisée, le titre principal, les titres de tous les niveaux et les noms des environnements de type théorème seront en gras. + \end{itemize} + \item \texttt{classical} + \begin{itemize} + \item Mode classique. Lorsque cette option est utilisée, le style deviendra plus régulier : les paragraphes sont en retrait, l'utilisation de soulignements est réduite, les styles de titres sont modifiés et les styles de théorème seront beaucoup plus proches des styles par défaut. + \end{itemize} + \begin{tip} + \texttt{allowbf} + \texttt{classical} est probablement un bon choix si vous préférez le style traditionnel. + \end{tip} + \item \texttt{useindent} + \begin{itemize} + \item Utilisez l'indentation des paragraphes au lieu de l'espacement entre les paragraphes. + \end{itemize} + \item \texttt{runin} + \begin{itemize} + \item Utilisez le style « runin » pour \lstinline|\subsubsection| + \end{itemize} + \item \texttt{puretext} ou \texttt{nothms} + \begin{itemize} + \item Mode texte pur. Ne pas définir les environnements de type théorème. + \end{itemize} + \item \texttt{nothmnum} + \begin{itemize} + \item Ne pas numéroter les environnements de type théorème. + \end{itemize} +\end{itemize} + +\LevelOneTitle{Instructions par sujet} + +\LevelTwoTitle{Configurer la langue} + +\einfart{} prend en charge plusieurs langues, notamment le chinois (simplifié et traditionnel), l'anglais, le français, l'allemand, l'italien, le japonais, le portugais (européen et brésilien), le russe et l'espagnol. La langue peut être sélectionnée par les macros suivantes : + +\begin{itemize} + \item \lstinline|\UseLanguage{|\meta{language name}\lstinline|}| est utilisé pour spécifier la langue. Le réglage correspondant de la langue sera appliqué après celui-ci. Il peut être utilisé soit dans le préambule ou dans le texte. Lorsqu'aucune langue n'est spécifiée, « English » est sélectionné par défaut. + \item \lstinline|\UseOtherLanguage{|\meta{language name}\lstinline|}{|\meta{content}\lstinline|}|, qui utilise les paramètres de langue spécifiés pour composer \meta{content}. Par rapport à \lstinline|\UseLanguage|, il ne modifiera pas l'interligne, donc l'interligne restera stable lorsque le texte CJK et occidental sont mélangés. +\end{itemize} + +\clearpage +\meta{language name} peut être (il n'est pas sensible à la casse, par exemple, \texttt{French} et \texttt{french} ont le même effet) : +\begin{itemize} + \item chinois simplifié : \texttt{CN}, \texttt{Chinese}, \texttt{SChinese} ou \texttt{SimplifiedChinese} + \item chinois traditionnel : \texttt{TC}, \texttt{TChinese} ou \texttt{TraditionalChinese} + \item anglais : \texttt{EN} ou \texttt{English} + \item français : \texttt{FR} ou \texttt{French} + \item allemand : \texttt{DE}, \texttt{German} ou \texttt{ngerman} + \item italien : \texttt{IT} ou \texttt{Italian} + \item portugais : \texttt{PT} ou \texttt{Portuguese} + \item portugais (brésilien) : \texttt{BR} ou \texttt{Brazilian} + \item espagnol : \texttt{ES} ou \texttt{Spanish} + \item japonais : \texttt{JP} ou \texttt{Japanese} + \item russe : \texttt{RU} ou \texttt{Russian} +\end{itemize} + +\medskip +De plus, vous pouvez également ajouter de nouveaux paramètres à la langue sélectionnée : +\begin{itemize} + \item \lstinline|\AddLanguageSetting{|\meta{settings}\lstinline|}| + \begin{itemize} + \item Ajoutez \meta{settings} à toutes les langues prises en charge. + \end{itemize} + \item \lstinline|\AddLanguageSetting(|\meta{language name}\lstinline|){|\meta{settings}\lstinline|}| + \begin{itemize} + \item Ajoutez \meta{settings} à la langue \meta{language name} sélectionnée. + \end{itemize} +\end{itemize} +Par exemple, \lstinline|\AddLanguageSetting(German){\color{orange}}| peut rendre tout le texte allemand affiché en orange (bien sûr, il faut alors ajouter \lstinline|\AddLanguageSetting{\color{black}}| afin de corriger la couleur du texte dans d'autres langues). + +\LevelTwoTitle{Théorèmes et comment les référencer} + +Des environnements tels que \texttt{definition} et \texttt{theorem} ont été prédéfinis et peuvent être utilisés directement. + +Plus précisement, les environnements prédéfinis incluent : \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}, et la version non numérotée correspondante avec un astérisque \lstinline|*| dans le nom. Les titres changeront avec la langue actuelle. Par exemple, \texttt{theorem} sera affiché comme « Theorem » en mode anglais et « Théorème » en mode français. + +Lors du référencement d'un environnement de type théorème, il est recommandé d'utiliser \lstinline|\cref{|\meta{label}\texttt{\}}. De cette façon, il n'est pas nécessaire d'écrire explicitement le nom de l'environnement correspondant à chaque fois. + +\begin{tip}[Exemple] +\begin{code} + \begin{definition}[Des choses étranges] \label{def: strange} ... +\end{code} + +will produce +\begin{definition}[Des choses étranges]\label{def: strange} + C'est la définition de certains objets étranges. Il y a approximativement un espace d'une ligne avant et après l'environnement de type théorème, et il y aura un symbole pour marquer la fin de l'environnement. +\end{definition} + +\lstinline|\cref{def: strange}| s'affichera sous la forme : \cref{def: strange}. + +Après avoir utilisé \lstinline|\UseLanguage{French}|, un théorème s'affichera sous la forme : + +\UseLanguage{English} +\begin{theorem}[Useless]\label{thm} + A theorem in English. +\end{theorem} + +Par défaut, lorsqu'il est référencé, le nom de l'environnement de type théorème correspond toujours à la langue du contexte dans lequel se trouve l'environnement. Par exemple, la définition ci-dessus est toujours affichée en français dans le mode anglais courant : \cref{def: strange} et \cref{thm}. Si vous voulez que le nom du théorème corresponde au contexte actuel lors du référencement, vous pouvez ajouter \texttt{regionalref} aux options globales. +\end{tip} + +\UseLanguage{French} + +\LevelTwoTitle{Définir un nouvel environnement de type théorème} + +Si vous avez besoin de définir un nouvel environnement de type théorème, vous devez d'abord définir le nom de l'environnement dans le langage à utiliser : +\begin{itemize} + \item \lstinline|\NameTheorem[|\meta{language name}\lstinline|]{|\meta{name of environment}\lstinline|}{|\meta{name string}\lstinline|}| +\end{itemize} +Pour \meta{language name}, veuillez vous référer à la section sur la configuration de la langue. Lorsqu'il n'est pas spécifié, le nom sera défini pour toutes les langues prises en charge. De plus, les environnements avec ou sans astérisque partagent le même nom, donc \lstinline|\NameTheorem{envname*}{...}| a le même effet que \lstinline|\NameTheorem{envname}{...}| . + +\medskip +Ensuite, créez cet environnement de l'une des cinq manières suivantes : +\begin{itemize} + \item \lstinline|\CreateTheorem*{|\meta{name of environment}\lstinline|}| + \begin{itemize} + \item Définir un environnement non numéroté \meta{name of environment} + \end{itemize} + \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}| + \begin{itemize} + \item Définir un environnement numéroté \meta{name of environment}, numéroté dans l'ordre 1, 2, 3, \dots + \end{itemize} + \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}[|\meta{numbered like}\lstinline|]| + \begin{itemize} + \item Définir un environnement numéroté \meta{name of environment}, qui partage le compteur \meta{numbered like} + \end{itemize} + \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}<|\meta{numbered within}\lstinline|>| + \begin{itemize} + \item Définir un environnement numéroté \meta{name of environment}, numéroté dans le compteur \meta{numbered within} + \end{itemize} + \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} + \item Identifiez \meta{name of environment} avec \meta{existed environment} ou \meta{existed environment}\lstinline|*|. + \item Cette méthode est généralement utile dans les deux situations suivantes : + \begin{enumerate} + \item Pour utiliser un nom plus concis. Par exemple, avec \lstinline|\CreateTheorem{thm}(theorem)|, on peut alors utiliser le nom \texttt{thm} pour écrire le théorème. + \item Pour supprimer la numérotation de certains environnements. Par exemple, on peut supprimer la numérotation de l'environnement \texttt{remark} avec \lstinline|\CreateTheorem{remark}(remark*)|. + \end{enumerate} + \end{itemize} +\end{itemize} + +\begin{tip} + Cette macro utilise la fonctionnalité de \textsf{amsthm} en interne, donc le traditionnel \texttt{theoremstyle} lui est également applicable. Il suffit de déclarer le style avant les définitions pertinentes. +\end{tip} + +\NameTheorem[FR]{proofidea}{Idée} +\CreateTheorem*{proofidea*} +\CreateTheorem{proofidea}<subsection> + +\bigskip +Voici un exemple. Le code suivant : + +\begin{code} + \NameTheorem[FR]{proofidea}{Idée} + \CreateTheorem*{proofidea*} + \CreateTheorem{proofidea}<subsection> +\end{code} + +définit un environnement non numéroté \lstinline|proofidea*| et un environnement numéroté \lstinline|proofidea| (numérotés dans la sous-section) respectivement. Ils peuvent être utilisés dans le contexte français. L'effet est le suivant : + +\vspace{-0.3\baselineskip} +\begin{proofidea*} + La environnement \lstinline|proofidea*| . +\end{proofidea*} + +\vspace{-\baselineskip} +\begin{proofidea} + La environnement \lstinline|proofidea| . +\end{proofidea} + +\LevelTwoTitle{Draft mark} + +Vous pouvez utiliser \lstinline|\dnf| pour marquer la partie inachevée. Par example : +\begin{itemize} + \item \lstinline|\dnf| ou \lstinline|\dnf<...>|. L'effet est : \dnf~ ou \dnf<...>. \\Le texte à l'intérieur changera en fonction de la langue actuelle. Par exemple, il sera affiché sous la forme \UseOtherLanguage{English}{\dnf} en mode anglais. +\end{itemize} + +De même, il y a aussi \lstinline|\needgraph| : +\begin{itemize} + \item \lstinline|\needgraph| ou \lstinline|\needgraph<...>|. L'effet est : \needgraph ou \needgraph<...>Le texte de l'invite change en fonction de la langue actuelle. Par exemple, en mode anglais, il sera affiché sous la forme \UseOtherLanguage{English}{\needgraph} +\end{itemize} + +\LevelTwoTitle{Titre, résumé et mots-clés} + +\einfart{} possède à la fois les caractéristiques des classes standard et celles des classes \AmS{}. + +Par conséquent, le titre et les informations sur l'auteur peuvent être soit écrits de la manière habituelle, conformément à la classe standard \textsf{article} : + +\begin{code} + \title{(*\meta{title}*)} + \author{(*\meta{author}*)\thanks{(*\meta{text}*)}} + \date{(*\meta{date}*)} + \maketitle + \begin{abstract} + (*\meta{abstract}*) + \end{abstract} + \begin{keyword} + (*\meta{keywords}*) + \end{keyword} +\end{code} + +ou écrit à la manière des classes \AmS{} : + +\begin{code} + \title{(*\meta{title}*)} + \author{(*\meta{author}*)} + \thanks{(*\meta{text}*)} + \address{(*\meta{address}*)} + \email{(*\meta{email}*)} + \date{(*\meta{date}*)} + \keywords{(*\meta{keywords}*)} + \subjclass{(*\meta{subjclass}*)} + \begin{abstract} + (*\meta{abstract}*) + \end{abstract} + \maketitle +\end{code} + +Les informations sur l'auteur peuvent contenir plusieurs groupes, écrits comme suit : + +\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} + +Parmi eux, l'ordre mutuel de \lstinline|\address|, \lstinline|\curraddr|, \lstinline|\email| n'est pas important. + +\LevelTwoTitle{Divers} + +\LevelThreeTitle{Les numéros de ligne} +Les numéros de ligne peuvent être activés et désactivés n'importe où dans votre texte. \lstinline|\linenumbers| est pour activer les numéros de ligne, et \lstinline|\nolinenumbers| est pour les désactiver. Par souci de beauté, le titre, la table des matières, l'index et certains autres éléments ne sont pas numérotés. + +\LevelThreeTitle{Les notes de bas de page dans le titre} +Dans \lstinline|\section| ou \lstinline|\subsection| , si vous souhaitez ajouter des notes de bas de page, vous n'avez d'autre choix que : +\begin{itemize} + \item écrivez d'abord \lstinline|\mbox{\protect\footnotemark}|, + \item puis ajoutez \lstinline|\footnotetext{...}| après le titre. +\end{itemize} +C'est un inconvénient provoqué par la décoration de soulignement du titre. + +\LevelThreeTitle{Les symboles QED} +Puisque la police dans les environnements de type théorème est la même que celle du texte principal, afin d'indiquer où se terminent les environnements, un symbole QED creux \simpleqedsymbol{} est placé à la fin des environnements de type théorème. Cependant, si votre théorème se termine par une équation ou une liste (itemize, énumérer, description, etc.), ce symbole ne peut pas être automatiquement placé à la bonne position. Dans ce cas, vous devez ajouter manuellement un \lstinline|\qedhere| à la fin de votre équation ou la dernière entrée de votre liste pour faire apparaître le symbole QED en fin de ligne. + +\LevelOneTitle{Problèmes connus} + +\begin{itemize}[itemsep=.6em] + \item Les paramètres de police ne sont pas encore parfaits. + \item Comme de nombreuses fonctionnalités sont basées sur la boîte à outils \ProjLib{}, \minimalist{} (et donc \minimart{}, \einfart{} et \minimbook{}, \simplivre{}) hérite de tous ses problèmes. Pour plus de détails, veuillez vous référer à la section « Problèmes connus » de la documentation de \ProjLib{}. + \item Le mécanisme de gestion des erreurs est incomplet : pas de messages correspondants lorsque certains problèmes surviennent. + \item Il y a encore beaucoup de choses qui peuvent être optimisées dans le code. +\end{itemize} + + +\end{document} +\endinput +%% +%% End of file `einfart/einfart-doc-fr.tex'. diff --git a/macros/unicodetex/latex/einfart/einfart.cls b/macros/unicodetex/latex/einfart/einfart.cls index 70a747e367..0471027bba 100644 --- a/macros/unicodetex/latex/einfart/einfart.cls +++ b/macros/unicodetex/latex/einfart/einfart.cls @@ -17,7 +17,7 @@ %% \NeedsTeXFormat{LaTeX2e}[2020-10-01] \ProvidesClass{einfart} - [2021/07/05 A simple and clear article style] + [2021/07/13 A simple and clear article style] \def\minimclass@baseclass{article} \RequirePackage{kvoptions} \RequirePackage{etoolbox} @@ -240,6 +240,7 @@ \renewcommand{\nmid}{\hspace{-.2em}\nmid@original\hspace{-.2em}} } +\RequirePackage{tikz-cd} \newbox\xratbelow \newbox\xratabove \renewcommand{\xrightarrow}[2][]{% diff --git a/macros/unicodetex/latex/simplivre/simplivre-doc-cn.pdf b/macros/unicodetex/latex/simplivre/simplivre-doc-cn.pdf Binary files differindex 26a44b253f..ceac6a1df4 100644 --- a/macros/unicodetex/latex/simplivre/simplivre-doc-cn.pdf +++ b/macros/unicodetex/latex/simplivre/simplivre-doc-cn.pdf diff --git a/macros/unicodetex/latex/simplivre/simplivre-doc-cn.tex b/macros/unicodetex/latex/simplivre/simplivre-doc-cn.tex index 5ce2d00a7d..351cdd73f3 100644 --- a/macros/unicodetex/latex/simplivre/simplivre-doc-cn.tex +++ b/macros/unicodetex/latex/simplivre/simplivre-doc-cn.tex @@ -1,22 +1,24 @@ -%! TEX program = xelatex -\documentclass[Chinese,English,French,puretext]{simplivre} +\documentclass[English,Chinese,French,puretext]{simplivre} \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,part,chapter,section,subsection,subsubsection,href, - color,NameTheorem,CreateTheorem,proofideanameCN,cref,dnf,needgraph,UseLanguage,UseOtherLanguage,AddLanguageSetting,maketitle,address,curraddr,email,keywords,subjclass,thanks,dedicatory,PLdate,ProjLib,parttext,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}% -{\LocallyStopLineNumbers% +\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 @@ -58,21 +65,21 @@ \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}\ResumeLineNumbers} %%================================ -%% 名称 +%% Names %%================================ \providecommand{\minimalist}{\textsf{minimalist}} \providecommand{\minimart}{\textsf{minimart}} @@ -80,21 +87,18 @@ \providecommand{\einfart}{\textsf{einfart}} \providecommand{\simplivre}{\textsf{simplivre}} -\usetikzlibrary{calc} - -\usepackage{blindtext} +%%================================ +%% Titles +%%================================ +\let\LevelOneTitle\chapter +\let\LevelTwoTitle\section +\let\LevelThreeTitle\subsection %%================================ -%% 正文 +%% Main text %%================================ \begin{document} -% \title{\simplivre{},以极简主义风格排版你的图书\thanks{对应版本. \texttt{\simplivre{} 2021/06/07}}} -% \author{许锦文} -% \date{2021年6月,北京} - -% \maketitle - \frontmatter \begin{titlepage} % Suppresses displaying the page number on the title page and the subsequent page counts as page 1 @@ -102,13 +106,14 @@ \fill [cyan!90!black] ($(current page.south west)+(0,7)$) rectangle ($(current page.north west)+(21,-7)$); \fill [yellow] (current page.south west) rectangle ($(current page.north west)+(3,0)$); \node[text width=10cm] at ($(current page.north west)+(8.5,-6)$) {\huge\ProjLib}; - \node[text width=6cm,text height=3.5cm,scale=2.5] at ($(current page.north west)+(11,-9)$) {\textcolor{white}{\sffamily\simplivre{}\\[5pt]\footnotesize\hspace*{-.05em}以极简主义风格排版你的图书\\[10pt]\tiny 对应版本. \texttt{\simplivre{} 2021/07/05}}}; + \node[text width=6cm,text height=3.5cm,scale=2.5] at ($(current page.north west)+(11,-9)$) {\textcolor{white}{\sffamily\simplivre{}\\[5pt]\footnotesize\hspace*{-.05em}以极简主义风格排版你的图书\\[10pt]\tiny 对应版本. \texttt{\simplivre{} 2021/07/13}}}; \node at ($(current page.south)+(1.5,3)$) {\fontsize{16pt}{0pt}\selectfont\textcolor{gray}{许锦文}}; \node at ($(current page.south)+(1.5,2)$) {\fontsize{12pt}{0pt}\selectfont\textcolor{gray}{2021年7月,北京}}; \end{tikzpicture}% \end{titlepage}% \cleardoublepage% + \chapter*{前言} \simplivre{} 是 \minimalist{} 文档类系列的成员之一,其名称取自于法文的 simple (“简约”),以及 livre (“书”),由二者组合而成。整个 \minimalist{} 系列包含用于排版文章的 \minimart{}、\einfart{} 以及用于排版书的 \minimbook{}、\simplivre{}。我设计这一系列的初衷是为了撰写草稿与笔记,使之看上去简朴而不简陋。 @@ -129,9 +134,18 @@ \part{说明} \parttext{可以通过 \lstinline|\\parttext|\meta{text} 在这里添加一些说明} -\chapter{初始化} +\medskip +\LevelOneTitle*{开始之前} +为了使用这篇文档中提到的文档类,你需要: +\begin{itemize} + \item 安装一个尽可能新版本的 TeX Live 或 MikTeX 套装,并确保 \texttt{minimalist} 和 \texttt{projlib} 被正确安装在你的 \TeX 封装中。 + \item 熟悉 \LaTeX{} 的基本使用方式,并且知道如何用 \hologo{pdfLaTeX}、\hologo{XeLaTeX} 或 \hologo{LuaLaTeX} 编译你的文档。 +\end{itemize} + + +\LevelOneTitle{使用示例} -\section{如何载入} +\LevelTwoTitle{如何加载} 只需要在第一行写: @@ -145,7 +159,110 @@ 要使用 \hologo{XeLaTeX} 或 \hologo{LuaLaTeX} 引擎才能编译。 \end{tip} -\section{选项} +\LevelTwoTitle{一篇完整的文档示例} + +首先来看一段完整的示例。 + + +\begin{code*} +\documentclass{minimbook} +\usepackage{ProjLib} + +\UseLanguage{French} + +\begin{document} + +\frontmatter + +\begin{titlepage} + (*\meta{code for titlepage}*) +\end{titlepage} + +\tableofcontents + +\mainmatter + +\part{(*\meta{part title}*)} +\parttext{(*\meta{text after part title}*)} + +\chapter{(*\meta{chapter title}*)} + +\section{(*\meta{section title}*)} + +\dnf<Plus de contenu est nécessaire.> + +\begin{theorem}\label{thm:abc} + Ceci est un théorème. +\end{theorem} +Référence du théorème: \cref{thm:abc} + +\backmatter + +... + +\end{document} +\end{code*} + +如果你觉得这个例子有些复杂,不要担心。现在我们来一点点地观察这个例子。 + +\LevelThreeTitle{初始化部分} + +\medskip +\begin{code} +\documentclass{simplivre} +\usepackage{ProjLib} +\end{code} + +初始化部分很简单:第一行加载文档类 \simplivre{},第二行加载 \ProjLib{} 工具箱,以便使用一些附加功能。 + +\LevelThreeTitle{设定语言} + +\medskip +\begin{code} +\UseLanguage{French} +\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|}|——这样就不必每次都写上相应环境的名称了。 + + + + +\LevelOneTitle{关于默认字体} +\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中自带的字体来代替,效果可能会有所折扣。 + + +\LevelOneTitle{选项} \simplivre{} 文档类有下面几个选项: @@ -153,6 +270,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} @@ -163,14 +281,13 @@ \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。 \end{itemize} - \clearpage \item \texttt{palatino}、\texttt{times}、\texttt{garamond}、\texttt{biolinum} ~$|$~ \texttt{useosf} \begin{itemize} \item 字体选项。顾名思义,会加载相应名称的字体。 @@ -184,10 +301,10 @@ \begin{itemize} \item 经典模式。启用这一选项时,样式会变得更加中规中矩:段落呈首行缩进样式、各类下划线减少、标题样式改变、定理类环境的样式也会更贴近常见的设置。 \end{itemize} -\begin{tip} - 如果你喜欢更加传统的样式,\texttt{allowbf} + \texttt{classical} 是一个不错的搭配。 -\end{tip} - \item \texttt{useindent} + \begin{tip} + 如果你喜欢更加传统的样式,\texttt{allowbf} + \texttt{classical} 是一个不错的搭配。 + \end{tip} + \item \texttt{useindent} \begin{itemize} \item 采用段首缩进而不是段间间距。 \end{itemize} @@ -195,7 +312,7 @@ \begin{itemize} \item \lstinline|\subsubsection| 采用 ``runin'' 风格。 \end{itemize} - \item \texttt{puretext} or \texttt{nothms} + \item \texttt{puretext} 或 \texttt{nothms} \begin{itemize} \item 纯文本模式,不加载定理类环境。 \end{itemize} @@ -204,32 +321,12 @@ \item 定理类环境不编号。 \end{itemize} \end{itemize} - \bigskip 另外,排版图书时常用的 \texttt{oneside}、\texttt{twoside} 选项也是可以使用的。默认采用双页排版。 -\chapter{关于默认字体} -\simplivre{} 默认使用 Palatino Linotype 作为英文字体,方正悠宋、悠黑GBK作为中文字体,并部分使用了 Neo Euler 作为数学字体。其中,Neo Euler可以在 \url{https://github.com/khaledhosny/euler-otf} 下载。其他字体不是免费字体,需要自行购买使用。可以在方正字库网站查询详细资料:\url{https://www.foundertype.com}。 - -\begin{tip}[字体演示] - \begin{itemize} - \item English main font. \textsf{English sans serif font}. \texttt{English typewriter 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} -\end{tip} - -\bigskip -在没有安装相应的字体时,将采用TeX Live中自带的字体来代替,效果可能会有所折扣。 - - -\chapter{使用说明} - -\vspace{-\baselineskip} +\LevelOneTitle{具体说明} -接下来介绍的许多功能是由 \ProjLib{} 工具箱提供的。这里只介绍了基本使用方法,更多细节可以直接参阅其用户文档。 - -\section{语言设置} +\LevelTwoTitle{语言设置} \simplivre{} 提供了多语言支持,包括英语、法语、德语、意大利语、葡萄牙语、巴西葡萄牙语、西班牙语、简体中文、繁体中文、日文、俄文。可以通过下列命令来选定语言: \begin{itemize} @@ -271,8 +368,7 @@ \end{itemize} 例如,\lstinline|\AddLanguageSetting(German){\color{orange}}| 可以让所有德语以橙色显示(当然,还需要再加上 \lstinline|\AddLanguageSetting{\color{black}}| 来修正其他语言的颜色)。 - -\section{定理类环境及其引用} +\LevelTwoTitle{定理类环境及其引用} 定义、定理等环境已经被预定义,可以直接使用。 @@ -281,6 +377,7 @@ 在引用定理类环境时,建议使用智能引用 \lstinline|\cref{|\meta{label}\lstinline|}|。这样就不必每次都写上相应环境的名称了。 +\medskip \begin{tip}[例子] \begin{code} \begin{definition}[奇异物品] \label{def: strange} ... @@ -292,6 +389,7 @@ \lstinline|\cref{def: strange}| 会显示为:\cref{def: strange}。 +\medskip 使用 \lstinline|\UseLanguage{English}| 后,定理会显示为: \UseLanguage{English} @@ -304,17 +402,15 @@ \UseLanguage{Chinese} - -\section{定义新的定理型环境} +\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}{...}| 效果相同。 +\clearpage 然后用下面五种方式之一定义这一环境: \begin{itemize} \item \lstinline|\CreateTheorem*{|\meta{name of environment}\lstinline|}| @@ -349,7 +445,6 @@ 其内部使用了 \textsf{amsthm},因此传统的 \texttt{theoremstyle} 对其也是适用的,只需在相关定义前标明即可。 \end{tip} -% \def\proofideanameCN{思路} \NameTheorem[CN]{proofidea}{思路} \CreateTheorem*{proofidea*} \CreateTheorem{proofidea}<section> @@ -365,15 +460,16 @@ 可以分别定义不编号的环境 \lstinline|proofidea*| 和编号的环境 \lstinline|proofidea| (在 section 内编号),它们支持在简体中文语境中使用,效果如下所示: +\vspace{-.3\baselineskip} \begin{proofidea*} \lstinline|proofidea*| 环境。 \end{proofidea*} - +\vspace{-.5\baselineskip} \begin{proofidea} \lstinline|proofidea| 环境。 \end{proofidea} -\section{未完成标记} +\LevelTwoTitle{未完成标记} 你可以通过 \lstinline|\dnf| 来标记尚未完成的部分。例如: \begin{itemize} @@ -386,60 +482,12 @@ \end{itemize} -% \section{关于文章标题、摘要与关键词} - -% % 由于引入了 \ProjLib{} 工具箱的 \textsf{PJLamssim} 组件, -% \simplivre{} 同时具有标准文档类与\AmS{} 文档类的一些特性。 - -% 因此,文章的标题部分既可以按照标准文档类 \textsf{article} 的写法来写: - -% \begin{code} -% \title{(*\meta{title}*)} -% \author{(*\meta{author}*)} -% \date{(*\meta{date}*)} -% \maketitle -% \begin{abstract} -% (*\meta{abstract}*) -% \end{abstract} -% \begin{keyword} -% (*\meta{keywords}*) -% \end{keyword} -% \end{code} - -% 也可以按照 \AmS{} 文档类的方式来写: - -% \begin{code} -% \title{(*\meta{title}*)} -% \author{(*\meta{author}*)} -% \address{(*\meta{address}*)} -% \email{(*\meta{email}*)} -% \date{(*\meta{date}*)} -% \keywords{(*\meta{keywords}*)} -% \subjclass{(*\meta{subjclass}*)} -% \begin{abstract} -% (*\meta{abstract}*) -% \end{abstract} -% \maketitle -% \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} - -% 其中 \lstinline|\address|、\lstinline|\curraddr|、\lstinline|\email| 的相互顺序是不重要的。 - -\section{关于行号} +\LevelTwoTitle{其他} + +\LevelThreeTitle{关于行号} 行号可以随时开启和关闭。\lstinline|\linenumbers| 用来开启行号,\lstinline|\nolinenumbers| 用来关闭行号。标题、目录、索引等位置为了美观,不进行编号。 -\section{关于标题中的脚注} +\LevelThreeTitle{关于标题中的脚注} 在 \lstinline|\section| 或 \lstinline|\subsection| 中,如果想使用脚注,只能: \begin{itemize} \item 先写 \lstinline|\mbox{\protect\footnotemark}|, @@ -447,118 +495,22 @@ \end{itemize} 这是标题使用下划线装饰之后带来的一个缺点。 -\section{关于QED符号} +\LevelThreeTitle{关于QED符号} 由于定理类环境中的字体和正文字体是一样的,为了方便看出定理类环境在哪里结束,在其结尾处放置了一个空心的QED符号。然而,如果你的定理是由公式或者列表结尾的,这个符号就无法自动地放在正确的位置。这时,你需要手动在公式或列表最后一个条目的后面加上 \lstinline|\qedhere|,以让QED符号显示到这一行的最后。 - -\section{目前存在的问题} +\LevelOneTitle{目前存在的问题} \begin{itemize}[itemsep=.6em] \item 对于字体的设置仍然不够完善。 - \item 由于很多核心功能建立在 \ProjLib{} 工具箱的基础上,因此 \simplivre{} 自然继承了其所有问题。详情可以参阅 \ProjLib{} 用户文档的“目前存在的问题”这一小节。 + \item 由于很多核心功能建立在 \ProjLib{} 工具箱的基础上,因此 \einfart{} 自然继承了其所有问题。详情可以参阅 \ProjLib{} 用户文档的“目前存在的问题”这一小节。 \item 错误处理功能不完善,在出现一些问题时没有相应的错误提示。 \item 代码中仍有许多可优化之处。 \end{itemize} - - -\UseLanguage{English} - \part{演示} - -\chapter{文档示例} - -\vspace*{-1.5\baselineskip} - -\section{标准文档类写法} - -如果想采用标准文档类中的写法,可以参考下面的例子: - -\begin{code} -\documentclass{simplivre} -\usepackage{ProjLib} % Load ProjLib toolkit - -\UseLanguage{French} % Use French from here - -\begin{document} - -\title{Le Titre} -\author{Auteur} -\date{\PLdate{2022-04-01}} - -\maketitle - -\chapter{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{book} -\usepackage[a4paper,margin=1in]{geometry} -\usepackage[hidelinks]{hyperref} -\usepackage[palatino]{ProjLib} % Load ProjLib toolkit -\end{code} - - -% \clearpage -\section{\texorpdfstring{\AmS{}}{AMS} 文档类写法} - -如果日后有意切换到期刊模版,想采用 \AmS{} 文档类中的写法,可以参考下面的例子: - -\begin{code} -\documentclass{simplivre} -\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{...} - -\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{amsbook} -\usepackage[a4paper,margin=1in]{geometry} -\usepackage[hidelinks]{hyperref} -\usepackage[palatino]{ProjLib} % Load ProjLib toolkit -\end{code} - \blinddocument \end{document} +\endinput +%% +%% End of file `simplivre/simplivre-doc-cn.tex'. diff --git a/macros/unicodetex/latex/simplivre/simplivre-doc-en.pdf b/macros/unicodetex/latex/simplivre/simplivre-doc-en.pdf Binary files differindex 6b4ed825c1..34a65c050f 100644 --- a/macros/unicodetex/latex/simplivre/simplivre-doc-en.pdf +++ b/macros/unicodetex/latex/simplivre/simplivre-doc-en.pdf diff --git a/macros/unicodetex/latex/simplivre/simplivre-doc-en.tex b/macros/unicodetex/latex/simplivre/simplivre-doc-en.tex index 1885bfd03c..96012c739b 100644 --- a/macros/unicodetex/latex/simplivre/simplivre-doc-en.tex +++ b/macros/unicodetex/latex/simplivre/simplivre-doc-en.tex @@ -1,8 +1,7 @@ -%! TEX program = xelatex -\documentclass[English,French,puretext]{simplivre} +\documentclass[English,Chinese,French,puretext]{simplivre} \CreateTheorem{definition}<highest> -\CreateTheorem{theorem}<highest> +\CreateTheorem{theorem}[definition] \linenumbers % Enable line numbers @@ -12,9 +11,14 @@ \usepackage{ProjLib} \usepackage{longtable} % breakable tables \usepackage{hologo} % more TeX logo +\usetikzlibrary{calc} + +\usepackage{blindtext} + +\UseLanguage{English} %%================================ -%% For typestting code +%% For typesetting code %%================================ \usepackage{listings} \definecolor{maintheme}{RGB}{70,130,180} @@ -33,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,part,chapter,section,subsection,subsubsection,href, - color,NameTheorem,CreateTheorem,proofideanameEN,cref,dnf,needgraph,UseLanguage,UseOtherLanguage,AddLanguageSetting,maketitle,address,curraddr,email,keywords,subjclass,thanks,dedicatory,PLdate,ProjLib,parttext,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}% -{\LocallyStopLineNumbers% +\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 @@ -70,7 +79,7 @@ }{\end{tcolorbox}\ResumeLineNumbers} %%================================ -%% 名称 +%% Names %%================================ \providecommand{\minimalist}{\textsf{minimalist}} \providecommand{\minimart}{\textsf{minimart}} @@ -78,21 +87,18 @@ \providecommand{\einfart}{\textsf{einfart}} \providecommand{\simplivre}{\textsf{simplivre}} -\usetikzlibrary{calc} - -\usepackage{blindtext} +%%================================ +%% Titles +%%================================ +\let\LevelOneTitle\chapter +\let\LevelTwoTitle\section +\let\LevelThreeTitle\subsection %%================================ %% Main text %%================================ \begin{document} -% \title{\simplivre{}, write your books in a simple and clear way} -% \author{Jinwen XU} -% \thanks{Corresponding to: \texttt{\simplivre{} 2021/05/23}} -% \date{May 2021, Beijing} - -% \maketitle \frontmatter @@ -101,13 +107,14 @@ \fill [cyan!90!black] ($(current page.south west)+(0,7)$) rectangle ($(current page.north west)+(21,-7)$); \fill [yellow] (current page.south west) rectangle ($(current page.north west)+(3,0)$); \node[text width=10cm] at ($(current page.north west)+(8.5,-6)$) {\huge\ProjLib}; - \node[text width=6cm,text height=3.5cm,scale=2.5] at ($(current page.north west)+(11,-9)$) {\textcolor{white}{\sffamily\simplivre{}\\[5pt]\footnotesize\textsc{Write your books in \\a simple and clear way}\\[10pt]\tiny Corresponding to: \texttt{\simplivre{} 2021/07/05}}}; + \node[text width=6cm,text height=3.5cm,scale=2.5] at ($(current page.north west)+(11,-9)$) {\textcolor{white}{\sffamily\simplivre{}\\[5pt]\footnotesize\textsc{Write your books in \\a simple and clear way}\\[10pt]\tiny Corresponding to: \texttt{\simplivre{} 2021/07/13}}}; \node at ($(current page.south)+(1.5,3)$) {\fontsize{16pt}{0pt}\selectfont\textcolor{gray}{\scshape Jinwen XU}}; \node at ($(current page.south)+(1.5,2)$) {\fontsize{12pt}{0pt}\selectfont\textcolor{gray}{July 2021, Beijing}}; \end{tikzpicture}% \end{titlepage}% \cleardoublepage% + \chapter*{Preface} \simplivre{} is part of the \minimalist{} class series. Its name is taken from French words ``simple'' and ``livre'' (for ``book''). The entire collection includes \minimart{} and \einfart{} for typesetting articles, and \minimbook{} and \simplivre{} for typesetting books. My original intention in designing them was to write drafts and notes that look simple yet not shabby. @@ -126,53 +133,166 @@ This documentation is typeset using \simplivre{}. You can think of it as a short \mainmatter \part{Instruction} -\parttext{You can add some introduction text here via \lstinline|\\parttext|\meta{text}.} +\parttext{You can add some introductory text here via \lstinline|\\parttext|\meta{text}.} + +\medskip +\LevelOneTitle*{Before you start} +\addcontentsline{toc}{chapter}{Before you start} +In order to use the package or classes described here, you need to: +\begin{itemize} + \item install TeX Live or MikTeX of the latest possible version, and make sure that \texttt{minimalist} and \texttt{projlib} are correctly installed in your \TeX{} system. + \item be familiar with the basic usage of \LaTeX{}, and knows how to compile your document with \hologo{pdfLaTeX}, \hologo{XeLaTeX} or \hologo{LuaLaTeX}. +\end{itemize} -\chapter{Initialization} -\section{How to load it} +\LevelOneTitle{Usage and examples} + +\LevelTwoTitle{How to load it} One only needs to put \begin{code} \documentclass{simplivre} \end{code} - as the first line to use the \simplivre{} class. \begin{tip}[Attention] You need to use either \hologo{XeLaTeX} or \hologo{LuaLaTeX} engine to compile. \end{tip} -\section{Options} +\LevelTwoTitle{Example - A complete document} + +Let's first look at a complete document. + + +\begin{code*} +\documentclass{minimbook} +\usepackage{ProjLib} + +\UseLanguage{French} + +\begin{document} + +\frontmatter + +\begin{titlepage} + (*\meta{code for titlepage}*) +\end{titlepage} + +\tableofcontents + +\mainmatter + +\part{(*\meta{part title}*)} +\parttext{(*\meta{text after part title}*)} + +\chapter{(*\meta{chapter title}*)} + +\section{(*\meta{section title}*)} + +\dnf<Plus de contenu est nécessaire.> + +\begin{theorem}\label{thm:abc} + Ceci est un théorème. +\end{theorem} +Référence du théorème: \cref{thm:abc} + +\backmatter + +... + +\end{document} +\end{code*} + +If you find this example a little complicated, don't worry. Let's now look at this example piece by piece. + +\LevelThreeTitle{Initialization} + +\medskip +\begin{code} +\documentclass{simplivre} +\usepackage{ProjLib} +\end{code} + +Initialization is straightforward. The first line loads the document class \simplivre{}, and the second line loads the \ProjLib{} toolkit to obtain some additional functionalities. + +\LevelThreeTitle{Set the language} + +\medskip +\begin{code} +\UseLanguage{French} +\end{code} + +This line indicates that French will be used in the document (by the way, if only English appears in your article, then there is no need to set the language). You can also switch the language in the same way later in the middle of the text. Supported languages include Simplified Chinese, Traditional Chinese, Japanese, English, French, German, Spanish, Portuguese, Brazilian Portuguese and Russian% +.% + +For detailed description of this command and more related commands, please refer to the section on the multi-language support. + + +\LevelThreeTitle{Draft marks} + +\medskip +\begin{code} +\dnf<(*\meta{some hint}*)> +\end{code} + +When you have some places that have not yet been finished yet, you can mark them with this command, which is especially useful during the draft stage. + +\LevelThreeTitle{Theorem-like environments} + +\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} + +Commonly used theorem-like environments have been pre-defined. Also, 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. + + -\simplivre{} offers the following options: + +\LevelOneTitle{On the default fonts} +By default, \einfart{} uses Palatino Linotype as the English font, FounderType's YouSong and YouHei GBK as the Chinese fonts\footnote{For detail, pleaser visit FounderType's website: \url{https://www.foundertype.com}.}, and partially uses Neo Euler as the math font. Among them, Neo Euler can be downloaded at \url{https://github.com/khaledhosny/euler-otf}. The other fonts are not free, you need to purchase and install them on your own. + +\begin{itemize} + \item English main font. \textsf{English sans serif font}. + \item 中文主要字体, \textsf{中文无衬线字体} + \item Math demonstration: \( \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} + +When the corresponding font is not installed, fonts that comes with TeX Live will be used instead. In this case, the experience might be reduced. + +\LevelOneTitle{The options} + +\simplivre{} offers the following options: \begin{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. + \item The language options are optional, mainly for increasing the compilation speed. Without them the result would be the same, only slower. \end{itemize} \item \texttt{draft} or \texttt{fast} \begin{itemize} \item The option \verb|fast| enables a faster but slightly rougher style, main differences are: \begin{itemize} - \item Use simpler math font configuration; - \item Do not use \textsf{hyperref}; + \item Use simpler math font configuration; + \item Do not use \textsf{hyperref}; \item Enable the fast mode of \ProjLib{} toolkit. \end{itemize} \end{itemize} -\begin{tip} - During the draft stage, it is recommended to use the \verb|fast| option to speed up compilation. When in \verb|fast| mode, there will be a watermark ``DRAFT'' to indicate that you are currently in the draft mode. -\end{tip} + \begin{tip} + During the draft stage, it is recommended to use the \verb|fast| option to speed up compilation. When in \verb|fast| mode, there will be a watermark ``DRAFT'' to indicate that you are currently in the draft mode. + \end{tip} \item \texttt{a4paper} or \texttt{b5paper} \begin{itemize} - \item Optional paper size. The default paper size is 7in $\times$ 10in. + \item Paper size options. The default paper size is 7in $\times$ 10in. \end{itemize} - \clearpage \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 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{allowbf} @@ -183,9 +303,9 @@ as the first line to use the \simplivre{} class. \begin{itemize} \item Classic mode. When this option is enabled, the style will become more regular: paragraphs are indented, the use of underlines are reduced, heading styles are changed, and the theorem styles will be much closer to common styles. \end{itemize} -\begin{tip} - \texttt{allowbf} + \texttt{classical} is probably a good choice if you prefer traditional style. -\end{tip} + \begin{tip} + \texttt{allowbf} + \texttt{classical} is probably a good choice if you prefer traditional style. + \end{tip} \item \texttt{useindent} \begin{itemize} \item Use paragraph indentation instead of inter-paragraph spacing. @@ -207,26 +327,9 @@ as the first line to use the \simplivre{} class. \bigskip In addition, the commonly used \texttt{oneside} and \texttt{twoside} options are also available. Two-page layout is used by default. -\chapter{On the default fonts} -By default, \simplivre{} uses Palatino Linotype as the English font, FounderType's YouSong and YouHei GBK as the Chinese fonts, and partially uses Neo Euler as the math font. Among them, Neo Euler can be downloaded at \url{https://github.com/khaledhosny/euler-otf}. The other fonts are not free, you need to purchase and install them on your own. (For the Chinese fonts, visit FounderType's website for detail: \url{https://www.foundertype.com} ). - -\begin{tip}[Font demonstration] - \begin{itemize} - \item English main font. \textsf{English sans serif font}. \texttt{English typewriter 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} -\end{tip} - -\bigskip -When the corresponding font is not installed, fonts that comes with TeX Live will be used instead. In this case, the experience might be reduced. - - -\chapter{Some instructions} +\LevelOneTitle{Instructions by topic} -Many of the features described next are provided by the \ProjLib{} toolkit. Only the basic usage is mentioned here. For more details, please refer to its user documentation. - -\section{Language configuration} +\LevelTwoTitle{Language configuration} \simplivre{} has multi-language support, including Chinese (simplified and traditional), English, French, German, Italian, Japanese, Portuguese (European and Brazilian), Russian and Spanish. The language can be selected by the following macros: @@ -264,13 +367,12 @@ 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). +\LevelTwoTitle{Theorems and how to reference them} -\section{Theorems and how to reference them} - -Environments such as \texttt{definition} and \texttt{theorem} have been pre-defined and can be used directly. +Environments such as \texttt{definition} and \texttt{theorem} have been preset and can be used directly. -More specifically, 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 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. +More specifically, 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. 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. @@ -298,8 +400,7 @@ By default, when referenced, the name of the theorem always matches the language \UseLanguage{English} - -\section{Define a new theorem-like environment} +\LevelTwoTitle{Define a new theorem-like environment} 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} @@ -324,7 +425,7 @@ And then define this environment in one of following five ways: \end{itemize} \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}<|\meta{numbered within}\lstinline|>| \begin{itemize} - \item Define a numbered environment \meta{name of environment}, numbered within the \\counter \meta{numbered within} + \item Define a numbered environment \meta{name of environment}, numbered within the counter \meta{numbered within} \end{itemize} \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}(|\meta{existed environment}\lstinline|)|\\ \lstinline|\CreateTheorem*{|\meta{name of environment}\lstinline|}(|\meta{existed environment}\lstinline|)| @@ -332,8 +433,8 @@ And then define this environment in one of following five ways: \item Identify \meta{name of environment} with \meta{existed environment} or \meta{existed environment}\lstinline|*|. \item This method is usually useful in the following two situations: \begin{enumerate} - \item To use a more concise name. For example, with \lstinline|\CreateTheorem{thm}|\\\lstinline|(theorem)|, one can then use the name \texttt{thm} to write theorem. - \item To remove the numbering. For example, one can remove the numbering of the \texttt{remark} environment with \lstinline|\CreateTheorem{remark}(remark*)|. + \item To use a more concise name. For example, with \lstinline|\CreateTheorem{thm}(theorem)|, one can then use the name \texttt{thm} to write theorem. + \item To remove the numbering of some environments. For example, one can remove the numbering of the \texttt{remark} environment with \lstinline|\CreateTheorem{remark}(remark*)|. \end{enumerate} \end{itemize} \end{itemize} @@ -342,7 +443,6 @@ And then define this environment in one of following five ways: 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} \CreateTheorem*{proofidea*} \CreateTheorem{proofidea}<section> @@ -356,203 +456,62 @@ Here is an example. The following code: \CreateTheorem{proofidea}<section> \end{code} -defines an unnumbered environment \lstinline|proofidea*| and a numbered environment \lstinline|proofidea| (numbered within section) respectively. They can be used in English context. The effect is as follows: +defines an unnumbered environment \lstinline|proofidea*| and a numbered environment \lstinline|proofidea| (numbered within section) respectively. They can be used in English context. +The effect is as follows: +\vspace{-0.3\baselineskip} \begin{proofidea*} The \lstinline|proofidea*| environment. \end{proofidea*} +\vspace{-\baselineskip} \begin{proofidea} The \lstinline|proofidea| environment. \end{proofidea} -% \clearpage -\section{Draft mark} +\clearpage +\LevelTwoTitle{Draft mark} You can use \lstinline|\dnf| to mark the unfinished part. For example: \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. \end{itemize} -Similarly, there is \lstinline|\needgraph| : +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} \end{itemize} -% \vspace{-.5\baselineskip} -% \section{On the title, abstract and keywords} - -% \simplivre{} has both the features of standard classes and that of the \AmS{} classes. - -% Therefore, the title part can either be written in the usual way, in accordance with the standard class \textsf{article}: - -% \begin{code} -% \title{(*\meta{title}*)} -% \author{(*\meta{author}*)} -% \date{(*\meta{date}*)} -% \maketitle -% \begin{abstract} -% (*\meta{abstract}*) -% \end{abstract} -% \begin{keyword} -% (*\meta{keywords}*) -% \end{keyword} -% \end{code} - -% \vspace{-.5\baselineskip} -% or written in the way of \AmS{} classes: - -% \begin{code} -% \title{(*\meta{title}*)} -% \author{(*\meta{author}*)} -% \address{(*\meta{address}*)} -% \email{(*\meta{email}*)} -% \date{(*\meta{date}*)} -% \keywords{(*\meta{keywords}*)} -% \subjclass{(*\meta{subjclass}*)} -% \begin{abstract} -% (*\meta{abstract}*) -% \end{abstract} -% \maketitle -% \end{code} - -% \medskip -% The author information can contain multiple groups, written as: - -% \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} - -% Among them, the mutual order of \lstinline|\address|, \lstinline|\curraddr|, \lstinline|\email| is not important. - -\section{On the line numbers} + +\LevelTwoTitle{Miscellaneous} + +\LevelThreeTitle{On the line numbers} Line numbers can be turned on and off at any time. \lstinline|\linenumbers| is used to enable the line numbers, and \lstinline|\nolinenumbers| is used to disable them. For the sake of beauty, the title, table of contents, index and some other elements are not numbered. -\section{On the footnotes in the title} +\LevelThreeTitle{On the footnotes in the title} In \lstinline|\section| or \lstinline|\subsection| , if you wish to add footnotes, you can only: \begin{itemize} - \item first write \lstinline|\mbox{\protect\footnotemark}|, - \item then add \lstinline|\footnotetext{...}| afterwards. + \item first write \lstinline|\mbox{\protect\footnotemark}|, + \item then add \lstinline|\footnotetext{...}| afterwards. \end{itemize} This is a disadvantage brought about by the underline decoration of the title. -\section{On the QED symbols} +\LevelThreeTitle{On the QED symbols} Since the font in the theorem-like environments is the same as that of the main text, in order to indicate where the environments end, a hollow QED symbol \simpleqedsymbol{} is placed at the end of the theorem-like environments. However, if your theorem ends with an equation or list (itemize, enumerate, description, etc.), this symbol cannot be automatically placed in the correct position. In this case, you need to manually add a \lstinline|\qedhere| at the end of your equation or the last entry of your list to make the QED symbol appear at the end of the line. - -\clearpage -\section{Known issues} +\LevelOneTitle{Known issues} \begin{itemize}[itemsep=.6em] \item The font settings are still not perfect. - \item Since many features are based on the \ProjLib{} toolkit, \simplivre{} inherits all its problems. For details, please refer to the "Known Issues" section of the \ProjLib{} documentation. + \item Since many features are based on the \ProjLib{} toolkit, \minimalist{} (and hence \minimart{}, \einfart{} and \minimbook{}, \simplivre{}) inherits all its problems. For details, please refer to the ``Known Issues'' section of the \ProjLib{} documentation. \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. \end{itemize} - \part{Demonstration} - -\chapter{Document templates} - -\vspace*{-1.5\baselineskip} - -\section{The standard way} - -If you want to write in the standard way, you can refer to the following example: - -\begin{code} -\documentclass{simplivre} -\usepackage{ProjLib} % Load ProjLib toolkit - -\UseLanguage{French} % Use French from here - -\begin{document} - -\title{Le Titre} -\author{Auteur} -\date{\PLdate{2022-04-01}} - -\maketitle - -\chapter{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} - -If you wish to switch to the standard class later, just replace the first two lines with: - -\begin{code} -\documentclass{article} -\usepackage[a4paper,margin=1in]{geometry} -\usepackage[hidelinks]{hyperref} -\usepackage[palatino]{ProjLib} % Load ProjLib toolkit -\end{code} - - -\clearpage -\section{The \texorpdfstring{\AmS{}}{AMS} way} - -If you intend to switch to the journal template in the future and thus want to use the writing style as in the \AmS{} classes, you can refer to the following example: - -\begin{code} -\documentclass{simplivre} -\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{...} - -\maketitle - -\chapter{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} - -\vspace{-0.3\baselineskip} -In this way, if you wish to switch to \AmS{} class later, just replace the first two lines with: - -\begin{code} -\documentclass{amsart} -\usepackage[a4paper,margin=1in]{geometry} -\usepackage[hidelinks]{hyperref} -\usepackage[palatino]{ProjLib} % Load ProjLib toolkit -\end{code} - \blinddocument \end{document} +\endinput +%% +%% End of file `simplivre/simplivre-doc-en.tex'. diff --git a/macros/unicodetex/latex/simplivre/simplivre-doc-fr.pdf b/macros/unicodetex/latex/simplivre/simplivre-doc-fr.pdf Binary files differnew file mode 100644 index 0000000000..de83ca3ed2 --- /dev/null +++ b/macros/unicodetex/latex/simplivre/simplivre-doc-fr.pdf diff --git a/macros/unicodetex/latex/simplivre/simplivre-doc-fr.tex b/macros/unicodetex/latex/simplivre/simplivre-doc-fr.tex new file mode 100644 index 0000000000..fd50796985 --- /dev/null +++ b/macros/unicodetex/latex/simplivre/simplivre-doc-fr.tex @@ -0,0 +1,511 @@ +\documentclass[English,Chinese,French,puretext]{simplivre} + +\CreateTheorem{definition}<highest> +\CreateTheorem{theorem}[definition] + +\linenumbers % Enable line numbers + +%%================================ +%% Import toolkit +%%================================ +\usepackage{ProjLib} +\usepackage{longtable} % breakable tables +\usepackage{hologo} % more TeX logo +\usetikzlibrary{calc} + +\usepackage{blindtext} + +\UseLanguage{French} + +%%================================ +%% For typesetting code +%%================================ +\usepackage{listings} +\definecolor{maintheme}{RGB}{70,130,180} +\definecolor{forestgreen}{RGB}{21,122,81} +\definecolor{lightergray}{gray}{0.99} +\lstset{language=[LaTeX]TeX, + keywordstyle=\color{maintheme}, + basicstyle=\ttfamily, + commentstyle=\color{forestgreen}\ttfamily, + stringstyle=\rmfamily, + showstringspaces=false, + breaklines=true, + frame=lines, + backgroundcolor=\color{lightergray}, + flexiblecolumns=true, + escapeinside={(*}{*)}, + % numbers=left, + numberstyle=\scriptsize, stepnumber=1, numbersep=5pt, + % firstnumber=last, +} +\providecommand{\meta}[1]{$\langle${\normalfont\itshape#1}$\rangle$} +\lstset{moretexcs=% + {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}% +{\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 +%%================================ +\usepackage[many]{tcolorbox} +\newenvironment{tip}[1][Astuce]{% + \LocallyStopLineNumbers% + \begin{tcolorbox}[breakable, + enhanced, + width = \textwidth, + colback = paper, colbacktitle = paper, + colframe = gray!50, boxrule=0.2mm, + coltitle = black, + fonttitle = \sffamily, + 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={\scshape\sffamily #1}]% +}{\end{tcolorbox}\ResumeLineNumbers} + +%%================================ +%% Names +%%================================ +\providecommand{\minimalist}{\textsf{minimalist}} +\providecommand{\minimart}{\textsf{minimart}} +\providecommand{\minimbook}{\textsf{minimbook}} +\providecommand{\einfart}{\textsf{einfart}} +\providecommand{\simplivre}{\textsf{simplivre}} + +%%================================ +%% Titles +%%================================ +\let\LevelOneTitle\chapter +\let\LevelTwoTitle\section +\let\LevelThreeTitle\subsection + +%%================================ +%% Main text +%%================================ +\begin{document} + +\frontmatter + +\begin{titlepage} % Suppresses displaying the page number on the title page and the subsequent page counts as page 1 +\begin{tikzpicture}[overlay,remember picture] + \fill [cyan!90!black] ($(current page.south west)+(0,7)$) rectangle ($(current page.north west)+(21,-7)$); + \fill [yellow] (current page.south west) rectangle ($(current page.north west)+(3,0)$); + \node[text width=10cm] at ($(current page.north west)+(8.5,-6)$) {\huge\ProjLib}; + \node[text width=6cm,text height=3.5cm,scale=2.5] at ($(current page.north west)+(11,-9)$) {\textcolor{white}{\sffamily\simplivre{}\\[5pt]\footnotesize\textsc{Écrivez vos livres \\de manière simple et claire}\\[10pt]\tiny Correspondant à : \texttt{\simplivre{} 2021/07/13}}}; + \node at ($(current page.south)+(1.5,3)$) {\fontsize{16pt}{0pt}\selectfont\textcolor{gray}{\scshape Jinwen XU}}; + \node at ($(current page.south)+(1.5,2)$) {\fontsize{12pt}{0pt}\selectfont\textcolor{gray}{juillet 2021, à Pékin}}; +\end{tikzpicture}% +\end{titlepage}% +\cleardoublepage% + + +\chapter*{Préface} + +\simplivre{} fait partie de la série de classes \minimalist{}, dont le nom est tiré des mots « simple » et « livre ». L'ensemble de la collection comprend \minimart{} et \einfart{} pour la composition d'articles, et \minimbook{} et \simplivre{} pour celle des livres. Mon intention initiale en les concevant était d'écrire des brouillons et des notes qui semblent simples mais pas grossières. + +\simplivre{} prend en charge plusieurs langues, notamment le chinois (simplifié et traditionnel), l'anglais, le français, l'allemand, l'italien, le japonais, le portugais (européen et brésilien), le russe et l'espagnol. Ces langues peuvent être commutées de manière transparente dans un seul document. En raison de l'utilisation de polices personnalisées, \simplivre{} demande soit \hologo{XeLaTeX} soit \hologo{LuaLaTeX} pour la compilation. + +Cette documentation est composée à l'aide de \simplivre{}. Vous pouvez le considérer comme une courte introduction et une démonstration. + +\bigskip +\begin{tip} + La prise en charge multilingue, les environnements de type théorème, les marques de brouillon et quelques autres fonctionnalités sont fournis par la boîte à outils \ProjLib{}. Ici, nous ne discutons que brièvement de la façon de l'utiliser avec cette classe de document. Pour plus d'informations, veuillez vous référer à la documentation de \ProjLib{}. +\end{tip} + +\tableofcontents + +\mainmatter + +\part{Instruction} +\parttext{Vous pouvez ajouter quelque texte d'introduction ici via \lstinline|\\parttext|\meta{text}.} + +\LevelOneTitle*{Avant de commencer} +\addcontentsline{toc}{chapter}{Avant de commencer} + +Pour utiliser les classes de documents décrites ici, vous devez : +\begin{itemize} + \item installer TeX Live ou MikTeX de la dernière version possible, et vous assurer que \texttt{minimalist} et \texttt{projlib} sont correctement installés dans votre système \TeX{}. + \item être familiarisé avec l'utilisation de base de \LaTeX{}, et savoir comment compiler vos documents avec \hologo{pdfLaTeX}, \hologo{XeLaTeX} ou \hologo{LuaLaTeX}. +\end{itemize} + + +\LevelOneTitle{Utilisation et exemples} + +\LevelTwoTitle{Comment l'ajouter} + +Il suffit simplement de mettre + +\begin{code} + \documentclass{simplivre} +\end{code} + +comme première ligne pour utiliser la classe \simplivre{}. + +\begin{tip}[Attention] + Vous devez utiliser le moteur \hologo{XeLaTeX} ou \hologo{LuaLaTeX} pour compiler. +\end{tip} + +\LevelTwoTitle{Exemple - Un document complet} + +Regardons d'abord un document complet. + + +\begin{code*} +\documentclass{minimbook} +\usepackage{ProjLib} + +\UseLanguage{French} + +\begin{document} + +\frontmatter + +\begin{titlepage} + (*\meta{code for titlepage}*) +\end{titlepage} + +\tableofcontents + +\mainmatter + +\part{(*\meta{part title}*)} +\parttext{(*\meta{text after part title}*)} + +\chapter{(*\meta{chapter title}*)} + +\section{(*\meta{section title}*)} + +\dnf<Plus de contenu est nécessaire.> + +\begin{theorem}\label{thm:abc} + Ceci est un théorème. +\end{theorem} +Référence du théorème: \cref{thm:abc} + +\backmatter + +... + +\end{document} +\end{code*} + +Si vous trouvez cela un peu compliqué, ne vous inquiétez pas. Examinons maintenant cet exemple pièce par pièce. + +\LevelThreeTitle{Initialisation} + +\medskip +\begin{code} +\documentclass{simplivre} +\usepackage{ProjLib} +\end{code} + +L'initialisation est simple. La première ligne ajoute la classe de document \simplivre{}, et la deuxième ligne ajoute la boîte à outils \ProjLib{} pour obtenir des fonctionnalités supplémentaires. + +\LevelThreeTitle{Choisir la langue} + +\medskip +\begin{code} +\UseLanguage{French} +\end{code} + +Cette ligne indique que le français sera utilisé dans le document (d'ailleurs, si seul l'anglais apparaît dans votre article, alors il n'est pas nécessaire de choisir la langue). Vous pouvez également changer de langue de la même manière plus tard au milieu du texte. Les langues prises en charge sont les suivantes : chinois simplifié, chinois traditionnel, japonais, anglais, français, allemand, espagnol, portugais, portugais brésilien et russe. + +Pour une description détaillée de cette commande et d'autres commandes associées, veuillez vous référer à la section sur le support multilingue. + + +\LevelThreeTitle{Marques de brouillon} + +\medskip +\begin{code} +\dnf<(*\meta{some hint}*)> +\end{code} +Lorsque vous avez des endroits qui ne sont pas encore finis, vous pouvez les marquer avec cette commande, ce qui est particulièrement utile lors de la phase de brouillon. + +\LevelThreeTitle{Environnements de type théorème} + +\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} + +Les environnements de type théorème couramment utilisés ont été prédéfinis. De plus, lors du référencement d'un environnement de type théorème, il est recommandé d'utiliser \lstinline|\cref{|\meta{label}\texttt{\}} --- de cette manière, il ne serait pas nécessaire d'écrire explicitement le nom de l'environnement correspondant à chaque fois. + + + + +\LevelOneTitle{À propos des polices par défaut} +Par défaut, cette classe de document utilise Palatino Linotype comme police anglaise, YouSong et YouHei GBK de FounderType comme polices chinoises\footnote{Pour plus de détails, veuillez visiter le site web de FounderType : \url{https://www.foundertype.com}.}, et utilise partiellement Neo Euler comme police mathématique. Parmi eux, Neo Euler peut être téléchargé sur \url{https://github.com/khaledhosny/euler-otf}. Les autres polices ne sont pas gratuites, vous devez les acheter et les installer vous-même. + +\begin{itemize} + \item English main font. \textsf{English sans serif font}. + \item 中文主要字体, \textsf{中文无衬线字体} + \item Démonstration de maths : \( \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} + +Lorsque la police correspondante n'est pas installée, les polices fournies avec TeX Live seront utilisées à la place. Dans ce cas, l'expérience peut être réduite. + + +\LevelOneTitle{Les options} + + +\begin{itemize} + \item Les options de langue \texttt{EN} / \texttt{english} / \texttt{English}, \texttt{FR} / \texttt{french} / \texttt{French}, etc. + \begin{itemize} + \item Pour les noms d'options d'une langue spécifique, veuillez vous référer à \meta{language name} dans la section suivante. La première langue spécifiée sera considérée comme la langue par défaut. + \item Les options de langue ne sont pas nécessaires, elles servent principalement à augmenter la vitesse de compilation. Sans eux, le résultat serait le même, justement plus lent. + \end{itemize} + \item \texttt{draft} ou \texttt{fast} + \begin{itemize} + \item L'option \verb|fast| permet un style plus rapide mais légèrement plus rugueux, les principales différences sont : + \begin{itemize} + \item Utilisez une configuration de police mathématique plus simple ; + \item N'utilisez pas \textsf{hyperref} ; + \item Activez le mode rapide de la boîte à outils \ProjLib{}. + \end{itemize} + \end{itemize} + \begin{tip} + Pendant la phase de brouillon, il est recommandé d'utiliser le \verb|fast| option pour accélérer la compilation. Quand dans \verb|fast| mode, il y aura un filigrane ``DRAFT'' pour indiquer que vous êtes actuellement en mode brouillon. + \end{tip} + \item \texttt{a4paper} ou \texttt{b5paper} + \begin{itemize} + \item Options de format de papier. Le format de papier par défaut est 7 pouces $\times$ 10 pouces. + \end{itemize} + \item \texttt{palatino}, \texttt{times}, \texttt{garamond}, \texttt{biolinum} ~$|$~ \texttt{useosf} + \begin{itemize} + \item Options de police. Comme son nom l'indique, la police avec le nom correspondant sera utilisée. + \item L'option \texttt{useosf} est pour activer les chiffres à l'ancienne. + \end{itemize} + \item \texttt{allowbf} + \begin{itemize} + \item Pour activer les titres en gras. Lorsque cette option est utilisée, le titre principal, les titres de tous les niveaux et les noms des environnements de type théorème seront en gras. + \end{itemize} + \item \texttt{classical} + \begin{itemize} + \item Mode classique. Lorsque cette option est utilisée, le style deviendra plus régulier : les paragraphes sont en retrait, l'utilisation de soulignements est réduite, les styles de titres sont modifiés et les styles de théorème seront beaucoup plus proches des styles par défaut. + \end{itemize} + \begin{tip} + \texttt{allowbf} + \texttt{classical} est probablement un bon choix si vous préférez le style traditionnel. + \end{tip} + \item \texttt{useindent} + \begin{itemize} + \item Utilisez l'indentation des paragraphes au lieu de l'espacement entre les paragraphes. + \end{itemize} + \item \texttt{runin} + \begin{itemize} + \item Utilisez le style « runin » pour \lstinline|\subsubsection| + \end{itemize} + \item \texttt{puretext} ou \texttt{nothms} + \begin{itemize} + \item Mode texte pur. Ne pas définir les environnements de type théorème. + \end{itemize} + \item \texttt{nothmnum} + \begin{itemize} + \item Ne pas numéroter les environnements de type théorème. + \end{itemize} +\end{itemize} +\bigskip +De plus, les options \texttt{oneside} et \texttt{twoside} couramment utilisées lors de la composition de livres sont également disponibles. La disposition recto-verso est utilisée par défaut. + +\LevelOneTitle{Instructions par sujet} + +\LevelTwoTitle{Configurer la langue} + +\simplivre{} prend en charge plusieurs langues, notamment le chinois (simplifié et traditionnel), l'anglais, le français, l'allemand, l'italien, le japonais, le portugais (européen et brésilien), le russe et l'espagnol. La langue peut être sélectionnée par les macros suivantes : + +\begin{itemize} + \item \lstinline|\UseLanguage{|\meta{language name}\lstinline|}| est utilisé pour spécifier la langue. Le réglage correspondant de la langue sera appliqué après celui-ci. Il peut être utilisé soit dans le préambule ou dans le texte. Lorsqu'aucune langue n'est spécifiée, « English » est sélectionné par défaut. + \item \lstinline|\UseOtherLanguage{|\meta{language name}\lstinline|}{|\meta{content}\lstinline|}|, qui utilise les paramètres de langue spécifiés pour composer \meta{content}. Par rapport à \lstinline|\UseLanguage|, il ne modifiera pas l'interligne, donc l'interligne restera stable lorsque le texte CJK et occidental sont mélangés. +\end{itemize} + +\meta{language name} peut être (il n'est pas sensible à la casse, par exemple, \texttt{French} et \texttt{french} ont le même effet) : +\begin{itemize} + \item chinois simplifié : \texttt{CN}, \texttt{Chinese}, \texttt{SChinese} ou \texttt{SimplifiedChinese} + \item chinois traditionnel : \texttt{TC}, \texttt{TChinese} ou \texttt{TraditionalChinese} + \item anglais : \texttt{EN} ou \texttt{English} + \item français : \texttt{FR} ou \texttt{French} + \item allemand : \texttt{DE}, \texttt{German} ou \texttt{ngerman} + \item italien : \texttt{IT} ou \texttt{Italian} + \item portugais : \texttt{PT} ou \texttt{Portuguese} + \item portugais (brésilien) : \texttt{BR} ou \texttt{Brazilian} + \item espagnol : \texttt{ES} ou \texttt{Spanish} + \item japonais : \texttt{JP} ou \texttt{Japanese} + \item russe : \texttt{RU} ou \texttt{Russian} +\end{itemize} + +\medskip +De plus, vous pouvez également ajouter de nouveaux paramètres à la langue sélectionnée : +\begin{itemize} + \item \lstinline|\AddLanguageSetting{|\meta{settings}\lstinline|}| + \begin{itemize} + \item Ajoutez \meta{settings} à toutes les langues prises en charge. + \end{itemize} + \item \lstinline|\AddLanguageSetting(|\meta{language name}\lstinline|){|\meta{settings}\lstinline|}| + \begin{itemize} + \item Ajoutez \meta{settings} à la langue \meta{language name} sélectionnée. + \end{itemize} +\end{itemize} +Par exemple, \lstinline|\AddLanguageSetting(German){\color{orange}}| peut rendre tout le texte allemand affiché en orange (bien sûr, il faut alors ajouter \lstinline|\AddLanguageSetting{\color{black}}| afin de corriger la couleur du texte dans d'autres langues). + +\LevelTwoTitle{Théorèmes et comment les référencer} + +Des environnements tels que \texttt{definition} et \texttt{theorem} ont été prédéfinis et peuvent être utilisés directement. + +Plus précisement, les environnements prédéfinis incluent : \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}, et la version non numérotée correspondante avec un astérisque \lstinline|*| dans le nom. Les titres changeront avec la langue actuelle. Par exemple, \texttt{theorem} sera affiché comme « Theorem » en mode anglais et « Théorème » en mode français. + +Lors du référencement d'un environnement de type théorème, il est recommandé d'utiliser \lstinline|\cref{|\meta{label}\texttt{\}}. De cette façon, il n'est pas nécessaire d'écrire explicitement le nom de l'environnement correspondant à chaque fois. + +\begin{tip}[Exemple] +\begin{code} + \begin{definition}[Des choses étranges] \label{def: strange} ... +\end{code} + +will produce +\begin{definition}[Des choses étranges]\label{def: strange} + C'est la définition de certains objets étranges. Il y a approximativement un espace d'une ligne avant et après l'environnement de type théorème, et il y aura un symbole pour marquer la fin de l'environnement. +\end{definition} + +\lstinline|\cref{def: strange}| s'affichera sous la forme : \cref{def: strange}. + +Après avoir utilisé \lstinline|\UseLanguage{French}|, un théorème s'affichera sous la forme : + +\UseLanguage{English} +\begin{theorem}[Useless]\label{thm} + A theorem in English. +\end{theorem} + +Par défaut, lorsqu'il est référencé, le nom de l'environnement de type théorème correspond toujours à la langue du contexte dans lequel se trouve l'environnement. Par exemple, la définition ci-dessus est toujours affichée en français dans le mode anglais courant : \cref{def: strange} et \cref{thm}. Si vous voulez que le nom du théorème corresponde au contexte actuel lors du référencement, vous pouvez ajouter \texttt{regionalref} aux options globales. +\end{tip} + +\UseLanguage{French} + +\LevelTwoTitle{Définir un nouvel environnement de type théorème} + +Si vous avez besoin de définir un nouvel environnement de type théorème, vous devez d'abord définir le nom de l'environnement dans le langage à utiliser : +\begin{itemize} + \item \lstinline|\NameTheorem[|\meta{language name}\lstinline|]{|\meta{name of environment}\lstinline|}{|\meta{name string}\lstinline|}| +\end{itemize} +Pour \meta{language name}, veuillez vous référer à la section sur la configuration de la langue. Lorsqu'il n'est pas spécifié, le nom sera défini pour toutes les langues prises en charge. De plus, les environnements avec ou sans astérisque partagent le même nom, donc \lstinline|\NameTheorem{envname*}{...}| a le même effet que \lstinline|\NameTheorem{envname}{...}| . + +\medskip +Ensuite, créez cet environnement de l'une des cinq manières suivantes : +\begin{itemize} + \item \lstinline|\CreateTheorem*{|\meta{name of environment}\lstinline|}| + \begin{itemize} + \item Définir un environnement non numéroté \meta{name of environment} + \end{itemize} + \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}| + \begin{itemize} + \item Définir un environnement numéroté \meta{name of environment}, numéroté dans l'ordre 1, 2, 3, \dots + \end{itemize} + \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}[|\meta{numbered like}\lstinline|]| + \begin{itemize} + \item Définir un environnement numéroté \meta{name of environment}, qui partage le compteur \meta{numbered like} + \end{itemize} + \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}<|\meta{numbered within}\lstinline|>| + \begin{itemize} + \item Définir un environnement numéroté \meta{name of environment}, numéroté dans le compteur \meta{numbered within} + \end{itemize} + \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} + \item Identifiez \meta{name of environment} avec \meta{existed environment} ou \meta{existed environment}\lstinline|*|. + \item Cette méthode est généralement utile dans les deux situations suivantes : + \begin{enumerate} + \item Pour utiliser un nom plus concis. Par exemple, avec \lstinline|\CreateTheorem{thm}(theorem)|, on peut alors utiliser le nom \texttt{thm} pour écrire le théorème. + \item Pour supprimer la numérotation de certains environnements. Par exemple, on peut supprimer la numérotation de l'environnement \texttt{remark} avec \lstinline|\CreateTheorem{remark}(remark*)|. + \end{enumerate} + \end{itemize} +\end{itemize} + +\begin{tip} + Cette macro utilise la fonctionnalité de \textsf{amsthm} en interne, donc le traditionnel \texttt{theoremstyle} lui est également applicable. Il suffit de déclarer le style avant les définitions pertinentes. +\end{tip} + +\NameTheorem[FR]{proofidea}{Idée} +\CreateTheorem*{proofidea*} +\CreateTheorem{proofidea}<section> + +\bigskip +Voici un exemple. Le code suivant : + +\begin{code} + \NameTheorem[FR]{proofidea}{Idée} + \CreateTheorem*{proofidea*} + \CreateTheorem{proofidea}<section> +\end{code} + +définit un environnement non numéroté \lstinline|proofidea*| et un environnement numéroté \lstinline|proofidea| (numérotés dans la section) respectivement. Ils peuvent être utilisés dans le contexte français. L'effet est le suivant : + +\vspace{-0.3\baselineskip} +\begin{proofidea*} + La environnement \lstinline|proofidea*| . +\end{proofidea*} + +\vspace{-\baselineskip} +\begin{proofidea} + La environnement \lstinline|proofidea| . +\end{proofidea} + +\LevelTwoTitle{Draft mark} + +Vous pouvez utiliser \lstinline|\dnf| pour marquer la partie inachevée. Par example : +\begin{itemize} + \item \lstinline|\dnf| ou \lstinline|\dnf<...>|. L'effet est : \dnf~ ou \dnf<...>. \\Le texte à l'intérieur changera en fonction de la langue actuelle. Par exemple, il sera affiché sous la forme \UseOtherLanguage{English}{\dnf} en mode anglais. +\end{itemize} + +De même, il y a aussi \lstinline|\needgraph| : +\begin{itemize} + \item \lstinline|\needgraph| ou \lstinline|\needgraph<...>|. L'effet est : \needgraph ou \needgraph<...>Le texte de l'invite change en fonction de la langue actuelle. Par exemple, en mode anglais, il sera affiché sous la forme \UseOtherLanguage{English}{\needgraph} +\end{itemize} + + +\LevelTwoTitle{Divers} + +\LevelThreeTitle{Les numéros de ligne} +Les numéros de ligne peuvent être activés et désactivés n'importe où dans votre texte. \lstinline|\linenumbers| est pour activer les numéros de ligne, et \lstinline|\nolinenumbers| est pour les désactiver. Par souci de beauté, le titre, la table des matières, l'index et certains autres éléments ne sont pas numérotés. + +\LevelThreeTitle{Les notes de bas de page dans le titre} +Dans \lstinline|\section| ou \lstinline|\subsection| , si vous souhaitez ajouter des notes de bas de page, vous n'avez d'autre choix que : +\begin{itemize} + \item écrivez d'abord \lstinline|\mbox{\protect\footnotemark}|, + \item puis ajoutez \lstinline|\footnotetext{...}| après le titre. +\end{itemize} +C'est un inconvénient provoqué par la décoration de soulignement du titre. + +\LevelThreeTitle{Les symboles QED} +Puisque la police dans les environnements de type théorème est la même que celle du texte principal, afin d'indiquer où se terminent les environnements, un symbole QED creux \simpleqedsymbol{} est placé à la fin des environnements de type théorème. Cependant, si votre théorème se termine par une équation ou une liste (itemize, énumérer, description, etc.), ce symbole ne peut pas être automatiquement placé à la bonne position. Dans ce cas, vous devez ajouter manuellement un \lstinline|\qedhere| à la fin de votre équation ou la dernière entrée de votre liste pour faire apparaître le symbole QED en fin de ligne. + +\LevelOneTitle{Problèmes connus} + +\begin{itemize}[itemsep=.6em] + \item Les paramètres de police ne sont pas encore parfaits. + \item Comme de nombreuses fonctionnalités sont basées sur la boîte à outils \ProjLib{}, \minimalist{} (et donc \minimart{}, \einfart{} et \minimbook{}, \simplivre{}) hérite de tous ses problèmes. Pour plus de détails, veuillez vous référer à la section « Problèmes connus » de la documentation de \ProjLib{}. + \item Le mécanisme de gestion des erreurs est incomplet : pas de messages correspondants lorsque certains problèmes surviennent. + \item Il y a encore beaucoup de choses qui peuvent être optimisées dans le code. +\end{itemize} + +\part{Démonstration} +\blinddocument + +\end{document} +\endinput +%% +%% End of file `simplivre/simplivre-doc-fr.tex'. diff --git a/macros/unicodetex/latex/simplivre/simplivre.cls b/macros/unicodetex/latex/simplivre/simplivre.cls index 28b2e7d16c..b234e411a5 100644 --- a/macros/unicodetex/latex/simplivre/simplivre.cls +++ b/macros/unicodetex/latex/simplivre/simplivre.cls @@ -17,7 +17,7 @@ %% \NeedsTeXFormat{LaTeX2e}[2020-10-01] \ProvidesClass{simplivre} - [2021/07/05 A simple and clear book style] + [2021/07/13 A simple and clear book style] \def\minimclass@baseclass{book} \RequirePackage{kvoptions} \RequirePackage{etoolbox} @@ -240,6 +240,7 @@ \renewcommand{\nmid}{\hspace{-.2em}\nmid@original\hspace{-.2em}} } +\RequirePackage{tikz-cd} \newbox\xratbelow \newbox\xratabove \renewcommand{\xrightarrow}[2][]{% |