summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-02-15 23:58:36 +0000
committerKarl Berry <karl@freefriends.org>2013-02-15 23:58:36 +0000
commitaeb928a24790407db5779d28c62f6c514619cdaa (patch)
treef0d5a88ea417a03816f38dc440c6631c2db8dc51 /Master/texmf-dist/doc/latex
parentc1a3181be2e0466144b193df768e3fd64eaa6106 (diff)
ascelike (15feb13)
git-svn-id: svn://tug.org/texlive/trunk@29129 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/ascelike/README3
-rw-r--r--Master/texmf-dist/doc/latex/ascelike/ascexmpl.pdfbin266457 -> 115879 bytes
-rw-r--r--Master/texmf-dist/doc/latex/ascelike/ascexmpl.tex176
3 files changed, 125 insertions, 54 deletions
diff --git a/Master/texmf-dist/doc/latex/ascelike/README b/Master/texmf-dist/doc/latex/ascelike/README
index 84b71c13cbc..45fa6a097f0 100644
--- a/Master/texmf-dist/doc/latex/ascelike/README
+++ b/Master/texmf-dist/doc/latex/ascelike/README
@@ -2,7 +2,8 @@ Unofficial LaTeX class and bibliography style-files for ASCE documents
(Amer. Soc. of Civil Engineers), both journal manuscripts and camera-ready
manuscripts for conference proceedings
-Version 2.2, Dec. 16, 2011
+ascelike.cls - Version 2.3, Feb. 14, 2013
+ascelike.bst - Version 2.2, Feb. 14, 2013
The package is freely available under the LaTeX Project Public License,
version 1.1
diff --git a/Master/texmf-dist/doc/latex/ascelike/ascexmpl.pdf b/Master/texmf-dist/doc/latex/ascelike/ascexmpl.pdf
index 4b00bf31e45..4cefa7a5fc8 100644
--- a/Master/texmf-dist/doc/latex/ascelike/ascexmpl.pdf
+++ b/Master/texmf-dist/doc/latex/ascelike/ascexmpl.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/ascelike/ascexmpl.tex b/Master/texmf-dist/doc/latex/ascelike/ascexmpl.tex
index 82fc527dcfd..7b44031a8ec 100644
--- a/Master/texmf-dist/doc/latex/ascelike/ascexmpl.tex
+++ b/Master/texmf-dist/doc/latex/ascelike/ascexmpl.tex
@@ -1,7 +1,7 @@
%
-\documentclass[Journal]{ascelike}
+\documentclass[Proceedings]{ascelike}
%
-% Dec. 16, 2011
+% Feb. 14, 2013
%
% Some useful packages...
%
@@ -19,8 +19,9 @@
%
%
% NOTE: Don't include the \NameTag{<your name>} if you have selected
-% the NoPageNumbers option: this leads to an inconsistency.
-\NameTag{Kuhn, Dec. 16, 2011}
+% the NoPageNumbers option: this leads to an inconsistency and
+% a warning, and the NameTag is ignored.
+\NameTag{Kuhn, Feb. 14, 2013}
%
%
\begin{document}
@@ -30,6 +31,8 @@
%
\author{
Matthew R. Kuhn%
+%
+% ---- The first of two styles for addresses: using footnotes and \thanks ----
\thanks{
Dept.\ of Civil Engrg.,
Donald P.\ Shiley School of Engrg., Univ.\ of Portland,
@@ -37,17 +40,29 @@ Donald P.\ Shiley School of Engrg., Univ.\ of Portland,
Portland, OR 97203. E-mail: kuhn@up.edu.},
\ Member, ASCE
%
-% Here, we add a second author with the same affiliation
-%% \\
-%% Ima Colleague,\footnotemark[1] Member, ASCE%
-%
-% I have found that the \and command doesn't quite work, so just use "and"
-% such as the following (and don't forget the ending curly brace `}').
-%\\
-%and
-%Younyee Kuhn%
-%\thanks{Flourishing wife of same.},%
-%\ Not a Member, ASCE
+% Adding a second author with the same affiliation (still using \thanks):
+% \\
+% Ima Colleague,\footnotemark[1] Member, ASCE%
+%
+% Adding another author with a different affiliation. I have found that
+% the \and command doesn't quite work, so just use "and", as in the following
+% \\
+% and
+% Younyee Kuhn%
+% \thanks{Flourishing wife of same.},%
+% \ Not a Member, ASCE
+%
+% ---- The second of two styles for addresses: below names, no footnotes ----
+%
+% For this style, don't use \thanks. Instead, use superscripts and carriage
+% returns ("\\"). It's not pretty, but neither is the new ASCE proceedings
+% style. Something like the following:
+%
+% Matthew R. Kuhn$^1$, Member, ASCE\\[1ex]%
+%
+% $^1$\parbox[t]{5.75in}{Dept.\ of Civil Engrg.,
+% Donald P.\ Shiley School of Engrg., Univ.\ of Portland,
+% 5000 N.\ Willamette Blvd., Portland, OR 97203. kuhn@up.edu.}
}
%
\maketitle
@@ -55,7 +70,7 @@ Portland, OR 97203. E-mail: kuhn@up.edu.},
\begin{abstract}
This document was produced with the \LaTeX\ typesetting program
using the document class ``\texttt{ascelike.cls}'' and the
-example document ``\texttt{ascexmpl.tex}''.
+example file ``\texttt{ascexmpl.tex}''.
The reference section on page~\pageref{section:references}
was produced with the \textsc{Bib}\TeX\ style ``\texttt{ascelike.bst}''
and the database ``\texttt{ascelike.bib}''.
@@ -63,8 +78,8 @@ The objective of these files is manuscripts that roughly comply with the
guidelines of the American Society of Civil Engineers.
The document class
produces either double-spaced manuscripts for journal submissions or
-camera-ready manuscripts
-for conference proceedings.
+manuscripts for conference proceedings, either in ASCE's older or newer
+styles.
This document serves as a brief guide to \texttt{ascelike.cls},
as well as a test of the output that is produced
by the input file \texttt{ascexmpl.tex}.
@@ -75,21 +90,25 @@ Project Public License, version 1.1
% Some keywords, using a new command: \KeyWords{}
%
\KeyWords{\LaTeX, ASCE, document class,
- ascelike.cls~(version 2.2),
- ascelike.bst~(version 2.1).}
+ ascelike.cls~(version 2.3),
+ ascelike.bst~(version 2.2).}
%
\section{Introduction}
-The document class ``\texttt{ascelike.cls}''
+The class file ``\texttt{ascelike.cls}''
produces manuscripts that roughly comply with the
guidelines of the American Society of Civil Engineers (ASCE).
The \texttt{ascelike.cls} document class, the
bibliographic style \texttt{ascelike.bst}, and
example files are available on the \texttt{ctan}
web-site \cite{Kuhn:2011a}.
-Although it is \emph{not} produced by ASCE, its agents,
+Although the files are \emph{not} produced by ASCE, its agents,
or employees, \texttt{ascelike.cls} is now referenced on
the ASCE web-site.
\par
+This document was created from the file
+``\texttt{ascexmpl.tex}'', which also serves to test the
+\texttt{ascelike.cls} and \texttt{ascelike.bst} system.
+\par
The program \texttt{ascelike.cls} is distributed under the
terms of the LaTeX Project Public License Distributed,
available from the CTAN archives;
@@ -112,17 +131,17 @@ supplementary files:
\end{itemize}
\emph{Without these files,} \texttt{ascelike.cls} \emph{won't work}.
These files are typically included in \LaTeX\ distributions, such as the
-\textsf{TexLive} and \textsf{MikTex} distributions.
-All of these files are also freely available
+\textsf{TexLive}, \textsf{MikTex}, and \textsf{MacTex} distributions.
+All of these files are freely available
from the Comprehensive \TeX\ Archive Network (CTAN) archive,
through \verb+http://www.ctan.org+ or
\verb+http://www.tug.org+, although they may need to be unbundled from
-a \verb+*.dtx+ form.
+a \verb+*.dtx+ file.
If one of these files is not installed as part of your \TeX\ system,
then download the file from the CTAN archive and place it in the same folder
as your manuscript files.
On Debian GNU/Linux systems, the \texttt{setspace.sty}
-file is part of the \texttt{texlive-latex-recommended} package;
+file is part of the \texttt{texlive-latex-re\-com\-mended} package;
the \texttt{endfloat.sty}
file is part of the \texttt{texlive-latex-extra} package;
and the \texttt{lineno.sty}
@@ -133,7 +152,8 @@ the file \texttt{ascelike.bst} can be used with
the bibliographic tool \textsc{Bib}\TeX\ to produce ASCE-like
reference citations and entries (with the weird use of
quotation marks around titles, etc.) \cite{Kuhn:2011a}.
-An example bibliographic data base is given in \texttt{ascexmpl.bib}.
+An example bibliographic data base is given in the
+supplementary file \texttt{ascexmpl.bib}.
\par
In addition to these essential files,
we have found the following packages very useful:
@@ -157,28 +177,29 @@ ampersand ``\&'' symbols with web addresses.
%
All of these packages are freely
available from the CTAN archive,
-but they are also included in most \LaTeX\ distributions.
+and they are included in most \LaTeX\ distributions.
%
\section{Input and Options}
You should
prepare your \verb+*.tex+ input file as a regular
\LaTeX\ file using the standard \texttt{article.cls} constructs,
-but, of course, substitute \texttt{ascelike} for \texttt{article}
+but, of course, substituting \texttt{ascelike} for \texttt{article}
in the opening \verb+\documentclass+ command.
You will likely need to specify a number of options as described below.
In addition, \texttt{ascelike} provides two new commands: \verb+KeyWords+ and
\verb+NameTag+, both of which are described further below.
\par
-Document class \texttt{ascelike.cls} provides the options given
+The document class \texttt{ascelike.cls} provides several options given
below.
-The \verb+Proceedings|+\-\verb+Journal+ options are the most important;
+The \verb+Proceedings|+\-\verb+Journal|+\-\verb+NewProceedings+
+option is the most important;
the other options are largely incidental.
%
\begin{enumerate}
\item
Options
-\verb+Journal|+\verb+Proceedings+ specify the overall format
-of the output man\-u\-script.
+\verb+Journal|+\verb+Proceedings|+\verb+NewProceedings+ specify the overall
+format of the output man\-u\-script.
\par
\texttt{Journal} produces double-spaced manuscripts for ASCE journals.
As default settings, it places tables and figures at the end of the manuscript
@@ -190,11 +211,13 @@ It also numbers the appendices with Roman numerals and produces
proper headings for
sections, subsections, subsubsections, appendices, and abstract.
It produces the proper page margins and numbers the pages.
+%
\par
-\texttt{Proceedings} produces camera-ready single-spaced manuscripts
-for most ASCE conference proceedings.
+\texttt{Proceedings} produces older-style camera-ready single-spaced
+manu\-scripts for ASCE conference proceedings.
+The newer ASCE style is enacted with the \verb+NewProceedings+ option.
As default settings,
-it places figures and tables within the text.
+\verb+Proceedings|+ places figures and tables within the text.
It does not place line numbers within the left margin.
Pages are numbered, and the bottom left corner can be ``tagged'' with
the author's name (this can be done by inserting the command
@@ -202,20 +225,46 @@ the author's name (this can be done by inserting the command
document).
All of these default settings can be altered with the options that are
described below.
-It also produces the proper page margins as
+\verb+Proceedings|+ also produces the proper page margins as
given on the old shiny,
camera-ready paper (with the light blue lines)
supplied by ASCE.
It produces proper headings for
sections, subsections, subsubsections, appendices, and the abstract.
+%
+\par
+\texttt{NewProceedings} produces newer-style single-spaced
+manu\-scripts for ASCE conference proceedings, as shown on the
+ASCE website (\emph{ca.} 2013).
+The older ASCE style is enacted with the \verb+Proceedings+ option.
+As default settings,
+\verb+NewProceedings+ places figures and tables within the text.
+It does not place line numbers within the left margin.
+Pages are not numbered.
+If desired, the bottom left corner can be ``tagged'' with
+the author's name (this can be done by inserting the command
+\verb+\NameTag{<+\emph{your name}\verb+>}+ within the preamble of your
+document).
+All of the default settings can be altered with the options that are
+described below.
+\verb+NewProceedings+ also produces the proper page margins as
+specified by ASCE.
+It produces proper headings for
+sections, subsections, subsubsections, appendices, and the abstract.
+To create author addresses that do \emph{not} appear as footnotes,
+use the kluge that is described on page~\pageref{address.kluge}
+and in this \texttt{ascexmpl.tex} example.
+%
\item
Options \verb+BackFigs|InsideFigs+ can be used to override
the default placement of tables
-and figures in the \texttt{Journal} and \texttt{Proceedings} formats.
+and figures in the \texttt{Journal}, \texttt{Proceedings}, and
+\texttt{NewProceed\-ings} formats.
\item
Options \verb+SingleSpace|DoubleSpace+ can be used to override
the default text spacing in the
-\texttt{Journal} and \texttt{Proceedings} formats.
+\texttt{Journal}, \texttt{Proceedings}, and
+\texttt{NewProceedings} formats.
\item
Options \verb+10pt|11pt|12pt+ can be used to override the
default text size (12pt).
@@ -249,15 +298,16 @@ a paper. Note, however, that the starred form will not suppress
the numbering of subsections or subsubsections.
\item
The options \verb+NoLineNumbers|LineNumbers+ can be used to override
-the default use (or absence) of line numbers in the \texttt{Journal}
-and \texttt{Proceedings}.
+the default use (or absence) of line numbers in the \texttt{Journal},
+\texttt{Proceedings}, and
+\texttt{NewProceedings} formats.
\end{enumerate}
%
\section{Sections, subsections, equations, etc.}
This section is included to explain and to
test the formating of sections, subsections,
subsubsections, equations, tables, and figures.
-Section heads are automatically made uppercase, which is great unless
+Section heading are automatically made uppercase, which is great unless
your section heading contains mathematics, \verb+$<math stuff>$+.
If a heading does contain mathematics, you will need to modify
\texttt{ascelike.cls}, in particular the line containing the
@@ -325,19 +375,25 @@ Assembly size & $54D_{50} \times 54D_{50} \times 54D_{50}$ \\
%
Notice that the caption of Fig.~\ref{fig:box_fig} contains
a citation of a bibliographic item \cite{Stahl:2004a}.
-This can lead to the following errors:
+This can lead to the following error message:
\begin{verbatim}
-! Illegal parameter number in definition of \reserved@a.
-! Missing control sequence inserted
+ ! Illegal parameter number in definition of \reserved@a.
+ ! Missing control sequence inserted
\end{verbatim}
These errors are avoided by protecting citations within captions,
-as \verb|\protect\cite{...}|.
+with the command \verb|\protect\cite{...}|.
%
\par
-A new command \verb+\KeyWords{<your key words>}+ can be used to produce
+The command \verb+\KeyWords{<your key words>}+ can be used to produce
a labeled list of key words.
It can be placed anywhere in the document and produces an unindented
paragraph of keywords at that location.
+\par
+The command \verb+\NameTag{<+\emph{your name}\verb+>}+ can be placed
+within the preamble of your document, which will produce a name
+and date tag in bottom left corner of the page.
+Do not use \verb+\NameTag+ in combination with the \verb+NoPageNumbers+
+option, as the former will be ignored.
%
\section{Citations and bibliographic entries}
When used together, \texttt{ascelike.cls} and \texttt{ascelike.bst}
@@ -441,7 +497,7 @@ in the \texttt{.bib} file:
\end{verbatim}
%
\section{Miscellany}
-Many ASCE conference proceedings are now published on CD ROM media.
+Most ASCE conference proceedings are now published on CD ROM media.
I have noticed that instructions on paper formats issued by
conference organizers often differ from the
standard ASCE instructions.
@@ -453,15 +509,29 @@ making any changes to \texttt{ascelike.cls}.
(See the \LaTeX\ book
\cite{Lamport:1994a}, its companion \cite{Goossens:1994a}, or
online web documentation.)
+%
\par
-Authors' addresses can be placed below the title (instead of
-in a footnote) by \emph{not} using the \verb+\thanks+ command.
Multiple authors from the same institution can be handled within
-the \verb|\author{...}| command by using the \verb|\footnotemark| command:
+the \verb|\author| \verb|{...}| command by using the \verb|\footnotemark| command:
\begin{verbatim}
-\\
-Ima Colleague,\footnotemark[1] Member, ASCE%
+ \\
+ Ima Colleague,\footnotemark[1] Member, ASCE%
\end{verbatim}
+%
+\par\label{address.kluge}
+Authors' addresses can be placed below the title (instead of
+in a footnote) by \emph{not} using the \verb+\thanks+ command,
+replacing it with superscripts \verb+$^1$+, carriage returns
+``\verb+\\+'', and \verb+\parbox+'s.
+An example is shown in the \texttt{ascexmpl.tex} file.
+%
+\section{Wish List}
+I would like to enable the \texttt{a4paper} option and could use some
+advice about passing this option to \texttt{article} so that the
+\texttt{article.cls} commands for \verb+\paperheight+ and \verb+\paperwidth+
+are executed. I am also uncertain about using \texttt{a4paper} as
+a Boolean to set page margins.
+%
\pagebreak
%
%