Debian Codegraph @

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

raw
1 % \iffalse meta-comment
2 %
3 % (c) 2009-2010 George R. Louthan IV <[email protected]>
4 % http://georgerloutha.nthefourth.com
5 % (c) 2007 Todd C. Miller <[email protected]>
6 % http://www.gratisoft.us/todd/
7 % (c) 2003-2007 David J. Grant <davidgrant-at-gmail.com>
8 % http://www.davidgrant.ca
9 % (c) 2002 Matthew Boedicker <[email protected]>
10 % http://matthewm.boedicker.org/
11 %
12 % This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
13 % Unported License. To view a copy of this license, visit
14 % http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to
15 % Creative Commons
16 % 171 Second Street, Suite 300
17 % San Francisco, California, 94105, USA.
18 %
19 % \fi
20 %
21 %\iffalse
22 %<*driver>
23 \ProvidesFile{tucv.dtx}
24 %</driver>
25 %<package>\NeedsTeXFormat{LaTeX2e}
26 %<package>\ProvidesPackage{tucv}
27 %<*package>
28 [2010/11/11 v1.0 Univ. of Tulsa iSec CV Style]
29 %</package>
30 %
31 %<*driver>
32 \documentclass{ltxdoc}
33 \usepackage{tucv}
34 \usepackage[american]{babel}
35 \EnableCrossrefs
36 \CodelineIndex
37 \RecordChanges
38 \begin{document}
39 \DocInput{tucv.dtx}
40 \PrintChanges
41 \PrintIndex
42 \end{document}
43 %</driver>
44 %\fi
45 %
46 % \CheckSum{0}
47 %
48 % \CharacterTable
49 % {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
50 % 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
51 % Digits \0\1\2\3\4\5\6\7\8\9
52 % Exclamation \! Double quote \" Hash (number) \#
53 % Dollar \$ Percent \% Ampersand \&
54 % Acute accent \' Left paren \( Right paren \)
55 % Asterisk \* Plus \+ Comma \,
56 % Minus \- Point \. Solidus \/
57 % Colon \: Semicolon \; Less than \<
58 % Equals \= Greater than \> Question mark \?
59 % Commercial at \@ Left bracket \[ Backslash \\
60 % Right bracket \] Circumflex \^ Underscore \_
61 % Grave accent \` Left brace \{ Vertical bar \|
62 % Right brace \} Tilde \~}
63 %
64 % \changes{v1.0}{2010/11/13}{Initial version}
65 %
66 % \GetFileInfo{tucv.dtx}
67 %
68 % \DoNotIndex{\^, \begin, \colorbox, \DeclareOption, \definecolor, \end}
69 % \DoNotIndex{\evensidemargin, \extracolsep, \fancyfoot, \fancyhead, \fill}
70 % \DoNotIndex{\headheight, \headrulewidth, \headsep, \hspace, \IfNoValueTF}
71 % \DoNotIndex{\large, \NewDocumentCommand, \newline, \oddsidemargin}
72 % \DoNotIndex{\pagestyle, \parskip, \ProcessOptions, \raggedbottom}
73 % \DoNotIndex{\raggedright, \renewcommand, \RequirePackage, \setlength}
74 % \DoNotIndex{\tabcolsep, \tabularnewline, \textbf, \textheight, \textit}
75 % \DoNotIndex{\textwidth, \topmargin, \voffset, \vphantom}
76 % \DoNotIndex{\^{E}}
77 % \title{The \textsf{tucv} package\thanks{This document
78 % corresponds to \textsf{tucv}~\fileversion, dated \filedate.}}
79 % \author{George Louthan \\ \texttt{[email protected]}}
80 %
81 % \maketitle
82 %
83 % \section{Introduction}
84 %
85 % This style provides commands for typesetting a CV or resume. Its current form
86 % is based upon the shaded resume style originally by Matthew Boedicker and
87 % updated by David Grant, Todd Miller, and George Louthan. It has been modified
88 % to provide the tools to produce the style of resume used by the University of
89 % Tulsa's Institute for Information Security and Cyber Corps program, which is
90 % the work, among others, of Christopher Swenson and Alexander Barclay. This
91 % work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported
92 % License.
93 %
94 % This style is designed to produce a somewhat long and quite detailed document.
95 % It may be suitable to typeset a shorter resume, as well, but that is not
96 % necessarily the goal.
97 %
98 % Although this style expects a page with quite narrow margins (narrower even
99 % than you are likely to see with the |fullpage| package), it does not by default adjust
100 % the margins or do any other page setup activities. However, when passed the
101 % |pagesetup| option (as in |\usepackage[pagesetup]{tucv}|), it sets up
102 % known-compatible margins.
103 %
104 % \section{Usage}
105 %
106 % Note: The \textsf{tucv} package is designed to be used in a document of
107 % \textsf{article} class. It is suggested that you import it with the
108 % \DescribeMacro{pagesetup}
109 % |pagesetup| option in order to avoid having to set up your own margins.
110 %
111 % A \textsf{tucv} resume will likely have three levels of content: resume
112 % headings (e.g. ``Employment,'' ``Education,'' etc.), resume entries (e.g.
113 % schools, employers, etc. which are meant to be part of itemized
114 % lists under headings), and resume subentries (e.g. degrees from schools, jobs
115 % at particular employers, etc., which are indented by default 10pt from the
116 % level of entries).
117 %
118 % There are two types of commands provided by this package: raw and high level.
119 % Raw commands are mainly intended to be internal to the package and are
120 % unlikely to be particularly useful by themselves in a document. These have
121 % names like |\resentry| and |\ressubentry|. High level commands are the ones
122 % that are likely to be most useful in typesetting a resume and include
123 % |\resschool| and |\resjob|.
124 %
125 % \subsection{Raw commands}
126 % \DescribeMacro{\resentry}
127 % Raw (internal) two-column resume entries are provided by |\resentry|. It is
128 % unlikely that this will be of
129 % much use directly very often. Instead, it is used internally by other commands
130 % provided by this package. It may also be indented by an optional width.
131 % Usage: |\resentry| \oarg{indent} \marg{lefttext} \marg{righttext}
132 %
133 % \DescribeMacro{\ressubentry}
134 % Indented two-column resume subentries are provided by
135 % |\ressubentry|; this is just a |\resentry|
136 % with a 10pt indentation specified. Usage:
137 % |\ressubentry| \marg{lefttext} \marg{righttext}. Same as
138 % |\resentry{10pt}{|\meta{lefttext}|}{|\meta{righttext}|}|.
139 %
140 % \DescribeMacro{\resentrysinglecol}
141 % Single-column resume entries are
142 % provided by |\resentrysinglecol| with optional indentation. The
143 % text will fill the same area occupied by both columns of the two-column
144 % entries. Usage: |\resentrysinglecol| \oarg{indent} \marg{text}
145 %
146 %\DescribeMacro{\ressubentrysinglecol}
147 % Indented one-column resume entries are provided by
148 % |\ressubentrysinglecol|. Usage:
149 % |\ressubentrysinglecol| \marg{text}. Same as |\resentrysinglecol{10pt}{|
150 % \meta{text}|}|.
151 %
152 % \subsection{High level commands}
153 % \DescribeMacro{\resheading}
154 % Place top-level section headings with the |\resheading| command. This will
155 % place the heading inside a shaded box. Usage: |\resheading| \marg{heading}.
156 %
157 % \DescribeMacro{\resschool}
158 % |\resschool| provides an entry for a school, with a name, location, and
159 % optional description. Usage: |\resschool| \oarg{description} \marg{name}
160 % \marg{location}. This describes only the school itself; a subentry called
161 % |\resdegree| is provided to place immediately following |\resschool| entries
162 % in order to specify the degrees issued by that school (and their dates).
163 %
164 % \DescribeMacro{\resdegree}
165 % |\resdegree| provides an entry for a degree or other issuance from a school,
166 % with a
167 % degree, major, date, and optional description. Intended to be a subentry
168 % beneath a school. Usage: |\resdegree| \oarg{description} \marg{degree}
169 %
170 % \DescribeMacro{\resemployer}
171 % |\resemployer| provides an entry for an employer. This entry is very similar
172 % to the school
173 % entry; it is different mainly for semantic reasons and to allow easier
174 % customization. Usage: |\resemployer| \oarg{description} \marg{name}
175 %
176 % \DescribeMacro{\resjob}
177 % |\resjob| provides an entry for a job. This works similarly to the
178 % school/degree
179 % set of entries and is intended to be a subentry of an employer field. Provides
180 % title, start date, end date, and description fields. Usage: |\resjob|
181 % \oarg{description} \marg{title} \marg{startdate} \marg{enddate}.
182 %
183 % \DescribeMacro{\resconference}
184 % |\resconference| provides an entry for denoting conference participation,
185 % with name and role
186 % fields. An optional description argument is accepted by not currently typeset.
187 % Usage: |\resconference| \oarg{description} \marg{name} \marg{role}
188 %
189 %\DescribeMacro{\ressubconference}
190 % |\ressubconference| provides an entry for denoting ``subconference''
191 % participation, with name and
192 % role fields. An optional description argument is accepted by not currently
193 % typeset. Usage: |\ressubconference| \oarg{description} \marg{name} \marg{role}
194 % This is intended to denote workshops, tutorials, special topics symposia,
195 % sessions, etc.
196 %
197 %\DescribeMacro{\resdesc}
198 % |\resdesc| provides an item/description pair, somewhat similar in appearance
199 % to |\item|s
200 % in \LaTeX's |\description| environment, though |\resdesc| is not a drop-in
201 % replacement for |\item| because it does not use |\item| in its implementation.
202 % Usage: |\resdesc| \marg{item} \marg{description}.
203 %
204 %\DescribeMacro{\resbib}
205 % |\resbib| provides a bibliography entry. Currently identical to |\resdesc| in
206 % behavior, but separate because of the semantic difference and the possibility
207 % of altering its appearance in the future. Usage: |\resbib| \marg{title}
208 %
209 % \StopEventually{}
210 % \section{Implementation}
211 % Require dependencies, adjust margins, set up header/footer.
212 % \begin{macrocode}
213 \RequirePackage{array}
214 \RequirePackage{color}
215 \RequirePackage{calc}
216 \RequirePackage{fancyhdr}
217 \RequirePackage{xparse}
218 \DeclareOption{pagesetup}{
219 \renewcommand{\headrulewidth}{0pt}
220 \setlength{\voffset}{0.1in}
221 \setlength{\headheight}{0in}
222 \setlength{\headsep}{0in}
223 \setlength{\textheight}{11in}
224 \setlength{\textheight}{9.5in}
225 \setlength{\topmargin}{-0.25in}
226 \setlength{\textwidth}{7in}
227 \setlength{\oddsidemargin}{-0.25in}
228 \setlength{\evensidemargin}{-0.25in}
229 \setlength{\tabcolsep}{0in}
230 \raggedbottom
231 \raggedright
232 \pagestyle{fancy}
233 \fancyhead{}
234 \fancyfoot{}
235 }
236 \ProcessOptions
237 % \end{macrocode}
238 %\begin{macro}{tucvheading}
239 % Set the default color of the |\resheading| shaded backgrounds. Overwrite in
240 % your documents in order to adjust the color.
241 % \begin{macrocode}
242 \definecolor{tucvheading}{gray}{0.85}
243 % \end{macrocode}
244 %\end{macro}
245 % \begin{macro}{\resheading}
246 % Resume heading. Heading inside a shaded box. Usage:
247 % |\resheading| \marg{heading}
248 % \begin{macrocode}
249 \NewDocumentCommand\resheading{m}{{\large \colorbox{tucvheading}{\begin{minipage}
250 {\textwidth-6.0pt}{\textbf{#1 \vphantom{p\^{E}}}}\end{minipage}}}}
251 % \end{macrocode}
252 % \end{macro}
253 %
254 %\begin{macro}{\resentry}
255 % Raw (internal) two-column resume entry. It is unlikely that this will be of
256 % much use directly very often. Instead, it is used internally by other commands
257 % provided by this package. It may also be indented by an optional width.
258 % Usage: |\resentry| \oarg{indent} \marg{lefttext} \marg{righttext}
259 % \begin{macrocode}
260 \NewDocumentCommand\resentry{O{0pt}mm}{
261 \begin{tabular*}{0.9\textwidth}[t]{@{\hspace{#1}}
262 p{5.0in-#1}@{\extracolsep{\fill}}p{0.75in}}
263 \raggedright #2 & #3
264 \tabularnewline
265 \end{tabular*}
266 }
267 % \end{macrocode}
268 %\end{macro}
269 %
270 %\begin{macro}{\ressubentry}
271 % Raw (internal) indented two-column resume subentry; this is just a |\resentry|
272 % with a 10pt indentation specified. Usage:
273 % |\ressubentry| \marg{lefttext} \marg{righttext}. This is equivalent to
274 % |\resentry{10pt}{|\meta{lefttext}|}{|\meta{righttext}|}|.
275 % \begin{macrocode}
276 \NewDocumentCommand\ressubentry{mm}{
277 \resentry[10pt]{
278 \setlength{\parskip}{1ex plus 0.5ex minus 0.2ex}
279 #1}{#2}
280 }
281 % \end{macrocode}
282 %\end{macro}
283 %
284 %\begin{macro}{\resentrysinglecol}
285 % Raw (internal) single-column resume entry with optional indentation. The
286 % text will fill the same area occupied by both columns of the two-column
287 % entries. Usage: |\resentrysinglecol| \oarg{indent} \marg{text}
288 % \begin{macrocode}
289 \NewDocumentCommand\resentrysinglecol{O{0pt}m}{
290 \begin{tabular*}{0.9\textwidth}[t]{@{\hspace{#1}}p{0.9\textwidth-#1}}
291 #2
292 \tabularnewline
293 \end{tabular*}
294 }
295 % \end{macrocode}
296 %\end{macro}
297 %
298 %\begin{macro}{\ressubentrysinglecol}
299 % Raw (internal) indented one-column resume entry. This is just
300 % |\resentrysinglecol| with a fixed 10pt indentation. Usage:
301 % |\ressubentrysinglecol| \marg{text}. Equivalent to |\resentrysinglecol{10pt}{|
302 % \meta{text}|}|.
303 % \begin{macrocode}
304 \NewDocumentCommand\ressubentrysinglecol{m}{
305 \resentrysinglecol[10pt]{
306 \setlength{\parskip}{1ex plus 0.5ex minus 0.2ex}
307 #1}
308 }
309 % \end{macrocode}
310 %\end{macro}
311 %
312 %\begin{macro}{\resschool}
313 % Provides an entry for a school, with a name, location, and optional
314 % description. Usage: |\resschool| \oarg{description} \marg{name}
315 % \marg{location}.
316 % \begin{macrocode}
317 \NewDocumentCommand\resschool{omm}{
318 \resentry{\textbf{#2}
319 \IfNoValueTF{#1}
320 {}
321 {\newline \textit{#1}}
322 }{#3}
323 }
324 % \end{macrocode}
325 %\end{macro}
326 %
327 %\begin{macro}{\resdegree}
328 % Provides an entry for a degree or other issuance from a school, with a
329 % degree, major, date, and optional description. Intended to be a subentry
330 % beneath a school. Usage: |\resdegree| \oarg{description} \marg{degree}
331 % \marg{major} \marg{date}.
332 % \begin{macrocode}
333 \NewDocumentCommand\resdegree{ommm}{
334 \ressubentry{#2 in #3
335 \IfNoValueTF{#1}
336 {}
337 {\newline \textit{#1}}
338 }{#4}
339 %\ressubentry{#2 in #3}{#4}
340 }
341 % \end{macrocode}
342 %\end{macro}
343 %
344 %\begin{macro}{\resemployer}
345 % Provides an entry for an employer. This entry is very similar to the school
346 % entry; it is different mainly for semantic reasons and to allow easier
347 % customization. Usage: |\resemployer| \oarg{description} \marg{name}
348 % \marg{location}.
349 % \begin{macrocode}
350 \NewDocumentCommand\resemployer{omm}{
351 \resentry{\textbf{#2}
352 \IfNoValueTF{#1}
353 {}
354 {\newline #1}
355 }{#3}
356 }
357 % \end{macrocode}
358 %\end{macro}
359 %
360 %\begin{macro}{\resjob}
361 % Provides an entry for a job. This works similarly to the school/degree
362 % set of entries and is intended to be a subentry of an employer field. Provides
363 % title, start date, end date, and description fields. Usage: |\resjob|
364 % \oarg{description} \marg{title} \marg{startdate} \marg{enddate}.
365 % \begin{macrocode}
366 \NewDocumentCommand\resjob{ommm}{
367 \resentry[10pt]{
368 \setlength{\parskip}{1ex plus 0.5ex minus 0.2ex} \textbf{#2}
369 \IfNoValueTF{#1}
370 {}
371 {\newline #1}
372 }{#3 -- \newline #4}
373 }
374 % \end{macrocode}
375 %\end{macro}
376 %
377 %\begin{macro}{\resconference}
378 % Provides an entry for denoting conference participation, with name and role
379 % fields. An optional description argument is accepted by not currently typeset.
380 % Usage: |\resconference| \oarg{description} \marg{name} \marg{role}
381 % \begin{macrocode}
382 \NewDocumentCommand\resconference{omm}{
383 \resentrysinglecol{\raggedright \textbf{#2} #3}
384 }
385 % \end{macrocode}
386 %\end{macro}
387 %
388 %\begin{macro}{\ressubconference}
389 % Provides an entry for denoting ``subconference'' participation, with name and
390 % role fields. An optional description argument is accepted by not currently
391 % typeset. Usage: |\ressubconference| \oarg{description} \marg{name} \marg{role}
392 % This is intended to denote workshops, tutorials, special topics symposia,
393 % sessions, etc.
394 % \begin{macrocode}
395 \NewDocumentCommand\ressubconference{omm}{
396 \resentrysinglecol[10pt]{\textbf{#2} #3}
397 }
398 % \end{macrocode}
399 %\end{macro}
400 %
401 %\begin{macro}{\resdesc}
402 % Provides an item/description pair, somewhat similar in appearance to |\item|s
403 % in \LaTeX's |\description| environment, though |\resdesc| is not a drop-in
404 % replacement for |\item| because it does not use |\item| in its implementation.
405 % Usage: |\resdesc| \marg{item} \marg{description}.
406 % \begin{macrocode}
407 \NewDocumentCommand\resdesc{mm}{
408 \resentrysinglecol{\raggedright \textbf{#1} #2}
409 }
410 % \end{macrocode}
411 %\end{macro}
412 %
413 %\begin{macro}{\resbib}
414 % Provides a bibliography entry. Currently identical to |\resdesc| in
415 % behavior, but separate because of the semantic difference and the possibility
416 % of altering its appearance in the future. Usage: |\resbib| \marg{title}
417 % \marg{citation\_remainder}.
418 % \begin{macrocode}
419 \NewDocumentCommand\resbib{mm}{
420 \resentrysinglecol{\raggedright \textbf{#1} #2}
421 }
422 % \end{macrocode}
423 %\end{macro}
424 %
425 % \Finale
426 \endinput