Debian Codegraph @

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

raw
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 all general mathematics macros .
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 % chairxmathGeneral.dtx
26 %\fi
27 %
28 %
29 % We use the |tensor| package and modify things slightly to fit our
30 % needs: we provide a decoration command that allows to decorate
31 % arbitrary math symbols from left and right, top and bottom with
32 % other math symbols. This can be used to produce tensors with many
33 % indices. However, this is far too useful to be restricted to tensors
34 % only. The original |\tensor| macro from the |tensor package| is
35 % still available under the name |\originaltensor|. Note, that the
36 % |\tensor| command in |nchairx| is intended for the symbol of tensor
37 % product, and not for decorating a symbol with indices.
38 %
39 % \DescribeMacro{\decorate}
40 % Decorate a symbol from all sides. The option argument gives the
41 % decoration in front of the symbol, the first argument the symbol,
42 % the second (mandatory) argument the decoration after the symbol. For
43 % each decoration several superscripts and subscripts can be used like
44 % |\decorate[^a_b^c]{S}{_d^{rt}_e}|:
45 % $\decorate[^a_b^c]{S}{_d^{rt}_e}$.
46 %
47 % \DescribeMacro{\deco}
48 % We also provide a simpler version of |\decorate| called |\deco|
49 % which takes five usual arguments and sets them as sub- and
50 % superscripts before and after the middle symbol
51 % |\deco{a}{b}{c}{d}{e}|:$\deco{a}{b}{c}{d}{e}$ This can be used to
52 % define your own macros with decoration. E.g. for bimodules over
53 % rings one could define
54 % |\newcommand{\bimodule}[3]{\deco{}{\ring{#1}{\module{#2}}{}{\ring{#3}}}}|
55 % which can then be used as |\bimodule{R}{E}{S}|:
56 % $\deco{}{\ring{R}}{\module{E}}{}{\ring{S}}$.
57 %
58 % \DescribeMacro{\script}
59 % Sets the argument in the |scriptfont| and hence allows to create macros
60 % with fonts consistent with the other |nchairx| macros.