Debian Codegraph @

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

raw
1 % \iffalse
2 % $Id: sageep.dtx,v 1.7 2009-01-14 21:43:46 boris Exp $
3 %
4 % Copyright 2008, Boris Veytsman
5 % This work 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
8 % later version.
9 % The latest version of the license is in
10 % http://www.latex-project.org/lppl.txt
11 % and version 1.3 or later is part of all distributions of
12 % LaTeX version 2005/12/01 or later.
13 %
14 % This work has the LPPL maintenance status `maintained'.
15 %
16 % The Current Maintainer of this work is Boris Veytsman,
17 % <[email protected]>
18 %
19 % This work consists of the files sageep.dtx, sageep.bst and the
20 % derived file sageep.cls
21 %
22 % \fi
23 % \CheckSum{129}
24 %
25 %
26 %% \CharacterTable
27 %% {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
28 %% 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
29 %% Digits \0\1\2\3\4\5\6\7\8\9
30 %% Exclamation \! Double quote \" Hash (number) \#
31 %% Dollar \$ Percent \% Ampersand \&
32 %% Acute accent \' Left paren \( Right paren \)
33 %% Asterisk \* Plus \+ Comma \,
34 %% Minus \- Point \. Solidus \/
35 %% Colon \: Semicolon \; Less than \<
36 %% Equals \= Greater than \> Question mark \?
37 %% Commercial at \@ Left bracket \[ Backslash \\
38 %% Right bracket \] Circumflex \^ Underscore \_
39 %% Grave accent \` Left brace \{ Vertical bar \|
40 %% Right brace \} Tilde \~}
41 %
42 %\iffalse
43 % Taken from xkeyval.dtx
44 %\fi
45 %\makeatletter
46 %\def\DescribeOption#1{\leavevmode\@bsphack
47 % \marginpar{\raggedleft\PrintDescribeOption{#1}}%
48 % \SpecialOptionIndex{#1}\@esphack\ignorespaces}
49 %\def\PrintDescribeOption#1{\strut\emph{option}\\\MacroFont #1\ }
50 %\def\SpecialOptionIndex#1{\@bsphack
51 % \index{#1\actualchar{\protect\ttfamily#1}
52 % (option)\encapchar usage}%
53 % \index{options:\levelchar#1\actualchar{\protect\ttfamily#1}\encapchar
54 % usage}\@esphack}
55 %\def\DescribeOptions#1{\leavevmode\@bsphack
56 % \marginpar{\raggedleft\strut\emph{options}%
57 % \@for\@tempa:=#1\do{%
58 % \\\strut\MacroFont\@tempa\SpecialOptionIndex\@tempa
59 % }}\@esphack\ignorespaces}
60 %\makeatother
61 % \newcommand{\progname}[1]{\textsf{#1}}
62 %
63 % \MakeShortVerb{|}
64 % \GetFileInfo{sageep.dtx}
65 % \title{\LaTeX{} Style for Environmental and Engineering Geophysical
66 % Society's Annual Meeting Papers
67 % \thanks{\copyright 2008, Boris Veytsman}}
68 % \author{Boris Veytsman\thanks{%
69 % \href{mailto:[email protected]}{\texttt{[email protected]}},
70 % \href{mailto:[email protected]}{\texttt{[email protected]}}}}
71 % \date{\filedate, \fileversion}
72 % \maketitle
73 % \begin{abstract}
74 % This package provides class for typesetting papers for
75 % Environmental and Engineering Geophysical Society's Annual
76 % Meeting, SAGEEP. It is based on the recommendations for
77 % SAGEEP-2009.
78 % \end{abstract}
79 % \changes{v0.1}{2008/12/19}{First fully functional version}
80 % \changes{v1.0}{2009/01/14}{First publicly released version}
81 % \tableofcontents
82 %
83 % \clearpage
84 %\section{Introduction}
85 %\label{sec:intro}
86 %
87 % The Environmental and Engineering Geophysical Society (EEGS) is an
88 % international scientific organization with about 700
89 % members~\cite{EEGS_web_site}. One of its main activities is its
90 % annual meetings, the Application of Geophysics to Engineering and
91 % Environmental Problems (SAGEEP). The papers for this meeting are
92 % accepted as PDF files. This class typesets papers according to the
93 % guidelines~\cite{SAGEEP09}, intended for SAGEEP-2009. It should
94 % probably work for the future SAGEEP, unless EEGS changes its
95 % guidelines.
96 %
97 % The class was commissioned and paid for by US Army Corps of
98 % Engineers, Engineer Research and Development Center, 3909 Halls
99 % Ferry Road, Vicksburg, MS 39180-6199.
100 %
101 %
102 %\section{User Guide}
103 %\label{sec:user_guide}
104 %
105 %
106 %
107 %\subsection{Installation}
108 %\label{sec:ug_install}
109 %
110 % The class uses some \LaTeX{} packages. Normally they should be
111 % present in any up-to-date distribution. If you do not have them,
112 % you can download them using the links below prior to using the class.
113 %
114 % You will need \progname{PSFNSS}~\cite{Schmidt04:PSNFSS9.2}: the
115 % \LaTeX{} package providing the access to common PostScript fonts.
116 % Of course you will need the fonts themselves. You will also need
117 % packages \progname{geometry}~\cite{Umeki08:Geometry},
118 % \progname{caption}~cite{Sommerfeldt07:Caption} and
119 % \progname{natbib}~\cite{Daly07:Natbib}.
120 %
121 %
122 % The installation of the class follows the usual
123 % practice~\cite{TeXFAQ} for \LaTeX{} packages:
124 % \begin{enumerate}
125 % \item Run \progname{latex} on |sageep.ins|. This will produce the
126 % \LaTeX{} class |sageep.cls|.
127 % \item Put the files |sageep.cls| and |sageep.bst| to
128 % the places where \LaTeX{} and Bib\TeX{} can find them (see
129 % \cite{TeXFAQ} or the documentation for your \TeX{}
130 % system).\label{item:install}
131 % \item Update the database of file names. Again, see \cite{TeXFAQ}
132 % or the documentation for your \TeX{} system for the system-specific
133 % details.\label{item:update}
134 % \item The file |sageep.pdf| provides the documentation for the
135 % package (this is the file you are probably reading now).
136 % \end{enumerate}
137 % As an alternative to items~\ref{item:install} and~\ref{item:update}
138 % you can just put the files |sageep.cls| and |sageep.bst| in the
139 % working directory where your |.tex| file is.
140 %
141 %
142 %\subsection{Invocation}
143 %\label{sec:ug_invocation}
144 %
145 % To use the class, put in the preamble of your document
146 % \begin{flushleft}
147 % |\documentclass[|\meta{options}|]{sageep}|
148 % \end{flushleft}
149 %
150 % The class recoginzes the standard \LaTeX{} options, shared by the
151 % most document classes~\cite{Lamport94}.
152 % \DescribeOptions{8pt,9pt,10pt,11pt,12pt} The default font size
153 % changing options (|8pt|, |9pt|, \dots, |12pt|) have no effect other
154 % than producing a warning in the log.
155 %
156 %
157 %\subsection{Use of the Class}
158 %\label{sec:ug_use}
159 %
160 % Most of the standard \LaTeX{} commands work with the class. Here we
161 % document only the differences from the standard system.
162 %
163 %
164 %\subsubsection{Front Matter}
165 %\label{sec:ug_frontmatter}
166 %
167 %
168 % \DescribeMacro{\title}
169 % \DescribeMacro{\author}
170 % \DescribeMacro{\maketitle}
171 % The |\title| command works as usual. The |\author| command should
172 % include both the author's name and affiliation in the format
173 % described in~\cite{SAGEEP09} (first name, middle initial, last
174 % name, name of organization/institution, city and state abbreviation
175 % or country). For papers with several authors you can issue several
176 % |\author| commands. For example,
177 % \begin{verbatim}
178 % \author{Sam A. Llaun, Academy of Lagado, Lagado, Balnibarbi}
179 % \author{James Incandenza, Interdependence University, Boston, MA}
180 % \end{verbatim}
181 % The command |\maketitle| should be put \emph{after} |\title| and
182 % |\author| commands.
183 %
184 %
185 %\subsubsection{Sections}
186 %\label{sec:ug_sections}
187 %
188 % \DescribeMacro{section}
189 % The sections in SAGEEP articles are unnumbered. Accordingly, the
190 % command |\section| does not produce section number (and is
191 % equivalent to the command |\section*|).
192 %
193 % There is a certain inconsistency in the format
194 % guidelines~\cite{SAGEEP09}: the text says that section headings
195 % should be in initial caps, while the headings in the sample are
196 % uppercase. Therefore the class does not change the case of the
197 % headings and subheadings. If
198 % you enter them with initial caps, they will be typeset with initial
199 % caps. If you enter them in upper case, they will be typeset in
200 % upper case.
201 %
202 % Note that ``Abstract'' should be the first section of the paper. The
203 % other obligatory sections are ``Conclusions'' and ``References''.
204 %
205 %
206 %\subsubsection{Tables and Figures}
207 %\label{sec:ug_floats}
208 %
209 % \DescribeMacro{\caption}
210 % There is an important difference between the style of tables
211 % required by~\cite{SAGEEP09} and the standard \LaTeX{} style: the
212 % caption of a table must be placed \emph{above} the table rather than
213 % below it. The class takes care of the proper spacing between the
214 % caption and the table body, but it is your responsibility to put
215 % the |\caption| command in a table first, and then the body of the
216 % table, for example:
217 % \begin{verbatim}
218 % \begin{table}[htbp]
219 % \caption{North American Paper Sizes}
220 % \label{tab:paper}
221 % \begin{tabular}{lll}
222 % \hline
223 % Size & in $\times$ in &mm $\times$ mm\\
224 % \hline
225 % Letter &8.5 $\times$ 11 &216 $\times$ 279\\
226 % Legal &8.5 $\times$ 14 &216 $\times$ 356\\
227 % Junior Legal &8 x 5 &\\
228 % Ledger &17 $\times$ 11 &432 $\times$ 279\\
229 % Tabloid &11 $\times$ 17 &279 $\times$ 432\\
230 % \hline
231 % \end{tabular}
232 % \end{table}
233 % \end{verbatim}
234 % Do not center table or figure body.
235 %
236 % To include graphics you can use, for example, the
237 % \progname{graphics} bundle~\cite{Carlisle05:Graphics}. It is
238 % \emph{not} loaded automatically.
239 %
240 %
241 %\subsubsection{References}
242 %\label{sec:ug_refs}
243 %
244 % \DescribeMacro{\cite}
245 % The class loads \progname{natbib} package~\cite{Daly07:Natbib} to
246 % properly format the references. It also redefines |\cite| to work
247 % as |\citep|, producing a parenthetical (author, year) citation. You
248 % can get the other forms of citation using |\citet|, |\citeauthor| or
249 % |\citeyear| commands of \progname{natbib}.
250 %
251 % The Bib\TeX{} style |sageep.bst| is supplied with the class to
252 % format the list of references. If you use Bib\TeX, just select this
253 % bibliography style with |\bibliographystyle{sageep}|.
254 %
255 % \changes{v0.2}{2009/01/11}{Bibliography style change for manuals}
256 % This style has a non-standard treatment of manuals as required by
257 % SAGEEP style: the organization that published the manual is used as
258 % an author of the manual for sorting and citation purposes. Of
259 % course this means that manuals should not have real authors, which
260 % is usually the case with technical manuals.
261 %
262 %\StopEventually{%
263 % \clearpage
264 % \bibliography{sageep}
265 % \bibliographystyle{unsrt}}
266 % \clearpage
267 %\section{Implementation}
268 %\label{sec:impl}
269 %
270 %\subsection{Identification}
271 %\label{sec:ident}
272 %
273 % We start with the declaration who we are. Most |.dtx| files put
274 % driver code in a separate driver file |.drv|. We roll this code into the
275 % main file, and use the pseudo-guard |<gobble>| for it.
276 % \begin{macrocode}
277 %<class>\NeedsTeXFormat{LaTeX2e}
278 %<*gobble>
279 \ProvidesFile{sageep.dtx}
280 %</gobble>
281 %<class>\ProvidesClass{sageep}
282 [2009/01/14 v1.0 Typesetting Papers for Environmental and
283 Engineering Geophysical Society's Annual Meeting]
284 % \end{macrocode}
285 %
286 % And the driver code:
287 % \begin{macrocode}
288 %<*gobble>
289 \documentclass{ltxdoc}
290 \usepackage{array}
291 \usepackage{url,amsfonts}
292 \usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black,
293 pagecolor=black,urlcolor=black,hyperindex=false]{hyperref}
294 \PageIndex
295 \CodelineIndex
296 \RecordChanges
297 \EnableCrossrefs
298 \begin{document}
299 \DocInput{sageep.dtx}
300 \end{document}
301 %</gobble>
302 %<*class>
303 % \end{macrocode}
304 %
305 %
306 %\subsection{Options}
307 %\label{sec:options}
308 %
309 % \begin{macro}{\sageep@size@warning}
310 % The font-changing options are not used in our setup, so we just
311 % produce a warning:
312 % \begin{macrocode}
313 \long\def\sageep@size@warning#1{%
314 \ClassWarning{sageep}{Size-changing option #1 will not be
315 honored}}%
316 \DeclareOption{8pt}{\sageep@size@warning{\CurrentOption}}%
317 \DeclareOption{9pt}{\sageep@size@warning{\CurrentOption}}%
318 \DeclareOption{10pt}{\sageep@size@warning{\CurrentOption}}%
319 \DeclareOption{11pt}{\sageep@size@warning{\CurrentOption}}%
320 \DeclareOption{12pt}{\sageep@size@warning{\CurrentOption}}%
321 % \end{macrocode}
322 % \end{macro}
323 %
324 % All other options are just sent to the main class:
325 % \begin{macrocode}
326 \DeclareOption*{\PassOptionsToClass{\CurrentOption}{book}}
327 \ProcessOptions\relax
328 % \end{macrocode}
329 %
330 %\subsection{Loading Class and Packages}
331 %\label{sec:loading}
332 %
333 % We start with the base class
334 % \begin{macrocode}
335 \LoadClass[12pt]{article}
336 % \end{macrocode}
337 %
338 %\subsection{Fonts}
339 %\label{sec:fonts}
340 %
341 % We use Times for the main font. The guidelines say nothing about other
342 % fonts, but to reproduce the familiar look, we also use Helvetica for
343 % the sans serifed font, and Courier for the monospaced font:
344 % \begin{macrocode}
345 \usepackage{mathptmx}
346 \usepackage[scaled]{helvet}
347 \usepackage{courier}
348 % \end{macrocode}
349 %
350 %\subsection{Page Dimensions and Paragraphing}
351 %\label{sec:page}
352 %
353 % The requirements are 0.75'' margin top, left and right, and 1''
354 % bottom.
355 %
356 % \begin{macrocode}
357 \RequirePackage[top=0.75in, left=0.75in, right=0.75in, bottom=1in]{geometry}
358 % \end{macrocode}
359 %
360 %
361 % \begin{macro}{\parindent}
362 % The paragraphs have 0.5'' indentation
363 % \begin{macrocode}
364 \setlength{\parindent}{0.5in}
365 % \end{macrocode}
366 % \end{macro}
367 %
368 % We indent even the paragraphs after section heads:
369 % \begin{macrocode}
370 \RequirePackage{indentfirst}
371 % \end{macrocode}
372 %
373 %
374 %\subsection{Headers and Footers}
375 %\label{sec:headers}
376 %
377 % No footers or headers:
378 % \begin{macrocode}
379 \pagestyle{empty}
380 % \end{macrocode}
381 %
382 %
383 %
384 %\subsection{Front Matter}
385 %\label{sec:frontmatter}
386 %
387 % \begin{macro}{\author}
388 % The |\author| command can be repeated. Each invocation adds an
389 % author and affiliation to the list of authors. The following is
390 % adapted from~\cite{Downes04:amsart}.
391 % \begin{macrocode}
392 \renewcommand{\author}[1]{%
393 \ifx\@empty\authors
394 \gdef\authors{#1}%
395 \else
396 \g@addto@macro\authors{\and#1}%
397 \fi}
398 \let\authors\@empty
399 % \end{macrocode}
400 % \end{macro}
401 %
402 %
403 % \begin{macro}{\maketitle}
404 % Now we are ready to make the title. The title and authors are
405 % centered.
406 % \begin{macrocode}
407 \def\maketitle{%
408 \bgroup
409 \centering
410 \ifx\@empty\@title\relax
411 \else
412 {\large\bfseries\MakeUppercase{\@title}\par\vspace{\baselineskip}}%
413 \fi
414 \ifx\@empty\authors\relax
415 \else
416 {\let\and=\linebreak
417 \normalfont\itshape\authors\par\vspace{\baselineskip}}%
418 \fi
419 \egroup}
420 % \end{macrocode}
421 %
422 % \end{macro}
423 %
424 %
425 %\subsection{Sectioning}
426 %\label{sec:sectioning}
427 %
428 %
429 % We do not number sections:
430 % \begin{macrocode}
431 \setcounter{secnumdepth}{0}
432 % \end{macrocode}
433 %
434 %
435 % \begin{macro}{\section}
436 % Sections are in 14\,pt bold centered.
437 % \begin{macrocode}
438 \renewcommand\section{\@startsection{section}{1}{0pt}{\baselineskip}%
439 {\baselineskip}{\normalfont\centering\large\bfseries}}
440 % \end{macrocode}
441 % \end{macro}
442 %
443 %
444 % \begin{macro}{\subsection}
445 % Subsections are bold, italics, normal size:
446 % \begin{macrocode}
447 \renewcommand\subsection{\@startsection{subsection}{2}{0pt}{\baselineskip}%
448 {1sp}{\normalfont\normalsize\itshape\bfseries}}
449 % \end{macrocode}
450 % \end{macro}
451 %
452 %
453 %
454 %\subsection{Floats}
455 %\label{sec:floats}
456 %
457 % We use \progname{caption} package~\cite{Sommerfeldt07:Caption} for
458 % control of captions:
459 % \begin{macrocode}
460 \RequirePackage{caption}
461 % \end{macrocode}
462 %
463 % Captions are justified left with ``Figure'' or ``table'' in boldface:
464 % \begin{macrocode}
465 \captionsetup{labelfont=bf, indent=0pt, singlelinecheck=off}
466 % \end{macrocode}
467 %
468 % For tables the caption is above the table:
469 % \begin{macrocode}
470 \captionsetup[table]{position=above}
471 % \end{macrocode}
472 %
473 % \changes{v0.2}{2009/01/11}{Changed floats parameters}
474 % We change the parameters of float placement according to the
475 % recommendations from~\cite{Oostrum97:Floats}:
476 % \begin{macrocode}
477 \renewcommand{\textfraction}{0.05}
478 \renewcommand{\topfraction}{0.95}
479 \renewcommand{\bottomfraction}{0.95}
480 \renewcommand{\floatpagefraction}{0.35}
481 \setcounter{totalnumber}{5}
482 % \end{macrocode}
483 %
484 %
485 %
486 %\subsection{Bibliography}
487 %\label{sec:biblio}
488 %
489 % We use \progname{natbib}~\cite{Daly07:Natbib}.
490 % \begin{macrocode}
491 \RequirePackage[round]{natbib}
492 % \end{macrocode}
493 % \begin{macro}{\cite}
494 % We redefine |\cite| to be |\citep|:
495 % \begin{macrocode}
496 \let\cite=\citep
497 % \end{macrocode}
498 %
499 % \end{macro}
500 %
501 % \subsection{The final word}
502 %\label{sec:final}
503 %
504 % \begin{macrocode}
505 %</class>
506 % \end{macrocode}
507 %
508 %\Finale
509 %\clearpage
510 %
511 %\PrintChanges
512 %\clearpage
513 %\PrintIndex
514 %
515 \endinput