| 1 |
% \iffalse meta-comment |
| 2 |
% |
| 3 |
% Copyright 2010 by Stefan Majewsky <[email protected]> |
| 4 |
% |
| 5 |
% This file may be distributed and/or modified under the |
| 6 |
% conditions of the LaTeX Project Public License, either version 1.2 |
| 7 |
% of this license or (at your option) any later version. |
| 8 |
% The latest version of this license is in: |
| 9 |
% |
| 10 |
% http://www.latex-project.org/lppl.txt |
| 11 |
% |
| 12 |
% and version 1.2 or later is part of all distributions of LaTeX |
| 13 |
% version 1999/12/01 or later. |
| 14 |
% |
| 15 |
% \fi |
| 16 |
% |
| 17 |
% \iffalse |
| 18 |
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01] |
| 19 |
%<package>\ProvidesPackage{delim} |
| 20 |
%<package> [2011/09/13 1.0 Typesetting of mathematical delimiters] |
| 21 |
% |
| 22 |
%<*driver> |
| 23 |
\documentclass{ltxdoc} |
| 24 |
\usepackage[english]{babel} |
| 25 |
\usepackage[utf8]{inputenc} |
| 26 |
\usepackage[T1]{fontenc} |
| 27 |
\usepackage{delim,calc} |
| 28 |
|
| 29 |
\newenvironment{pexample} |
| 30 |
{\vspace{1em}\begin{tabular}{@{\hspace{1em}}l}} |
| 31 |
{\end{tabular}\par} |
| 32 |
\newenvironment{example}[1] |
| 33 |
{\vspace{1em}\begin{tabular}{@{\hspace{1em}}p{#1\linewidth}@{\hspace{3em}}l}} |
| 34 |
{\end{tabular}\vspace{1em}} |
| 35 |
|
| 36 |
\setlength\parindent{0pt} |
| 37 |
\EnableCrossrefs |
| 38 |
\CodelineIndex |
| 39 |
\RecordChanges |
| 40 |
\begin{document} |
| 41 |
\DocInput{delim.dtx} |
| 42 |
\end{document} |
| 43 |
%</driver> |
| 44 |
% |
| 45 |
% \fi |
| 46 |
% |
| 47 |
% \CheckSum{66} |
| 48 |
% |
| 49 |
% \CharacterTable |
| 50 |
% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z |
| 51 |
% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z |
| 52 |
% Digits \0\1\2\3\4\5\6\7\8\9 |
| 53 |
% Exclamation \! Double quote \" Hash (number) \# |
| 54 |
% Dollar \$ Percent \% Ampersand \& |
| 55 |
% Acute accent \' Left paren \( Right paren \) |
| 56 |
% Asterisk \* Plus \+ Comma \, |
| 57 |
% Minus \- Point \. Solidus \/ |
| 58 |
% Colon \: Semicolon \; Less than \< |
| 59 |
% Equals \= Greater than \> Question mark \? |
| 60 |
% Commercial at \@ Left bracket \[ Backslash \\ |
| 61 |
% Right bracket \] Circumflex \^ Underscore \_ |
| 62 |
% Grave accent \` Left brace \{ Vertical bar \| |
| 63 |
% Right brace \} Tilde \~} |
| 64 |
% |
| 65 |
% \changes{v1.0}{2011/09/13}{Simplified user interface} |
| 66 |
% \changes{v0.2}{2010/05/13}{Much simpler implementation without ifthen package} |
| 67 |
% \changes{v0.1}{2010/05/06}{Initial Version} |
| 68 |
% |
| 69 |
% \GetFileInfo{delim.sty} |
| 70 |
% |
| 71 |
% \DoNotIndex{} |
| 72 |
% |
| 73 |
% \title{The \textsf{delim} package\thanks{This document |
| 74 |
% corresponds to \textsf{delim}~\fileversion, |
| 75 |
% dated~\filedate.}} |
| 76 |
% \author{Stefan Majewsky \\ \texttt{[email protected]}} |
| 77 |
% |
| 78 |
% \maketitle |
| 79 |
% \begin{abstract} |
| 80 |
% This package simplifies typesetting of variable-size delimiters (like |
| 81 |
% parentheses) in mathematical expressions. |
| 82 |
% \end{abstract} |
| 83 |
% |
| 84 |
% {\LaTeX} provides some commands for the correct typesetting of delimiters in |
| 85 |
% mathematical expressions. Consider the following equation: |
| 86 |
% |
| 87 |
% \begin{example}{0.15} |
| 88 |
% $\displaystyle(a + \frac bc) \cdot d$ & |
| 89 |
% |(a + \frac bc) \cdot d| |
| 90 |
% \end{example} |
| 91 |
% |
| 92 |
% By default, the parentheses will not scale up correctly. The |\left| and |\right| commands fix this problem: |
| 93 |
% |
| 94 |
% \begin{example}{0.15} |
| 95 |
% $\displaystyle\left(a + \frac bc\right) \cdot d$ & |
| 96 |
% |\left(a + \frac bc\right) \cdot d| |
| 97 |
% \end{example} |
| 98 |
% |
| 99 |
% But because it's cumbersome to write |\left| and |\right| every time, we |
| 100 |
% define and use a macro: |
| 101 |
% |
| 102 |
% \delimdef\p#1{\dleft(#1\dright)} |
| 103 |
% \begin{pexample} |
| 104 |
% |\delimdef\p#1{\dleft(#1\dright)}| |
| 105 |
% \end{pexample} |
| 106 |
% \begin{example}{0.15} |
| 107 |
% $\displaystyle\p{a + \frac bc} \cdot d$ & |
| 108 |
% |\p{a + \frac bc} \cdot d| |
| 109 |
% \end{example} |
| 110 |
% |
| 111 |
% \DescribeMacro{\delimdef} |
| 112 |
% \DescribeMacro{\dleft} \DescribeMacro{\dmiddle} \DescribeMacro{\dright} |
| 113 |
% We did not use |\def|, but |\delimdef| which is defined by this package. |
| 114 |
% Also, we substituted |\dleft| and |\dright| for |\left| and |\right|. There's |
| 115 |
% also |\dmiddle|, as in this example: |
| 116 |
% |
| 117 |
% \delimdef\braket#1#2{\dleft\langle#1\dmiddle\vert#2\dright\rangle} |
| 118 |
% \begin{pexample} |
| 119 |
% |\delimdef\braket#1#2{\dleft\langle#1\dmiddle\vert#2\dright\rangle}| |
| 120 |
% \end{pexample} |
| 121 |
% \begin{example}{0.15} |
| 122 |
% $\displaystyle\braket{\psi_n(t)}\psi$ & |
| 123 |
% |\braket{\psi_n(t)}\psi| |
| 124 |
% \end{example} |
| 125 |
% |
| 126 |
% But why wouldn't we want to use |\def|? Because |\left|, |\middle| and |
| 127 |
% |\right| are not always what you want. For example, if you want the delimiters |
| 128 |
% to be a bit bigger in the last example, you would substitute |\bigl|, |\bigm| |
| 129 |
% and |\bigr| for |\left|, |\middle| and |\right|. This is not possible with |
| 130 |
% a simple |\def| macro. Macros defined by |\delimdef| can substitute |\dleft| |
| 131 |
% etc. for any common set of delimiter commands, by using a \emph{size prefix}: |
| 132 |
% |
| 133 |
% \begin{example}{0.15} |
| 134 |
% $\displaystyle\mbig\braket{\psi_n(t)}\psi$ & |
| 135 |
% |\mbig\braket{\psi_n(t)}\psi| |
| 136 |
% \end{example} |
| 137 |
% |
| 138 |
% Let's look at another example: |
| 139 |
% |
| 140 |
% \begin{example}{0.15} |
| 141 |
% $\displaystyle\p{\underbrace{a_1 + a_2}_{=b}}$ & |
| 142 |
% |\p{\underbrace{a_1 + a_2}_{=b}}| |
| 143 |
% \end{example} |
| 144 |
% |
| 145 |
% We want to use our |\p| macro, but the parentheses should be reset to their |
| 146 |
% normal size. The size prefix |\mnorm| does just that: |
| 147 |
% |
| 148 |
% \begin{example}{0.15} |
| 149 |
% $\displaystyle\mnorm\p{\underbrace{a_1 + a_2}_{=b}}$ & |
| 150 |
% |\mnorm\p{\underbrace{a_1 + a_2}_{=b}}| |
| 151 |
% \end{example} |
| 152 |
% |
| 153 |
% \DescribeMacro{\mnorm} \DescribeMacro{\mbig} \DescribeMacro{\mBig} |
| 154 |
% \DescribeMacro{\mbigg} \DescribeMacro{\mBigg} \DescribeMacro{\mauto} |
| 155 |
% The following size prefixes are defined by this package: |
| 156 |
% |
| 157 |
% \begin{example}{0.15} |
| 158 |
% $\displaystyle\mnorm\p{\frac ab}$ & |\mnorm| (normal character size) \\[1em] |
| 159 |
% $\displaystyle\mbig\p{\frac ab}$ & |\mbig = \bigl| etc. \\[1em] |
| 160 |
% $\displaystyle\mBig\p{\frac ab}$ & |\mBig = \Bigl| etc. \\[1em] |
| 161 |
% $\displaystyle\mbigg\p{\frac ab}$ & |\mbigg = \biggl| etc. \\[1em] |
| 162 |
% $\displaystyle\mBigg\p{\frac ab}$ & |\mBigg = \Biggl| etc. \\[1.5em] |
| 163 |
% $\displaystyle\mauto\p{\frac ab}$ & |\mauto = \left| etc. (default behavior) |
| 164 |
% \end{example} |
| 165 |
% |
| 166 |
% \DescribeMacro{\delim@load} |
| 167 |
% If no prefix is given, |\mauto| is used. New size prefixes can be defined |
| 168 |
% using the |\delim@load| macro; refer to the implementation of the existing |
| 169 |
% prefixes for details. |
| 170 |
% |
| 171 |
% \clearpage\section*{Implementation} |
| 172 |
% |
| 173 |
% \begin{macro}{\delim@load} |
| 174 |
% Size prefixes use this macro to enter a new delimiter level and define the |
| 175 |
% delimiter commands for that level. |\delim@loaded| signals that delimiter |
| 176 |
% commands have been provided for this level. Its exact content is irrelevant, |
| 177 |
% only the fact that it is defined is needed (see below). |
| 178 |
% \begin{macrocode} |
| 179 |
\def\delim@load#1#2#3{% |
| 180 |
\begingroup% |
| 181 |
\def\dleft{#1}% |
| 182 |
\def\dmiddle{#2}% |
| 183 |
\def\dright{#3}% |
| 184 |
\def\delim@loaded{}% |
| 185 |
}% |
| 186 |
% \end{macrocode} |
| 187 |
% \end{macro} |
| 188 |
% \begin{macro}{\mauto}\begin{macro}{\mnorm}\begin{macro}{\mbig}\begin{macro}{\mBig}\begin{macro}{\mbigg}\begin{macro}{\mBigg} |
| 189 |
% The size prefixes are defined using |\delim@load|. |
| 190 |
% \begin{macrocode} |
| 191 |
\newcommand\mauto{\delim@load\left\middle\right}% |
| 192 |
\newcommand\mnorm{\delim@load\relax\relax\relax}% |
| 193 |
\newcommand\mbig{\delim@load\bigl\bigm\bigr}% |
| 194 |
\newcommand\mBig{\delim@load\Bigl\Bigm\Bigr}% |
| 195 |
\newcommand\mbigg{\delim@load\biggl\biggm\biggr}% |
| 196 |
\newcommand\mBigg{\delim@load\Biggl\Biggm\Biggr}% |
| 197 |
% \end{macrocode} |
| 198 |
% \end{macro}\end{macro}\end{macro}\end{macro}\end{macro}\end{macro} |
| 199 |
% \begin{macro}{\delimdef} |
| 200 |
% This defines a new delimiter macro. The macro substitution text is |
| 201 |
% extended by a grouping level, with additional logic being collected in |
| 202 |
% |\delim@begingroup|. |
| 203 |
% \begin{macrocode} |
| 204 |
\def\delimdef#1#{\delim@def{#1}}% |
| 205 |
\def\delim@def#1#2{\def#1{\delim@begingroup#2\endgroup}}% |
| 206 |
% \end{macrocode} |
| 207 |
% Special thanks go to Martin Scharrer for pointing out to me the capabilities |
| 208 |
% of |\def| used in this implementation (see |
| 209 |
% |http://tex.stackexchange.com/questions/28207/|). |
| 210 |
% \end{macro} |
| 211 |
% \begin{macro}{\delim@begingroup} |
| 212 |
% |\delim@begingroup| ensures that delimiters are loaded (default is |\mauto|) |
| 213 |
% and the |\delim@loaded| flag is cleared (for cascaded delimiter macros to work |
| 214 |
% properly). The |\begingroup| is contained in the delimiter macro, see the |
| 215 |
% definition of |\delim@load|. |
| 216 |
% \begin{macrocode} |
| 217 |
\def\delim@begingroup{% |
| 218 |
\ifx\delim@loaded\undefined\mauto\fi% |
| 219 |
\let\delim@loaded\undefined% |
| 220 |
}% |
| 221 |
% \end{macrocode} |
| 222 |
% \end{macro} |
| 223 |
% |
| 224 |
% \Finale |