Debian Codegraph @

texmf-dist/source/latex/dotarrow/DotArrow.dtx

raw
1 %% DotArrow.dtx
2 %% Copyright 2008 Sven Schneider
3 %
4 % This work may be distributed and/or modified under the
5 % conditions of the LaTeX Project Public License, either version 1.3
6 % of this license or (at your option) any later version.
7 % The latest version of this license is in
8 % http://www.latex-project.org/lppl.txt
9 % and version 1.3 or later is part of all distributions of LaTeX
10 % version 2005/12/01 or later.
11 %
12 % This work has the LPPL maintenance status `maintained'.
13 %
14 % The Current Maintainer of this work is Sven Schneider.
15 %
16 % This work consists of the files DotArrow.dtx, README, DotArrow.pdf and DotArrow.ins
17 % and the derived file DotArrow.sty, DotArrow.tex.
18
19 % Version 0.02a
20
21 %<*driver>
22 \documentclass{ltxdoc}
23
24
25 \usepackage[utf8]{inputenc}
26 \usepackage{epsfig,ifthen,amsmath,url,hyperref}
27
28 \usepackage{DotArrow}
29
30 \title{The DotArrow-Package\\ -- Dotted Extendable Arrows --}
31 \author{Sven Schneider}
32
33 \setlength{\parindent}{0pt}
34 \begin{document}
35 \maketitle
36
37 \begin{abstract}
38 This package defines a new extendable arrow. This time its a dotted one. Other interesting packages are \verb+extPfeil+\footnote{\url{http://tug.ctan.org/tex-archive/macros/latex/contrib/extpfeil/}} \verb+symbols+\footnote{\url{http://www.ctan.org/tex-archive/info/symbols/comprehensive/}} \verb+extarrows+\footnote{\url{http://tug.ctan.org/tex-archive/macros/latex/contrib/extarrows/}}
39 \verb+chemarrow+\footnote{\url{http://tug.ctan.org/tex-archive/macros/latex/contrib/chemarrow/}}.
40 \end{abstract}
41 \tableofcontents
42 \section{Simple Usage}
43 \DescribeMacro{\dotarrow}
44 $S\dotarrow{\kappa}S^\prime$\\
45 \verb+$S\dotarrow{\kappa}S^\prime$+
46 \section{Package - Options}
47 \DescribeMacro{Option:autosep**}
48 These Package-Options can be used to adjust the space on left and right to the label. The default is \verb+autosep03+.
49
50 \begin{center}
51 \begin{tabular}{ll}
52 autosep00 & \DotArrowSetSep{0.0em}$S\dotarrow{\kappa}S^\prime$\\
53 autosep01 & \DotArrowSetSep{0.1em}$S\dotarrow{\kappa}S^\prime$\\
54 autosep02 & \DotArrowSetSep{0.2em}$S\dotarrow{\kappa}S^\prime$\\
55 autosep03 & \DotArrowSetSep{0.3em}$S\dotarrow{\kappa}S^\prime$\\
56 autosep04 & \DotArrowSetSep{0.4em}$S\dotarrow{\kappa}S^\prime$\\
57 autosep05 & \DotArrowSetSep{0.5em}$S\dotarrow{\kappa}S^\prime$\\
58 autosep06 & \DotArrowSetSep{0.6em}$S\dotarrow{\kappa}S^\prime$\\
59 autosep07 & \DotArrowSetSep{0.7em}$S\dotarrow{\kappa}S^\prime$\\
60 autosep08 & \DotArrowSetSep{0.8em}$S\dotarrow{\kappa}S^\prime$\\
61 autosep09 & \DotArrowSetSep{0.9em}$S\dotarrow{\kappa}S^\prime$\\
62 autosep10 & \DotArrowSetSep{1.0em}$S\dotarrow{\kappa}S^\prime$
63 \end{tabular}
64 \end{center}
65
66 \DescribeMacro{Option:autoraise**}
67 These Package-Options can be used to adjust the space between label and arrow. The default is \verb+autosep06+.
68
69 \begin{center}
70 \begin{tabular}{ll}
71 autoraise00 & \DotArrowSetRaise{0.0ex}$S\dotarrow{\kappa}S^\prime$\\
72 autoraise01 & \DotArrowSetRaise{0.1ex}$S\dotarrow{\kappa}S^\prime$\\
73 autoraise02 & \DotArrowSetRaise{0.2ex}$S\dotarrow{\kappa}S^\prime$\\
74 autoraise03 & \DotArrowSetRaise{0.3ex}$S\dotarrow{\kappa}S^\prime$\\
75 autoraise04 & \DotArrowSetRaise{0.4ex}$S\dotarrow{\kappa}S^\prime$\\
76 autoraise05 & \DotArrowSetRaise{0.5ex}$S\dotarrow{\kappa}S^\prime$\\
77 autoraise06 & \DotArrowSetRaise{0.6ex}$S\dotarrow{\kappa}S^\prime$\\
78 autoraise07 & \DotArrowSetRaise{0.7ex}$S\dotarrow{\kappa}S^\prime$\\
79 autoraise08 & \DotArrowSetRaise{0.8ex}$S\dotarrow{\kappa}S^\prime$\\
80 autoraise09 & \DotArrowSetRaise{0.9ex}$S\dotarrow{\kappa}S^\prime$\\
81 autoraise10 & \DotArrowSetRaise{1.0ex}$S\dotarrow{\kappa}S^\prime$
82 \end{tabular}
83 \end{center}
84
85 \DescribeMacro{Option:head*}
86 These Package-Options can be used to choose a different head. The default is \verb+head1+.
87
88 \begin{center}
89 \begin{tabular}{ll}
90 head1 & \DotArrowSetHead{\ensuremath{\succ}}$S\dotarrow{\kappa}S^\prime$\\
91 head2 & \DotArrowSetHead{\ensuremath{>}}$S\dotarrow{\kappa}S^\prime$\\
92 head3 & \DotArrowSetHead{\ensuremath{\gg}}$S\dotarrow{\kappa}S^\prime$
93 \end{tabular}
94 \end{center}
95
96 \section{Commands}
97 \DescribeMacro{\DotArrowSetSep}
98 Select a new separation-value. \verb+\DotArrowSetSep{0.3em}+
99
100 \DescribeMacro{\DotArrowSetRaise}
101 Select a new raisevalue. \verb+\DotArrowSetRaise{0.6ex}+
102
103 \DescribeMacro{\DotArrowSetHead}
104 Select a new arrowhead. \verb+\DotArrowSetHead{\ensuremath{\succ}}+
105
106 \end{document}
107 %</driver>
108
109 %<*package>
110 \NeedsTeXFormat{LaTeX2e}
111 \ProvidesPackage{DotArrow}[2007/02/12 draw dotted arrows]
112
113 \RequirePackage{ifthen}
114
115 \PackageInfo{DotArrow}{This is the DotArrow-Package-0.02a}
116
117 % ####################################################
118 % Define Setters
119 % ####################################################
120 \newcommand{\DotArrowSetRaise}[1]{\setlength{\AUTORAISE}{#1}}
121 \newcommand{\DotArrowSetSep}[1]{\setlength{\AUTOSEP}{#1}}
122 \newcommand{\DotArrowSetHead}[1]{\renewcommand*{\ARROWHEAD}{\scalebox{.5}[.5]{#1}}}
123
124
125 \newlength{\AUTOSEP}
126 \setlength{\AUTOSEP}{0.3em}
127 \DeclareOption{autosep00}{\DotArrowSetSep{0.0em}}
128 \DeclareOption{autosep01}{\DotArrowSetSep{0.1em}}
129 \DeclareOption{autosep02}{\DotArrowSetSep{0.2em}}
130 \DeclareOption{autosep03}{\DotArrowSetSep{0.3em}}
131 \DeclareOption{autosep04}{\DotArrowSetSep{0.4em}}
132 \DeclareOption{autosep05}{\DotArrowSetSep{0.5em}}
133 \DeclareOption{autosep06}{\DotArrowSetSep{0.6em}}
134 \DeclareOption{autosep07}{\DotArrowSetSep{0.7em}}
135 \DeclareOption{autosep08}{\DotArrowSetSep{0.8em}}
136 \DeclareOption{autosep09}{\DotArrowSetSep{0.9em}}
137 \DeclareOption{autosep10}{\DotArrowSetSep{1.0em}}
138
139
140 \newlength{\AUTORAISE}
141 \setlength{\AUTORAISE}{0.6ex}
142 \DeclareOption{autoraise00}{\DotArrowSetRaise{0.0ex}}
143 \DeclareOption{autoraise02}{\DotArrowSetRaise{0.2ex}}
144 \DeclareOption{autoraise04}{\DotArrowSetRaise{0.4ex}}
145 \DeclareOption{autoraise06}{\DotArrowSetRaise{0.6ex}}
146 \DeclareOption{autoraise08}{\DotArrowSetRaise{0.8ex}}
147 \DeclareOption{autoraise10}{\DotArrowSetRaise{1.0ex}}
148 \DeclareOption{autoraise12}{\DotArrowSetRaise{1.2ex}}
149 \DeclareOption{autoraise14}{\DotArrowSetRaise{1.4ex}}
150 \DeclareOption{autoraise16}{\DotArrowSetRaise{1.6ex}}
151
152 \newcommand*{\ARROWHEAD}{\scalebox{.5}[.5]{$\succ$}}
153 \DeclareOption{head1}{\DotArrowSetHead{\ensuremath{\succ}}}
154 \DeclareOption{head2}{\DotArrowSetHead{\ensuremath{>}}}
155 \DeclareOption{head3}{\DotArrowSetHead{\ensuremath{\gg}}}
156
157 \ProcessOptions\relax
158
159 % ##################################################
160 % \newlength - commands
161 % ##################################################
162 % width of the printed horizontal bars
163 \newlength{\actualWidth}
164 % the width of one horizontal bar
165 \newlength{\oneWidth}
166 % the width of the text on top of the arrow
167 \newlength{\labelWidth}
168
169 % second store for the \labelWidth (the \labelWidth is used for calculation)
170 \newlength{\labelWidthBack}
171 % the distance to go backwards/forwards to print the
172 % label/to print the arrowhead
173 \newlength{\captionStart}
174
175 % the distance of the bars from the baseline
176 \newlength{\moveUpBars}
177 % the distance of the label from the baseline
178 \newlength{\moveUpLabel}
179
180 % the distance the arrowhead is moved up
181 \newlength{\moveSuccHeight}
182 \newlength{\succHeight}
183 % \newcommand*{\ARROWHEAD}{\scalebox{.5}[.5]{$\succ$}}
184
185 % ##################################################
186 % \onePartX : prints one horizontal bar
187 % ##################################################
188 \newlength{\WIDTH}
189 \setlength{\WIDTH}{.4pt}
190
191 % this is one single horizontal bar
192 % \newcommand{\onePartX}{\raisebox{\moveUpBars}{\rule{2pt}{\WIDTH}}}
193 \newcommand*{\onePartX}{\raisebox{\moveUpBars}{\rule{2pt}{\WIDTH}}}
194 % oneWidth is the width of one such bar
195 \settowidth{\oneWidth}{\onePartX}
196
197 % ##################################################
198 % \allPartFront : print the first bar without any space around it
199 % ##################################################
200 \newcommand{\allPartFront}{
201 % determine the actual width of the horizontal bars:
202 \setlength{\actualWidth}{0pt}
203 \onePartX%
204 \addtolength{\labelWidth}{-\oneWidth}
205 \addtolength{\actualWidth}{\oneWidth}
206 }
207
208 % ##################################################
209 % \allPartFront : prints all further bars with space on the left side
210 % ##################################################
211 \newcommand{\allPart}{%
212 \ifthenelse{\labelWidth > 0}{%
213 \hspace*{1.5pt}%
214 \addtolength{\labelWidth}{-1.5pt}%
215 \onePartX%
216 \addtolength{\labelWidth}{-\oneWidth}%
217 \addtolength{\actualWidth}{\oneWidth}%
218 \addtolength{\actualWidth}{1.5pt}%
219 \allPart%
220 }{%
221 }%
222 }%
223
224 % ##################################################
225 % \dotarrow : draws the whole arrow
226 % ##################################################
227 \newcommand{\dotarrow}[1]{%
228 \setlength{\moveUpBars}{.8ex}%
229 \addtolength{\moveUpBars}{-.5\WIDTH}%
230 \setlength{\moveUpLabel}{\AUTORAISE}%
231 \addtolength{\moveUpLabel}{\moveUpBars}%
232 \addtolength{\moveUpLabel}{\WIDTH}%
233 % print a little space at the left side
234 \;%
235 % get the width of the label
236 \settowidth{\labelWidthBack}{\hspace*{\AUTOSEP}\scriptsize\ensuremath{#1}\hspace*{\AUTOSEP}}%
237 \setlength{\labelWidth}{\labelWidthBack}%
238 \setlength{\captionStart}{\labelWidth}%
239 % and print the horizontal bars
240 \allPartFront{}\allPart%
241 % determine the space to go back to print the label
242 \addtolength{\captionStart}{\actualWidth}%
243 \setlength{\captionStart}{.5\captionStart}%
244 % now go back
245 \hspace*{-\captionStart}%
246 % print the label
247 \raisebox{\moveUpLabel}{\hspace*{\AUTOSEP}\scriptsize\ensuremath{#1}\hspace*{\AUTOSEP}}%
248 % determine the space to go forward
249 \setlength{\captionStart}{\actualWidth}%
250 \addtolength{\captionStart}{-\labelWidthBack}%
251 \setlength{\captionStart}{.5\captionStart}%
252 % and go forward
253 \hspace*{\captionStart}%
254 % print the top of the arrow
255 % arrowhead distance-calculation:
256 \settoheight{\succHeight}{\ARROWHEAD}%
257 \setlength{\succHeight}{.5\succHeight}%
258 \setlength{\moveSuccHeight}{\moveUpBars}%
259 \addtolength{\moveSuccHeight}{.5\WIDTH}%
260 \addtolength{\moveSuccHeight}{-\succHeight}%
261 \raisebox{\moveSuccHeight}{\ARROWHEAD}%
262 % print a little space at the right side
263 \;%
264 }%
265 %</package>