Debian Codegraph @

texmf-dist/source/latex/nchairx/nchairx.dtx

raw
1 % \iffalse meta-comment
2 %
3 % Copyright (C) 2018 - 2021 by ChairX
4 %
5 % This work may be distributed and/or modified under the
6 % conditions of the LaTeX Project Public License, either version 1.3
7 % of this license or (at your option) any later version.
8 % The latest version of this license is in
9 % http://www.latex-project.org/lppl.txt
10 % and version 1.3 or later is part of all distributions of LaTeX
11 % version 2005/12/01 or later.
12 %
13 % \fi
14 %
15 %\iffalse
16 %<*nchairx>
17 \NeedsTeXFormat{LaTeX2e}
18 \ProvidesPackage{nchairx}
19 [2021/07/29 v1.0.0 First major release]
20 %</nchairx>
21 %
22 %<*driver>
23 \documentclass{ltxdoc}
24
25 \usepackage[english,german,strings]{babel}
26 \usepackage[utf8]{inputenc}
27 \usepackage[T1]{fontenc}
28 \usepackage{nchairx}
29 \usepackage{ifdraft}
30 \usepackage{gitinfo2}
31 \usepackage[linktoc=all]{hyperref}
32
33 \EnableCrossrefs
34
35 \CodelineIndex
36
37 \RecordChanges
38
39 \begin{document}
40 \DocInput{nchairx.dtx}
41 \end{document}
42 %</driver>
43 %\fi
44 %
45 % \CheckSum{2012}
46 %
47 % \changes{v0.1}{2018/02/27}{Initial test}
48 % \changes{v0.9}{2019/02/21}{First official release}
49 % \changes{v1.0.0}{2021/07/29}{First major release}
50 %
51 % \GetFileInfo{nchairx.sty}
52 %
53 % \title{The \textsf{nChairX} package}
54 % \author{ChairX \\
55 % \ifdraft{Last changes by \gitAuthorName{} on \gitAuthorDate \\ }
56 % \ifdraft{Git revision of nchairx:}
57 % \ifdraft{\texttt{\gitAbbrevHash{}} {\gitReferences{}} \\ }
58 % \ifdraft{}
59 % Version \fileversion{} (\filedate) \\
60 % \texttt{[email protected]}}
61 %
62 % \maketitle
63 %
64 % \selectlanguage{english}
65 %
66 % \begin{abstract}
67 % This is a part of the new nChairX package providing the famous
68 % ChairX style.
69 % \end{abstract}
70 %
71 % \setcounter{tocdepth}{2}
72 % \tableofcontents
73 %
74 % \section{Introduction}
75 % This package defines the New ChairX style. Based on previous
76 % versions we provide a major clean-up with many additional features
77 % and easier handling. The style file is a rather high-level style
78 % file providing many standard environments needed in math, many
79 % macros needed in differential geometry, algebra, and analysis and
80 % some other useful tools. The style file includes several other
81 % packages and sets various defaults. There is a companion package
82 % called |chairxmath| which only defines the math-related macros but
83 % avoids setting environments etc.
84 %
85 %
86 % \section{Usage}
87 % \label{sec:Usage}
88 %
89 % To use the package you have to include it as usual by
90 % \begin{center}
91 % \begin{tabular}[l]{p{0.8\textwidth}}
92 % \verb|\usepackage{nchairx}|
93 % \end{tabular}
94 % \end{center}
95 % and specify some options if needed.
96 %
97 %
98 % \subsection{Package Options}
99 %
100 % \DescribeMacro{noMath} The math
101 % macros of the |nchairx| package can be excluded with the option |noMath|.
102 % This can be used if one does not need the math macros of |nchairx| and there occur
103 % clashes with other packages or macros, but the environments and other settings of
104 % |nchairx| are still desired.
105 %
106 % \subsection{Setting the Defaults}
107 % \label{sec:SettingDefaults}
108 %
109 % \input{chairxDefaultsDoc.dtx}
110 %
111 %
112 % \subsection{Supporting many Languages}
113 % \label{sec:LanguageSupport}
114 %
115 % For the use of other languages than English (our default) the
116 % options of the |babel| package are respected. The important keywords
117 % of \textsf{nChairX} (essentially the names of the environments) will
118 % then be translated accordingly. In order to enable this you have to
119 % load |babel| with the additional language you intend to use, e.g.
120 % \begin{center}
121 % \begin{tabular}[l]{p{0.8\textwidth}}
122 % \verb|\usepackage[german,strings]{babel}|
123 % \end{tabular}
124 % \end{center}
125 % \emph{before} you load |nchairx|.
126 % Currently, only German is supported beside English. Then you can
127 % switch between the languages inside one document with
128 % |\selectlanguage{language}| to get the correct names of the
129 % keywords. When loading several languages it is always a good idea
130 % to place an explicit |\selectlanguage{language}| at the beginning of
131 % the document to set the stage correctly. Note that you have to use
132 % the |strings| option for babel as well.
133 %
134 %
135 % \subsection{Environments}
136 % \label{sec:Environments}
137 %
138 % The \textsf{nChairX} package provides many predefined mathematical
139 % environments like definitions, theorems etc. The styling is fairly
140 % standard. The names of the environments are language sensitive based
141 % on the |babel| package.
142 %
143 % \input{chairxEnvDoc.dtx}
144 %
145 %
146 % \subsection{Logo Support}
147 % \label{sec:LogoSupport}
148 %
149 % \input{chairxLogoDoc.dtx}
150 %
151 %
152 % \section{The Math Macros}
153 %
154 % One of the main purposes of |nchairx| is to provide several (in
155 % fact, many) new math macros needed in various situations: we have
156 % support for many things in differential geometry, algebra, and
157 % functional analysis. The math macros can be used independently of
158 % the full |nchairx| package under the name |chairxmath|. However,
159 % |nchairx| always includes the math macros.
160 %
161 % \subsection{The Handling of the Fonts}
162 % \input{chairxmathFontsDoc.dtx}
163 %
164 % \subsection{New Delimiter Sizes}
165 % \input{chairxmathDelimitersDoc.dtx}
166 %
167 % \subsection{Decoration}
168 % \input{chairxmathDecorationDoc.dtx}
169 %
170 % \setlength{\parindent}{0pt}
171 %
172 % \subsection{General Mathematics Macros}
173 % \input{chairxmathGeneralDoc.dtx}
174 %
175 % \subsection{Algebra}
176 % \input{chairxmathAlgebraDoc.dtx}
177 %
178 % \subsection{Analysis}
179 % \input{chairxmathAnalysisDoc.dtx}
180 %
181 % \subsection{Category Theory}
182 % \input{chairxmathCategoryDoc.dtx}
183 %
184 % \subsection{Differential Geometry}
185 % \input{chairxmathDiffgeoDoc.dtx}
186 %
187 % \subsection{Linear Algebra}
188 % \input{chairxmathLinalgDoc.dtx}
189 %
190 % \subsection{Statistics}
191 % \input{chairxmathStatisticsDoc.dtx}
192 %
193 % \subsection{Topology}
194 % \input{chairxmathTopologyDoc.dtx}
195 %
196 % \section{Known Bugs and Conflicts}
197 %
198 % There are several conflicts possible since |nchairx| loads a number
199 % of other packages, some with explicit options needed to obtain the
200 % aspired functionality. In this case, it can not be avoided that the
201 % packages is loaded via |nchairx|.
202 % \begin{itemize}
203 % \item The package |xkeyval| is loaded without options. This is
204 % necessary for many reasons like internal processing of ifs etc.
205 % \item The package |amsmath| and |amssymb| are loaded. This can
206 % sometimes yield unexpected conflicts with packages overwriting
207 % commands from these two packages.
208 % \item We define a smiley symbol from the |wasysym| font. This gives
209 % a conflict with the |wasysym| package.
210 % \item We load the |tensor| package and overwrite the |\tensor|
211 % command of that package. The original macro is available under
212 % |\originaltensor| and as identical macro |\decorate|.
213 % \item We load |ntheorem| with specified options. This is unavoidable
214 % to have the correct behaviour of our environments.
215 % \item The theorem lists from the |ntheorem| package seem to crash
216 % with the |babel| names we use for the actual environments. A
217 % workaround for this is e.g.
218 % \begin{quote}
219 % |\makeatletter \listtheorems{definitions} \makeatother|
220 % \end{quote}
221 % to get the list of definitions.
222 % \end{itemize}
223 %
224 % \StopEventually{\PrintIndex \PrintChanges}
225 %
226 %
227 % \section{Implementation}
228 % \label{sec:Implementation}
229 %
230 %
231 % \subsection{Processing the Options}
232 %
233 % Before including other packages we make sure that we can use
234 % key-value pairs as options using |xkeyval|
235 %
236 % \begin{macrocode}
237 \RequirePackage{xkeyval}
238 % \end{macrocode}
239 %
240 % Before including other required packages we have to process the
241 % options that might alter the options given to these packages.
242 %
243 % First we create ifs for later use.
244 %
245 % \begin{macrocode}
246 \newif\if@loadmath \@loadmathtrue
247 % \end{macrocode}
248 %
249 % Define option for excluding math macros
250 %
251 % \begin{macrocode}
252 \DeclareOptionX[chairx]<math>{noMath}{
253 \@loadmathfalse
254 }
255 % \end{macrocode}
256 %
257 % Process options for the style file
258 %
259 % \begin{macrocode}
260 \ProcessOptionsX[chairx]<math>
261 % \end{macrocode}
262 %
263 % \subsection{Required Packages}
264 %
265 % After processing the options we can now load the other required
266 % packages. The following packages are required for the correct usage
267 % of |nchairx|. We include them with some mandatory options.
268 %
269 % We will need several things from |amsmath| and |amssymb|.
270 %
271 % \begin{macrocode}
272 \RequirePackage{amsmath}
273 \RequirePackage{amssymb}
274 % \end{macrocode}
275 %
276 % The |suffix| package allows to define $*$-versions of macros.
277 %
278 % \begin{macrocode}
279 \RequirePackage{suffix}
280 % \end{macrocode}
281 %
282 % The |mathtools| package provides so many nice things to type-set
283 % math. Always a good idea to include this. In particular, we will
284 % need the |\DeclarePairedDelimiter| command a lot.
285 %
286 % \begin{macrocode}
287 \RequirePackage{mathtools}
288 % \end{macrocode}
289 %
290 % The |ntheorem| package is used to define math environments of
291 % various type. We need this package with particular options to make
292 % the proof environment work correctly. Note that the proof
293 % environment of |ntheorem| places the end-of-proof in a much better
294 % way than every other available option.
295 %
296 % \begin{macrocode}
297 \RequirePackage[amsmath,thmmarks,hyperref]{ntheorem}
298 % \end{macrocode}
299 %
300 % The |graphicx| package is useful for many things. We need it for our
301 % logo support to include pdf-files
302 % \begin{macrocode}
303 \RequirePackage{graphicx}
304 % \end{macrocode}
305 %
306 % The |enumitem| package is now used to generate the enumerated lists
307 % of items for the math environments. This allows various fine-tuning
308 % and additional functionality for referring to items in lists.
309 %
310 % \begin{macrocode}
311 \RequirePackage{enumitem}
312 % \end{macrocode}
313 %
314 % The |tensor| package is used to place symbols at all possible
315 % positions around one central symbol
316 % \begin{macrocode}
317 \RequirePackage{tensor}
318 % \end{macrocode}
319 %
320 % Some additional fonts and symbols from |stmaryrd|: we only load the
321 % font and grab those symbols we actually need to keep things easy.
322 %
323 % \begin{macrocode}
324 \DeclareSymbolFont{stmry}{U}{stmry}{m}{n}
325 \SetSymbolFont{stmry}{bold}{U}{stmry}{b}{n}
326 % \end{macrocode}
327 %
328 % Last we need |aliascnt| to allow the usage of |\autoref|.
329 %
330 % \begin{macrocode}
331 \RequirePackage{aliascnt}
332 % \end{macrocode}
333 %
334 % \subsection{The Handling of the Fonts}
335 % \input{chairxmathFonts.dtx}
336 %
337 %
338 % \subsection{Setting some Defaults}
339 % \input{chairxDefaults.dtx}
340 %
341 %
342 % \subsection{Environments}
343 % \input{chairxEnv.dtx}
344 %
345 %
346 % \subsection{Logo Support}
347 % \input{chairxLogo.dtx}
348 %
349 %
350 % \subsection{The Math Macros}
351 %
352 % Include the math macros in alphabetical order of the file names.
353 %
354 % \input{chairxmathDelimiters.dtx}
355 % \input{chairxmathDecoration.dtx}
356 % \input{chairxmathGeneral.dtx}
357 % \input{chairxmathAlgebra.dtx}
358 % \input{chairxmathAnalysis.dtx}
359 % \input{chairxmathCategory.dtx}
360 % \input{chairxmathDiffgeo.dtx}
361 % \input{chairxmathLinalg.dtx}
362 % \input{chairxmathStatistics.dtx}
363 % \input{chairxmathTopology.dtx}
364 %
365 % \begin{macrocode}
366 % \end{macrocode}
367 %
368 % \Finale
369 \endinput