%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Sample document for asme.sty
% Copyright (c) 1996 by ASME
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Please refer to section 2 in this document for details about
% using \documentstyle options.
% 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\documentstyle[twocolumn]{asme}
% use the above document style for
% --- 'LaTeX-Times' format or 
% --- 'LaTeX2.09' with the font names changed to Computer Modern 
%        family in the style file. 
% --- 'LaTeX2e' commenting out the definition \def\bi ... 
%        (Search for the string %?% to locate this command)
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%\documentstyle[twocolumn,MathTimes]{asme}
% use the above style with 'LaTeX' format using Times and Mathtimes fonts
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Set the ASME Paper Number below
\def\papernum{0000:0000}
%
%
\begin{document}
%
\newtheorem*{theorem}{Theorem}
\newtheorem{theorem}{Theorem}
%
\setcounter{secnumdepth}{3}
%\markboth{Left running head}{Right running head}
%

\title{Guidelines for using this LaTeX Macro Package:\\
The output of this title is always in
uppercase, no matter how\\
it is typed and the lines are wrapped and centered
automatically,\\
but if you want to specify
your own breaks use two backslashes ($\backslash\backslash$) at the desired 
break point}

\author{First A. Author\thanks{This author receives the correspondence concerning
this paper, unless otherwise specified.}
\affiliation{Postal address I\\ City, State (spelled out), zip code\\
country name\\
Email: author1@asme.org}}

\author{Second B. Author\thanks{Any specific note about the author goes here.}
\affiliation{Postal address II\\ City, State (spelled out), zip code\\
country name\\
Email: author2@company.com}}

\author{Third C. Author\affiliation{Postal address III\\ City, State (spelled out), zip code\\
country name\\
Email: author3@university.edu}}

\author{Fourth D. Author 
\thanks{Do not leave a space (or carriage return)
before this command $\backslash$thanks; 
the footnote marker next to the author name 
will fall after a word space, as it appears here.}
\affiliation{Postal address IV\\ City, State (spelled out), zip code\\
country name\\
Email address (if available)}}

\maketitle

\begin{abstract}
This article describes how to use the \LaTeX{} style sheet and other
electronic files provided by ASME to prepare your paper in electronic
form for inclusion in the 1996 ASME DETC Proceedings on CD.  If you
are preparing a paper for any other ASME conference, comtact ASME for
the standard author kit at {\bf http://www.asme.org} or Barbara
Singorelli at (p) 212-705-7779; (f) 212-705-7841; (e) {\bf
signorellib@asme.org}.  The following files are provided by ASME: {\bf
asme.sty}, the actual \LaTeX{} macro package;   {\bf manual.tex}
which is the file you are currently reading which is a brief tutorial
for using the {\bf asme.sty} macro package (which can also be used
as a templaye); and {\bf manual.ps} which is a PostScript
version of {\bf manual.tex}.  To get the most out of this
document, you should read it in its entirety and also examine the
\LaTeX{} code used to produce it.  If you are a site administrator,
please make this document available to your users in both \LaTeX{} and
PostScript form.  Information below outlines the functions of the
various commands and environments used in the style file {\bf
asme.sty}.  Most of this article consists of brief explanations on the
function of the elements.  However, you might find nonsense text here
and there, inserted whenever the space had to be filled out to
demonstrate the formatted output.

This article is not intended to explain the basics of using \LaTeX{};
instead it is geared to deal with the new commands and environments
that are local to the style file {\bf asme.sty} and features that
are not generally discussed or emphasized in textbooks available on
\LaTeX{}.  Hence the users of the style file and this documentation
are expected to have prior basic knowledge on using \LaTeX{}.
First-time users are recommended to refer to the \LaTeX{} book by
Lamport (1985).
\end{abstract}


\begin{nomenclature}
\entry{$A$}{The first alphabet in English.}
\entry{$a$}{The lower case representation of the first alphabet in
English.}
\entry{$\alpha$}{The first alphabet in Greek.}
\entry{$^{\circ}$}{This tiny superscript circle represents `degree';
this is used to represent temperature as well as the 360th part of the
circumference of a circle.}
\end{nomenclature}

See page 3 for an explanation of how to set up the nomenclature section.


\section*{Fonts and Formats}
\subsection*{Fonts}
The default fonts used by this style file are Times, Helvetica,
Courier, and MathTimes.  Find out the exact name of the font used on
your system.  For example, the roman font of the Times family may be
used under different names like `Times', `Times-Roman', `tir' etc., on
different systems.  So it is important to find out the {\em exact}
name of the font used on your system.

The following definitions are found in the style file:

\begin{verbatim}
\def\textname{Times}%
\def\italname{TimesI}%
\def\boldname{TimesB}%
\def\bfitname{TimesBI}%
\def\slntname{TimesO}%
\def\sansname{Helvetica}%
\def\sfbname{HelveticaB}%
\def\sfiname{HelveticaI}%
\def\sfbiname{HelveticaBI}%
\def\typename{Courier}%
\def\mathsyname{MTSY}%
\def\mathexname{MTEX}%
\def\mathitname{MTMI}%
\end{verbatim}

If any of the font names used above is not found on your system, replace 
with the correct font name.

To use some other font, for example, the sans serif font `Avant Garde'
instead of `Helvetica', define:

\begin{verbatim}
\def\sansname{AvantGarde}%
\def\sfbname{AvantGardeB}%
\def\sfiname{AvantGardeI}%
\def\sfbiname{AvantGardeBI}%
\end{verbatim}

If MathTimes family (MTSY, MTEX, MTMI) is not available use
ComputerModern instead by changing:

\begin{verbatim}
\def\mathsyname{cmsy10}%
\def\mathexname{cmex10}%
\def\mathitname{cmmi10}%
\end{verbatim}

Similarly, any font could be changed, depending on its availability to
you.

Calligraphic fonts are preloaded in the style file and will work fine
with LaTeX-Times format also. The command \verb!{\cal A}!) will
produce a calligraphic `A' ${\cal A}$

Blackboard fonts are also preloaded in the style file.  If the font
msbm10 is not available to you, the font name in the command
\verb!\def\bbname{msbm10}%!\ can be changed.  \verb!{\bb R}! will
produce a blackboard `R' ${\bb R}$.


\subsection*{Formats: LaTeX2.09, LaTeX-Times, LaTeX2e}

\subsubsection*{LaTeX2.09}
To use computer modern fonts with LaTeX2.09 format use the following
definitions in the style file:

\begin{verbatim}
\def\textname{cmr10}%
\def\italname{cmti10}%
\def\slntname{cmsl10}%
\def\boldname{cmbx10}%
\def\bfitname{cmbxsl10}%
\def\sansname{cmss10}%
\def\sfbname{cmssbx10}%
\def\sfiname{cmssi10}%
\def\sfbiname{cmssbx10}%
\def\typename{cmtt10}%
\def\mathsyname{cmsy10}%
\def\mathexname{cmex10}%
\def\mathitname{cmmi10}%
\end{verbatim}

\subsubsection*{LaTeX-Times}
No alteration is needed to the style file if you are using this
format. But if you would like to use MathTimes fonts (MTSY, MTEX,
MTMI) with the LaTeX format, you need to use the MathTimes option in
your documentstyle command:\\
\verb!\documentstyle[twocolumn,MathTimes]{asme}!.

\subsubsection*{LaTeX2e}
This style file is not written for LaTeX2e; however, you could use
LaTeX2e format to compile this style file with the documentstyle\\
\verb!\documentstyle[twocolumn]{asme}!\\ and the output will be set in
Computer Modern.  The \verb!\bi! command for getting bolditalic font
is not available with this format.  Other than the way the fonts are
set up and used, the way the environments and other commands work does
not change with this format.

\section*{Paper Number}
The ASME paper number is set at the beginning of your \LaTeX{} document
with the command \verb!\def\papernum{0000:0000}!.  Replace 0000:0000 with
the number supplied to you by ASME for your paper.

\section*{Title and Author names}
Author names and affiliations are included using the
\verb!\author{...\affiliation{...}}!  macro.  If you would like to
have any footnotes for the title or author names, use \verb!\thanks!
instead of the normal \verb!\footnote! command.

If the paper is written by more than one author, the \verb!\author!
command must be used for each author.  The address of the author must
be placed using the command \verb!\affiliation!, and it should be
inside the \verb!\author! command, like,\\
\verb!\author{...\affiliation{...}}!

If the total number of authors is less than 8, the placement of their
names and addresses will automatically fall by the format specified by
the ASME guideline.  However, you {\em have} to specify the line
breaks with \verb!\\! command for breaking the address.  If the total
number of authors is more than 7, it will still be formatted
automatically, falling in a format depending on the width of the
entries.

The \verb!\maketitle! command should immediately follow the 
\verb!\title! and \verb!\author! commands.

\begin{figure}%1
\figurebox{5pc}{5pc}
\subcaption{This is the caption for the first subfigure}
\figurebox{8pc}{8pc}
\subcaption{This is the caption for the second and the very last subfigure}
\caption{This is a figure with two subparts.}
\end{figure}

\section*{Abstract}
The abstract must be used within the {\bf environment}.
\begin{verbatim}
\begin{abstract}
........
\end{abstract}
\end{verbatim}
And {\it not} as an {\bf argument} with the command
\begin{verbatim}
\abstract{
........
}
\end{verbatim}
The `ABSTRACT' head is generated automatically.


\section*{The Nomenclature Environment}
The nomenclature (as shown after the abstract on page 1 of this
document) is set within the nomenclature environment as shown below:
\begin{verbatim}
\begin{nomenclature}

\entry{...}{....}
\entry{...}{....}
\end{nomenclature}
\end{verbatim}
The command \verb!\entry! takes two arguments, 
the first one being the nomenclature term and the second one being the
definition for the term.  Please refer to the sample shown in this file.
The `NOMENCLATURE' head is generated automatically.


\section*{Headings}
The level 1 heading (\verb!\section*{Name}!) is set automatically in
uppercase, no matter how it is typed. But {\em all other} levels of
headings (\verb!\subsection*{Name}!, \verb!\subsubsection*{Name}!)
must be typed with initial caps only.

{\bi Note:} When using any of the headings, be sure to include the
asterix (*) (as in \verb!\section*{Name}!) if you want to suppress
section and subsection numbering.

\section*{Footnotes in headings\protect\footnotemark}

\footnotetext{This is how a footnote is given in a head.}

If you want to use a footnote in any of the heads, use: (i)~the
commands \verb!\protect\footnotemark!  within the sectioning command,
where you need the footnote mark, and (ii)~the actual footnote text
below the head using the command \verb!\footnotetext{...}!.

\section*{Bold-Italic {\bi BI}}
Bold-Italic font type is available with this style file. If you want
to make something {\bi Bold-Italics}, use the font switching command
\verb!\bi! just like \verb!\it! and \verb!\bf!.


\section*{Math}

To get an unnumbered single-line display equation,
use \verb!\[...\]! or \verb!\begin{equation*}...\end{equation*}!.
\[
a = b + c
\]
or
\begin{equation*}
A = B + C
\end{equation*}
The \verb!{equation*}! feature is available with {\bf asme.sty},
to be consistent with the \verb!{eqnarray*}! style for getting an
unnumbered equation.


\verb!\noalign! is a useful command to align equations with
intervening line of text (please refer to the code used to generate
the following equations):

\begin{eqnarray}
a &=& b + c\\
c + d &=& b\\
\noalign{\noindent and hence}
a &=&  2c + d\\
\noalign{\noindent or}
2b - d &=&  a
\end{eqnarray}

Testing $a + b \times \{c + d\} = (e + f) \cdot -g \ldots h$

\section*{Figures}
The command \verb!\subcaption{}! can be used to get subcaptions with
alphabetic numbering.

Also, the command \verb!\figurebox{width}{height}!  can be used to
draw a box of specified width and height, in case figures need to be
pasted up.

\section*{Tables}
The command \verb!\subcaption{}! is also available with tables.

The command \verb!\x! could be used in the {\tt tabular} argument,
for setting tables on the width of the column. The codes used
for generating Table~1 demonstrate the usage of this command.

Use \verb!\begin{table*}! and \verb!\end{table*}! instead of
\verb!\begin{table}! and \verb!\end{table}! to set tables that
do not fit in a single column.

\begin{table}
\caption{This is a table set to the full text width with its elements
aligned on the decimal and the column centered on the column head.}
{\def~{\phantom{0}}%
\begin{tabular*}{\hsize}{@{}l\x c\x c\x c@{}}
\hline
Column head & Column 1 & Column 2 & Column 3\\\hline
Row 1 & ~0.11~& 2.2~ &6\\
Row 2 & 10.1~~& 3.3~ &7\\
Row 3 & 10.11~& 4.4~ &8\\
Row 4 & 10.111& 5.55 &9\\
\hline
\end{tabular*}}
\end{table}

\begin{theorem}
This is a sample of the theorem environment.  Any environment can be
created with the command; for example, a Corollary environment can be
created with the command\\ \verb!\newtheorem{corollary}{Corollary}!.
\end{theorem}

\begin{theorem}[Optional head]
This is a sample of the theorem environment with an 
optional head.
\end{theorem}

\begin{theorem*}
This is a sample of an unnumbered theorem environment.
Any environment can be created, with the command
\verb!\newtheorem*{}{}!.  Using a * after the
\verb!\newtheorem! creates an unnumbered environment.
\end{theorem*}

\begin{theorem*}[Optional head]
This is a sample of an unnumbered 
theorem environment with an optional head.
\end{theorem*}

\begin{proof}
This is an example of the proof environment.
The command \verb!\qed! must be used 
before the \verb!\end{proof}! command
to get the end of proof box. \qed
\end{proof}

\begin{proof}[Proof of Theorem 1]
This also is an example of the proof environment, but
with an optional argument for using a different 
head.\qed
\end{proof}

\begin{proof}[Remark]
This is an example to show how the proof environment can be
used to format other similar environments. By giving 
the head `Remark' as the optional argument for the 
proof environment, the remark environment is produced. 
\end{proof}

Sample of bullet list:
\begin{itemize}
\item First item
\item Second item
\item Third item
\end{itemize}

\begin{table}
\caption{This is a table set on its natural width with its elements aligned on 
the decimal and the column centered on the column head.}
\centerline{\def~{\phantom{0}}%
\begin{tabular}{@{}lccc@{}}
\hline
Column head & Column 1 & Column 2 & Column 3\\\hline
Row 1 & ~0.11~& 2.2~ &6\\
Row 2 & 10.1~~& 3.3~ &7\\
Row 3 & 10.11~& 4.4~ &8\\
Row 4 & 10.111& 5.55 &9\\
\hline
\end{tabular}}
\end{table}

Sample of number list:
\begin{enumerate}
\item First item
\item Second item
\item Third item
\end{enumerate}

Sample of alphabetic list:
\begin{sequence}
\item First item
\item Second item
\item Third item
\end{sequence}

Sample of roman list:
\begin{enumeroman}
\item First item
\item Second item
\item Third item
\end{enumeroman}

Sample of list with heads:
\begin{description}
\item[Head 1:] First item
\item[Head 2:] This is the second item in the description list
that runs longer than one line to show the format.
\item[Head 3:] Third item
\end{description}

The following is an example for a block quote, where the body of the
quote indents on the left as well as on the right and sets as a block:
\begin{quote}
This is an extract set with the environment
\verb!{quote}!. 

This is the second paragraph of this extract, which is made longer
than one line to show the line breaks and to show that its paragraphs
do not indent.
\end{quote}

The following is an example of another type of quotation, which does
not have any left or right indent but sets as regular text with italic
font:
\begin{quotation}
This is another extract set with the environment
\verb!{quotation}!.

This is the second paragraph of this extract, which is made longer
than one line to show the lines breaks and to show that its paragraphs
do indent.
\end{quotation}
This completes the two ways of setting quotes.

This is the end of the main body of the article.  Now, a sample for an
appendix follows.

\appendix
\section*{First appendix}
\subsection*{First subsection in the first appendix}
The command \verb!\appendix! must be placed before the appendix
section starts.  Basically, this command resets the sectioning
counters and makes the section counter number in uppercase alphabetic
style.

The equation counter is not reset in appendix and the numbers will
follow one sequence from the beginning of the article to the very end.

\subsubsection*{First subsub head with no body}
\subsubsection*{Second subsubsection in appendix}
Just checking to see that the equation numbers follow the same
sequence from the beginning of the article to the end.
\begin{equation}
a = b + c.
\end{equation}
The following is an acknowledgment environment.

\begin{acknowledgment}
Use the environment\\
\verb!\begin{acknowledgment}! and\\
\verb!\end{acknowledgment}!\\
for formatting the acknowledgments section.
\end{acknowledgment}
	
\begin{thebibliography}{}
\bibitem{Leslie}%1
Lamport, L., 1985, {\em \LaTeX{}---A Document Preparation
System---User's Guide and Reference Manual,} Addison-Wesley, Reading.

\bibitem{}
Knuth, D. E., 1986, {\em The \TeX{}book, volume A of Computers and
Typesetting,} Addison-Wesley, Reading.
\end{thebibliography}
\end{document}