summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/musixtex/addons/underbracket.sty
blob: 994aee60ba18f646fb1343eda4969044b3bc31d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% LaTeX package underbracket
%
% draws brackets to underline text
% (especially, but not exclusively, syllables of song text)
%
% v1.2 by Bernd Jantzen
% For e-mail contact please use "ctan" before the "@"-sign
% and "bernd-jantzen.de" after it to form my address
% (not given in full clear text here to prevent spam).
% 
% This package draws brackets to underline text (especially,
% but not exclusively, syllables of song text).
% It may be combined with musixtex/musixlyr, within the argument of
% the \setlyrics command or outside the music score.
% It provides several macros to define brackets which may e.g. start
% and end centered below syllables.
% Three length variables are provided to allow a fine adjustment
% of the bracket parameters.
%
% This material is subject to the LaTeX Project Public License.
% See http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html
% for the details of that license.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Commands:
%
% \underbracket{TEXT}
%   draws a bracket underlining TEXT
%   the bracket starts below the left end of TEXT
%   and stops below the right end of TEXT
%
% \Underbracket{TEXT}
%   like \underbracket, but reserves no vertical space below the text
%
% \cunderbracket{LEFT}{TEXT}{RIGHT}
%   draws a bracket underlining LEFTTEXTRIGHT
%   the bracket starts centered below LEFT and stops centered below RIGHT
%
% \cUnderbracket{LEFT}{TEXT}{RIGHT}
%   like cunderbracket, but reserves no vertical space below the text
%
%
% The commands \[c]underbracket do well in normal text which is aligned
% according to the baseline. The vertical space reserved below the text
% guarantees the distance to the next line.
% The commands \[c]Underbracket do well within the \setlyrics command of
% musixlyr where the text is vertically centered between the staves. Vertical
% space reserved below the text would shift the whole text upwards here.
%
%
% Adjustable length parameters:
% (change e.g. with \setlength{\underbracketheight}{4pt})
%
% \underbracketwidth (default 0.3pt):
%   linewidth of the bracket
%
% \underbracketheight (default 3pt):
%   height of the bracket (length of the vertical lines)
%
% \underbracketsep (default 2pt):
%   vertical distance between the lowest part of the text
%   and the upper end of the bracket;
%   also minimal vertical distance below the bracket
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\ProvidesPackage{underbracket}[2004/03/24 v1.2 LaTeX package underbracket]
\NeedsTeXFormat{LaTeX2e}

% declare length variables
\newlength{\underbracketwidth}
\newlength{\underbracketheight}
\newlength{\underbracketsep}
\newlength{\underbracketlength}
\newlength{\underbracketdist}

% need calc pages for adding lengts
\RequirePackage{calc}

% \underbracket{TEXT}
%   draws a bracket underlining TEXT
%   the bracket starts below the left end of TEXT
%   and stops below the right end of TEXT
%
\newcommand{\underbracket}[1]{%
  \settodepth{\underbracketdist}{#1}%
  \addtolength{\underbracketdist}{\underbracketsep+\underbracketheight}%
  \mbox{%
    \rule[-\underbracketdist-\underbracketsep]{0pt}{\underbracketsep}%
    \makebox[0pt][l]{%
      \rule[-\underbracketdist]{\underbracketwidth}{\underbracketheight}}%
    \settowidth{\underbracketlength}{#1}%
    \makebox[0pt][l]{%
      \rule[-\underbracketdist]{\underbracketlength}{\underbracketwidth}}%
    \mbox{#1}%
    \makebox[0pt][r]{%
      \rule[-\underbracketdist]{\underbracketwidth}{\underbracketheight}}%
  }%
}

% \Underbracket{TEXT}
%   like \underbracket, but reserves no vertical space below the text
%
\newcommand{\Underbracket}[1]{%
  \settodepth{\underbracketdist}{#1}%
  \addtolength{\underbracketdist}{\underbracketsep+\underbracketheight}%
  \mbox{%
    \raisebox{0pt}[0pt][0pt]{\makebox[0pt][l]{%
      \rule[-\underbracketdist]{\underbracketwidth}{\underbracketheight}}}%
    \settowidth{\underbracketlength}{#1}%
    \raisebox{0pt}[0pt][0pt]{\makebox[0pt][l]{%
      \rule[-\underbracketdist]{\underbracketlength}{\underbracketwidth}}}%
    \mbox{#1}%
    \raisebox{0pt}[0pt][0pt]{\makebox[0pt][r]{%
      \rule[-\underbracketdist]{\underbracketwidth}{\underbracketheight}}}%
  }%
}

% \cunderbracket{LEFT}{TEXT}{RIGHT}
%   draws a bracket underlining LEFTTEXTRIGHT
%   the bracket starts centered below LEFT and stops centered below RIGHT
%
\newcommand{\cunderbracket}[3]{%
  \settodepth{\underbracketdist}{#1#2#3}%
  \addtolength{\underbracketdist}{\underbracketsep+\underbracketheight}%
  \mbox{%
    \rule[-\underbracketdist-\underbracketsep]{0pt}{\underbracketsep}%
    \settowidth{\underbracketlength}{#1}%
    \makebox[0pt][l]{%
      \hspace*{0.5\underbracketlength}%
      \makebox[0pt]{%
        \rule[-\underbracketdist]{\underbracketwidth}{\underbracketheight}}%
      \rule[-\underbracketdist]{0.5\underbracketlength}{\underbracketwidth}}%
    \mbox{#1}%
    \settowidth{\underbracketlength}{#2}%
    \makebox[0pt][l]{%
      \rule[-\underbracketdist]{\underbracketlength}{\underbracketwidth}}%
    \mbox{#2}%
    \settowidth{\underbracketlength}{#3}%
    \makebox[0pt][l]{%
      \rule[-\underbracketdist]{0.5\underbracketlength}{\underbracketwidth}%
      \makebox[0pt]{%
        \rule[-\underbracketdist]{\underbracketwidth}{\underbracketheight}}}%
    \mbox{#3}%
  }%
}

% \cUnderbracket{LEFT}{TEXT}{RIGHT}
%   like cunderbracket, but reserves no vertical space below the text
%
\newcommand{\cUnderbracket}[3]{%
  \settodepth{\underbracketdist}{#1#2#3}%
  \addtolength{\underbracketdist}{\underbracketsep+\underbracketheight}%
  \mbox{%
    \settowidth{\underbracketlength}{#1}%
    \raisebox{0pt}[0pt][0pt]{\makebox[0pt][l]{%
      \hspace*{0.5\underbracketlength}%
      \makebox[0pt]{%
        \rule[-\underbracketdist]{\underbracketwidth}{\underbracketheight}}%
      \rule[-\underbracketdist]{0.5\underbracketlength}{\underbracketwidth}}}%
    \mbox{#1}%
    \settowidth{\underbracketlength}{#2}%
    \raisebox{0pt}[0pt][0pt]{\makebox[0pt][l]{%
      \rule[-\underbracketdist]{\underbracketlength}{\underbracketwidth}}}%
    \mbox{#2}%
    \settowidth{\underbracketlength}{#3}%
    \raisebox{0pt}[0pt][0pt]{\makebox[0pt][l]{%
      \rule[-\underbracketdist]{0.5\underbracketlength}{\underbracketwidth}%
      \makebox[0pt]{%
        \rule[-\underbracketdist]{\underbracketwidth}{\underbracketheight}}}}%
    \mbox{#3}%
  }%
}

% adjustable length parameters
%
% linewidth of the bracket
\setlength{\underbracketwidth}{0.3pt}
%
% height of the bracket (length of the vertical lines)
\setlength{\underbracketheight}{3pt}
%
% vertical distance between the lowest part of the text
% and the upper end of the bracket;
% also minimal vertical distance below the bracket
\setlength{\underbracketsep}{2pt}