summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/asmejour/asmejour-template.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/asmejour/asmejour-template.tex')
-rw-r--r--macros/latex/contrib/asmejour/asmejour-template.tex69
1 files changed, 36 insertions, 33 deletions
diff --git a/macros/latex/contrib/asmejour/asmejour-template.tex b/macros/latex/contrib/asmejour/asmejour-template.tex
index b30dc023b2..9eb8b6aa75 100644
--- a/macros/latex/contrib/asmejour/asmejour-template.tex
+++ b/macros/latex/contrib/asmejour/asmejour-template.tex
@@ -3,7 +3,7 @@
%%
%% This file is asmejour-template.tex, a template to format papers in the style of ASME journal papers.
%%
-%% This file is version 1.20 dated 2022/12/30
+%% This file is version 1.21 dated 2023/10/22
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -23,8 +23,8 @@
%% * [smallerops, varg, slantedGreek, frenchmath, varbb, cmbraces]. Version 1.6 or higher
%% * is recommended.
%%
-%% * Option to include line numbers [lineno]. The lineno package does not number tables,
-%% * footnotes, captions, etc. You must run *twice* for proper placement of the numbers.
+%% * Option to include line numbers [lineno]. You must run *twice* for proper placement of the
+%% * line numbers. The lineno package does not number tables, footnotes, or captions.
%% * This option will disable balancing of the column heights on final page.
%%
%% * Option to balance column heights on final page [balance]. This option sometimes
@@ -39,25 +39,25 @@
%%
%% * Option to omit all ASME text fields from the footer [nofoot].
%%
-%% * Options for PDF/A compliance. [pdf-a] will produce PDF/A-3u compliance with sRGB OutputIntent.
+%% * Options for PDF/A compliance. With pdfTeX, [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.)
+%% * Recently, LaTeX (2021 and later) has integrated support for pdf-a, through the \DocumentMetadata{..}
+%% * command. This approach works with both pdfTeX and luaLaTeX. The asmeconf class supports this new feature,
+%% * which can replace the aforementioned class options. (An up-to-date LaTeX installation is required.)
%%
%% * Many options for calligraphic, script, and fraktur fonts from the mathalfa package; the
%% * example value used is: mathalfa=cal=euler (use Euler font for \mathcal)
%% * some other options for cal are: dutchcal, zapfc, cm (default), boondox,...
%% * frak (fraktur), bb (blackboard bold), scr (script) may also be controlled.
%%
-%% * An option to use newtxtext's superiors font for footnotes [nodefaultsups] and an option
-%% * for slightly larger small capitals [largesc]
+%% * With pdfTeX, an option to use newtxtext's superiors font for footnotes [nodefaultsups] and an option
+%% * for slightly larger small capitals [largesc].
%%
%% * Options for typewriter font
-%% * [hyphenate] allow hyphenation (normally suppressed because for typewriter font is often used for code)
%% * [var0] replace default slashed zero by unslashed zero
%% * [mono] force interword separation to monospacing
+%% * [hyphenate] allow hyphenation, with pdfTeX only (normally, the typewriter font is not hyphenated)
%%
%% * Options for the babel package to support passages in other languages (such as a translated
%% * abstract in an appendix), e.g. [french]. The main language will default to English
@@ -73,25 +73,27 @@
%%
%% LICENSE:
%%
-%% Copyright (c) 2022 John H. Lienhard
+%% Copyright (c) 2023 John H. Lienhard
%%
%% Offered under the MIT license: https://ctan.org/license/mit
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% New pdf management code (June 2021); with this, the \docuemntclass options for [pdf-a] can be omitted.
-%% This change to the LaTeX kernel is being phased-in by the LaTeX3 team. Can delete if it gives you trouble.
-%% Under LuaLaTeX, choose pdfstandard=A-3b.
+%% RECOMMENDED new pdf management code.
+%% This addition the LaTeX kernel was made by the LaTeX Project team in June 2022.
+%% 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
%\DocumentMetadata{%
-% pdfstandard=A-3b,% A-2b, A-2u, A-3b, or A-3u
-%}%
+% pdfstandard=A-3b,% A-2b, A-2u, A-3b, or A-3u (don't use u options with LuaLaTeX)
+% pdfversion=1.7,
+% lang=en-US,
+%}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Class options are described above.
-\documentclass[subscriptcorrection,upint,varvw,barcolor=Goldenrod3,mathalfa=cal=euler,balance,hyphenate,french,pdf-a]{asmejour} %
-
+\documentclass[upint,varvw,barcolor=Goldenrod3,mathalfa=cal=euler,balance,hyphenate,french,pdf-a]{asmejour}% subscriptcorrection,
%%%% pdf metadata %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -107,10 +109,10 @@
%%%% Journal name and optional copyright year %%%%%%%%%%%%%%
%% Omit "Journal of". If Journal Name is quite long, use \\ to insert a line break
-\JourName{Heat Transfer}%<=== change to the name of your journal
+\JourName{Heat and Mass Transfer}%<=== change to the name of your journal
%% The default copyright year is the current year
-%% \PaperYear{2022} sets 2022; and \PaperYear{} omits the year entirely.
+%% \PaperYear{2023} sets 2023; and \PaperYear{} omits the year entirely.
%%%% end of preamble %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -124,7 +126,7 @@
\SetAuthorBlock{Author Name[s]}{Department of Mechanical Engineering,\\
Institution or Company Name,\\
Street address,\\
- City, State, Country \\
+ City, State, Country\\
email: xxx@yyy.zzz}
% To label one or more corresponding authors put "Name\CorrespondingAuthor". No space after "Name".
@@ -135,10 +137,10 @@
\SetAuthorBlock{John H.\ Lienhard V\CorrespondingAuthor}{%
Fellow ASME\\
-Rohsenow Kendall Heat Transfer Laboratory, \\
+Rohsenow Kendall Heat Transfer Laboratory,\\
Department of Mechanical Engineering,\\
-Massachusetts Institute of Technology, \\
-Cambridge, MA 02139 USA \\
+Massachusetts Institute of Technology,\\
+Cambridge, MA 02139 USA\\
email: lienhard@mit.edu
}
@@ -151,7 +153,7 @@ email: lienhard@mit.edu
%%% If you don't want keywords, omit the \keyword{..} command.
\keywords{ASME, Paper, Template, {\upshape\LaTeX}, {\upshape\hologo{BibTeX}}}
-
+
%% Abstract should be no more than 250 words
\begin{abstract}
This paper is an example and {\upshape\LaTeX} template for the {\upshape\texttt{asmejour}} class. Papers typeset in this class will follow ASME journal style for margins, fonts, headings, captions, and reference formats. The class will also lay out the author, title, and abstract in ASME style. The pdf file produced will include internal and external hyperlinks, bookmarks, and pdf metadata. The class is intended to be used with the {\upshape\texttt{asmejour.bst} \hologo{BibTeX}}, which is part of this distribution. This style produces modern reference formats, following current ASME styles and including hyperlinked DOI and URL fields. Options to the class include line numbering, final column balancing, various math options, government copyright notices, 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}}.
@@ -176,6 +178,8 @@ This class is not a publication of ASME, although the author has published in AS
The \texttt{.tex} file may be written using standard \LaTeX\ commands, although some specific initial commands are needed to format the block containing the author[s], title, and abstract. The class calls a number of packages, all of which are contained in up-to-date versions of \TeX~Live, Mac\TeX, and similar platforms. If you find that you are missing a package, you may obtain it at no cost from CTAN (\href{http://ctan.org}{ctan.org}).
+For \hologo{LuaLaTeX}, you must have the following fonts installed as system fonts on your computer: TeX Gyre Termes, TeX Gyre Heros, and Insolatazi4. These fonts can be downloaded at no charge here: \url{http://www.gust.org.pl/projects/e-foundry/tex-gyre} and \url{https://ctan.org/tex-archive/fonts/inconsolata/opentype}. No additional fonts should need to be loaded with \hologo{pdfLaTeX}.
+
\subsection{Essential Initial Commands}
To begin, fill in the fields to be completed at top of the \texttt{asmejour-template.tex} file. The first are pdf metadata in the preamble that will tag the pdf file itself. Next is the \verb|\JourName{..}| command, which should be changed as appropriate (omit ``Journal of'').
@@ -219,7 +223,7 @@ If you wish to override the default math format in a heading or caption, put \ve
Single-sentence captions should not end with a period. Multi-sentence captions do include periods.
\subsection{Subsection Headings}
-Section, subsection, and subsubsection headings should be in title case (first letter of primary words capitalized). ASME does not use \verb|\paragraph|, so the class file equates this command to \verb|\subsubsection|. \textsf{Try some text for size scaling.} Try some text for size scaling.
+Section, subsection, and subsubsection headings should be in title case (first letter of primary words capitalized). ASME does not use \verb|\paragraph|, so the class file equates this command to \verb|\subsubsection|.
%%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -332,13 +336,13 @@ Our competitor's data & 72.321 & 141.384\\
\subsection{eprint Support} Elementary support for \texttt{eprint} numbers is included, either hyperlinking or generating a url at the end of the citation. The \texttt{archive} type may be specified using the macros \texttt{arxiv, googlebooks, hndl, jstore, oclc}, or \texttt{pubmed} (e.g., \texttt{archive=hndl}, \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/}|.
-\subsection{Online Sources} A bibliography field \verb|@online{..| is included for citation of online sources, such as web pages. A \texttt{url}, \texttt{doi}, or \texttt{eprint} with \texttt{archive} should be included. See the examples of use in the \texttt{asmejour-sample.bib} file.
+\subsection{Online Sources} A bibliography field \verb|@online{..| is included for citation of online sources, such as web pages. A \texttt{url}, \texttt{doi}, or \texttt{eprint} with \texttt{archive} should be included. See the examples of use in the \texttt{asmejour-sample.bib} file.
\subsection{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.
\subsection{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. Omit \verb|address={..}| if \verb|venue={..}| is used.
-\subsection{Version Number\protect\footnote{Footnotes can appear in \texttt{\string\section} commands. However, when the \texttt{[lineno]} option is used either: i) write \texttt{\string\protect\string\footnote\{..\}}; or ii) include the optional argument, as in \texttt{\string\section[Foo]\{Foo\string\footnote\{..\}\}}.\label{ftnt:3}}}
+\subsection{Version Number\footnote{Footnotes can appear in \texttt{\string\section} commands.\label{ftnt:3}}}
The \verb|version={..}| field may be used with \verb|@book|, \verb|@online|, and \verb|@manual|. By default, the text will read \texttt{Version `number'} as in Refs.~\cite{sharpe1,sharpe2}, but different wording may be selected using the \verb|versiontype={..}| field, to have ``Revision'' or something similar, as in Ref.~\cite{GSL}. ASME often puts the version in the title, as in Refs.~\cite{dlmf, texshop}, so I've left the final decision for discussion between the authors and the copy editor.
\subsection{Articles in Collections} In addition to the standard entry, \verb|@incollection{..|, an entry \verb|@inserialcollection{..| is defined for serials in which each volume has a different title. See the \texttt{asmejour-sample.bib} file for discussion and compare Ref.~\cite{clauser56} to Ref.~\cite{DKE70}.
@@ -448,7 +452,7 @@ q_\textrm{gray} & q_\textrm{int, $T_1$} & q_\textrm{int, $T_m$} & q_\textrm{exa
\subsection{Final Column Balancing} The option \texttt{[balance]} invokes the the \texttt{flushend} package~\cite{tolusis}.
This package will attempt to give equal height to the two columns on the last page. The performance of this package is sometimes inconsistent (with odd page layout or, very rarely, errors), so use this option with caution.
-\subsection{Line Numbers} The option \texttt{[lineno]} invokes the the \texttt{lineno} package~\cite{bottcher}. This will produce line numbers in the margins. You must run \LaTeX\ \textit{twice} for proper placement of the numbers. The \texttt{lineno} package is not compatible with the \texttt{flushend} package that makes final short columns the same height. Balancing is disabled when this option is called. See the documentation of the \texttt{lineno} package for further commands to control line numbering. See footnote~\ref{ftnt:3} with regard to footnotes in section headings while this option is in~effect. The abstract, tables, captions, and footnotes will not be numbered.
+\subsection{Line Numbers} The option \texttt{[lineno]} invokes the the \texttt{lineno} package~\cite{bottcher}. This will produce line numbers in the margins. You must run \LaTeX\ \textit{twice} for proper placement of the numbers. The \texttt{lineno} package is not compatible with the \texttt{flushend} package that makes final short columns the same height. Balancing is disabled when this option is called. See the documentation of the \texttt{lineno} package for further commands to control line numbering. The abstract, tables, captions, and footnotes will not be numbered.
\subsection{Changing the Footer Text}\label{sec:footer} The option \texttt{[nofoot]} will omit everything other than a page number from the page footer. The option \texttt{nocopyright} will omit the ASME copyright from the first page footer. The command \verb|\PreprintString{..}| replaces the words \textsf{PREPRINT FOR REVIEW}. The left and right preprint strings can be changed separately using an optional argument: \verb|\PreprintString{..}[L]| and \verb|\PreprintString{..}[R]|.
The final paper number may be added to the page number using \verb|\PaperNumber{..}|.
@@ -465,12 +469,11 @@ default setting is for PDF/A-3u with sRGB OutputIntent (\texttt{sRGB.icc}). If l
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.
-As of late 2021, the \LaTeX 3 team is phasing in native support for PDF/A in the \LaTeX\ kernel, which eventually will make these
-class options unnecessary when using an up-to-date installation.
+As of June 2022, the \LaTeX 3 team has added native support for PDF/A in the \LaTeX\ kernel, using \verb|\DocumentMetadata{..}|. This approach works with \textit{both} \hologo{pdfLaTeX} and \hologo{LuaLaTeX}. The class options previously mentioned can be omitted when using \verb|\DocumentMetadata{..}|.
-\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (numbers and letters) for use in footnote markers and superscripts. The option \texttt{[nodefaultsups]} enables this font. (The corresponding author mark in the author block will not change.)
+\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (numbers and letters) for use in footnote markers and superscripts. The option \texttt{[nodefaultsups]} enables this font, but only when running \hologo{pdfTeX}. %The corresponding author mark in the author block will not change.
-\subsection{Typewriter Font Options} This font is the sans-serif, monospaced font \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 of the typewriter font.
+\subsection{Typewriter Font Options} This font is the sans-serif, monospaced font \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 of the typewriter font when running \hologo{pdfTeX}.
%%%%%%%%%%%%%%% begin two column table %%%%%%%%%%%%%%%%%%