summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/asmejour
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-02-29 03:02:30 +0000
committerNorbert Preining <norbert@preining.info>2020-02-29 03:02:30 +0000
commit4736ac744a8c914e0d5ced1d157e017a385bbf43 (patch)
treecc6b754ea0d704573dfffffdbf327e14057ce864 /macros/latex/contrib/asmejour
parent02193cc5ca03abf234d3bc9d77b4821d85f58c62 (diff)
CTAN sync 202002290302
Diffstat (limited to 'macros/latex/contrib/asmejour')
-rw-r--r--macros/latex/contrib/asmejour/README.md8
-rw-r--r--macros/latex/contrib/asmejour/asmejour-template.pdfbin476955 -> 477385 bytes
-rw-r--r--macros/latex/contrib/asmejour/asmejour-template.tex20
-rw-r--r--macros/latex/contrib/asmejour/asmejour.bst7
-rw-r--r--macros/latex/contrib/asmejour/asmejour.cls50
5 files changed, 51 insertions, 34 deletions
diff --git a/macros/latex/contrib/asmejour/README.md b/macros/latex/contrib/asmejour/README.md
index 6c30bc0159..1d9901b796 100644
--- a/macros/latex/contrib/asmejour/README.md
+++ b/macros/latex/contrib/asmejour/README.md
@@ -1,11 +1,11 @@
#asmejour: A template for ASME journal papers#
- Version 1.09 dated 2019/11/07.
+ Version 1.10 dated 2020/02/28.
####Overview####
This class provides a template to format preprints submitted to ASME journals in the style that
- is being used in 2019.
+ is being used in 2020.
This work is not a publication of ASME itself.
@@ -57,6 +57,8 @@
####Change log####
+v1.10: update asmeconf.bst to most recent Crossref standard prefix for doi (https://doi.org/); remove xpatch package from class file; disable \\( and \\) in pdf bookmarks to avoid warnings; adjust \\eqref in bookmarks; edit documentation.
+
v1.09: adjust nomenclature list; edit language support
v1.08: adjust penalties in nomenclature list; fix minor typos in template
@@ -81,7 +83,7 @@ v1.00: initial release
####License####
- Copyright (c) 2019 John H. Lienhard
+ Copyright (c) 2020 John H. 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,
diff --git a/macros/latex/contrib/asmejour/asmejour-template.pdf b/macros/latex/contrib/asmejour/asmejour-template.pdf
index 69c3bf0361..f41e442098 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 c6ea3b60f0..2d6601004f 100644
--- a/macros/latex/contrib/asmejour/asmejour-template.tex
+++ b/macros/latex/contrib/asmejour/asmejour-template.tex
@@ -1,9 +1,9 @@
% !TEX encoding = UTF-8 Unicode
%%
%% 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.
+%% as they are being published in 2020.
%%
-%% This file is version 1.09 dated 2019/11/07
+%% This file is version 1.10 dated 2020/02/28
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -60,7 +60,7 @@
%%
%% LICENSE:
%%
-%% Copyright (c) 2019 John Lienhard
+%% 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,
@@ -83,11 +83,8 @@
%% Class options are described above.
\documentclass[largesc,upint,varvw,barcolor=Red4,nocopyright,hyphenate,balance,lang-second=french,lang=english]{asmejour}
-\pdfminorversion=7 % This selection is not required.
-
%%%%% FIELDS TO BE COMPLETED FOLLOW %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
%%%%% pdf metadata, the user should edit %%%%%%%%%%%%%%%%%%
\hypersetup{%
pdftitle={ASME Journal Paper Template}, % <=== change to YOUR pdf file title
@@ -95,7 +92,6 @@
pdfauthor={John H. Lienhard}, % <=== change to YOUR name[s]!!!
}
-
%%%% Journal name and optional copyright year %%%%%%%%%%%%%%
%% Omit "Journal of"
@@ -222,7 +218,7 @@ Section, subsection, and subsubsection headings should be in title case (first l
%% 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}}
+\caption{A figure caption with math, Eq.~\eqref{eqn:1}: $z = (r,\phi)$ \cite{Lienhard2019b}\label{fig:1}}
\end{figure}
%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%
@@ -284,7 +280,7 @@ The \texttt{booktabs} package \cite{fear} is loaded (and customized) to provide
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.
+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. Images in figures are handled by the standard \texttt{graphicx} package.
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}.
@@ -336,7 +332,8 @@ Run 12 & 24 & 68.3 \\
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\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.
+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. Citations and references are managed by the standard \texttt{natbib} package.
+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, 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}
@@ -414,7 +411,7 @@ q_\textrm{gray} & q_\textrm{int, $T_1$} & q_\textrm{int, $T_m$} & q_\textrm{exa
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% 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.
+%% without losing characters or producing warnings/errors. Note that bookmark can include simple math and \eqref{..}.
%%
%% Newtxmath provides the option for upright Greek letters as \upomega (vs. \omega), etc.
%%
@@ -573,7 +570,6 @@ Joseph Fourier est connu pour avoir déterminé, par le calcul, la diffusion de
\bibliography{asmejour-sample} %% <=== change this to name of your bib file
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% To omit final list of figures and tables, use the class option [nolists]
diff --git a/macros/latex/contrib/asmejour/asmejour.bst b/macros/latex/contrib/asmejour/asmejour.bst
index 29876b85da..426add9076 100644
--- a/macros/latex/contrib/asmejour/asmejour.bst
+++ b/macros/latex/contrib/asmejour/asmejour.bst
@@ -26,13 +26,13 @@
% ===============================================================
%-------------------------------------------------------------------
%%
- %% This file is asmejour.bst, version 1.01 dated 2019/05/26.
+ %% This file is asmejour.bst, version 1.02 dated 2019/12/03.
%%
%% This file was generated and edited by John Lienhard.
%% This file is a derivative work under Clause 6 of the LPPL license.
%%
%% The generated file and the modifications are based on what ASME is actually putting into
- %% published journal papers in early 2019. The modification mainly relate to handling of online
+ %% published journal papers in early 2019. The modifications mainly relate to handling of online
%% information. Details follow.
%%
%% Added fields: eventdate, urldate, urltype, venue, version, versiontype
@@ -40,6 +40,7 @@
%% Added: urlprefix = {}, format.web.urldate, bbl.urldate; urltype field changes "accessed" to something else.
%% Added: venue and eventdate to @inproceedings
%% Added: format.version to @book, @online, and @manual; text can be changed with versiontype field.
+ %% Updated: doi url prefix to https://doi.org/
%%
%% Remove "emphasize" from journal article, and linked doi (or else url) to journal name (or book title)
%% without explicitly showing the urls. The urls may be added to the note = {..} field to display explicitly
@@ -762,7 +763,7 @@ FUNCTION {doilink}
{ "\href{" url * "}{" * swap$ * "}" * }
if$
}
- { "\href{http://dx.doi.org/" doi * "}{" * swap$ * "}" * }
+ { "\href{https://doi.org/" doi * "}{" * swap$ * "}" * }
if$
}
if$
diff --git a/macros/latex/contrib/asmejour/asmejour.cls b/macros/latex/contrib/asmejour/asmejour.cls
index 87bd31d377..b452428380 100644
--- a/macros/latex/contrib/asmejour/asmejour.cls
+++ b/macros/latex/contrib/asmejour/asmejour.cls
@@ -6,9 +6,9 @@
%% The asmejour.cls file should be used with the files asmejour.bst (for citations) and asmejour-template.tex.
%%
%%
-%% This file is version 1.09 dated 2019/11/07.
- \def\versionno{1.09}
- \def\versiondate{2019/11/07\space}
+%% This file is version 1.10 dated 2020/2/28.
+ \def\versionno{1.10}
+ \def\versiondate{2020/02/28\space}
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -34,7 +34,7 @@
%%
%% LICENSE:
%%
-%% Copyright (c) 2019 John H. Lienhard
+%% Copyright (c) 2020 John H. 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,
@@ -210,7 +210,7 @@
%%%%%%%% FONT related %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\RequirePackage{mathtools} % extends amsmath
-\RequirePackage[utf8]{inputenc} % backward compatibility...
+\RequirePackage[utf8]{inputenc} % backward compatibility...LuaLaTeX will disable
\RequirePackage[]{babel}
\RequirePackage[]{newtxtext}
\RequirePackage[varqu,varl]{inconsolata} % sans typewriter font
@@ -274,8 +274,8 @@
%%%%%%%%%%%%%%%%% EQUATION AND LINE NUMBERING %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% ASME puts equation tags in blue
-\RequirePackage{xpatch}
-\xpatchcmd{\tagform@}{(\ignorespaces#1\unskip\@@italiccorr)}{\color{blue}(\ignorespaces#1\unskip\@@italiccorr)}{}{}
+\RequirePackage{etoolbox} % dropped xpatch 28/2/20
+\patchcmd{\tagform@}{(\ignorespaces#1\unskip\@@italiccorr)}{\color{blue}(\ignorespaces#1\unskip\@@italiccorr)}{}{}
%% Ensure that the current font is used for equation tags, not \normalfont as set by amsmath
\def\maketag@@@#1{\hbox{\m@th#1}}
@@ -484,7 +484,7 @@
\urlstyle{same} % don't switch to typewriter font
-\RequirePackage{doi} % provides hyperlinks for doi in bibliography
+\RequirePackage{doi} % supports nasty characters in some doi's
\renewcommand{\doitext}{doi:~} % change the default, {doi:}, to this for ASME specification
@@ -494,16 +494,26 @@
\def\bm#1#{\relax}%
}
+%% Let's disable \( and \) in pdf bookmarks, 28/2/20
+\pdfstringdefDisableCommands{%
+ \def\({\relax}%
+ \def\){\relax}%
+}
+
%% Let's just remove citations from pdf bookmarks
\pdfstringdefDisableCommands{%
\def\cite{\@gobble}%
}
+%% Ensure that tag color does not follow \eqref into bookmarks, 28/2/20
+\pdfstringdefDisableCommands{%
+ \def\eqref#1{(\ref{#1})}%
+}
+
%% Let's make sure footnotes in section headings don't break pdf bookmarks.
-\RequirePackage{etoolbox}
\robustify{\footnote}
\pdfstringdefDisableCommands{%
- \def\footnote#1{}%
+ \def\footnote#1{}%
}
%%% Create an optional argument for unnumbered sections and set pdf bookmark (thru \addcontentsline).
@@ -513,16 +523,16 @@
\let\svsection\section
\RenewDocumentCommand{\section}{s o m}{%
\IfBooleanTF {#1}
- {\svsection*{#3}\phantomsection
+ {\svsection*{#3}\phantomsection%
{\IfNoValueTF {#2}
- {\addcontentsline{toc}{section}{#3} }
- {\addcontentsline{toc}{section}{#2} }
- }
+ {\addcontentsline{toc}{section}{#3}}
+ {\addcontentsline{toc}{section}{#2}}% remove trailing space 28/2/20
+ }%
}
{\IfNoValueTF {#2}
{\svsection{#3}}
- {\svsection[#2]{#3}}
- }
+ {\svsection[#2]{#3}}%
+ }%
}
@@ -758,6 +768,14 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\usepackage{iftex}%% can delete all this if desired.
+\ifpdftex
+ \pdfminorversion=7 % This selection is not required.
+\else
+ \relax
+\fi
+
+
\endinput
%%
%% End of file `asmejour.cls'.