summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/asmeconf
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/asmeconf
parent02193cc5ca03abf234d3bc9d77b4821d85f58c62 (diff)
CTAN sync 202002290302
Diffstat (limited to 'macros/latex/contrib/asmeconf')
-rw-r--r--macros/latex/contrib/asmeconf/README.md8
-rw-r--r--macros/latex/contrib/asmeconf/asmeconf-template.pdfbin483752 -> 479400 bytes
-rw-r--r--macros/latex/contrib/asmeconf/asmeconf-template.tex36
-rw-r--r--macros/latex/contrib/asmeconf/asmeconf.cls68
4 files changed, 63 insertions, 49 deletions
diff --git a/macros/latex/contrib/asmeconf/README.md b/macros/latex/contrib/asmeconf/README.md
index 6dabe3eae3..2039844683 100644
--- a/macros/latex/contrib/asmeconf/README.md
+++ b/macros/latex/contrib/asmeconf/README.md
@@ -1,11 +1,11 @@
#asmeconf: A template for ASME conference papers#
- Version 1.15 dated 2020/01/24.
+ Version 1.16 dated 2020/02/28.
####Overview####
This class provides a template to format ASME Conference papers according to
- the requirements on ASME's web pages (as posted in December 2019).
+ the requirements on ASME's web pages (as posted in early 2020).
[www.asme.org/publications-submissions/proceedings/formatting-the-paper](https://www.asme.org/publications-submissions/proceedings/formatting-the-paper)
@@ -67,7 +67,9 @@
####Change log####
- v1.15: correct extra space left by \\CorrespondingAuthor when that author is not last; correct breakage of \\ref and \\eqref in captions. Thanks to Bret Van Poppel for reporting these issues.
+ v1.16: remove xpatch and comment packages from class file; disable \\( and \\) in pdf bookmarks to avoid warnings; edit documentation.
+
+ v1.15: correct extra space left by \\CorrespondingAuthor when that author is not last; correct breakage of \\ref in captions. Thanks to Bret Van Poppel for reporting these issues.
v1.14: edit documentation; use 2020 IMECE header in layout example
diff --git a/macros/latex/contrib/asmeconf/asmeconf-template.pdf b/macros/latex/contrib/asmeconf/asmeconf-template.pdf
index 14dbd71208..74cebad255 100644
--- a/macros/latex/contrib/asmeconf/asmeconf-template.pdf
+++ b/macros/latex/contrib/asmeconf/asmeconf-template.pdf
Binary files differ
diff --git a/macros/latex/contrib/asmeconf/asmeconf-template.tex b/macros/latex/contrib/asmeconf/asmeconf-template.tex
index bc2fb371c0..542c090acd 100644
--- a/macros/latex/contrib/asmeconf/asmeconf-template.tex
+++ b/macros/latex/contrib/asmeconf/asmeconf-template.tex
@@ -1,12 +1,12 @@
%%
%% This file is asmeconf-template.tex, a template to format ASME Conference papers according to
-%% the requirements on ASME's conference web pages. As of version 1.11, this template follows ASME's
-%% newer conference guidelines as posted in July 2019.
-%%
-%% The new guidelines have changed the request author block formatting.
-%% Nomenclature follows the abstract. Abstract is in italics.
+%% the requirements on ASME's conference web pages.
%%
-%% This file is version 1.15 dated 2020/01/24.
+%% This file is version 1.16 dated 2020/02/28.
+%%
+%% As of version 1.11, this template follows ASME's newer conference guidelines posted in July 2019.
+%% The new guidelines have changed the requested author block formatting.
+%% Nomenclature now follows the abstract. Abstract is in italics.
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -62,7 +62,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,
@@ -248,9 +248,6 @@ If you wish to override the default math format in captions, put \verb|\mathvers
\subsection{Subsection and Sub-subsection Headings}
Subsections and sub-subsection headings should be entered in title case, with the first letter of primary words capitalized. Sub-subsections (i.e., paragraphs) are never numbered.
-\subsection{Colored hyperlinks}
-ASME requires that all text be in black when the paper is submitted for publication. For other uses, authors may
-obtain colored hyperlinks with the [\texttt{colorlinks}] option.
%%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -297,7 +294,7 @@ Our competitor's test & 72.321 & 141.384 \\
Table \ref{tab:1} is an example of a simple table. Table captions should be placed above tables.
The class loads the \texttt{booktabs} package (used for horizontal rules in both Table \ref{tab:1} and \ref{tab:2}), and the \texttt{array} and \texttt{dcolumn} packages which provide extended capabilities for columns in the \texttt{tabular} environment (used in Table \ref{tab:2}). Table \ref{tab:3} is an example of a table that spans two columns.
-Figure captions go below figures. Figure~\ref{fig:2} is an example of a figure that spans two columns and includes subfigures. The text in figures (and tables) should be no smaller than 6~point type.
+Figure captions go below figures. Figure~\ref{fig:2} is an example of a figure that spans two columns and includes subfigures. The text in figures (and tables) should be no smaller than 6~point type. Images in figures are handles 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}.
@@ -331,9 +328,9 @@ Landscape figures and tables may be produced at full-page size by putting \verb|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Reference Formatting with \NoCaseChange{\texttt{asmeconf.bst}}\footnote{If you have text in a section heading or caption that you do not want to be capitalized, such as an SI unit, enclose it in a \texttt{\textbackslash NoCaseChange} command.}}
-Citations are automatically numbered \cite{ning2002}. They should be inserted at the appropriate point using a \verb|\cite{ref}| command~\cite{gibson2008,stevens1999}. The citations will be automatically sorted and compressed as well if they are given in a set \cite{stevens1999,ning2002,gibson2008,wions2005,smith2002,watson1982,smith1998}. See the \texttt{asmeconf-sample.bib} file for examples of how to enter your references.
+Citations are automatically numbered \cite{ning2002}. They should be inserted at the appropriate point using a \verb|\cite{ref}| command~\cite{gibson2008,stevens1999}. The citations will be automatically sorted and compressed as well if they are given in a set \cite{stevens1999,ning2002,gibson2008,wions2005,smith2002,watson1982,smith1998}. See the \texttt{asmeconf-sample.bib} file for examples of how to enter your references. Citations and references are managed by the standard \texttt{natbib} package.
-The {\upshape\texttt{asmeconf.bst}} \textsc{Bib}\negthinspace\TeX\ style follows the reference styles posted on ASME's conference web site in mid-2019. Examples for these and many other cases are given in the \texttt{asmeconf-sample.bib} file, which is part of this distribution. Nevertheless, a few comments are necessary.
+The {\upshape\texttt{asmeconf.bst}} \textsc{Bib}\negthinspace\TeX\ style follows the reference styles posted on ASME's conference web site in early 2020. Examples for these and many other cases are given in the \texttt{asmeconf-sample.bib} file, which is part of this distribution. Nevertheless, a few comments are necessary.
%% subsubsections are not numbered
\subsubsection*{DOI, URL, and eprint} Include DOI numbers when they are available. URL's may alternatively be given.
@@ -390,8 +387,15 @@ which selects the Euler font for \verb|\mathcal| (this is our default). To find
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.
+
+%%%%%%%%%%%%%%% ADDITIONAL PACKAGE OPTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\section{Additional Options for \NoCaseChange{\texttt{asmeconf.cls}}}
-The class accepts a number of options in addition to those already described.
+The class accepts a number of options in addition to those already described. These options are discussed next.
+
+\subsection{Colored hyperlinks}
+ASME requires that all text be in black when the paper is submitted for publication. For other uses, authors may
+obtain colored hyperlinks with the [\texttt{colorlinks}] option.
\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.
@@ -410,6 +414,8 @@ The footers are generated with the \texttt{fancyhdr} package~\cite{oostrum}, so
\subsection{Hyphenation of Typewriter Font} The option \texttt{[hyphenate]} will allow hyphenation of the typewriter font.
Hyphenation is normally suppressed for typewriter mode because this font is often used for code.
+\subsection{Support for Other Languages} The package can be adapted to incorporate (or entirely use) languages other than English. See Appendix \ref{appendix:c} for details.
+
%%%%%%%%%%%%%%% begin two column table %%%%%%%%%%%%%%%%%%
\begin{table*}[t]
@@ -505,7 +511,7 @@ the option [\texttt{oldauthors}]. When using this form, the author names and ad
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section{Language Support}
+\section{Language Support}\label{appendix:c}
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
diff --git a/macros/latex/contrib/asmeconf/asmeconf.cls b/macros/latex/contrib/asmeconf/asmeconf.cls
index 0eda4a2701..4f2d8f3d42 100644
--- a/macros/latex/contrib/asmeconf/asmeconf.cls
+++ b/macros/latex/contrib/asmeconf/asmeconf.cls
@@ -5,9 +5,9 @@
%%
%% Please note that ASME's journals follow specifications different from ASME conference papers.
%%
-%% This file is version 1.15 dated 2020/01/24.
- \def\versionno{1.15}
- \def\versiondate{2020/01/24\space}
+%% This file is version 1.16 dated 2020/02/28.
+ \def\versionno{1.16}
+ \def\versiondate{2020/02/28\space}
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -49,7 +49,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,
@@ -89,7 +89,7 @@
\RequirePackage{kvoptions}
-%\RequirePackage{kvsetkeys}
+%\RequirePackage{kvsetkeys} % already loaded by kvoptions
\SetupKeyvalOptions{
family=asmeconf,
prefix=asmeconf@,
@@ -190,7 +190,7 @@
\RequirePackage{graphicx}
\RequirePackage[hyperref,fixpdftex,dvipsnames,svgnames,x11names]{xcolor}
\RequirePackage{xparse}
-\RequirePackage{comment}
+%\RequirePackage{comment} % user may load this in preamble if desired.
%%%%%%%%%%%%%%%%%%%%%%%%
@@ -243,7 +243,7 @@
%% This provides sans serif italic and sans serif bold italic math.
-%% It's intended only for use in the figure captions and section heading (recommend \bm{..} elsewhere).
+%% It's intended only for use in the figure captions and section headings (recommend \bm{..} elsewhere).
\DeclareMathVersion{sansbold}
\SetSymbolFont{letters}{sansbold}{OML}{ntxsfmi}{b}{it}
\SetSymbolFont{lettersA}{sansbold}{U}{ntxsfmia}{b}{it}
@@ -360,16 +360,22 @@
\urlstyle{same} % don't switch to typewriter font
-\RequirePackage{doi} % provides hyperlinks for doi in bibliography
+\RequirePackage{doi} % provides line breaking for doi hyperlinks in bibliography
\renewcommand{\doitext}{DOI } % change the default value, {doi:}, to this per ASME specification
\RequirePackage{bookmark} % improves handling of pdf bookmarks
%% Since \bm may be useful in headings, this fix will reduce frequency with which
-%% alternate pdfstrings must be given in revised section command as \section[pdfstring]{texstring}
+%% alternate pdfstrings must be given in revised section command as \section[pdfstring]{texstring}
\pdfstringdefDisableCommands{%
\def\bm#1#{\relax}%
}
+%% Let's disable \( and \) in pdf bookmarks, 28/2/20
+\pdfstringdefDisableCommands{%
+ \def\({\relax}%
+ \def\){\relax}%
+}
+
%% Let's also make sure \NoCaseChange in section headings won't break pdf bookmarks
\pdfstringdefDisableCommands{%
\let\NoCaseChange\relax%
@@ -383,35 +389,35 @@
%% Let's make sure footnotes in section headings don't break pdf bookmarks.
\RequirePackage{etoolbox}
\robustify{\footnote}
+% \patchcmd{\section}{\sectionmark}{\let\footnote\@gobble\sectionmark}{}{} <== not really needed in this context 28/2/20
\pdfstringdefDisableCommands{%
\def\footnote#1{}%
}
-
%% Let's also add \footnote to the \TextUppercase exception list, so that footnote text won't be capitalized
%% if given in section headings. Ditto for \eqref
-\RequirePackage{xpatch}
-\xpatchcmd{\@uclcnotmath}{\@nonchangecase\ref}{\@nonchangecase\ref\@nonchangecase\footnote}{}{}
-\xpatchcmd{\@uclcnotmath}{\@nonchangecase\ref}{\@nonchangecase\ref\@nonchangecase\eqref}{}{} %% correct 24 Jan 2020
+%
+\patchcmd{\@uclcnotmath}{\@nonchangecase\ref}{\@nonchangecase\ref\@nonchangecase\footnote}{}{}
+\patchcmd{\@uclcnotmath}{\@nonchangecase\ref}{\@nonchangecase\ref\@nonchangecase\eqref}{}{} %% corrected 24 Jan 2020
%%% Create an optional argument for unnumbered sections and set pdf bookmark (thru \addcontentsline).
%%% The optional argument will manually set the pdf bookmark for that section; can be used to avoid hyperref
%%% errors when macros are in section titles.
-%%% There should not be errors for $$, \cite, \ref, \label, \footnote, or \bm with current construction.
+%%% There should not be errors for $, \cite, \ref, \eqref, \label, \footnote, \NoCaseChange, or \bm with current constructions.
\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}}% removed trailing space 28/2/20
+ }%
+ }%
{\IfNoValueTF {#2}
{\svsection{#3}}
- {\svsection[#2]{#3}}
- }
+ {\svsection[#2]{#3}}%
+ }%
}
%%%%%%%%%%%%% Line numbering and balancing columns on last page %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -482,7 +488,7 @@
}{%
\item[#1\hfill]#2%
\@itempenalty=-\@lowpenalty%
- }
+ }%
}
\DeclareDocumentEnvironment{nomenclature}{O{2em} O{\nomname}}{%
@@ -491,13 +497,13 @@
\section*{#2}
\raggedright
\begin{list}{}{%
- \setlength{\itemsep}{0pt}
- \setlength{\parsep}{\itemsep}
+ \setlength{\itemsep}{0pt}%
+ \setlength{\parsep}{\itemsep}%
\setlength{\labelsep}{1em}%
\setlength{\labelwidth}{\nomenwidth}%
\setlength{\leftmargin}{\labelwidth}%
\addtolength{\leftmargin}{\labelsep}%
- \setlength\savitemsep\itemsep
+ \setlength\savitemsep\itemsep%
}%
}{\end{list}}
@@ -637,13 +643,13 @@
\DeclareDocumentCommand{\CorrespondingAuthor}{m g}{%
\global\CAtrue%
\IfNoValueTF{#2}{%
- \gdef\@CAsep{\relax}
- \gdef\@CAemail{\relax}
+ \gdef\@CAsep{\relax}%
+ \gdef\@CAemail{\relax}%
}{%
- \gdef\@CAsep{:\space}
- \gdef\@CAemail{#2}
- }
- \renewcommand*{\thefootnote}{\fnsymbol{footnote}}
+ \gdef\@CAsep{:\space}%
+ \gdef\@CAemail{#2}%
+ }%
+ \renewcommand*{\thefootnote}{\fnsymbol{footnote}}%
\ignorespaces#1\ignorespaces\footnotemark[1]%
}