|
The example LaTeX files show the usage of all available options
in the SANDreport class (see Download). Here is a summary.
Obviously, you will need to include the class in your document:
\documentclass[12pt]{SANDreport}
There are four options available: strict, relax,
report, and OUO.
For example:
\documentclass[12pt, strict]{SANDreport}
Strict forces
the class file to follow the guidelines as closely as possible, while
using relax makes the document look more like a standard LaTeX file.
With strict specified, figures and tables from appendices
do not appear in the table of contents, and sections are
not numbered. If strict is not specified, then sections
are numbered to two decimal places (1.2.3.)
If no options are specified, then all figures and tables are listed in
the table of contents.
With the relax option, section entries in the table of contents become
bold face and have a blank line between them.
The SANDreport class is based on the LaTeX article class. If
the report option is specified, then the LaTeX report
class is used as a base. This allows the use of \chapter, for
example.
The OUO option is necessary for Official Use Only reports. It makes
some changes to the back cover.
The options CA and NM were briefly introduced in
version 1.12, but are no longer valid. Use them as options to the
\begin{SANDdistribution}
command instead.
If pdflatex is used, then the pdf versions of the DOE and
Sandia logos are used. With regular LaTeX, the encapsulated
postscript versions are used.
Mandatory Preamble Commands
There are several commands that are required for a SAND report.
The SAND report number has to be provided using:
\SANDnum{SAND200x-xxxx}
nnn is the number you got through the review and approval process.
It has a format like this: SAND2003-nnn.
The authors, as they should appear on the cover page, have to
be provided as well: (Name only, no institution.)
\SANDauthor{Jane Doe\\John Smith}
The last mandatory command in the preamble sets the print date:
(Use \date{} without parameters to avoid an extra date on the page.)
\SANDprintDate{June 2003}
Optional Preamble Commands
If this reports supersedes another one, you should specify the
SAND number and print date of the older report using:
\SANDsupersed{SAND00-0000}{January 0000}
If this is a reprint, provide the date like this: (It will be
used on the cover page, and added to the original print date on
the title page.)
\SANDrePrintDate{March 2006}
You will also need to supply a new distribution list (see below).
If there is more than one reprinting, use the \SANDrePrintDate command
multiple times. The last one will be used on the cover and title page.
The others are needed for the corresponding distribution lists.
Text Body Commands
The following commands are mandatory and belong inside \begin{document}
and \end{document}.
\SANDmain
This starts the body of the report, usually an introduction, after
the acknowledgments, prefaces, and table of contents. \SANDmain
prints the title of the report again.
At the end of your report, you have to provide a distribution list.
This is done using
\begin{SANDdistribution}
\end{SANDdistribution}
The \SANDditribution command takes an optional CA or NM
like this:
\begin{SANDdistribution}[NM]
Using CA or NM inserts the necessary housekeeping
copies in the distribution list according to the requirements for
each site.
Within the \SANDditribution environment you can use
\SANDdistInternal{1}{9018}{Central Technical Files}{8940-2}
to specify the number of copies, the mail stop, the recipient,
and the organization of an internal distribution.
The following command
\SANDdistInternalM{1}{M9999}{Somone}{0123-4}
can be used for mail channels or other addresses that do not use
mail stops (MS).
For external distributions you can use
\SANDdistExternal{3}{Some Address\\ street\\City, State}
to provide the number of copies and the address of an external
recipient.
The following four commands help automate distribution lists for
special cases. To use them, you need to specify whether this report
uses a California (CA) or New Mexico (NM) distribution list.
\SANDdistCRADA
If this report pertains to CRADA work.
\SANDdistLDRD
If this report pertains to LDRD work.
\SANDdistPatent
If this report has a Patent Caution or Patent Interest.
\SANDdistClassified
If this report is classified. This option must be given between
the external addresses (if any), and the Sandia internal addresses.
Each reprinting requires a new distribution list (without the
housekeeping copies). Use the commands below for each new list.
Keep them in the (date) order of reprintings, just like the \SANDrePrintDate
above.
\begin{SANDreDistribution}
\end{SANDreDistribution}
Document Marking Commands
The commands in this section allow you to place markings in your
SAND report that are required for OUO, Export Controlled, CRADA,
etc. Below are some examples, but since there are so many different
possibilities, you will need to consult Appendix A in "Guide to
Preparing SAND Reports and Other Communication Products". pages 55ff.
and our internal WEB pages to find out what exactly goes where.
The release type goes on the cover and title page, under the SAND number.
The default is "Unlimited Release". You can change it using
\SANDreleaseType{}
The next command places text at the bottom of only the cover page.
The default is "".
\SANDmarkBottomCover{text}
The next command places text at the top and bottom of every page
The default is "".
\SANDmarkTopBottom{text}
The next command places text at the top of every page.
The default is "".
\SANDmarkTop{text}
The next command places text at the bottom of every page
The default is "".
\SANDmarkBottom{text}
The next command places text at the top and bottom of the cover,
back cover, and title page. The default is "".
\SANDmarkTopBottomCoverBackTitle{text}
The next command places text at the top and bottom of the cover
and the title page. The default is "".
\SANDmarkTopBottomCoverTitle{text}
The next command places type and text on the cover
and the title page. type will be in a larger font and bold.
The default is type = "", text = "".
\SANDmarkCoverTitle{type}{text}
\SANDmarkCoverTitle doesn't actually work yet. I don't know
where to put the text on the title page.
The next command places type and text on the cover
page. type will be in a larger font and bold.
The default is type = "", text = "Approved for public
release; further dissemination unlimited."
\SANDmarkCover{type}{text}
Document Marking Examples
These are just examples. You will need to
look up the exact text in Appendix A of
the "Guide to Preparing SAND Reports and
Other Communication Products". pages 55ff,
and the Sandia classifier handbook.
Unlimited Release
That is the default. Under the SAND number
on the cover and the title page, it will
say "Unlimited Release". On the cover page
it will say "Approved for public release;
further dissemination unlimited."
You do not need to use any marking commands
for the default, but the equivalent would be:
\SANDreleaseType{Unlimited Release}
\SANDmarkCover{}{Approved for public release;
further dissemination unlimited.}
Official Use Only
\SANDreleaseType{Official Use Only}
\SANDmarkTopBottom{Official Use Only}
\SANDmarkCover{OFFICIAL USE ONLY}{Contains 6. Personal Privacy Information...}
Export Controlled
\SANDreleaseType{Export Controlled Information}
\SANDmarkBottom{Export Controlled Information}
\SANDmarkCover{EXPORT CONTROLLED INFORMATION}{This product contains technical data...}
CRADA
\SANDreleaseType{Protected CRADA Information}
\SANDmarkCoverTitle{Protected CRADA Information}{This product contains protected CRADA information and was produced...}
\SANDmarkTopBottomCoverBackTitle{Protected CRADA Information}
Top of page
|