summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/asmeconf/asmeconf-template.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/asmeconf/asmeconf-template.tex')
-rw-r--r--macros/latex/contrib/asmeconf/asmeconf-template.tex71
1 files changed, 31 insertions, 40 deletions
diff --git a/macros/latex/contrib/asmeconf/asmeconf-template.tex b/macros/latex/contrib/asmeconf/asmeconf-template.tex
index 81615a54aa..f9860ccbc8 100644
--- a/macros/latex/contrib/asmeconf/asmeconf-template.tex
+++ b/macros/latex/contrib/asmeconf/asmeconf-template.tex
@@ -3,11 +3,11 @@
%% This file is asmeconf-template.tex, a template to format ASME Conference papers according to
%% the requirements on ASME's conference web pages.
%%
-%% This file is version 1.20 dated 2020/11/08
+%% This file is version 1.21 dated 2020/12/10
%%
%% As of version 1.11, this template follows ASME's newer conference guidelines first posted July 2019.
%% The new guidelines have changed the requested author block formatting to be inline.
-%% (This template continues to support the old grid format as a package option.)
+%% (This template continues to support the traditional grid format as a package option.)
%% Nomenclature now follows the abstract. Abstract is in italics.
%%
%% Author: John H. Lienhard V
@@ -71,20 +71,7 @@
%%
%% Copyright (c) 2020 John Lienhard
%%
-%% Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
-%% associated documentation files (the "Software"), to deal in the Software without restriction,
-%% including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
-%% and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
-%% subject to the following conditions:
-%%
-%% The above copyright notice and this permission notice shall be included in all copies or
-%% substantial portions of the Software.
-%%
-%% The software is provided "as is", without warranty of any kind, express or implied, including but
-%% not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement.
-%% In no event shall the authors or copyright holders be liable for any claim, damages or other liability,
-%% whether in an action of contract, tort or otherwise, arising from, out of or in connection with the
-%% software or the use or other dealings in the software.
+%% Offered under the MIT license: https://ctan.org/license/mit
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -163,7 +150,7 @@
%%
%% Abstract should be no more than 200 words
\begin{abstract}
-This paper is an example of and a template for typesetting ASME Conference Papers in {\upshape\LaTeX} using the {\upshape\texttt{asmeconf}} class. This class follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of early 2020. The class is intended to be used with the {\upshape\texttt{asmeconf.bst} \hologo{BibTeX}} style, which is part of this distribution. The class is compatible with the {\upshape\texttt{hyperref}} package, so that pdfs will contain internal and external hyperlinks, pdf bookmarks, and metadata. Links may be colored, for online use, or black, for publication. Section headers may contain mathematics, references, citations, and footnotes. The class enables inline author names, following ASME's current style, but is backward compatible to the traditional block style. The class includes many options, e.g., for math fonts. The class calls a number of packages, all of which are in {\upshape\TeX\ Live} and on CTAN. The class is compatible with {\upshape\hologo{pdfLaTeX}} or {\upshape\hologo{LuaLaTeX}}.
+This paper is an example of and a template for typesetting ASME Conference Papers in {\upshape\LaTeX} using the {\upshape\texttt{asmeconf}} class. This class follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of 2020. The class is intended to be used with the {\upshape\texttt{asmeconf.bst} \hologo{BibTeX}} style, which is part of this distribution. The class incorporates the {\upshape\texttt{hyperref}} package, so that pdfs will contain hyperlinks, bookmarks, and metadata, and references can include the DOI and URL fields. Links may be colored, for online use, or black, for publication. The class enables inline author names, following ASME's current style, but can also produce the traditional grid style. Options include line numbering, final column balancing, various math options, government copyright, and archivability (PDF/A). In addition, section headers may contain mathematics, references, citations, and footnotes. The class is compatible with {\upshape\hologo{pdfLaTeX}} or {\upshape\hologo{LuaLaTeX}}.
\end{abstract}
%%%%%%%%% NOMENCLATURE (OPTIONAL) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -196,19 +183,19 @@ This paper is an example of and a template for typesetting ASME Conference Paper
%%%%%%%%% BODY OF PAPER %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Introduction}
-The \texttt{asmeconf} class file will typeset papers with margins, fonts, headings, captions, and reference formats that follow those specified for conference papers of the American Society of Mechanical Engineers (ASME). Internal and external hyperlinks will be set automatically, and the pdf file will contain bookmarks and metadata. This class is not a publication of ASME.
+The \texttt{asmeconf} class typesets papers with margins, fonts, headings, captions, and reference formats that follow the specifications for conference papers of the American Society of Mechanical Engineers (ASME). In contrast to older ASME \LaTeX\ templates, \texttt{asmeconf} will set internal and external hyperlinks, and the pdf file will contain bookmarks and metadata. Many other useful features have been incorporated. This class is not a publication of ASME, but the author has published in ASME conferences since 1983.
-The \texttt{.tex} file may be written using standard \LaTeX\ commands, although some specific initial commands are needed to format the blocks containing the author[s], title, and abstract. This class loads a number of other packages, all of which are contained in up-to-date versions of \href{https://www.tug.org/texlive/}{\TeX\ Live}, \href{http://www.tug.org/mactex/}{Mac\TeX}, and similar distributions. If you find you are missing one of these packages, you may obtain it at no cost from CTAN (\href{http://ctan.org}{ctan.org}).
+The \texttt{.tex} file may be written using standard \LaTeX\ commands, although some specific initial commands are needed to format the blocks containing the author[s], title, and abstract. This class loads a number of other packages, all of which are contained in up-to-date versions of \href{https://www.tug.org/texlive/}{\TeX\ Live}, \href{http://www.tug.org/mactex/}{Mac\TeX}, and similar platforms. If you find that you are missing one of these packages, you may obtain it at no cost from CTAN (\href{http://ctan.org}{ctan.org}).
\subsection{Essential Initial Commands}
To begin, fill in the fields to be completed at top of the \texttt{asmeconf-template.tex} file. These fields include the headers for your conference and your paper number. Specified metadata will be placed into the pdf file itself.
The title should be placed into \verb|\title{..}|.
-Put author names into the \verb|\SetAuthors{name, name,...}| command in the desired order; follow the syntax illustrated \texttt{asmeconf-template.tex} file. Put each distinct address sequentially into a separate \verb|\SetAffiliation{n}{address}|, where $n = 1,2,\ldots$ Tag each author with the right affiliation by putting \verb|\affil{n}| after that author's name inside the \verb|\SetAuthors{..| command.
+Put author names into the \verb|\SetAuthors{name, name,...}| command in the desired order; follow the syntax illustrated \texttt{asmeconf-template.tex} file. Put each distinct address sequentially into a separate \verb|\SetAffiliation{n}{address}|, where $n = 1,2,\ldots$ Tag each author with an affiliation by putting \verb|\affil{n}| after that author's name inside the \verb|\SetAuthors{..| command.
-Author addresses are to be kept short. List the author institution, and the City, State (US authors), City, Province, Canada (Canadian authors), or City, Country (for other international authors).
+Keep author addresses short. List the author institution, and the City, State (US authors), City, Province, Canada (Canadian authors), or City, Country (other international authors).
-One author (or more) may be designated as the corresponding author by placing \verb|\CorrespondingAuthor{email}| after \verb|\affil{#}|. Two or more authors may be joint first authors by putting \verb|\JointFirstAuthor| after \verb|\affil{#}|.
+One author (or more) may be designated as the corresponding author by placing \verb|\CorrespondingAuthor{email}| after \verb|\affil{n}|. Two or more authors may be joint first authors by putting \verb|\JointFirstAuthor| after \verb|\affil{n}|.
After setting up the headers, authors, and title, issue the \verb|\maketitle| command.
@@ -350,7 +337,8 @@ Landscape figures and tables may be produced at full-page size by putting \verb|
\section{Reference Formatting with \NoCaseChange{\texttt{asmeconf.bst}}\footnote{If you have text in a section heading or caption that you do not want to be capitalized, such as an SI unit, enclose it in a \texttt{\textbackslash NoCaseChange} command.}}\label{sec:references}
-The {\upshape\texttt{asmeconf.bst}} \hologo{BibTeX} style follows the reference styles shown on ASME's conference web site in early 2020. Examples for these and many other cases are given in the \texttt{asmeconf-sample.bib} file, which is part of this distribution. Citations and references are managed by the standard \texttt{natbib} package. Nevertheless, a few comments are necessary.
+The {\upshape\texttt{asmeconf.bst}} \hologo{BibTeX} style follows the reference styles shown on ASME's conference web site in 2020.\footnote{\texttt{asmeconf.bst} is intended as a replacement for the old \texttt{asmems4.bst}, which does not follow ASME's current reference formats or support DOI and URL.}
+Examples for these and many other cases are given in the \texttt{asmeconf-sample.bib} file, which is part of this distribution. Citations and references are managed by the standard \texttt{natbib} package. Nevertheless, a few comments are necessary.
%% sub-subsections should *not* be numbered
@@ -358,13 +346,13 @@ The {\upshape\texttt{asmeconf.bst}} \hologo{BibTeX} style follows the reference
Elementary support for \texttt{eprint} numbers is also included, generating a url at the end of the citation. The \texttt{archive} type may be specified using the macros \texttt{arxiv, googlebooks, hdl, jstore, oclc}, or \texttt{pubmed} (e.g., \texttt{archive=hdl}, \textit{without} braces). Both \texttt{eprint} and \texttt{archive} fields \textit{must} be given. Other root urls may be invoked using \verb|archive = {http://another.url.org/}|.
-\subsubsection*{Online Sources} A bibliography field \verb|@online{..| is included for citation of online sources, such as web pages. A \texttt{url} or \texttt{eprint} with \texttt{archive} must be included. See the examples of use in the \texttt{asmeconf-sample.bib} file.
+\subsubsection*{Online Sources} A bibliography entry \verb|@online{..| is included for citation of online sources, such as web pages. A \texttt{url} or \texttt{eprint} with \texttt{archive} must be included. See the examples of use in the \texttt{asmeconf-sample.bib} file.
\subsubsection*{Date Accessed} The \verb|urldate={..}| field may be used to provide the date on which a given url was accessed. By default, the text printed will be \texttt{Accessed `date',}. The word ``Accessed'' may be changed using the \verb|urltype={..}| field.
\subsubsection*{Conference Location and Date} For the entry types \verb|@inproceeedings{..| and \verb|@proceeedings{..|, you may include \verb|venue={..}| and \verb|eventdate={..}| to specify the city and the date of a conference.
-\subsubsection*{Capitalization of Titles} ASME's bibliography style requires that document titles be in title case. The first letters of principal words are capitalized. Do this when writing the \texttt{.bib} file.
+\subsubsection*{Capitalization of Titles} ASME's bibliography style requires that document titles be in title case. The first letters of principal words are capitalized. Do this in the \texttt{.bib} file.
@@ -455,25 +443,25 @@ This package will attempt to give equal height to the two columns on the last pa
The \texttt{lineno} package is not compatible with the \texttt{flushend} package that makes final short columns the same height. Balancing is automatically disabled when this option is called.
+\subsection{Grid-Style Author Block} The option \texttt{[authorgrid]} invokes ASME's grid-style arrangement of author names. The authors and affiliations must be entered differently in this case. See Appendix \ref{appendix:b} for usage.
+
\subsection{Changing the Copyright Footer} The option \texttt{[nofoot]} will omit the ASME copyright from the page footer. The option \texttt{[govt]} will produce a copyright notice for authors who are employees of the U.\ S.\ Government. The option \texttt{[contractor]} will produce a copyright
notice for authors who are employed by a U.\ S.\ Government contractor.
The footers are generated with the \texttt{fancyhdr} package~\cite{oostrum}, so you can change them in any way you like using the commands of that package. Only the default arrangement of footers matches ASME's style, however.
-\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (both numbers and letters) for use in footnote markers and superscripts. To enable this font, use the option \texttt{[nodefaultsups]}.
+\subsection{Archivability:~PDF/A} Compliance with PDF/A standards can be enabled using the option \texttt{[pdf-a]}
+when running with \hologo{pdfLaTeX}. The default setting is for PDF/A-3u with sRGB OutputIntent (\texttt{sRGB.icc}).
+If levels 1b, 2b, 2u, or 3b are preferred, use the options \texttt{[pdfapart=1 or 2 or 3]} and
+\texttt{[pdfaconformance=b or u]}. Note that accessible conformance~(\texttt{a}) is not currently possible with \LaTeX.
-\subsection{Grid-Style Author Block} The option \texttt{[authorgrid]} invokes ASME's grid-style arrangement of author names. The authors and affiliations must be entered differently in this case. See Appendix \ref{appendix:b} for usage.
+\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (both numbers and letters) for use in footnote markers and superscripts. To enable this font, use the option \texttt{[nodefaultsups]}.
\subsection{Hyphenation of Typewriter Font} The option \texttt{[hyphenate]} will allow hyphenation of the typewriter font.
-Hyphenation is normally suppressed for typewriter mode because this font is often used for code.
+Hyphenation is normally suppressed for typewriter mode because this font is often used for computer code.
\subsection{Support for Other Languages} The package can be adapted to incorporate (or entirely use) languages other than English. See Appendix \ref{appendix:c} for details.
-\subsection{Archivability:~PDF/A} Compliance with PDF/A standards can be enabled using the option \texttt{[pdf-a]}
-when running with \hologo{pdfLaTeX}. The default setting is for PDF/A-3u with sRGB OutputIntent (\texttt{sRGB.icc}).
-If levels 1b, 2b, 2u, or 3b are preferred, use the options \texttt{[pdfapart=1 or 2 or 3]} and
-\texttt{[pdfaconformance=b or u]}. Note that accessible conformance~(\texttt{a}) is not currently possible with \LaTeX.
-
%%%%% Conclusions %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -511,7 +499,7 @@ Place any acknowledgments here.
\section[The Vector Product A\times B]{The vector product $\vec{A}\times\vec{B}$}\label{appendix:a}
This brief illustration of an appendix shows the numbering of the appendix and equations. Equations are numbered
-consecutively, following those in the paper.
+consecutively, following those in the paper. Consider $\rho \neq \textrm{fn}(p)$:
\begin{align}
\frac{d\Gamma}{dt} &{}= \frac{d}{dt} \int_{\mathcal{C}} \mathbf{u} \cdot d\mathbf{r}\\
&{}= \int_{\mathcal{C}} \frac{D\mathbf{u}}{Dt} \cdot d\mathbf{r} + \underbrace{\int_{\mathcal{C}} \mathbf{u}\cdot d\biggl( \frac{d\mathbf{r}}{dt}\Biggr)}_{=\, 0} \\[-2pt]
@@ -519,7 +507,6 @@ consecutively, following those in the paper.
&{}= \iint_{\mathcal{S}} \nabla p \times \nabla \left( \frac{1}{\rho}\right) \cdot d\mathbf{A}
\end{align}
-
\section{Option to Use an Author Grid}\label{appendix:b}
ASME's most recent templates place author names inline, with affiliations for all authors in rows below.
@@ -551,11 +538,11 @@ subsequent row.
\section{Language Support}\label{appendix:c}
ASME publishes in English, but the \texttt{babel} package is loaded for
-users who may wish to include other languages. Options are supported to load a primary language, \texttt{lang=},
-as well as a secondary and tertiary language, \texttt{lang-second} and \texttt{lang-third}.
+users who may wish to include other languages. Class options allow loading a primary language, \texttt{lang=},
+as well as secondary and tertiary languages, \texttt{lang-second} and \texttt{lang-third}.
The primary language must be specified explicitly if a secondary language is loaded.
-If no language option is given, the package defaults to English. An example of use is
-shown in \selectlanguage{french}\appendixname\ \ref{app:fourier}.\selectlanguage{english}
+If no language option is given, the package defaults to English. An example of including a passage in French is
+shown in \selectlanguage{french}{\appendixname\ \ref{app:fourier}.\selectlanguage{english}
The standard caption and section names will follow \texttt{babel}'s dictionary for primary languages other than English. Users may additionally change ``Keywords'', ``Nomenclature'', ``Corresponding author'', and ``Joint first authors'' by renewing the commands \verb|\keywordname|, \verb|\nomname|, \verb|\CAwords|, and \verb|\JAwords|. Changes to the page footer were described earlier. The pdf bookmark for ``Appendices'' may be changed by renewing \verb|\appendicesname|.
@@ -564,7 +551,7 @@ Font encoding is set to T1 with utf-8 input supported:
\typeout{If you have trouble with the next line, your file may not be saved in utf-8 format. You can delete that line to resolve the issue.}
àáâäæãåā èéęëêēė îïíīįì ôöòóœøōõ ûüùúū çćč ł ñń ßśš ÿ žźż.
-No effort has been made to support customization of language-specific fonts, although this is possible by modifying the class file (examples are given in the \texttt{newtx} documentation). The bibliography style, \texttt{asmeconf.bst}, is designed in English and aimed at \hologo{BibTeX}. Multilingual bibliographies can be supported using \texttt{BibLaTeX}.
+The \texttt{substitutefont} package \cite{milde} may be loaded in the preamble to enable the selection of language-specific fonts. Examples for Greek and Cyrillic are included in that package's documentation. The bibliography style, \texttt{asmeconf.bst}, is designed in English and aimed at \hologo{BibTeX}. Multilingual bibliographies can be supported using \texttt{BibLaTeX}.
\selectlanguage{french}
\section{Discours Préliminaire de Fourier}\label{app:fourier}
@@ -575,6 +562,10 @@ La chale ur pénètre, comme la gravité, toutes les substances de l'univers, se
\selectlanguage{english}
+\textsc{Translation:} \textit{Primary causes are unknown to us; but are subject to simple and constant laws, which may be discovered by observation, the study of them being the object of natural philosophy}.
+
+\textit{Heat, like gravity, penetrates every substance of the universe, its rays occupy all parts of space. The object of our work is to set forth the mathematical laws which this element obeys. The theory of heat will hereafter form one of the most important branches of general physics}.
+
\end{document}