diff options
Diffstat (limited to 'macros/unicodetex/latex/beaulivre/beaulivre-doc-en.tex')
-rw-r--r-- | macros/unicodetex/latex/beaulivre/beaulivre-doc-en.tex | 113 |
1 files changed, 23 insertions, 90 deletions
diff --git a/macros/unicodetex/latex/beaulivre/beaulivre-doc-en.tex b/macros/unicodetex/latex/beaulivre/beaulivre-doc-en.tex index fa55565a37..32892aba4a 100644 --- a/macros/unicodetex/latex/beaulivre/beaulivre-doc-en.tex +++ b/macros/unicodetex/latex/beaulivre/beaulivre-doc-en.tex @@ -1,4 +1,5 @@ -\documentclass[English,Chinese,French,JP,TC,allowbf]{beaulivre} +\documentclass[English,Chinese,French,JP,TC,use boldface,simple name]{beaulivre} + %%================================ %% Import toolkit @@ -37,7 +38,7 @@ \providecommand{\meta}[1]{$\langle${\normalfont\itshape#1}$\rangle$} \lstset{moretexcs=% {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 + color,NameTheorem,CreateTheorem,cref,dnf,needgraph,UseLanguage,UseOtherLanguage,AddLanguageSetting,maketitle,address,curraddr,email,keywords,subjclass,thanks,dedicatory,TheDate,ProjLib,qedhere } } \lstnewenvironment{code}% @@ -91,20 +92,23 @@ %%================================ \begin{document} +\def\PackageVersion{2022/03/19} \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)+(25,-7)$); - \fill [yellow] (current page.south west) rectangle ($(current page.north west)+(3,0)$); + \fill [forestgreen!75!black] ($(current page.south west)$) rectangle ($(current page.north east)+(0,-7)$); + \fill [forestgreen!10!yellow!30] ($(current page.south west)$) rectangle ($(current page.north west)+(2.5,-7)$); + \fill [forestgreen!75!black] ($(current page.north west)$) rectangle ($(current page.north west)+(2.5,-7)$); + \fill [forestgreen!10!yellow!30] ($(current page.north east)$) rectangle ($(current page.north west)+(2.5,-7)$); \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,-10)$) {\textcolor{white}{\sffamily\beaulivre{}\\[5pt]\footnotesize\textsc{Write your books in \\a colorful way}\\[10pt]\tiny Corresponding to: \texttt{\beaulivre{} 2021/12/16}}}; - \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}{December 2021, in Paris}}; + \node[text width=6cm,text height=3.5cm,scale=2.5] at ($(current page.north west)+(11,-9)$) {\textcolor{forestgreen!10!yellow!30}{\sffamily\beaulivre{}\\[5pt]\footnotesize\textsc{Write your books in \\a colorful way}\\[10pt]\tiny Corresponding to: \texttt{\beaulivre{} \PackageVersion}}}; + \node[text width=15em] at ($(current page.south)+(5,4)$) {\color{forestgreen!10!yellow!30}\hfill\fontsize{16pt}{0pt}\selectfont{\scshape Jinwen XU}\\[1em]\hfill\fontsize{12pt}{0pt}\selectfont\TheDate{\PackageVersion}[only-year-month], in Paris}; \end{tikzpicture}% \end{titlepage}% -\cleardoublepage% + +\setcounter{page}{0} \chapter{Preface} @@ -120,6 +124,10 @@ This documentation is typeset using \beaulivre{} (with the option \texttt{allowb 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} +\begin{tip} + This documentation has not been fully up-to-date with the new \texttt{expl3} version of this class series. Some options or commands introduced here might be obsolete. +\end{tip} + \tableofcontents \mainmatter @@ -134,7 +142,7 @@ 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{colorist} and \texttt{projlib} are correctly installed in your \TeX{} system. \item download and install the required fonts, see the section "On the default fonts". - \item be familiar with the basic usage of \LaTeX{}, and knows how to compile your document with \hologo{pdfLaTeX}, \hologo{XeLaTeX} or \hologo{LuaLaTeX}. + \item be familiar with the basic usage of \LaTeX{}, and know how to compile your document with \hologo{pdfLaTeX}, \hologo{XeLaTeX} or \hologo{LuaLaTeX}. \end{itemize} @@ -294,17 +302,13 @@ In addition, Source Code Pro is used as the English sans serif font, New Compute \begin{itemize} \item Use the ``runin'' style for \lstinline|\subsubsection| \end{itemize} - \item \texttt{puretext} or \texttt{nothms} + \item \texttt{nothms} \begin{itemize} \item Pure text mode. Do not load theorem-like environments. \end{itemize} - \item \texttt{delaythms} - \begin{itemize} - \item Defer the definition of theorem-like environments to the end of the preamble. Use this option if you want the theorem-like environments to be numbered within a custom counter. - \end{itemize} \item \texttt{nothmnum}, \texttt{thmnum} or \texttt{thmnum=}\meta{counter} \begin{itemize} - \item Theorem-like environments will not be numbered / numbered in order 1, 2, 3... / numbered within \meta{counter}. Here, \meta{counter} should be a built-in counter (such as \texttt{subsection}) or a custom counter defined in the preamble (with the option \texttt{delaythms} enabled). If no option is used, they will be numbered within \texttt{chapter} (book) or \texttt{section} (article). + \item Theorem-like environments will not be numbered / numbered in order 1, 2, 3... / numbered within \meta{counter}. If no option is used, they will be numbered within \texttt{chapter} (book) or \texttt{section} (article). \end{itemize} \item \texttt{regionalref}, \texttt{originalref} \begin{itemize} @@ -415,7 +419,7 @@ The following are the main styles of theorem-like environments: \end{problem} \medskip -\clearpage +% \clearpage For aesthetics, adjacent definitions will be connected together automatically: \begin{definition} First definition. @@ -425,76 +429,11 @@ For aesthetics, adjacent definitions will be connected together automatically: Second definition. \end{definition} -\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} - \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|}| - \begin{itemize} - \item Define an unnumbered environment \meta{name of environment} - \end{itemize} - \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}| - \begin{itemize} - \item Define a numbered environment \meta{name of environment}, numbered in order 1,2,3,\dots - \end{itemize} - \item \lstinline|\CreateTheorem{|\meta{name of environment}\lstinline|}[|\meta{numbered like}\lstinline|]| - \begin{itemize} - \item Define a numbered environment \meta{name of environment}, which shares the counter \meta{numbered like} - \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} - \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 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}(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} - \begin{tip} - This macro utilizes the feature of \textsf{amsthm} internally, so the traditional \texttt{theoremstyle} is also applicable to it. One only needs declare the style before the relevant definitions. + Please refer to the documentation of the package \textsf{create-theorem} to see how to declare new theorem-like environments. \end{tip} -\NameTheorem[EN]{proofidea}{Idea} -\CreateTheorem*{proofidea*} -\CreateTheorem{proofidea}<section> - -\bigskip -Here is an example. The following code: - -\begin{code} -\NameTheorem[EN]{proofidea}{Idea} -\CreateTheorem*{proofidea*} -\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: - -\vspace{-0.3\baselineskip} -\begin{proofidea*} - The \lstinline|proofidea*| environment. -\end{proofidea*} - -\vspace{-\baselineskip} -\begin{proofidea} - The \lstinline|proofidea| environment. -\end{proofidea} - -\clearpage +% \clearpage \LevelTwoTitle{Draft mark} You can use \lstinline|\dnf| to mark the unfinished part. For example: @@ -502,17 +441,11 @@ You can use \lstinline|\dnf| to mark the unfinished part. For example: \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| : -\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} - \bigskip \LevelOneTitle{Known issues} -\begin{itemize}[itemsep=.6em] +\begin{itemize} \item The font settings are still not perfect. \item The TOC design does not look very nice. \item Since many features are based on the \ProjLib{} toolkit, \colorist{} (and hence \colorart{}, \lebhart{} and \colorbook{}, \beaulivre{}) inherits all its problems. For details, please refer to the ``Known Issues'' section of the \ProjLib{} documentation. |