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.tex130
1 files changed, 75 insertions, 55 deletions
diff --git a/macros/latex/contrib/asmeconf/asmeconf-template.tex b/macros/latex/contrib/asmeconf/asmeconf-template.tex
index c45170adb3..84eecfb071 100644
--- a/macros/latex/contrib/asmeconf/asmeconf-template.tex
+++ b/macros/latex/contrib/asmeconf/asmeconf-template.tex
@@ -4,7 +4,7 @@
%% This file is asmeconf-template.tex, a LaTeX template to format ASME Conference papers according to
%% the requirements on ASME's conference web pages, and including hypertext support for the pdf.
%%
-%% This file is version 1.36 dated 2023/12/28
+%% This file is version 1.37 dated 2024/02/06
%%
%% As of version 1.11, this template defaults to ASME's newer conference guidelines first posted July 2019.
%% Those guidelines changed the requested author block formatting to be inline.
@@ -18,15 +18,6 @@
%%
%% Class options include:
%%
-%% * Math options from M. Sharpe's newtxmath package: upright integrals [upint];
-%% * [varvw] for a v and w that are better distinguished from Greek nu; and also
-%% * [subscriptcorrection, smallerops, varg, frenchmath, varbb, cmbraces, slantedGreek,...]
-%% * See newtx documentation for descriptions (at CTAN: http://ctan.org, v1.6 or higher is best).
-%%
-%% * Options to: omit the ASME copyright footer [nofoot];
-%% * use government employee copyright notice [govt];
-%% * use government contractor copyright notice [contractor]
-%%
%% * An option to use the traditional grid arrangement of author names [grid].
%% * With this option, line breaks (\\) may be inserted into the address as needed.
%% * Author names that include commas should be enclosed in braces, e.g., {Joseph L. Smith, Jr.}.
@@ -43,20 +34,32 @@
%% * just leave a blank line above the displayed equation while you are editing and then remove the
%% * blank line and [lineno] option when you move to your final version.
%%
+%% * An option not to use boldface font for caption text [unboldcaption]
+%%
+%% * Options to: omit the ASME copyright footer [nofoot];
+%% * use government employee copyright notice [govt];
+%% * use government contractor copyright notice [contractor]
+%% * use copyright notice for some gov't employees [somegovt]
+%%
%% * Options for PDF/A compliance. [pdf-a] will produce PDF/A-3u compliance with sRGB OutputIntent.
%% * [pdfapart= 1 or 2 or 3] and [pdfaconformance= b or u] can enable levels 1b, 2b, 2u, and 3b.
-%% * The most recent versions of LaTeX (2021 and later) are moving toward integrated support for pdf-a,
-%% * through \DeclareDocumentMetadata{..}. The asmeconf class supports these new features, which can
-%% * replace the aforementioned class options. (An up-to-date LaTeX installation is required to use this.)
+%% *
+%% * The most recent versions of LaTeX (2021 and later) have adopted integrated support for pdf-a,
+%% * through \DeclareDocumentMetadata{..}. The asmeconf class supports these features, which are preferred
+%% * to the aforementioned class options. (An up-to-date LaTeX installation is required to use this.)
%%
%% * Many options for calligraphic, script, and fraktur fonts from the mathalfa package; the
-%% * example shown here is: [mathalfa=cal=boondoxo] to use a Boondox font for \mathcal.
+%% * example shown here is: [mathalfa=cal=boondoxo] to use the Boondox font for \mathcal.
%% * Some other options for cal are: dutchcal, zapfc, cm (default), euler,...
%% * frak (fraktur), bb (blackboard bold), scr (script) may also be chosen this way.
-%% * For details, refer to mathalfa documentation (at CTAN: http://ctan.org).
+%% * For details, refer to mathalfa documentation (at CTAN: https://www.ctan.org/pkg/mathalpha).
+%%
+%% * Math options from M. Sharpe's newtxmath package: upright integrals [upint];
+%% * [varvw] for a v and w that are better distinguished from Greek nu; and also
+%% * [subscriptcorrection, smallerops, varg, frenchmath, varbb, cmbraces, slantedGreek,...]
+%% * See newtx documentation for descriptions (at CTAN: https://www.ctan.org/pkg/newtx, v1.6 or higher is best).
%%
-%% * Option to use superiors font from newtxtext for footnotes [nodefaultsups] and
-%% * for slightly larger small capitals, [largesc], also from newtxtext.
+%% * Option to for slightly larger small capitals, [largesc], from newtxtext package.
%%
%% * An option to allow hyphenation of the typewriter font [hyphenate], from inconsolata package.
%% * Hyphenation is normally suppressed for typewriter mode because it is often used for code.
@@ -65,8 +68,11 @@
%%
%% * Options (used by the babel package) to include passages in languages other than English (e.g., a translation
%% * of the abstract). Languages are called as options, e.g. [french], [spanish], [greek], [russian], etc.
-%% * Language support is greatest when running LuaLaTeX with the [fontspec] option.
-%% * See Appendix B for details.
+%% * See Appendix B for details.
+%% * Language support is most extensive when running LuaLaTeX, which automatically loads fontspec, but
+%% * be aware that you may to install additional fonts on your system to use fontspec.
+%% *
+%% * To use LuaLaTeX without bothering about extra fonts, use the [nofontspec] option to asmeconf.
%%
%% The use of commands defined or modified by the asmeconf class is illustrated throughout this file. In particular,
%% ASME requires capitalized, sans-serif section headings, and as a result some care is needed when using macros
@@ -78,16 +84,16 @@
%%
%% LICENSE:
%%
-%% Copyright (c) 2023 John H. Lienhard
+%% Copyright (c) 2024 John H. Lienhard
%%
%% Offered under the MIT license: https://ctan.org/license/mit
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% RECOMMENDED newpdf management code (June 2022).
-%% This addition the LaTeX kernel was recently made by the LaTeX Project team
-%% see https://www.latex-project.org/news/latex2e-news/ltnews35.pdf
-%% Uncomment the next lines and omit the option [pdf-a] if you are using an up-to-date LaTeX platform
+%% STRONGLY RECOMMENDED new pdf management code follows.
+%% This addition the LaTeX kernel was made in June 2022 by the LaTeX Project team.
+%% https://www.latex-project.org/news/latex2e-news/ltnews35.pdf
+%% Uncomment the next lines and omit the option [pdf-a] from \documentclass[...]{asemconf}
%\DocumentMetadata{%
% pdfstandard=A-3b,% A-2b, A-2u, A-3b, or A-3u (don't use u options with LuaLaTeX)
@@ -102,7 +108,7 @@
%% Remove the [colorlinks] option before *final* submission to ASME, to get black text for printing,
%% but keep that option for other uses.
-\documentclass[balance,upint,subscriptcorrection,varvw,mathalfa=cal=boondoxo,spanish,french,vietnamese,russian,greek,pdf-a,colorlinks]{asmeconf}
+\documentclass[pdf-a,balance,colorlinks,upint,subscriptcorrection,varvw,mathalfa=cal=boondoxo, spanish,french,vietnamese,russian,greek]{asmeconf}
%%%%% pdf metadata %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -123,11 +129,11 @@
% You can comment these out if for some reason you don't want a header.
% Use title case (first letters capitalized), not all capitals
-\ConfName{Proceedings of the ASME 2023\linebreak International Mechanical Engineering Congress and Exposition}
-\ConfAcronym{IMECE2023}
-\ConfDate{October 29--November 2, 2023} % update
-\ConfCity{New Orleans, LA} % update
-\PaperNo{IMECE2023-XXXX}
+\ConfName{Proceedings of the ASME 2024\linebreak International Mechanical Engineering Congress and Exposition}
+\ConfAcronym{IMECE2024}
+\ConfDate{November 17--21, 2024} % update
+\ConfCity{Portland, OR} % update
+\PaperNo{IMECE2024-XXXX}
% Units of measure (e.g., cm) and other specialty lowercase terms in the title should be
% enclosed in \NoCaseChange{...} to maintain lower case type
@@ -183,7 +189,7 @@
%% Abstract should be 200 words or less
\begin{abstract}
-This paper is an example of and a {\upshape\LaTeX} template for typesetting ASME conference papers using the {\upshape\texttt{asmeconf}} class. This {\upshape\LaTeX} template follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of 2022. The class is intended to be used with the {\upshape\texttt{asmeconf.bst} \hologo{BibTeX}} style for reference formatting, which is part of this distribution. The template produces pdfs that 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}}.
+This paper is an example of and a {\upshape\LaTeX} template for typesetting ASME conference papers using the {\upshape\texttt{asmeconf}} class. This {\upshape\LaTeX} template follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of 2024. The class is intended to be used with the {\upshape\texttt{asmeconf.bst} \hologo{BibTeX}} style for reference formatting, which is part of this distribution. The template produces pdfs that 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) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -256,8 +262,8 @@ ASME prefers SI units. (U.S.\ style units may follow in parentheses.) Be sure to
%% captions go below figures
\begin{figure}
-\centering\includegraphics[width=0.7\linewidth]{sample-figure-1.pdf}
-\caption{Caption with math, eqn.~\eqref{eqn:fourier}: $z = (r,\phi)$ \cite{Lienhard2019b}}\label{fig:1}
+\centering\includegraphics[width=\linewidth, alt = {Linearization error in radiant flux}]{sample-figure-1.pdf}
+\caption{Caption with math, eqn.~\eqref{eqn:fourier}: $\Delta T/T_m$ vs.\ $\Delta T/T_1$~\cite{Lienhard2019}}\label{fig:1}
\end{figure}
%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%
@@ -393,24 +399,21 @@ Basic support for \texttt{eprint} numbers is also included, generating a url at
%%%%%%%%%%%%%%%%% begin two column figure %%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{figure*}
-\begin{subfigure}[t]{0.5\textwidth} % subfigure is basically the same as minipage
-\vbox{
-\vspace*{1.7em}
+\begin{subfigure}[b]{\columnwidth}% subfigure is basically the same as minipage
\centering{
- \includegraphics{sample-figure-2a.pdf}
-}%
-\vspace*{1.7em}
-}%
-\subcaption{Interior region\label{fig:interior-region}}
+ \includegraphics[width=0.9\linewidth, alt={Nusselt number data for isothermal wall}]{sample-figure-2a.pdf}%
+}
+\subcaption{Uniform temperature wall\label{fig:interior-region}}
\end{subfigure}%
-%%%%%%%%%%%%% no spaces or line breaks between these two subfigures
-\begin{subfigure}[t]{0.5\textwidth}
+\hspace*{\columnsep}% with this space added, puts each figure at column center
+%%%%%%%%%%%%% no line break between these two subfigures
+\begin{subfigure}[b]{\columnwidth}
\centering{%
-\includegraphics{sample-figure-2b.pdf}
+\includegraphics[width=0.927\linewidth, alt={Nusselt number data for constant heat flux wall}]{sample-figure-2b.pdf}%
}%
-\subcaption{Exterior region\label{fig:exterior-region}}
+\subcaption{Uniform heat flux wall with unheated starting length\label{fig:exterior-region}}
\end{subfigure}
-\caption{A figure with two subfigures \cite{lienhard2023}\label{fig:2}}
+\caption{A figure with two subfigures~\cite{lienhard2020}\label{fig:2}}
\end{figure*}
%%%%%%%%%%%%%%%%%%% end two column figure %%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -480,8 +483,10 @@ The \texttt{lineno} package is not compatible with the \texttt{flushend} package
Note that ASME interprets the author order in the grid style by reading names from left-to-right in the top row, then left-to-right in each subsequent row.
-\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
+\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 option \texttt{[somegovt]} gives a copyright notice for the case when only some authors are employees of the U.\ S.\ Government.
The footers are generated with the \texttt{fancyhdr} package~\cite{oostrum} and can be changed using the commands of that package. Only the default arrangement matches ASME's style, however.
@@ -493,11 +498,9 @@ If levels 1b, 2b, 2u, or 3b are preferred, use the options \texttt{[pdfapart=1 o
As of late 2021, the \LaTeX 3 team is phasing in native support for PDF/A in the \LaTeX\ kernel, which will make these
class options unnecessary when using up-to-date installations.
-\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (both numbers and letters) for use in footnote markers and text superscripts. To enable this font, use the option \texttt{[nodefaultsups]}.
-
-\subsection{Typewriter Font Options} This font is the sans-serif \texttt{inconsolata}. By default, the word spacing is variable, but option \texttt{[mono]} ends this behavior. A slashed zero is the default; option \texttt{[var0]} removes the slash. Option \texttt{[hyphenate]} enables hyphenation. (The hyphenation option is not available if the \texttt{[fontspec]} option is used.)
+\subsection{Typewriter Font Options} This font is the sans-serif \texttt{inconsolata}. By default, the word spacing is variable, but option \texttt{[mono]} ends this behavior. A slashed zero is the default; option \texttt{[var0]} removes the slash. Option \texttt{[hyphenate]} enables hyphenation. (The hyphenation option is not available under \hologo{LuaLaTeX} with \texttt{fontspec}.)
-\subsection{Support for Other Languages} This package can be adapted to incorporate (or entirely use) languages other than English. See Appendix \ref{appendix:b} for details.
+\subsection{Support for Other Languages} This package can be adapted to incorporate (or entirely use) languages other than English. See Appendix \ref{appendix:c} for details.
%%%%% Conclusions %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -544,24 +547,41 @@ consecutively, following those in the paper. Consider $\rho \neq \textrm{fn}(p)$
\end{align}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section{Multilingual Support}\label{appendix:b}
+\section[Use with LuaLaTeX]{Use with \NoCaseChange{\hologo{LuaLaTeX}}}\label{appendix:b}
+
+The \hologo{LuaLaTeX} engine is useful with \texttt{asmeconf} in two situations:
+
+\begin{description}
+
+\item \textbf{Executing lua code directly in your \LaTeX\ file.} With lua code, complicated functions can be plotted or numerical integration can be executed. An example file in the distribution demonstrates this capability~\cite{lienhard2024}. In this situation, \textit{be sure to use the class option} \texttt{[nofontspec]}, so that you won't need to install additional fonts on your computer.
+
+\item \textbf{Using complex alphabets.} With \hologo{pdfLaTeX}, the \texttt{asmeconf} package supports Latin alphabets, as well as Cyrillic, Greek, and Vietnamese. If you need scripts such as Arabic, Chinese, or Japanese, \hologo{LuaLaTeX} with the \texttt{fontspec} package can use fonts installed in your computer operating system. See the example file in this distribution for more details~\cite{lienhard2021}.
+
+\end{description}
+
+For clarity, \texttt{fontspec} is automatically loaded when \texttt{asmeconf} is run under \hologo{LuaLaTeX}. Fontspec requires that the necessary system fonts are already installed in your operating system. If you wish to use \hologo{LuaLaTeX} without bothering about system fonts, use the class option \texttt{[nofontspec]}.
+
+Access to \hologo{LuaLaTeX} is different in each \LaTeX\ platform. Check the documentation for your specific platform to see how to access various typesetting engines.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{Multilingual Support}\label{appendix:c}
ASME publishes in English, but the \texttt{babel} package is loaded for
users who may wish to include other languages. For example, an author might wish to include an appendix that provides the
abstract in another language.
When more than one language option is included in \verb|\documentclass[..]{asmeconf}|, English will be
-assumed to be the main language of the document. (To choose a different main language, set \texttt{[main=..]}).
+set as the document's main language. (To choose a different main language, set \texttt{[main=..]}).
If no language options are given, the package defaults to English. As examples, a passage in French is
shown in \selectlanguage{french}\appendixname~\ref{app:fourier}\selectlanguage{english}, followed by
\ifpdftex abstracts in Spanish, Greek, Russian, and Vietnamese.\else abstracts in other languages.\fi
The input encoding can be utf-8, as for these glyphs:
%% 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.
-\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. Under LuaLaTeX, you can load the [fontspec] option if you have the relevant systems fonts installed}%
+\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. Under LuaLaTeX, you can load the fontspec will support these characters if you have the relevant systems fonts installed}%
àáâäæãåā èéęëêēė îïíīįì ôöòóœøōõ ûüùúū çćč ł ñń ßśš ÿ žźż.
-Fonts similar to Times/Helvetica are automatically used when the Greek, Vietnamese, or selected cyrillic-alphabet languages are called as options under {\upshape\hologo{pdfLaTeX}}. Using {\upshape\hologo{LuaLaTeX}} with the \texttt{[fontspec]} option, many additional scripts are available; see the supplemental notes for such usage~\cite{lienhard2021}. Possibilities include Arabic, Bengali, Chinese, Devanagari (e.g., for Hindi), Hangul (for Korean), Kana (for Japanese), and Tamil. \textit{The {\upshape\texttt{[fontspec]}} option requires a \LaTeX\ installation dated October 2020 or later.}
+Fonts similar to Times/Helvetica are used when Greek, Vietnamese, or selected cyrillic-alphabet languages are called as options under {\upshape\hologo{pdfLaTeX}}. Using {\upshape\hologo{LuaLaTeX}}, which loads the fontspec package, many additional scripts are available; see the supplemental notes for such usage~\cite{lienhard2021}. Possibilities include Arabic, Bengali, Chinese, Devanagari (e.g., for Hindi), Hangul (for Korean), Kana (for Japanese), and Tamil. (Note: some fonts are not PDF/A compliant.) \textit{These options require a \LaTeX\ installation dated October 2020 or later.}
The bibliography style, \texttt{asmeconf.bst}, is designed in English and aimed at \hologo{BibTeX}.
% Multilingual bibliographies can be supported using \texttt{BibLaTeX}.