| 1 |
% \iffalse meta-comment |
| 2 |
% |
| 3 |
% Copyright (C) 2018 - 2021 by ChairX |
| 4 |
% |
| 5 |
% This file may be distributed and/or modified under the |
| 6 |
% conditions of the LaTeX Project Public License, either |
| 7 |
% version 1.3 of this license or (at your option) any later |
| 8 |
% version. The latest version of this license is in: |
| 9 |
% |
| 10 |
% http://www.latex-project.org/lppl.txt |
| 11 |
% |
| 12 |
% and version 1.3 or later is part of all distributions of |
| 13 |
% LaTeX version 2005/12/01 or later. |
| 14 |
% |
| 15 |
% This file contains the documentation of the environment handling. |
| 16 |
% |
| 17 |
% Macros have to be described by (delete the first %) |
| 18 |
% \DescribeMacro{\macro} |
| 19 |
% Description and usage of the macro. |
| 20 |
% |
| 21 |
% The description will appear in the usage |
| 22 |
% part of the documentation. Use \subsubsection{} etc. for structuring. |
| 23 |
% |
| 24 |
% The implementation of the macros defined here has to be written in |
| 25 |
% chairxEnv.dtx |
| 26 |
%\fi |
| 27 |
% |
| 28 |
% \subsubsection{The Predefined Environments} |
| 29 |
%\label{sec:doc_PredefinedEnvironments} |
| 30 |
% |
| 31 |
% The following theorem-like environments will be defined as standards |
| 32 |
% as they will be needed anyway. We use the |ntheorem| package |
| 33 |
% to do this and load it automatically with several options. Hence you |
| 34 |
% should not load it by hand with other options. |
| 35 |
% |
| 36 |
% |
| 37 |
\DescribeEnv{claim} |
| 38 |
\DescribeEnv{corollary} |
| 39 |
\DescribeEnv{definition} |
| 40 |
\DescribeEnv{lemma} |
| 41 |
\DescribeEnv{proposition} |
| 42 |
\DescribeEnv{theorem} |
| 43 |
% As usually needed we define the standard mathematical environments |
| 44 |
% |claim|, |corollary|, |definition|, |lemma|, |proposition|, and |
| 45 |
% |theorem| with a common appearance: titles in bold, body in |
| 46 |
% italic. The numbering will use a common counter including the |
| 47 |
% section counter. |
| 48 |
% |
| 49 |
% |
| 50 |
\DescribeEnv{conjecture} |
| 51 |
\DescribeEnv{convention} |
| 52 |
\DescribeEnv{example} |
| 53 |
\DescribeEnv{notation} |
| 54 |
\DescribeEnv{question} |
| 55 |
\DescribeEnv{remark} |
| 56 |
% The environments |conjecture|, |example|, |notation|, |question|, |
| 57 |
% and |remark| use the same counter as the above ones but have a body |
| 58 |
% in roman. |
| 59 |
% |
| 60 |
% |
| 61 |
\DescribeEnv{exercise} |
| 62 |
% The environment |exercise| has its own counter including the section |
| 63 |
% and is set in roman. |
| 64 |
% |
| 65 |
% |
| 66 |
\DescribeEnv{maintheorem} |
| 67 |
% We have a |maintheorem| environment which has no numbering at all: |
| 68 |
% this is useful for papers where there is one and only one main |
| 69 |
% theorem you want to place at a particular place, say in the |
| 70 |
% introduction. |
| 71 |
% |
| 72 |
% |
| 73 |
\DescribeEnv{nn<environment>} |
| 74 |
% For all these environments there is a non-numbered version |nn<environment>|. |
| 75 |
% So one can use e.g. |\begin{nntheorem} ... \end{nntheorem}| to get the theorem |
| 76 |
% environment as above, but without numbering. |
| 77 |
% |
| 78 |
% These environments are compatible with |autoref|. Hence using |
| 79 |
% \begin{quote} |
| 80 |
% |\autoref{label_to_<env-name>}| |
| 81 |
% \end{quote} |
| 82 |
% will give a linked reference to the |
| 83 |
% environment labelled with |
| 84 |
% \begin{quote} |
| 85 |
% |\label{label_to_<env-name>}| |
| 86 |
% \end{quote} |
| 87 |
% with a prefix depending on the type of environment. This also works |
| 88 |
% for chapters, sections, etc. |
| 89 |
% For non-numbered environments one should still use |\ref|. |
| 90 |
% |
| 91 |
% |
| 92 |
\DescribeEnv{proof} |
| 93 |
\DescribeEnv{subproof} |
| 94 |
% We have a |proof| and a |subproof| environment with an automatic |
| 95 |
% tombstone sign at their ends. The location of the tombstone signs is |
| 96 |
% maintained by the |ntheorem| package in a really good way. The |
| 97 |
% |proof| environment finishes with a box sign, the subproof with |
| 98 |
% $\triangledown$. The only catch is that one should not use the |
| 99 |
% commands |\[| and |\]| for equations without numbers in the proof |
| 100 |
% environment anymore: this causes errors as soon as one wants to |
| 101 |
% place a |\tag{$*$}| for these equations. Instead, one can achieve |
| 102 |
% this as follows: |
| 103 |
% \begin{center} |
| 104 |
% \begin{tabular}[l]{p{0.8\textwidth}} |
| 105 |
% |\begin{equation*}| \\ |
| 106 |
% | E = mc^2|\\ |
| 107 |
% | \tag{$*$}|\\ |
| 108 |
% |\end{equation*}| |
| 109 |
% \end{tabular} |
| 110 |
% \end{center} |
| 111 |
% It seems that also some float environments (like |figure| or |
| 112 |
% |table|) at the end of the proof confuse the |ntheorem| package: you |
| 113 |
% should avoid this by placing the float outside of the |proof| |
| 114 |
% environment. |
| 115 |
% |
| 116 |
% |
| 117 |
\DescribeEnv{hint} |
| 118 |
% We have a |hint| environment to be used inside exercises: set in a |
| 119 |
% very small font and without numbering. |
| 120 |
% |
| 121 |
% |
| 122 |
\DescribeEnv{<environment>list} |
| 123 |
% We have special list environments |claimlist|, |conjecturelist|, |conventionlist|, |
| 124 |
% |corollarylist|, |definitionlist|, |examplelist|, |exerciselist|, |
| 125 |
% |lemmalist|, |maintheoremlist|, |notationlist|, |propositionlist|, |
| 126 |
% |questionlist|, |remarklist|, |theoremlist| and |prooflist| corresponding to the |
| 127 |
% above mathematical environments. They allow to control the |
| 128 |
% appearance of the item lists individually. The items will be |
| 129 |
% numbered in italic and can be referred to using the command |
| 130 |
% |\ref{item:MyLabel}|. Currently, all the lists are styled the same |
| 131 |
% way, but this can individually be changed easily. The lists are |
| 132 |
% build using the |enumitem| package. |
| 133 |
% You can use all options that are available by the |enumitem| package |
| 134 |
% also for these lists. |
| 135 |
% |
| 136 |
% |
| 137 |
% \DescribeEnv{cptenum} |
| 138 |
% \DescribeEnv{cptitem} |
| 139 |
% \DescribeEnv{cptdesc} |
| 140 |
% Beside these mathematical environments we also provide generic |
| 141 |
% compact lists: |cptenum|, |cptitem|, and |cptdesc| similar to the |
| 142 |
% lists from the |paralist| package. |
| 143 |
% |