next up previous print clean
Next: About this document ... Up: Introducing SEP2e class Previous: Introducing SEP2e class

Available commands

The tables below list the SEP LATEX2e macros.

4|c| General formatting commands (headings,sections, etc.)      
Command minimal What it does latex2html translation
\sepreport Yes Sets the normal article layout. This command is invoked by default. Analogous.
\shortnote Yes Sets the short-note article layout. Analogous.
\morespace No Increases the inter-line spacing to 1.5. N/A
4|r| $\backslash$renewcommand{$\backslash$baselinestretch}{1.5}      
\doublespace No Increases the inter-line spacing to 2. N/A
4|r| $\backslash$renewcommand{$\backslash$baselinestretch}{2.0}      
\nopagenumbers No Switches off the page numbering. N/A
4|r| $\backslash$renewcommand{$\backslash$thepage}{}      
\bold{} Maybe In the math mode, sets the argument in the bold face. Emulates the same behavior by inclosing the argument between <B> and </B>.
4|r| $\backslash$ensuremath{$\backslash$mathbf{#1}}      
\ital{} No Sets the argument in italics. N/A
4|r| $\backslash$textit{#1}      
\righthead{} Yes Sets the right heading (normally a short name of the article.) Ignored for the book option. Includes it in <TITLE>.
\lefthead{} Yes Sets the left heading (normally author's last name.) Ignored for the book option. Includes it in <TITLE>.
\footer{} Yes Sets the footer. Ignored for the book option. Ignored.
\email{} Yes Sets the email string. The default string is Author has no known email address . Should be applied before \author. Analogous. Additionally, the email string is broken into individual e-mail addresses (for multiple authors.)
\noemailaddress Yes Switches off displaying of the e-mail string. Analogous.
\keywords{} Yes Sets the keyword string. The default string is not available . Should be applied before \author. Ignored (for now.)
\nokeywords Yes Switches off displaying of the keyword string. Ignored.
\title{} Yes Under alone and report options, this LATEX command is redefined to display the paper's title. If \shortnote, the title is left-justified (instead of centering) and prepended with ``Short Note''. Analogous. The title string is placed between <H1> and </H1>.
\author{} Yes Under alone and report options, this LATEX command is redefined to display the author(s) name. The keyword string is displayed under the author (unless \nokeyword.) The email string is displayed as a footnote (unless \noemailaddress) Analogous. The keyword string is ignored (for now), the email string is displayed under the author(s) name as hyperlink(s) to mailto: (James Rickett's idea.)
\chapter{} Maybe Under alone options, this LATEX command is equivalent to title. Analogous.
\mhead{} No Equivalent to \section{}. Under alone and report options, the \section command has been redefined to reflect Geophysics style (capital letters, centered headings.) N/A
4|r| $\backslash$section{#1}      
\shead{} No Equivalent to (redefined) \subsection{}. N/A
4|r| $\backslash$subsection{#1}      
\sshead{} No Equivalent to (redefined) \subsubsection{}. N/A
4|r| $\backslash$subsubsection{#1}      
\ssshead{} Maybe Supersmall heading (rarely used.) N/A
4|r| $\backslash$smallskip$\backslash$begin{flushleft}$\backslash$footnotesize$\backslash$textbf{#1}$\backslash$end{flushleft}      
\sssshead{} Maybe Extrasmall heading. N/A
4|r| $\backslash$smallskip$\backslash$begin{flushleft}$\backslash$scriptsize$\backslash$textbf{#1}$\backslash$end{flushleft}      
\boxit{} Maybe Puts the text in the argument in a frame. Analogous (uses a bordered table.)
\ABS{} Yes Puts abstract in the argument in a frame (Geophysics style.) Ignored if \shortnote. Analogous (uses a bordered table.)
\parab No Obsolete. It was used previously to define paragraphs in the abstract, but is no longer needed. N/A
\INT No Starts section INTRODUCTION. N/A
4|r| $\backslash$section{Introduction}      
\DIS No Starts section DISCUSSION. N/A
4|r| $\backslash$section{Discussion}      
\CON No Starts section CONCLUSIONS. N/A
4|r| $\backslash$section{Conclusions}      
\ACK No Starts section ACKNOWLEDGMENTS. N/A
4|r| $\backslash$section{Acknowledgements}      
\REF No Starts section REFERENCES. N/A
4|r| $\backslash$section{References} or $\backslash$section*{REFERENCES} (for books)      
\APPENDIX{} Yes Starts an appendix. The argument is normally a capitalized letter. Equations and figures in an appendix have different numeration and are prepended with the appendix name. Analogous. The translation is a little buggy right now, should be fixed eventually.
\APP No Starts appendix A. N/A
4|r| $\backslash$APPENDIX{A}      
\booktoreport No Obsolete. Now chapters in books and articles in reports can have the same source, interpreted differently according to the sep2e options. N/A
\reporttobook No Obsolete. Now chapters in books and articles in reports can have the same source, interpreted differently according to the sep2e options. N/A

3|c| Labeling and referencing commands    
Command minimal What it does
\oldlabel{} No Same as \label{}.
3|r| $\backslash$label{#1}    
\oldref{} No Same as \ref{}.
3|r| $\backslash$ref{#1}    
\oldpageref{} No Same as \pageref{}.
3|r| $\backslash$pageref{#1}    
\FIGLABEL{} No Labels a figure. Equivalent of this command is used internally by \activeplot and \activesideplot.
3|r| $\backslash$label{fig:#1}    
\FIG{} No References a figure, labeled by \FIGLABEL.
3|r| $\backslash$ref{fig:#1}    
\CHAPFIG{}{} No References a figure in a different chapter. The first argument is the directory name of the referenced chapter.
3|r| $\backslash$ref{#1/fig:#2}    
\EQNLABEL{} No Labels an equation.
3|r| $\backslash$label{eqn:#1}    
\EQN{} No References an equation, labeled by \EQNLABEL.
3|r| ($\backslash$ref{eqn:#1})    
\CHAPEQN{}{} No References an equation in a different chapter. The first argument is the directory name of the referenced chapter.
3|r| ($\backslash$ref{#1/eqn:#2})    
\PROGLABEL No Labels a program. This command is used internally by \prog and \progblock.
3|r| $\backslash$label{prog:#1}    
\PROG{} No References the page of a program, labeled by \PROGLABEL, and prints the name of the program with ().
3|r| $\backslash$texttt{#1()} $\backslash$vpageref{prog:#1}    
\GPROGLABEL{} No Labels a program. This command is used internally by \gprog and \gprogblock.
3|r| $\backslash$label{/prog:#1}    
\GPROG{} No References the page of a program, labeled by \GPROGLABEL, and prints the name of the program with ().
3|r| $\backslash$texttt{#1()} $\backslash$vpageref{/prog:#1}    
\LPROG{} No Prints the name of a program with () without referencing its page.
3|r| $\backslash$texttt{#1()}    
\CHAPLABEL{} No Labels a chapter.
3|r| $\backslash$label{paper:#1}    
\CHAP{} No References a chapter.
3|r| $\backslash$ref{#1/paper:#1}    
\chapterlabel{} No The same as \CHAPLABEL.
3|r| $\backslash$label{paper:#1}    
\chapterref{} No The same as \CHAP.
3|r| $\backslash$ref{#1/paper:#1}    

4|c| File input commands      
Command minimal What it does latex2html translation
\inputdir{} Maybe Defines the directory name for the files being included. The default is the current directory. One of the ``low-level'' commands. Analogous.
\sepinput{} No Inputs a file from the directory set by \inputdir. N/A
4|r| $\backslash$input{#1}      
\FloatListing Yes Sets a flag so that included programs will behave as floating figures. Ignored.
\NoFloatListing Yes Sets a flag so that included programs will NOT behave as floating figures. This command is invoked by default. Ignored.
\BreakListing No The same as \NoFloatListing. N/A
\NoBreakListing No The same as \FloatListing. N/A
\listing{} Yes Inputs a program in a small font and verbatim style. Analogous (uses <PRE>.)
\gprog{}{}{} Yes The first argument is a label, which can be referenced with \GPROG. The second argument is the program name. The third argument is the caption text. The letter ``g'' stands for global . It means that the program is supposed to be referenced in other chapters of a book or other papers in a report. Analogous.
\prog{}{}{} Yes The first argument is a label, which can be referenced with \PROG. The second argument is the program name. The third argument is the caption text. Analogous.
\gprogblock{}{} Yes The first argument is a label, which can be referenced with \GPROG. The second argument is the program name. Observes the flag set by \FloatListing or \NoFloatListing. The letter ``g'' stands for global . It means that the program is supposed to be referenced in other chapters of a book or other papers in a report. Analogous.
\progblock{}{} Yes The first argument is a label, which can be referenced with \PROG. The second argument is the program name. Observes the flag set by \FloatListing or \NoFloatListing. Analogous.

4|c| Bibliography commands      
Command minimal What it does latex2html translation
\cite{} Yes Puts a bibliography reference in the form (author, year). Translates into a transparent GIF image.
\shortcite{} Yes Puts a bibliography reference in the form (year). Translates into a transparent GIF image.
\longcite{} Yes Puts a bibliography reference in the form author (year). Translates into a transparent GIF image.
\putbib[] No Inserts a bibliography list. N/A
4|r| $\backslash$bibliographystyle{sep}$\backslash$bibliography{#1}      
\reference{} Maybe Emulates an entry in a bibliography list. Unimplemented yet. Ignored for now.

4|c| Plotting commands      
Command minimal What it does latex2html
translation
\withbutton No Sets a flag to include figure buttons. N/A
\nobutton No Sets a flag NOT to include figure buttons. The same effect can be achieved with \plot and \sideplot. N/A
\syscall{}{} No Obsolete. Used previously in conjunction with xtex. Ignored.
\SYSCALL{}{} No Obsolete. Used previously in conjunction with xtex. Ignored.
\plotbox[]{}{} Yes The first (optional) argument is the relative directory name, defaulted to \figdir. The second argument is the figure name. The third argument contains plot options (typically width=, height=). Use it for figures, which are not defined in RESULTS lists of the makefile. Analogous. Puts a corresponding GIF figure in a bordered table. The size of the figure is computed from the plot options, assuming the resolution of 75 dpi.
\activeplot[]{}{}{}{} Yes The first (optional) argument specifies the position of the figure and is defaulted to htbp (here, top, bottom, page). The second argument is the figure name. The third argument contains plot options (typically width=, height=). The fourth argument contains the caption text. The corresponding GIF figure is placed in a bordered table. The size of the figure is computed from the plot options, assuming the resolution of 75 dpi. A hyperlink to the full-sized GIF image is placed under the figure. Problem: the hyperreference to the figure goes under it. Sometimes it is inconvenient, and we would prefer the reference to be on top of the figure (pointed out by James Rickett.)
\activeplot[]{}{}{}{} Yes The first (optional) argument specifies the position of the figure and is defaulted to htbp (here, top, bottom, page). The second argument is the figure name. The third argument contains plot options (typically width=, height=). The fourth argument indicates the reproducibility status and is inserted by Actify. The fifth argument contains the caption text. The figure name is placed in a frame, and the reproducibility flag is placed in []. The corresponding GIF figure is placed in a bordered table. The size of the figure is computed from the plot options, assuming the resolution of 75 dpi. A hyperlink to the full-sized GIF image is placed under the figure. The figure is supplied with interactive sepshell buttons.
\activesideplot[]{}{}{}{} Yes Analogous to \plot, but the figure has a fixed maximum width, and the caption is placed on the left side of the plot. The first (optional) argument specifies the position of the figure and is defaulted to htbp (here, top, bottom, page). The second argument is the figure name. The third argument contains plot options (typically width=, height=). The fourth argument contains the caption text. The corresponding GIF figure is placed in a table with the caption on the left side. The size of the figure is computed from the plot options, assuming the resolution of 75 dpi. A hyperlink to the full-sized GIF image is placed under the figure. Problem: the hyperreference to the figure goes under it. Sometimes it is inconvenient, and we would prefer the reference to be on top of the figure (pointed out by James Rickett.)
\activesideplot[]{}{}{}{} Yes Analogous to \activeplot, but the figure has a fixed maximum width, and the caption is placed on the left side of the plot. The first (optional) argument specifies the position of the figure and is defaulted to htbp (here, top, bottom, page). The second argument is the figure name. The third argument contains plot options (typically width=, height=). The fourth argument indicates the reproducibility status and is inserted by Actify. The fifth argument contains the caption text. The figure name is placed in a frame, and the reproducibility flag is placed in []. Warning: Previously we were able to use something like \activesideplot{name} {2in}{}{caption}, where the length 2in was interpreted as the figure height. Now you have to spell out height=2in. This is the only serious back-compatability problem that we have encountered. The corresponding GIF figure is placed in a table with the caption on the left side. The size of the figure is computed from the plot options, assuming the resolution of 75 dpi. A hyperlink to the full-sized GIF image is placed under the figure. The figure is supplied with interactive sepshell buttons. Problem: the hyperreference to the figure goes under it. Sometimes it is inconvenient, and we would prefer the reference to be on top of the figure (pointed out by James Rickett.)
\passiveplot{}{}{}{} No Obsolete. Equivalent to \activeplot. N/A
\passivesideplot{}{}{}{} No Obsolete. Equivalent to \activesideplot. N/A
\activeplothere{}{}{}{} No Equivalent to \activeplot with the first (optional) argument set to h (here). N/A
4|r| $\backslash$activeplot[h]{#1}{#2}{#3}{#4}      
\activeplotpage{}{}{}{} No Equivalent to \activeplot with the first (optional) argument set to p (page). N/A
4|r| $\backslash$activeplot[p]{#1}{#2}{#3}{#4}      
\activeplottop{}{}{}{} No Equivalent to \activeplot with the first (optional) argument set to t (top). N/A
4|r| $\backslash$activeplot[t]{#1}{#2}{#3}{#4}      
\activeplotbottom{}{}{}{} No Equivalent to \activeplot with the first (optional) argument set to b (bottom). Equivalent to \activeplot.
4|r| $\backslash$activeplot[b]{#1}{#2}{#3}{#4}      
\notinteractive No Obsolete. Ignored. Ignored.
\interactive No Obsolete. Ignored. Ignored.
\iex{}{} No Obsolete. Ignored. Ignored.
\noshowiex No Obsolete. Ignored. Ignored.
\showiex No Obsolete. Ignored. Ignored.
\noIdocMenu No Obsolete. Ignored. Ignored.

next up previous print clean
Next: About this document ... Up: Introducing SEP2e class Previous: Introducing SEP2e class
Stanford Exploration Project
9/12/2000