diff options
author | Karl Berry <karl@freefriends.org> | 2023-01-02 21:23:26 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2023-01-02 21:23:26 +0000 |
commit | a6b52c418b122f8c7f693297f90312835d4b8ce0 (patch) | |
tree | d38b846d4ce9b1bde89c33d79a269be0cd98c25b /Master/texmf-dist/doc/latex/colorist | |
parent | 298587016f189af9336278f57b0f59980cbe234e (diff) |
jxu (2jan23)
git-svn-id: svn://tug.org/texlive/trunk@65436 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/colorist')
-rw-r--r-- | Master/texmf-dist/doc/latex/colorist/README.md | 8 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/colorist/colorist-doc.pdf | bin | 101376 -> 0 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/colorist/colorist-doc.tex | 625 |
3 files changed, 4 insertions, 629 deletions
diff --git a/Master/texmf-dist/doc/latex/colorist/README.md b/Master/texmf-dist/doc/latex/colorist/README.md index b40c6088b28..fbfd1cd0be2 100644 --- a/Master/texmf-dist/doc/latex/colorist/README.md +++ b/Master/texmf-dist/doc/latex/colorist/README.md @@ -1,8 +1,8 @@ -<!-- Copyright (C) 2021-2022 by Jinwen XU --> +<!-- Copyright (C) 2021-2023 by Jinwen XU --> # `colorist` bundle: write you documents in a colorful way -**The whole series have been rewritten with `expl3`. Please note that the documentations are not yet up-to-date. The syntax of some commands have been changed since the last version, especially the declaration of theorem-like environments by `\CreateTheorem`. For the moment, you can refer to the documentation of the package `create-theorem`.** +<!-- **The whole series have been rewritten with `expl3`. Please note that the documentations are not yet up-to-date. The syntax of some commands have been changed since the last version, especially the declaration of theorem-like environments by `\CreateTheorem`. For the moment, you can refer to the documentation of the package `create-theorem`.** --> ## Introduction @@ -30,7 +30,7 @@ with a colorful design. It mainly consists of two parts. Italian, Japanese, Portuguese (European and Brazilian), Russian and Spanish typesetting, and also use more beautiful fonts. -### How to get these files +<!-- ### How to get these files You can get the `.sty` and `.cls` files mentioned above simply by compiling `colorist.ins`: ``` @@ -39,7 +39,7 @@ latex colorist.ins To get the `.tex` source files of the documentation, compile `colorist-doc.ins`: ``` latex colorist-doc.ins -``` +``` --> ## Features diff --git a/Master/texmf-dist/doc/latex/colorist/colorist-doc.pdf b/Master/texmf-dist/doc/latex/colorist/colorist-doc.pdf Binary files differdeleted file mode 100644 index e1239399aa5..00000000000 --- a/Master/texmf-dist/doc/latex/colorist/colorist-doc.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex b/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex deleted file mode 100644 index a6b2ab97880..00000000000 --- a/Master/texmf-dist/doc/latex/colorist/colorist-doc.tex +++ /dev/null @@ -1,625 +0,0 @@ -\documentclass[title in boldface, title in scshape, simple name]{colorart} - -%%================================ -%% Import toolkit -%%================================ -\usepackage{ProjLib} -\usepackage{longtable} % breakable tables -\usepackage{hologo} % more TeX logo -\usetikzlibrary{calc} - -\usepackage{blindtext} - -\UseLanguage{English} - -%%================================ -%% For typesetting code -%%================================ -\usepackage{listings} -\usepackage{xcolor} -\usepackage{setspace} -\definecolor{code-main}{RGB}{70,130,180} -\definecolor{code-expl3}{RGB}{240,50,60} -\definecolor{code-option}{RGB}{40,110,20} -\definecolor{code-keys}{RGB}{100,130,150} -\definecolor{code-comment}{RGB}{20,120,80} -\definecolor{code-background}{gray}{0.99} -\lstset{ - language = [LaTeX]TeX, - basicstyle = \ttfamily, - keywordstyle = \color{code-main}, - commentstyle = \color{code-comment}, - showstringspaces = false, - breaklines = true, - frame = lines, - backgroundcolor = \color{code-background}, - flexiblecolumns = true, - escapeinside = {(*}{*)}, - alsoletter = {_,:}, - % numbers = left, - % firstnumber = last, - numberstyle = \scriptsize\ttfamily, - stepnumber = 1, - numbersep = 5pt, -} -\newcommand{\meta}[1]{$\langle${\normalfont\itshape#1}$\rangle$} -\lstset{% LaTeX2 commands - classoffset = 0, - texcsstyle =* \color{code-main}, - moretexcs = - { - linenumbers,nolinenumbers, - part,parttext,chapter,section,subsection,subsubsection, - frontmatter,mainmatter,backmatter, - tableofcontents, - href, - color, - NameTheorem,CreateTheorem, - cref, - ProjLib, - DNF, - UseLanguage,UseOtherLanguage,AddLanguageSetting, - maketitle,address,curraddr,email,keywords,subjclass,thanks,dedicatory,TheDate, - qedhere, - } -} -\lstset{% LaTeX3 commands - classoffset = 1, - texcsstyle =* \color{code-expl3}, - moretexcs = - { - } -} -\lstnewenvironment{code}{\setstretch{1.05}}{\vspace{-.3\baselineskip}\vspace{-.5\parskip}} -\lstnewenvironment{code*}{\setstretch{1.05}\lstset{numbers=left}}{\vspace{-.3\baselineskip}\vspace{-.5\parskip}} - -\newcommand{\classoption}[1]{\texttt{\textcolor{code-option}{#1}}} -\newcommand{\packageoption}[1]{\texttt{\textcolor{code-option}{#1}}} -\newcommand{\commandoption}[1]{\texttt{\textcolor{code-keys}{#1}}} - -%%================================ -%% tip -%%================================ -\usepackage[many]{tcolorbox} -\newenvironment{tip}[1][Tip]{% - \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}} - -%%================================ -%% Names -%%================================ -\providecommand{\colorist}{\textsf{colorist}} -\providecommand{\colorart}{\textsf{colorart}} -\providecommand{\colorbook}{\textsf{colorbook}} -\providecommand{\lebhart}{\textsf{lebhart}} -\providecommand{\beaulivre}{\textsf{beaulivre}} - -%%================================ -%% Titles -%%================================ -\let\LevelOneTitle\section -\let\LevelTwoTitle\subsection -\let\LevelThreeTitle\subsubsection - -%%================================ -%% Main text -%%================================ -\begin{document} - -\def\PackageVersion{2022/09/03} - -\title{{\normalfont\bfseries\color{main-text}\colorist{}}\\write your articles or books in a colorful way} -\author{Jinwen XU} -\thanks{Corresponding to: \texttt{\colorist{} \PackageVersion}} -\email{\href{mailto:ProjLib@outlook.com}{ProjLib@outlook.com}} -\date{\TheDate{\PackageVersion}[only-year-month], in Paris} - -\maketitle - -\begin{abstract} - \colorist{} is a series of styles and classes for you to typeset your articles or books in a colorful manner. The original intention in designing this series was to write drafts and notes that look colorful yet not dazzling. With the help of the \ProjLib{} toolkit, also developed by the author, the classes provided here have multi-language support, preset theorem-like environments with clever reference support, and many other functionalities. Notably, using these classes, one can organize the author information in the \AmS{} fashion, makes it easy to switch to journal classes later for publication. - - Finally, this documentation is typeset using the \colorart{} class (with the option \classoption{use boldface}). You can think of it as a short introduction and demonstration. -\end{abstract} - - -\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} - -\setcounter{tocdepth}{2} -\tableofcontents - - -\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{colorist} and \texttt{projlib} are correctly installed in your \TeX{} system. - \item download and install the required fonts if needed. - \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} - -\LevelOneTitle{Introduction} - -\colorist{} is a series of styles and classes for you to typeset your articles or books in a colorful manner. The original intention in designing this series was to write drafts and notes that look colorful yet not dazzling. - -The entire collection includes \verb|colorist.sty|, which is the main style shared by all of the following classes; \verb|colorart.cls| for typesetting articles and \verb|colorbook.cls| for typesetting books. They compile with any major \TeX{} engine, with native support to English, French, German, Italian, Portuguese (European and Brazilian) and Spanish typesetting via \lstinline|\UseLanguage| (see the instruction below for detail). - -You can also found \lebhart{} and \beaulivre{} on CTAN. They are the enhanced version of \colorart{} and \colorbook{} with unicode support. With this, they can access to more beautiful fonts, and additionally have native support for Chinese, Japanese and Russian typesetting. On the other hand, they need to be compiled with \hologo{XeLaTeX} or \hologo{LuaLaTeX} (not \hologo{pdfLaTeX}). - -With the help of the \ProjLib{} toolkit, also developed by the author, the classes provided here have multi-language support, preset theorem-like environments with clever reference support, and many other functionalities such as draft marks, enhanced author information block, mathematical symbols and shortcuts, etc. Notably, using these classes, one can organize the author information in the \AmS{} fashion, makes it easy to switch to journal classes later for publication. For more detailed information, you can refer to the documentation of \ProjLib{} by running \lstinline|texdoc projlib| in the command line. - -\LevelOneTitle{Usage and examples} - -\LevelTwoTitle{How to load it} -You can directly use \colorart{} or \colorbook{} as your document class. In this way, you can directly begin writing your document, without having to worry about the configurations. - -\begin{code} -\documentclass{colorart} (*{\normalfont or}*) \documentclass{colorbook} -\end{code} - -\begin{tip} - You may wish to use \lebhart{} or \beaulivre{} instead, which should produce better result. All the examples later using \colorart{} or \colorbook{} can be adopted to \lebhart{} and \beaulivre{} respectively, without further modification. -\end{tip} - -You can also use the default classes \textsf{article} or \textsf{book}, and load the \colorist{} package. This way, only the basic styles are set, and you can thus use your preferred fonts and page layout. All the features mentioned in this article are provided. - -\begin{code} -\documentclass{article} (*{\normalfont or}*) \documentclass{book} -\usepackage{colorist} -\end{code} - -\LevelTwoTitle{Example - \colorart} - -Let's first look at a complete example of \colorart{} (the same works for \lebhart{}). - -\begin{code*} -\documentclass{colorart} -\usepackage{ProjLib} - -\UseLanguage{French} - -\begin{document} - -\title{(*\meta{title}*)} -\author{(*\meta{author}*)} -\date{\TheDate{2022-04-01}} - -\maketitle - -\begin{abstract} - Ceci est un résumé. \DNF<(*\meta{some hint}*)> -\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. - -\LevelThreeTitle{Initialization} - -\begin{code} -\documentclass{colorart} -\usepackage{ProjLib} -\end{code} - -Initialization is straightforward. The first line loads the document class \colorart{}, and the second line loads the \ProjLib{} toolkit to obtain some additional functionalities. - -\LevelThreeTitle{Set the language} - -\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% -\footnote{The language Simplified Chinese, Traditional Chinese, Japanese and Russian requires Unicode support, thus the classes \lebhart{} or \beaulivre{}.}% -.% - -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} - -\begin{code} -\title{(*\meta{title}*)} -\author{(*\meta{author}*)} -\date{\TheDate{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{\TheDate{2022-04-01}} -\subjclass{*****} -\keywords{(*\meta{keywords}*)} - -\begin{abstract} - (*\meta{abstract}*) -\end{abstract} - -\maketitle -\end{code} - -\LevelThreeTitle{Draft marks} - -\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} - -\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: - -\begin{code} -\documentclass{amsart} -\usepackage[a4paper,margin=1in]{geometry} -\usepackage[hidelinks]{hyperref} -\usepackage[palatino]{ProjLib} -\end{code} - -\end{tip} - - -\vspace{1.5\baselineskip} -\LevelTwoTitle{Example - \colorbook} - -Now let's look at an example of \colorbook{} (the same works for \beaulivre{}). - -\begin{code*} -\documentclass{colorbook} -\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}*)} - -... - -\backmatter - -... - -\end{document} -\end{code*} - -There is no much differences with \colorart{}, only that the title and author information should be typeset within the \texttt{titlepage} environment. Currently no default titlepage style is given, since the design of the title page is a highly personalized thing, and it is difficult to achieve a result that satisfies everyone. - -\bigskip -In the next section, we will go through the options available. - - -% \clearpage -\LevelOneTitle{The options} - -\colorist{} offers the following options: - -\begin{itemize}[label=,leftmargin=1.25em,itemindent=-1.25em] - \item The language options \classoption{EN} / \classoption{english} / \classoption{English}, \classoption{FR} / \classoption{french} / \classoption{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 \classoption{draft} or \classoption{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 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} - \item \classoption{use boldface} - \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. - \end{itemize} - \item \classoption{runin} - \begin{itemize} - \item Use the ``runin'' style for \lstinline|\subsubsection| - \end{itemize} - \item \classoption{nothms} - \begin{itemize} - \item Pure text mode. Do not load theorem-like environments. - \end{itemize} - \item \classoption{nothmnum}, \classoption{thmnum} or \classoption{thmnum=}\meta{counter} - \begin{itemize} - \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 \classoption{regionalref}, \classoption{originalref} - \begin{itemize} - \item When referencing, whether the name of the theorem-like environment changes with the current language. The default is \classoption{regionalref}, \emph{i.e.}, the name corresponding to the current language is used; for example, when referencing a theorem-like environment in English context, the names "Theorem, Definition..." will be used no matter which language context the original environment is in. If \classoption{originalref} is enabled, then the name will always remain the same as the original place; for example, when referencing a theorem written in the French context, even if one is currently in the English context, it will still be displayed as ``Théorème''. - \item In \classoption{fast} mode, the option \classoption{originalref} will have no effect. - \end{itemize} -\end{itemize} - -Additionally, \colorart{} and \colorbook{} offers the following options: -\begin{itemize}[label=,leftmargin=1.25em,itemindent=-1.25em] - \item \classoption{a4paper} or \classoption{b5paper} - \begin{itemize} - \item Optional paper size. The default paper size is 8.5in $\times$ 11in. - \end{itemize} - \item \classoption{palatino}, \classoption{times}, \classoption{garamond}, \classoption{noto}, \classoption{biolinum} ~$|$~ \classoption{useosf} - \begin{itemize} - \item Font options. As the name suggest, font with corresponding name will be loaded. - \item The \classoption{useosf} option is used to enable the old-style figures. - \end{itemize} -\end{itemize} - -\LevelOneTitle{Instructions by topic} - -\LevelTwoTitle{Language configuration} - -\colorart{} has multi-language support, including English, French, German, Italian, Portuguese (European and Brazilian) and Spanish. The language can be selected by the following macros: - -\begin{itemize} - \item \lstinline|\UseLanguage{|\meta{language name}\lstinline|}| is used to specify the language. The corresponding setting of the language will be applied after it. It can be used either in the preamble or in the main body. When no language is specified, ``English'' is selected by default. - \item \lstinline|\UseOtherLanguage{|\meta{language name}\lstinline|}{|\meta{content}\lstinline|}|, which uses the specified language settings to typeset \meta{content}. Compared with \lstinline|\UseLanguage|, it will not modify the line spacing, so line spacing would remain stable when CJK and Western texts are mixed. -\end{itemize} - -\meta{language name} can be (it is not case sensitive, for example, \texttt{French} and \texttt{french} have the same effect): -\begin{itemize} - \item Simplified Chinese: \texttt{CN}, \texttt{Chinese}, \texttt{SChinese} or \texttt{SimplifiedChinese} - \item Traditional Chinese: \texttt{TC}, \texttt{TChinese} or \texttt{TraditionalChinese} - \item English: \texttt{EN} or \texttt{English} - \item French: \texttt{FR} or \texttt{French} - \item German: \texttt{DE}, \texttt{German} or \texttt{ngerman} - \item Italian: \texttt{IT} or \texttt{Italian} - \item Portuguese: \texttt{PT} or \texttt{Portuguese} - \item Portuguese (Brazilian): \texttt{BR} or \texttt{Brazilian} - \item Spanish: \texttt{ES} or \texttt{Spanish} - \item Japanese: \texttt{JP} or \texttt{Japanese} - \item Russian: \texttt{RU} or \texttt{Russian} -\end{itemize} - -\medskip -In addition, you can also add new settings to selected language: -\begin{itemize} - \item \lstinline|\AddLanguageSetting{|\meta{settings}\lstinline|}| - \begin{itemize} - \item Add \meta{settings} to all supported languages. - \end{itemize} - \item \lstinline|\AddLanguageSetting(|\meta{language name}\lstinline|){|\meta{settings}\lstinline|}| - \begin{itemize} - \item Add \meta{settings} to the selected language \meta{language name}. - \end{itemize} -\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} - -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{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. - -\begin{tip}[Example] -\begin{code} -\begin{definition}[Strange things] \label{def: strange} ... -\end{code} - -will produce -\begin{definition}[Strange things]\label{def: strange} - This is the definition of some strange objects. There is approximately a one-line spacing before and after the theorem environment, and there will be a symbol to mark the end of the environment. -\end{definition} - -\lstinline|\cref{def: strange}| will be displayed as: \cref{def: strange}. - -After using \lstinline|\UseLanguage{French}|, a theorem will be displayed as: - -\UseLanguage{French} -\begin{theorem}[Inutile]\label{thm} - Un théorème en français. -\end{theorem} - -By default, when referenced, the name of the theorem matches the current context. For example, the definition above will be displayed in French in the current French context: \cref{def: strange,thm}. If you want the name of the theorem to always match the language of the context in which the theorem is located, you can add \texttt{originalref} to the global options. -\end{tip} - -\UseLanguage{English} - -The following are the main styles of theorem-like environments: -\begin{theorem} - Theorem style: theorem, proposition, lemma, corollary, ... -\end{theorem} - -\begin{proof} - Proof style -\end{proof} - -\begin{remark} - Remark style -\end{remark} - -\begin{conjecture} - Conjecture style -\end{conjecture} - -\begin{example*} - Example style: example, fact, ... -\end{example*} - -\begin{problem} - Problem style: problem, question, ... -\end{problem} - -\medskip -For aesthetics, adjacent definitions will be connected together automatically: -\begin{definition} - First definition. -\end{definition} - -\begin{definition} - Second definition. -\end{definition} - -\begin{tip} - Please refer to the documentation of the package \textsf{create-theorem} to see how to declare new theorem-like environments. -\end{tip} - -\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} - -\LevelTwoTitle{Title, abstract and keywords} - -\colorart{} 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}*)\thanks{(*\meta{text}*)}} -\date{(*\meta{date}*)} -\maketitle -\begin{abstract} - (*\meta{abstract}*) -\end{abstract} -\begin{keyword} - (*\meta{keywords}*) -\end{keyword} -\end{code} - -or written in the way of \AmS{} classes: - -\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} - -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. - -\bigskip -% \clearpage -\LevelOneTitle{Known issues} - -\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. - \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} - - -\end{document} -\endinput -%% -%% End of file `colorist/colorist-doc.tex'. |