summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/asmejour
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-11-02 03:01:48 +0000
committerNorbert Preining <norbert@preining.info>2019-11-02 03:01:48 +0000
commit3479a92321ed7fe7e2133d3daec2d4f5fd53fbc6 (patch)
treef81c77e1742124279f68e41484d9e53ad40248ff /macros/latex/contrib/asmejour
parent61b8d58232b999b6cc966aee9152fb86bbb759cd (diff)
CTAN sync 201911020301
Diffstat (limited to 'macros/latex/contrib/asmejour')
-rw-r--r--macros/latex/contrib/asmejour/README.md4
-rw-r--r--macros/latex/contrib/asmejour/asmejour-sample.bib12
-rw-r--r--macros/latex/contrib/asmejour/asmejour-template.pdfbin494919 -> 476616 bytes
-rw-r--r--macros/latex/contrib/asmejour/asmejour-template.tex112
-rw-r--r--macros/latex/contrib/asmejour/asmejour.cls18
5 files changed, 81 insertions, 65 deletions
diff --git a/macros/latex/contrib/asmejour/README.md b/macros/latex/contrib/asmejour/README.md
index 8be9aa6158..c4475e0eca 100644
--- a/macros/latex/contrib/asmejour/README.md
+++ b/macros/latex/contrib/asmejour/README.md
@@ -1,7 +1,7 @@
#asmejour: A template for ASME journal papers#
- Version 1.06 dated 2019/10/01.
+ Version 1.07 dated 2019/10/31.
####Overview####
This class provides a template to format preprints submitted to ASME journals in the style that
@@ -57,6 +57,8 @@
####Change log####
+v1.07: add commands for \\toprule, \\midrule, and \\bottomrule in ASME style; add advice on landscape material; minor edits to \\entry and for language support.
+
v1.06: allow standard \\date, \\maketitle, and \\title commands and abstract environment; make final column balancing a package option; remove \\normalfont from AMS equation tags to allow tags to match caption font; incorporate \\subfigure in example template; allow line numbers in AMS display math; provide comma between sequential footnote marks; adjust babel options; other minor edits; revise template text.
v1.05: automate list of figures/tables with option to omit; replace balance package with flushend package and automate; revise skips in nomenclature; address conflicts of lineno package with other elements; option to hyphenate typewriter font; new options for footer text; adjust \\emergencystretch and \\tolerance; additional documentation and references
diff --git a/macros/latex/contrib/asmejour/asmejour-sample.bib b/macros/latex/contrib/asmejour/asmejour-sample.bib
index fcbcc7a840..62255d83d9 100644
--- a/macros/latex/contrib/asmejour/asmejour-sample.bib
+++ b/macros/latex/contrib/asmejour/asmejour-sample.bib
@@ -1,4 +1,4 @@
-%% Revised 1 October 2019.
+%% Revised 31 October 2019.
@article{DKE1969,
author = {D. K. Edwards},
@@ -125,6 +125,16 @@
version = {1.10},
}
+@online{fairbairns,
+ author = {Robin Fairbairns and Sebastian Rahtz and Leonor Barroca},
+ title = {A package for rotated objects in \LaTeX},
+ year = {2016},
+ organization = {Comprehensive \TeX\ Archive Network},
+ url = {https://www.ctan.org/pkg/rotating},
+ urldate = {October 2, 2019},
+ version = {v2.16d},
+}
+
@online{GSL,
title = {{GNU} Scientific Library},
URL = {https://www.gnu.org/software/gsl/},
diff --git a/macros/latex/contrib/asmejour/asmejour-template.pdf b/macros/latex/contrib/asmejour/asmejour-template.pdf
index b69e52b5ac..ade917abc4 100644
--- a/macros/latex/contrib/asmejour/asmejour-template.pdf
+++ b/macros/latex/contrib/asmejour/asmejour-template.pdf
Binary files differ
diff --git a/macros/latex/contrib/asmejour/asmejour-template.tex b/macros/latex/contrib/asmejour/asmejour-template.tex
index 93ce5d67ce..2d276e0956 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
%% as they are being published in 2019.
%%
-%% This file is version 1.06 dated 2019/10/1
+%% This file is version 1.07 dated 2019/10/31
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -84,7 +84,6 @@
\pdfminorversion=7 % This selection is not required.
-
%%%%% FIELDS TO BE COMPLETED FOLLOW %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -280,10 +279,13 @@ The typewriter font loaded is \texttt{inconsolata} (which is sans serif), as sug
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.
+The \texttt{booktabs} is been loaded (and customized) to provide versions of \verb|\toprule|, \verb|\midrule|, and \verb|\bottomrule}| appropriate to ASME-style tables.
+
Table~\ref{tab:4} shows a table that spans both text columns. Figure~\ref{fig:2} shows a figure spanning both 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.
+Landscape figures and tables may be produced at full-page size by putting \verb|\usepackage[figuresright]{rotating}| in your \texttt{.tex} file's preamble and using the \texttt{sidewaystable*} and \texttt{sidewaysfigure*} environments~\cite{fairbairns}.
%%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -293,19 +295,43 @@ Text in the figures should be checked for legibility at either single-column wid
\caption{A simple table\label{tab:1}}
\centering{%
\begin{tabular}{l l r}
-\hline\hline
-Experiment & $u$ [m/s] & $T$ [\textdegree C]\rule{0pt}{10pt} \\[2pt]
-\hline
-Run 11 & 12.5 & 103.4 \rule{0pt}{10pt} \\
-Run 12 & 24 & 68.3 \\[1pt]
-\hline\hline
+\toprule
+Experiment & $u$ [m/s] & $T$ [\textdegree C] \\
+\midrule
+Run 11 & 12.5 & 103.4 \\
+Run 12 & 24 & 68.3 \\
+\bottomrule
\end{tabular}
-}
+}%
\end{table}
%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%% begin two column figure %%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\begin{figure*}[t]
+\begin{subfigure}[t]{0.5\textwidth} % You will get same result using \begin{minipage}[t]{0.5\textwidth}
+\vbox{
+\vspace*{1.7em}
+\centering{
+ \includegraphics{sample-figure-2a.pdf}
+}
+\vspace*{1.7em}
+}
+\subcaption{Interior region\label{fig:interior-region}}
+\end{subfigure}%
+%%%%%%%% don't leave a break here
+\begin{subfigure}[t]{0.5\textwidth} % You will get same result using \begin{minipage}[t]{0.5\textwidth}
+\centering{
+\includegraphics{sample-figure-2b.pdf}
+\subcaption{Exterior region\label{fig:exterior-region}}
+}\end{subfigure}%
+\caption{A figure with two subfigures \cite{Lienhard2019b}\label{fig:2}}
+\end{figure*}
+
+%%%%%%%%%%%%%%%%%%% end two column figure %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Reference Formatting with \texttt{asmejour.bst}}
@@ -335,45 +361,20 @@ The \verb|version={..}| field may be used with \verb|@book|, \verb|@online|, and
\caption{Table with more complicated columns}\label{tab:2}%
\centering{%
\begin{tabular}{!{\hspace*{0.5cm}} >{\raggedright\hangindent=1em} p{3cm} d{3} @{\hspace*{1cm}} d{3} !{\hspace*{0.5cm}}}
-\hline\hline
-\rule{0pt}{10pt}Experiment & \multicolumn{1}{c@{\hspace*{1cm}}}{$u$ [m/s]} & \multicolumn{1}{c!{\hspace*{0.5cm}}}{$T$ [\textdegree C]} \\[1pt]
-\hline
-The first experiment we ran this morning & 124.3 & 68.3 \rule{0pt}{10pt} \\
-The second experiment we ran this morning & 82.50 & 103.46 \\
-Our competitor's data & 72.321 & 141.384 \\[1pt]
-\hline\hline
+\toprule
+Experiment & \multicolumn{1}{c@{\hspace*{1cm}}}{$u$ [m/s]} & \multicolumn{1}{c!{\hspace*{0.5cm}}}{$T$ [\textdegree C]} \\
+\midrule
+The first experiment we ran this morning & 124.3 & 68.3 \\
+The second experiment we ran this morning & 82.50 & 103.46 \\
+Our competitor's data & 72.321 & 141.384\\
+\bottomrule
\end{tabular}
-}
+}%
\end{table}
%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-%%%%%%%%%%%%%%%%% begin two column figure %%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\begin{figure*}[t]
-\begin{subfigure}[t]{0.5\textwidth} % You will get same result using \begin{minipage}[t]{0.5\textwidth}
-\vbox{
-\vspace*{1.7em}
-\centering{
- \includegraphics{sample-figure-2a.pdf}
-}
-\vspace*{1.7em}
-}
-\subcaption{Interior region\label{fig:interior-region}}
-\end{subfigure}%
-%%%%%%%% don't leave a break here
-\begin{subfigure}[t]{0.5\textwidth} % You will get same result using \begin{minipage}[t]{0.5\textwidth}
-\centering{
-\includegraphics{sample-figure-2b.pdf}
-\subcaption{Exterior region\label{fig:exterior-region}}
-}\end{subfigure}%
-\caption{A figure with two subfigures \cite{Lienhard2019b}\label{fig:2}}
-\end{figure*}
-
-%%%%%%%%%%%%%%%%%%% end two column figure %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Additional Options for \texttt{asmejour.cls}}
The class accepts a number of options in addition to those already described.
@@ -390,24 +391,21 @@ The footers are all generated with the \texttt{fancyhdr} package~\cite{oostrum},
\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]}. The corresponding author mark in the author block will not change.
-
%%%%%%%%%%%%%%%%%%% begin linewidth table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{table}[t]
\newcolumntype{C}{>{$}c<{$}} % math-mode version of "c" column type, from array package
\caption{\label{tab:3}Table at full column width with columns in math mode}
-\centering{%
\begin{tabular*}{\linewidth}{@{\extracolsep{\fill}}CCCC@{\extracolsep{\fill}}}
-\hline\hline
-X_{z} & X_{c} & X_{c,m} & X_{c,2}\rule{0pt}{11pt}\\
+\toprule
+X_{z} & X_{c} & X_{c,m} & X_{c,2}\rule{0pt}{8pt}\\
3.92069 & 5.70943 & 6.32429 & 7.08757\\[2pt]
\varepsilon (T_1) & \varepsilon^i (T_1) & \varepsilon^i (T_m) & \alpha (T_1, T_2)\\
0.7258 & 0.6237 & 0.6807 & 0.7964 \\[2pt]
q_\textrm{gray} & q_\textrm{int, $T_1$} & q_\textrm{int, $T_m$} & q_\textrm{exact}\\
-400.2 & 462.1 & 371.0 & 371.8 \\[1pt]
-\hline\hline
+400.2 & 462.1 & 371.0 & 371.8 \\
+\bottomrule
\end{tabular*}
-}
\end{table}
%%%%%%%%%%%%%%%%%%%% end linewidth table %%%%%%%%%%%%%%%%%%%%%%%
@@ -436,14 +434,14 @@ Note that bookmarks can include simple math. Also note that \texttt{newtxmath} p
\caption{A table spanning two columns}\label{tab:4}%
\centering{%
\begin{tabular*}{0.8\textwidth}{@{\hspace*{1.5em}}@{\extracolsep{\fill}}ccc!{\hspace*{3.em}}ccc@{\hspace*{1.5em}}}
-\hline\hline
-\multicolumn{1}{@{\hspace*{1.5em}}c}{$x$\rule{0pt}{11pt}} &
+\toprule
+\multicolumn{1}{@{\hspace*{1.5em}}c}{$x$\rule{0pt}{8pt}} &
\multicolumn{1}{c}{$\textrm{erf}(x)$} &
\multicolumn{1}{c!{\hspace*{3.em}}}{$\textrm{erfc}(x)$} &
\multicolumn{1}{c}{$x$} &
\multicolumn{1}{c}{$\textrm{erf}(x)$} &
-\multicolumn{1}{c@{\hspace*{1.5em}}}{$\textrm{erfc}(x)$} \\ \hline
-0.00 & 0.00000 & 1.00000 & 1.10 & 0.88021 & 0.11980\rule{0pt}{11pt} \\
+\multicolumn{1}{c@{\hspace*{1.5em}}}{$\textrm{erfc}(x)$} \\ \midrule
+0.00 & 0.00000 & 1.00000 & 1.10 & 0.88021 & 0.11980 \\
0.05 & 0.05637 & 0.94363 & 1.20 & 0.91031 & 0.08969 \\
0.10 & 0.11246 & 0.88754 & 1.30 & 0.93401 & 0.06599 \\
0.15 & 0.16800 & 0.83200 & 1.40 & 0.95229 & 0.04771 \\
@@ -455,10 +453,10 @@ Note that bookmarks can include simple math. Also note that \texttt{newtxmath} p
0.70 & 0.67780 & 0.32220 & 1.90 & 0.99279 & 0.00721 \\
0.80 & 0.74210 & 0.25790 & 2.00 & 0.99532 & 0.00468 \\
0.90 & 0.79691 & 0.20309 & 2.50 & 0.99959 & 0.00041 \\
-1.00 & 0.84270 & 0.15730 & 3.00 & 0.99998 & 0.00002 \\[2pt]
-\hline\hline
+1.00 & 0.84270 & 0.15730 & 3.00 & 0.99998 & 0.00002 \\
+\bottomrule
\end{tabular*}
-}
+}%
\end{table*}
%%%%%%%%%%%%%%%% end two column table %%%%%%%%%%%%%%%%%%%
@@ -551,7 +549,7 @@ 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}. The primary language must be given as the \textit{last} language option in \verb|\documentclass|.
-If no language option is given, the package defaults to English. The standard caption and section names will follow \texttt{babel}'s dictionary for primary languages other than English. Users may additionally change ``Keywords'' and ``Nomenclature'' by renewing the commands \verb|\keywordname| and \verb|\nomname|. Changes to the page footer were described earlier.
+If no language option is given, the package defaults to English. The standard caption and section names will follow \texttt{babel}'s dictionary for primary languages other than English. Users may additionally change ``Keywords'' and ``Nomenclature'' by renewing the commands \verb|\keywordname| and \verb|\nomname|. Changes to the page footer were described earlier. The pdf bookmark for ``Appendices'' by be changed by renewing \verb|\appendicesname|.
An example of use is shown in \selectlanguage{french}\appendixname\ \ref{app:fourier}.\selectlanguage{english}
diff --git a/macros/latex/contrib/asmejour/asmejour.cls b/macros/latex/contrib/asmejour/asmejour.cls
index beb4364634..3f7653278c 100644
--- a/macros/latex/contrib/asmejour/asmejour.cls
+++ b/macros/latex/contrib/asmejour/asmejour.cls
@@ -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.06 dated 2019/10/01.
+%% This file is version 1.07 dated 2019/10/31.
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -52,7 +52,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{asmejour}[2019/10/01 asmejour paper format]
+\ProvidesClass{asmejour}[2019/10/31 asmejour paper format]
\LoadClass[twoside,9pt,twocolumn]{extarticle}
@@ -200,11 +200,15 @@
%% make \hline in tables heavier than default 0.4pt
\setlength\arrayrulewidth{.5\p@}
+\RequirePackage{booktabs}
+\renewcommand*{\toprule}{\specialrule{0.5pt}{0pt}{\doublerulesep}\specialrule{0.5pt}{0pt}{3pt}}
+\renewcommand*{\midrule}{\specialrule{0.5pt}{2pt}{3pt}}
+\renewcommand*{\bottomrule}{\specialrule{0.5pt}{1pt}{\doublerulesep}\specialrule{0.5pt}{0pt}{0pt}}
%%%%%%%% FONT related %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\RequirePackage{mathtools} % extends amsmath
-\RequirePackage[utf8]{inputenc}
+\RequirePackage[utf8]{inputenc} % backward compatibility...
\RequirePackage[]{babel}
\RequirePackage[]{newtxtext}
\RequirePackage[varqu,varl]{inconsolata} % sans typewriter font
@@ -262,6 +266,8 @@
}
\providecommand{\nomname}{Nomenclature}
\providecommand{\keywordname}{Keywords}
+ \providecommand{\appendicesname}{Appendices}
+
%%%%%%%%%%%%%%%%% EQUATION AND LINE NUMBERING %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -432,7 +438,7 @@
%% Special handling of the appendices
%% Assumes that appendices are the last technical content in paper
\RenewDocumentCommand{\appendix}{}{%
- \pdfbookmark[1]{Appendices}{appendices}
+ \pdfbookmark[1]{\appendicesname}{appendices}
\setcounter{section}{0}
\renewcommand\thesection{\Alph{section}}
\setcounter{equation}{0}
@@ -536,8 +542,8 @@
\DeclareDocumentCommand{\entry}{m g}{%
\IfNoValueTF{#2}{%
\itemsep12\p@ plus 4\p@ minus 4\p@% \bigskip
- \goodbreak\item[\bfseries#1\hfill]\itemsep3\p@ plus 1\p@ minus 1\p@\nopagebreak% \smallskip, ASME closer to \medskip
- }{%
+ \goodbreak\item[\bfseries#1\hfill]\itemsep3\p@ plus 1\p@ minus 1\p@\@itempenalty=1000%
+ }{%
\item[\hfill#1${} = {}$]#2%
\setlength\itemsep\savitemsep
\settowidth\@widest{#1${} = {}$}%