texlive[51233] Master/texmf-dist: asmejour (27may19)
commits+karl at tug.org
commits+karl at tug.org
Mon May 27 22:55:16 CEST 2019
Revision: 51233
http://tug.org/svn/texlive?view=revision&revision=51233
Author: karl
Date: 2019-05-27 22:55:16 +0200 (Mon, 27 May 2019)
Log Message:
-----------
asmejour (27may19)
Modified Paths:
--------------
trunk/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst
trunk/Master/texmf-dist/doc/latex/asmejour/README.md
trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.pdf
trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex
trunk/Master/texmf-dist/tex/latex/asmejour/asmejour.cls
Modified: trunk/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst
===================================================================
--- trunk/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst 2019-05-27 19:03:14 UTC (rev 51232)
+++ trunk/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst 2019-05-27 20:55:16 UTC (rev 51233)
@@ -26,7 +26,7 @@
% ===============================================================
%-------------------------------------------------------------------
%%
- %% This file is asmejour.bst, version 1.0 dated 2019/04/27.
+ %% This file is asmejour.bst, version 1.01 dated 2019/05/26.
%%
%% This file was generated and edited by John Lienhard.
%% This file is a derivative work under Clause 6 of the LPPL license.
@@ -566,7 +566,7 @@
'skip$
{ "\eprint"
archive empty$
- 'skip$
+ { "there's an eprint but no archive in " cite$ * warning$ }
{ "[" * archive * "]" * }
if$
"{" * swap$ * "}" *
Modified: trunk/Master/texmf-dist/doc/latex/asmejour/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/asmejour/README.md 2019-05-27 19:03:14 UTC (rev 51232)
+++ trunk/Master/texmf-dist/doc/latex/asmejour/README.md 2019-05-27 20:55:16 UTC (rev 51233)
@@ -1,7 +1,7 @@
#asmejour: A template for ASME journal papers#
- Version 1.02 dated 2019/05/22.
+ Version 1.03 dated 2019/05/26.
####Overview####
This class provides a template to format preprints submitted to ASME journals in the style that
@@ -57,6 +57,8 @@
####Change log####
+v1.03: expand documentation; fix conflict between lineno and balance packages; more footer options; edit \\entry
+
v1.02: adjust formats of 2nd and 3rd level headings; add option for line numbers; eqn tags in blue
v1.01: edit documentation, remove development code
Modified: trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex 2019-05-27 19:03:14 UTC (rev 51232)
+++ trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex 2019-05-27 20:55:16 UTC (rev 51233)
@@ -2,7 +2,7 @@
%% This file is asmejour-template.tex, a template to format papers in the style of ASME journal papers
%% as they are being published in early 2019.
%%
-%% This file is version 1.02 dated 2019/05/22
+%% This file is version 1.03 dated 2019/05/26
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -12,12 +12,11 @@
%% Class options are set up in the asmejour.cls file. These include:
%%
%% * Option to color the vertical bar in the title block [barcolor = colorname]
-%% where colorname is any name def'd by xcolor package; omit barcolor option to get black
+%% * where colorname is any name def'd by xcolor package; omit barcolor option to get black
%%
%% * Option to include line numbers [lineno]. The lineno package does not number equation
%% * lines, captions, etc. You must run twice for proper placement.
-%% * If you have been using lineno and then disable it, you may see errors about \@LN at col
-%% * undefined. To resolve this, delete your aux file.
+%% * This option will disable balancing column height on final page.
%%
%% * Math options from M. Sharpe's newtxmath package: upright integrals [upint]; and
%% * varvw for a v and w that are better distinguished from greek nu; and also
@@ -69,20 +68,10 @@
%% Class options are described above.
\documentclass[largesc,upint,varvw,barcolor=Red4,nocopyright]{asmejour}
-\usepackage{balance} % issue balance command near the end to nearly balance heights of final page short columns
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% The following two packages can be deleted if not being used
+%%%%% FIELDS TO BE COMPLETED FOLLOW %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\usepackage{lipsum} % Generates paragraphs of gibberish latin for checking layout ... e.g. \lipsum[2-4] produces
- % paragraphs 2 through 4 of the text.
-\usepackage{metalogo,hologo} % Access various LaTeX logos
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%% Fields to be completed %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-
%%%%% pdf metadata, the user should edit %%%%%%%%%%%%%%%%%%
\hypersetup{%
pdftitle={ASME Journal Paper Template}, % <=== change to YOUR pdf file title
@@ -90,21 +79,22 @@
pdfauthor={John H. Lienhard}, % <=== change to YOUR name[s]!!!
}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%% Journal name and optional copyright year %%%%%%%%%%%%%%
+
%% Omit "Journal of"
-%% If Journal Name is quite long, use \\ to insert linebreak
+%% If Journal Name is quite long, use \\ to insert a line break
\JourName{Heat Transfer} %<=== change to name of your journal
-\PaperYear % defaults to current year if no argument; \PaperYear{} omits year; \PaperYear{2018} sets 2018.
+\PaperYear % defaults to current year if no argument or omitted;
+ % \PaperYear{} omits year; \PaperYear{2018} sets 2018.
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%% End of Preamable %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}
-% Change to your name[s] and addresses, in the desired order of authors.
+% Change to your author name[s] and addresses, in the desired order of authors.
% First name, middle initial, last name
% Use title case (upper and lower case letters)
% Note usage below for corresponding author.
@@ -129,7 +119,7 @@
email: lienhard at mit.edu
}
-%%% Change to your title. Can insert line breaks if you wish, otherwise selected automatically.
+%%% Change to your paper title. Can insert line breaks if you wish (otherwise selected automatically).
\SetTitle{Preprint Template for ASME\\ Journal Papers: asmejour.cls}
@@ -142,14 +132,16 @@
%% Abstract should be no more than 250 words
\SetAbstract{%
-This paper is an example and 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. Standard \LaTeX\ commands are used. The class will lay out the author, title, and abstract in ASME style. The class will produce a pdf file that that includes hyperlinks, bookmarks, and pdf metadata. The class is intended to be used with the {\upshape\texttt{asmejour.bst}} \hologo{BibTeX} style for typesetting references, which is part of this distribution. This style supports hyperlinks and modern reference formats, following current ASME practice. The class may be invoked with several options, most of which address math fonts. The class calls a number of packages, all of which are in \TeX\textsc{live}\ and on CTAN (\href{http://ctan.org}{ctan.org}). The class is compatible with \hologo{pdfLaTeX} or \LuaLaTeX.
+This paper is an example and 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. Standard \LaTeX\ commands are used. The class will lay out the author, title, and abstract in ASME style. The class will produce a pdf file that that includes hyperlinks, bookmarks, and pdf metadata. The class is intended to be used with the {\upshape\texttt{asmejour.bst}} \hologo{BibTeX} style for typesetting references, which is part of this distribution. This style supports hyperlinks and modern reference formats, following current ASME practice. The class may be invoked with several options, most of which address math fonts. The class calls a number of packages, all of which are in \TeX~Live and in CTAN (\href{http://ctan.org}{ctan.org}). The class is compatible with \hologo{pdfLaTeX} or \LuaLaTeX.
}
-\MakeTitlePage
-%%%%%%%%%%%%%%%%%%%%% End of fields to be completed. Now write! %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\MakeTitlePage %% This command creates the author/title/abstract block. Essential!
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%% End of fields to be completed. Now write! %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\section*{Introduction}
The \texttt{asmejour} class file will typeset papers with margins, fonts, headings, captions, and reference formats that follow those used in journals published by the American Society of Mechanical Engineers (ASME). Internal and external hyperlinks will be set automatically, and the pdf file will contain bookmarks and metadata.
@@ -173,13 +165,13 @@
\section*{References to Figures, Equations, and Citations}
For ASME papers, the labels Figure and Equation should be abbreviated when they do not start a sentence, as in Fig.~\ref{fig:1} and Eq.~\eqref{eqn:1}. Figure~\ref{fig:1} is spelled out when it starts a sentence. Equation~\eqref{eqn:1} is spelled out when it starts a sentence.
-Citations will be numbered automatically \cite{DKE1969}. They should be inserted at the appropriate point using a \verb|\cite{ref}| command~\cite{toohey2007,gibson2008}. The citations will be automatically sorted and compressed, as well, if they are given in a set \cite{stevens1999, DKE1969, wions2005, oligaria2011,mollen2014,smith2014,apple2019}. See the \texttt{asmeconf-sample.bib} file for examples of how to enter your references.
+Citations will be numbered automatically \cite{DKE1969}. They should be inserted at the appropriate point using a \verb|\cite{ref}| command~\cite{toohey2007,gibson2008}. The citations will be automatically sorted and compressed, as well, if they are given in a set \cite{stevens1999, DKE1969, wions2005, oligaria2011,mollen2014,smith2014,apple2019}. Just refer to the number when naming a reference, as in \cite{smith2014}. Reference~\cite{smith2014} is appropriate at the beginning of a sentence.
+See the \texttt{asmeconf-sample.bib} file for examples of how to enter your references.
Equations are typeset in the usual way. The class file loads the \texttt{amsmath} and \texttt{mathtools} packages. Further, the \texttt{newtxmath} package used for the math fonts includes many additional features.
\begin{equation}\label{eqn:1}
\mathbf{q} = -k\nabla T
\end{equation}
-Be sure to put your symbols into the nomenclature list, including SI units.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section*{Section Headings and Captions}
@@ -191,10 +183,22 @@
If you wish to override the default math format in a heading or caption, put \verb|\mathversion{normal}| in the heading or caption. (The \texttt{newtxmath} package \cite{sharpe1} includes a complete set of bold math fonts, however, so the need to override should be rare.)
+Single-sentence captions should not end with a period. Multi-sentence captions do include periods.
+
\subsection*{Subsection Headings}
-Section and subsection headings should be in title case (first letter of primary words capitalized). ASME does not use \verb|\subsubsection| or \verb|\paragraph|, so the class file treats these commands like \verb|\subsection|.
+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 treats this commands like \verb|\subsubsection|.
+%%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%%
+
+%% captions go below figures
+\begin{figure}
+\centering\includegraphics[width=0.7\linewidth]{sample-figure-1.pdf}
+\caption{A figure caption with math, $z = (r,\phi)$ \cite{Lienhard2019b}\label{fig:1}}
+\end{figure}
+
+%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section*{More on Math}
To get bold math outside of the captions, you can use the \verb|\bm{..}| macro from the \texttt{bm} package, which is loaded by the class.
@@ -203,17 +207,30 @@
\bm{ S = k \ln w}
\end{equation}
-Math italics are used for roman and greek letters by default. If you want an upright letter in math, you can use the relevant math alphabet, e.g., \verb|\mathrm, \mathbf, \mathsf|:
+Math italics are used for roman and lower-case greek letters by default. If you want an upright letter in math, you can use the relevant math alphabet, e.g., \verb|\mathrm, \mathbf, \mathsf|:
\begin{equation}\label{eqn:newton2}
\vec{F} = m \vec{a} \quad\textrm{or}\quad \vec{\mathrm{F}} = m \vec{\mathrm{a}} \quad\textrm{or}\quad \mathbf{F} = m \mathbf{a} \quad\textrm{or}\quad \vec{\mathsf{F}} = m \vec{\mathsf{a}}
\end{equation}
-ASME typesets vectors in upright bold, like the third instance in Eq.\ \eqref{eqn:newton2}, and sets matrices in bold italic.
-The \texttt{newtxmath} package includes a large number of options for mathematics, most of which can be called using options to the documentclass. For example, the \texttt{upint} option of \texttt{newtxmath} selects upright integral signs (rather than slanted integral signs):
+ASME typesets vectors in upright bold, like the third instance in Eq.\ \eqref{eqn:newton2}, and sets matrices in bold italic. In the next equation $\mathbf{w}$ is a vector and $\bm{J}_1$ is a matrix:
+\begin{equation}\label{eqn:dw}
+d\mathbf{w} =
+ \begin{pmatrix}
+ du \\ dv
+ \end{pmatrix} =
+ \underbrace{\begin{pmatrix}
+ \partial u/\partial x & \partial u/\partial y \\
+ \partial v/\partial x & \partial v/\partial y
+ \end{pmatrix}}_{=\,\bm{J}_1} \begin{pmatrix}
+ dx \\ dy
+ \end{pmatrix}
+\end{equation}
+
+The \texttt{newtxmath} package includes a large number of options for mathematics, most of which can be called as options to \verb|\documentclass|. For example, the \texttt{upint} option of \texttt{newtxmath} selects upright integral signs (rather than slanted integral signs):
\begin{quote}
\verb|\documentclass[upint]{asmejour}|.
\end{quote}
-Options are discussed further in the \texttt{asmejour-template.tex} file.
+These math options are discussed further in the \texttt{asmejour-template.tex} file.
In addition, many options for calligraphic, script, and fraktur fonts are available as options to the \texttt{mathalfa} package, which is also loaded. These may be invoked, for example, as
\begin{quote}
@@ -223,33 +240,28 @@
The typewriter font loaded is \texttt{inconsolata} (which is sans serif), as suggested by the \texttt{newtx} package documentation. The class is not set up for use with the \texttt{fontspec} or \texttt{unicode-math} packages.
-%%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%%
-%% captions go below figures
-\begin{figure}
-\centering\includegraphics[width=0.7\linewidth]{sample-figure-1.pdf}
-\caption{A figure caption with math, $z = (r,\phi)$ \cite{Lienhard2019b}\label{fig:1}}
-\end{figure}
-
-%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%
+\subsubsection*{Units and Nomenclature} ASME requires SI units. U.S.\ style units may be follow in parentheses. Be sure to put your symbols into the nomenclature list, including the SI units.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section*{Tables}
+\section*{Tables and Figures}
Table \ref{tab:1} is an example of a simple table. Table captions should be placed above tables.
The class loads the \texttt{array} and \texttt{dcolumn} packages which provide extended capabilities for columns in the \texttt{tabular} environment (used in Tables \ref{tab:2} and \ref{tab:3}). Table~\ref{tab:3} is designed to have exactly the width of a text column. Table~\ref{tab:4} shows a table that spans both text columns.
+Text in the figures should be checked for legibility at either single-column width (about 83~mm) or full-column width (about 170~mm). Figure captions should be placed below figures.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section*{Reference Formatting with \texttt{asmejour.bst}}
The {\upshape\texttt{asmejour.bst}} \hologo{BibTeX} style follows the reference styles observed in ASME journals in 2019. The vast majority of published references are to journal papers and books. Examples for these and many other cases are given in the \texttt{asmejour-sample.bib} file, which is part of this distribution. Nevertheless, a few comments are necessary.
-\subsection*{Hyperlinked Titles} If an \verb|@article{..| or \verb|@book{..| includes \verb|doi={..}|, the journal title will be hyperlinked to that doi number. If no doi is included, but a url is included, then the title will be hyperlinked to that url. To display the doi (or the url when no doi is given), put it into the \verb|note={..}| field:
+\subsection*{Hyperlinked Titles} If an \verb|@article{..| or \verb|@book{..| includes \verb|doi={..}|, the journal title will be hyperlinked to that doi number, and the doi number will not be printed. If no doi is included, but a url is included, then the title will be hyperlinked to that url. To display the doi (or the url when no doi is given), put it into the \verb|note={..}| field:
\begin{quote}
\verb|note = {\doi{10.1115/1.4042912}}|
\end{quote}
+Include doi numbers in references whenever possible.
-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, hndl, jstore}, or \texttt{pubmed} (e.g., \texttt{archive=hndl}, \textit{without} braces). Both fields \textit{must} be given. Other root urls may be invoked using \verb|archive = {http://another.url.org/}|.
+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, hndl, jstore}, 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. See the examples of use in the \texttt{asmejour-sample.bib} file.
@@ -259,17 +271,7 @@
\subsection*{Version Number\footnote{Another longer footnote to show the leading and line breaking, and how it will sit at the bottom of a column. Another longer footnote to show the leading and line breaking, and how it will sit at the bottom of a column.}} 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 \cite{sharpe1,sharpe2}, but different wording may be selected using the \verb|versiontype={..}| field, to have ``Revision'' or something similar, as in \cite{GSL}. ASME often puts the version in the title, as in \cite{dlmf, texshop}, so I've left the final decision for discussion between the authors and the copy editor.
-%% Dealing with complicated math in a section heading: optional argument of \section provides the pdfbookmark
-%% without losing characters or producing warnings/errors. Note that bookmark can include simple math.
-%%
-%% Newtxmath provides the option for upright Greek letters as \upomega (vs. \omega), etc.
-%%
-\section*[Math in a Section Heading: \omega\cdot U=0]{Math in a Section Heading: $\hat{\upomega}\cdot\hat{\mathrm{U}}=0$}
-The rest of this is fake Latin text to demonstrate formats.
-\lipsum[6] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere!
-
-
%%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%%
%% captions go above tables
@@ -310,6 +312,37 @@
%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%% begin wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{figure*}[t]
+\begin{minipage}[c]{0.5\textwidth}
+\centering{
+ \includegraphics{sample-figure-2a.pdf}
+\subcaption{Interior region\label{fig:interior-region}}
+}\end{minipage}
+%%%%%%%% don't leave a break here
+\begin{minipage}[c]{0.5\textwidth}
+\centering{
+\includegraphics{sample-figure-2b.pdf}
+\subcaption{Exterior region\label{fig:exterior-region}}
+}\end{minipage}
+\caption{A figure with two subfigures \cite{Lienhard2019b}}
+\end{figure*}
+
+%%%%%%%%%%%%%%%%%%% end wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section*{Additional Options for \texttt{asmejour.cls}}
+The class accepts a number of options in addition to those already described.
+
+\subsubsection*{Line Numbers} The option \texttt{[lineno]} invokes the the \texttt{lineno} package. This will produce line numbers in the margins. You must run \LaTeX\ twice for proper placement. The \texttt{lineno} package is not compatible with the \texttt{balance} package that makes final short columns the same height. Balancing will be disabled when this option is called. See the documentation of the \texttt{lineno} package for further commands to control line numbering.
+
+\subsubsection*{Changing the Footer Text} 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 final paper number may be added to the page number using \verb|\PaperNumber{..}|.
+
+\subsubsection*{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]}. The corresponding author mark in the author block will not change.
+
+
%%%%%%%%%%%%%%%%%%% begin linewidth table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{table}[b]
@@ -331,46 +364,25 @@
%%%%%%%%%%%%%%%%%%%% end linewidth table %%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%% begin wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%%
-\begin{figure*}[t]
-\begin{minipage}[c]{0.5\textwidth}
-\centering{
- \includegraphics{sample-figure-2a.pdf}
-\subcaption{Interior region\label{fig:interior-region}}
-}\end{minipage}
-%%%%%%%% don't leave a break here
-\begin{minipage}[c]{0.5\textwidth}
-\centering{
-\includegraphics{sample-figure-2b.pdf}
-\subcaption{Exterior region\label{fig:exterior-region}}
-}\end{minipage}
-\caption{A figure with two subfigures \cite{Lienhard2019b}}
-\end{figure*}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Dealing with complicated math in a section heading: optional argument of \section provides the pdfbookmark
+%% without losing characters or producing warnings/errors. Note that bookmark can include simple math.
+%%
+%% Newtxmath provides the option for upright Greek letters as \upomega (vs. \omega), etc.
+%%
+\section*[Math in a Section Heading: \omega\cdot U=0]{Math in a Section Heading: $\hat{\upomega}\cdot\hat{\mathrm{U}}=0$}
-%%%%%%%%%%%%%%%%%%% end wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+To include complicated math in a section heading without producing bookmark-related errors, use the optional argument of \verb|\section| to create the pdfbookmark. The heading above was set with the following command:
+\begin{quote}\raggedright
+\verb|\section*[Math in a Section Heading:|
+\hspace*{1em}\verb|\omega\cdot U=0]{Math in a Section Heading:|
+\hspace*{1em}\verb|$\hat{\upomega}\cdot\hat{\mathrm{U}}=0$}|
+\end{quote}
+Note that bookmark can include simple math. Also note that \texttt{newtxmath} provides the option to obtain upright Greek letters as \verb|\upomega| (vs.\ \verb|\omega|), etc.
-\subsection*{Subsection Heading}
-\lipsum[12-13] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere!
-\begin{equation}\label{eqn:dw}
-d\mathbf{w} =
- \begin{pmatrix}
- du \\ dv
- \end{pmatrix} =
- \underbrace{\begin{pmatrix}
- \partial u/\partial x & \partial u/\partial y \\
- \partial v/\partial x & \partial v/\partial y
- \end{pmatrix}}_{=\,\bm{J}_1} \begin{pmatrix}
- dx \\ dy
- \end{pmatrix}
-\end{equation}
-Note ASME style for vectors, $\mathbf{w}$, and matrices, $\bm{J}_1$.
-
-\subsubsection*{Third Level Heading}
-\lipsum[13]
-
%%%%%%%%%%%%%%% begin table %%%%%%%%%%%%%%%%%%
\begin{table*}[t]
\caption{A table spanning two columns}\label{tab:4}%
@@ -403,8 +415,10 @@
%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section*{Summary}
-\lipsum[17] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere!
+The class \texttt{asmejour} and associated files are for typesetting preprints in the style of ASME journals.
+Documentation is provided in this file and by comments in the \texttt{.tex} source code. Examples of entering references are shown in the \texttt{asmejour-sample.bib} file. The \texttt{asemjour.bst} file produces references following ASME's current formats. This package is not a publication of ASME and is offered without charge under the terms of the \href{https://ctan.org/license/mit}{MIT license}.
\begin{enumerate}
\item First conclusion
@@ -416,13 +430,14 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section*{Acknowledgement}
-\lipsum[17] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere!
+\section*{Acknowledgment} %% ASME requests this exact spelling, singular.
+Acknowledge individuals, institutions, or companies that supported the authors in preparing the work. Those mentioned might have provided technical support, insightful comments or conversations, materials used in the work, or access to facilities.
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section*{Funding Data}
\begin{itemize}
-\item U.S.\ Department of Heat Transfer, Office of Important Ideas (DOHT Award No.\ 3.14159265)
+\item U.S.\ Department of Heat Transfer, Office of Important Ideas (DOHT-OII Award No.\ 3.14159265)
\end{itemize}
@@ -450,7 +465,7 @@
\end{nomenclature}
-%%%%%%%%%%%%%%% Appendices %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%% APPENDICES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Note that appendices will be "numbered" A, B, C, ... etc. Use \section, not \section*
%% Subsections need not be numbered, use \subsection*
@@ -462,7 +477,7 @@
\section{Incomplete Zeta Function~\cite{Lienhard2019c}\label{app:zetafunction}}
-The radiation fractional function may be written in terms of the incomplete zeta function for convenience:
+This text is just an illustration of an appendix. The radiation fractional function may be written in terms of the incomplete zeta function for convenience:
\begin{align}
f(\lambda T) = {}& \frac{1}{\sigma T^4} \int_0^\lambda\frac{2\pi h c_o^2}{\lambda^5 \left[ \exp (h c_o/k_B T \lambda) - 1\right] } \, d\lambda \\
= {}& \frac{1}{\sigma T^4}\frac{2\pi k_B^4 T^4}{h^3c_o^2}\int^\infty_{c_2/\lambda T}\frac{t^3}{e^t -1}\, dt\label{eqn:zeta}
@@ -473,13 +488,16 @@
\end{equation}
where the Gamma function $\Gamma(4) = 3!$ and the Riemann zeta function, $\zetaup(4)$, has the indicated integral representation \cite[\S13.12]{ww1927}. A classical result due to Euler \cite{euler1740} gives $\zetaup(4) = \pi^4/90$ (see also \cite[\S167]{euler1748}), from which we recover the usual definition of the Stefan-Boltzmann constant, $\sigma$.
-%%%%%%%%%%%%% Bibliography %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%% BIBLIOGRAPHY %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\balance %<=== this command, from the balance package, attempts to balance column heights on last page.
% performance is a bit variable, however...
+ % The [lineno] option will disable this command
-\nocite{*} %% <=== delete this line unless you want to typeset the entire contents of your .bib file.
-\bibliographystyle{asmejour} %% .bst file following ASME journal format. Do not change.
+\nocite{*} %% <=== delete this line - unless you want to typeset the entire contents of your .bib file.
+
+\bibliographystyle{asmejour} %% .bst file that follows ASME journal format. Do not change.
+
\bibliography{asmejour-sample} %% <=== change this to name of your bib file
@@ -486,7 +504,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\clearpage
-%% ASME requires these lists for production
+%% ASME requires these lists for production.
\twocolumn[
\begin{@twocolumnfalse}
\listoffigures
Modified: trunk/Master/texmf-dist/tex/latex/asmejour/asmejour.cls
===================================================================
--- trunk/Master/texmf-dist/tex/latex/asmejour/asmejour.cls 2019-05-27 19:03:14 UTC (rev 51232)
+++ trunk/Master/texmf-dist/tex/latex/asmejour/asmejour.cls 2019-05-27 20:55:16 UTC (rev 51233)
@@ -6,7 +6,7 @@
%% The asmejour.cls file should be used with the files asmejour.bst (for citations) and asmejour-template.tex.
%%
%%
-%% This file is version 1.02 dated 2019/05/22.
+%% This file is version 1.03 dated 2019/05/26.
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -52,7 +52,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{asmejour}[2019/05/22 asmejour paper format]
+\ProvidesClass{asmejour}[2019/05/26 asmejour paper format]
\LoadClass[twoside,9pt,twocolumn]{extarticle}
@@ -64,6 +64,7 @@
\setboolean{DefaultSups}{true}
\newboolean{lineno}
+\setboolean{lineno}{false}
\RequirePackage{kvoptions}
\RequirePackage{kvsetkeys}
@@ -112,7 +113,7 @@
\DeclareOption{nocopyright}{%
\AtBeginDocument{\fancypagestyle{title}{%
\fancyhf{}
- \fancyfoot[RO]{\large\sffamily PREPRINT FOR REVIEW \bfseries / \thepage}
+ \fancyfoot[RO]{\large\sffamily \@PreprintString\ \bfseries / \@PaperNumber\thepage}
\fancyfoot[LO]{\large\bfseries\sffamily Journal of \@JourName}
\fancyfoot[CO]{}
}
@@ -137,6 +138,7 @@
\ProcessOptions \relax
+
%%%%%%%%%%%%% end options %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\RequirePackage[paperheight=285.7mm, paperwidth=215.9mm, left=21.1mm, right=21.1mm, top=15.9mm, bottom = 24mm, footskip=8mm]{geometry}
@@ -151,6 +153,7 @@
\RequirePackage{graphicx}
\RequirePackage[hyperref,fixpdftex,dvipsnames,svgnames,x11names]{xcolor}
\RequirePackage{xparse}
+\RequirePackage{metalogo,hologo} % Access various LaTeX logos if needed
%%%%%%%%%%%%%%%% Table related %%%%%%%%
@@ -214,10 +217,14 @@
\renewcommand{\linenumberfont}{\normalfont\footnotesize\color{red}}
\AtBeginDocument{\linenumbers}
}{%
- \relax%
+ \RequirePackage{balance}% balance is NOT compatible with lineno
}
+\providecommand{\@LN at col}[1]{\relax}
+\providecommand{\@LN}[2]{\relax}
+\providecommand{\balance}{\relax}% balance is NOT compatible with lineno
%% ASME page proofs seem to align these at top of baseline, rather than bottom as done here.
+
%% ASME puts equation tags in blue
\RequirePackage{xpatch}
\xpatchcmd{\tagform@}{(\ignorespaces#1\unskip\@@italiccorr)}{\color{blue}(\ignorespaces#1\unskip\@@italiccorr)}{}{}
@@ -235,6 +242,12 @@
}
\providecommand\@PaperYear{\the\year}
+\def\@PreprintString{PREPRINT FOR REVIEW}
+\newcommand{\PreprintString}[1]{\gdef\@PreprintString{#1}}
+
+\newcommand{\PaperNumber}[1]{\gdef\@PaperNumber{#1-}}
+\providecommand\@PaperNumber{\relax}
+
%%%%%%
\RequirePackage{fancyhdr}
@@ -245,8 +258,8 @@
\renewcommand{\footrulewidth}{0pt}
\fancyfoot[RE]{\large\bfseries\sffamily Transactions of the ASME}
\fancyfoot[LO]{\large\bfseries\sffamily Journal of \@JourName}
-\fancyfoot[RO]{\large\sffamily PREPRINT FOR REVIEW \bfseries / \thepage}
-\fancyfoot[LE]{\large\sffamily {\bfseries \thepage\ /} PREPRINT FOR REVIEW}
+\fancyfoot[RO]{\large\sffamily \@PreprintString\ \bfseries / \@PaperNumber\thepage}
+\fancyfoot[LE]{\large\sffamily {\bfseries \@PaperNumber\thepage\ /} \@PreprintString\ }
\fancypagestyle{title}{%
@@ -253,7 +266,7 @@
\fancyhf{} % clear all header and footer fields
\renewcommand{\headrulewidth}{0pt}
\renewcommand{\footrulewidth}{0pt}
-\fancyfoot[RO]{\large\sffamily PREPRINT FOR REVIEW \bfseries / \thepage}
+\fancyfoot[RO]{\large\sffamily \@PreprintString\ \bfseries / \thepage}
\fancyfoot[LO]{\large\bfseries\sffamily Journal of \@JourName}
\fancyfoot[CO]{\large\bfseries\sffamily Copyright \textcopyright\ \@PaperYear\ by ASME}
}
@@ -300,8 +313,8 @@
\titleformat{\subsubsection}[runin]{\itshape}{\thesubsubsection}{1em}{}[.]
\titlespacing\section{0pt}{14pt plus 3pt minus 2pt}{3pt plus 2pt minus 1pt}
-\titlespacing{\subsection}{\parindent}{14pt plus 3pt minus 2pt}{0.5em}
-\titlespacing{\subsubsection}{\parindent}{14pt plus 3pt minus 2pt}{0.5em}
+\titlespacing{\subsection}{\parindent}{12pt plus 3pt minus 2pt}{0.5em}
+\titlespacing{\subsubsection}{\parindent}{12pt plus 3pt minus 2pt}{0.5em}
%% ASME style does not seem to go lower than third level heading, so ...
%% ....putting \paragraph into \subsubsection settings.
@@ -413,7 +426,8 @@
%% If the second argument of \entry is omitted, a bold section heading is produced, e.g. \entry{Greek Letters}
\DeclareDocumentCommand{\entry}{m g}{%
\IfNoValueTF{#2}{%
- \item[\bfseries#1\hfill]\bigskip\hphantom{M}\smallskip%
+ \bigskip
+ \item[\bfseries#1\hfill]\hphantom{x}\par\smallskip% % ASME is probably closer to \medskip here
}{%
\item[\hfill#1${} = {}$]#2%
\settowidth\@widest{#1${} = {}$}%
More information about the tex-live-commits
mailing list