summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/latex/asmeconf
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-04-03 21:39:02 +0000
committerKarl Berry <karl@freefriends.org>2019-04-03 21:39:02 +0000
commit3b7f83d0c3c2e196609666664f5281065c23812b (patch)
treedf6ff97ecaf5cb7e7f72e36df3f1cf97fae5b292 /Master/texmf-dist/tex/latex/asmeconf
parent1c88174cd5df6c984f2846dee6a830522ccc9fbd (diff)
asmeconf (3apr19)
git-svn-id: svn://tug.org/texlive/trunk@50734 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/tex/latex/asmeconf')
-rw-r--r--Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls99
1 files changed, 51 insertions, 48 deletions
diff --git a/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls b/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls
index 30deb02d8cd..30fa47433d1 100644
--- a/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls
+++ b/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls
@@ -5,7 +5,7 @@
%%
%% Please note that ASME's journals follow specifications different from ASME conference papers.
%%
-%% This file is version 1.0 dated 2019/03/28
+%% This file is version 1.01 dated 2019/04/03.
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -35,7 +35,9 @@
%% New commands are described in the ASME-Conference-template.tex file. The \section[]{} command's optional
%% argument is changed to support pdf bookmarks.
%%
+%%
%=========================================================
+%%
%% LICENSE:
%%
%% Copyright (c) 2019 John H. Lienhard
@@ -49,36 +51,37 @@
%% The above copyright notice and this permission notice shall be included in all copies or
%% substantial portions of the Software.
%%
-%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
-%% NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-%% IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-%% WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-%% SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+%% The software is provided "as is", without warranty of any kind, express or implied, including but
+%% not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement.
+%% in no event shall the authors or copyright holders be liable for any claim, damages or other liability,
+%% whether in an action of contract, tort or otherwise, arising from, out of or in connection with the
+%% software or the use or other dealings in the software.
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{asmeconf}[2019/03/24 ASME Conference Paper Format]
+\ProvidesClass{asmeconf}[2019/04/03 ASME Conference Paper Format]
\LoadClass[twoside,twocolumn,10pt]{article}
-% Two-sided layout not used in ASME's specs, but it's included here since that's how they print
+% Two-sided layout not used in ASME's specs, although that's how papers are printed
-%%%%%%%%%%%%%% Options for the class %%%%%%%%%%%%%%%
-%% option to omit ASME footer %%%%%%%%%%%%%
+%%%%%%%%%%%%%% Options for the class %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%% option to omit ASME footer
\DeclareOption{nofoot}{%
\AtBeginDocument{\pagestyle{plain}}%
}
-%% Access many options from newtxmath %%%%%%%%%
-%% See newtxmath documentation for details %%%%
+%% Access many options from newtxmath
+%% See newtxmath documentation for details
\DeclareOption{upint,smallerops,varvw,varg,slantedGreek,frenchmath,varbb,cmbraces}{\PassOptionsToPackage{}{newtxmath}}
%% Access many options for mathalpha; defaults are scr=dutchcal,cal=euler
%% See mathalfa documentation for details
\DeclareOption{scr,cal,frak,bb,scrscaled,calscaled,frakscaled,bbscaled,scaled}{\PassOptionsToPackage{}{mathalfa}}
-%% Option for slightly large small capitals font
+%% Option for slightly larger small capitals font
\DeclareOption{largesc}{\PassOptionsToPackage{largesc}{newtxtext}}
%% Option not to use latex default superscripts, instead using the newtxtext superiors font [nodefaultsups]
@@ -92,7 +95,7 @@
\ExecuteOptions{scr=dutchcal,cal=euler}
\ProcessOptions\relax
-% now that \ignore is def'd and other options declared, we can deal with newtxtext defaultsups command
+%% now that \ignore is def'd and other options declared, we can deal with newtxtext defaultsups command
\ignore{\DeclareOption{supstyle}{\PassOptionsToPackage{defaultsups}{newtxtext}}}
\ExecuteOptions{supstyle}
\ProcessOptions\relax
@@ -124,8 +127,9 @@
\RequirePackage{mathtools} % extends amsmath
\RequirePackage[utf8]{inputenc}
-\RequirePackage[]{newtxtext} % stay with traditional superiors, rather than nice but small newtxtext ones
-\RequirePackage[]{newtxmath} % loads amsmath
+\RequirePackage[]{newtxtext}
+\RequirePackage[]{newtxmath}
+% See package documentation
\RequirePackage[]{mathalfa} % load optional fonts for Calligraphy, Script, etc.
% See package documentation
@@ -137,7 +141,7 @@
%%%% ASME's specs differ from latex standard article-10 class %%%
\makeatletter
-\renewcommand\LARGE{\@setfontsize\LARGE{15}{18}} %... default is 17
+\renewcommand\LARGE{\@setfontsize\LARGE{15}{18}} %... default is 17
\renewcommand\Large{\@setfontsize\Large{12}{14.5}} %... default is 14
\renewcommand\large{\@setfontsize\large{11}{13.6}} %... default is 12
\renewcommand\normalsize{\@setfontsize\normalsize{10}{12}}
@@ -170,7 +174,7 @@
\kern 2pt
}
-% reduce indentation of footnotes
+%% reduce indentation of footnotes
\makeatletter
\renewcommand\@makefntext[1]{%
\noindent\makebox[2ex][r]{\@makefnmark}#1}
@@ -185,8 +189,8 @@
\captionsetup[figure]{name=FIGURE,labelfont={sf,bf,small},textfont={sf,bf,small},labelsep=period}
\captionsetup[table]{name=TABLE,labelfont={sf,bf,small},textfont={sf,bf,small},labelsep=period}
-%%% This construction avoids a failure of hyperref in relation to uppercase caption
-%%% discussion: https://tex.stackexchange.com/questions/375695/maketextuppercase-inside-table-captions
+%% This construction avoids a failure of hyperref in relation to uppercase caption
+%% Discussion: https://tex.stackexchange.com/questions/375695/maketextuppercase-inside-table-captions
\AtBeginDocument{
\let\scaption\caption
\renewcommand*{\caption}[2][\shortcaption]{\def\shortcaption{#2}\scaption[#1]{\MakeTextUppercase{#2}}}%
@@ -200,9 +204,9 @@
\RequirePackage[raggedright,indentafter]{titlesec}
-% ASME specifies 10 pt headings
-\titleformat{\section}{\bfseries\sffamily\raggedright}{\thesection :}{0.5em}{\MakeTextUppercase} %\large
-\titleformat{name=\section,numberless}{\bfseries\sffamily\raggedright}{}{0em}{\MakeTextUppercase} %\large
+%% ASME specifies 10 pt headings
+\titleformat{\section}{\bfseries\sffamily\raggedright}{\thesection :}{0.5em}{\MakeTextUppercase}
+\titleformat{name=\section,numberless}{\bfseries\sffamily\raggedright}{}{0em}{\MakeTextUppercase}
\titleformat{\subsection}{\bfseries\sffamily\raggedright}{}{0pt}{\indent}
\titleformat{\subsubsection}[runin]{\bfseries\sffamily}{}{0pt}{\indent}[.\hspace*{0.5em}]
@@ -212,12 +216,12 @@
\titlespacing\subsubsection{0pt}{12pt plus 4pt minus 2pt}{0pt plus 2pt minus 1pt}
-%%%%%% Special handling of the appendices %%%%%%%%%%%%%%
-%%%%%% Assumes that appendices are the last content in paper %%%%%%%
+%% Special handling of the appendices
+%% Assumes that appendices are the last content in paper
\RenewDocumentCommand{\appendix}{}{%
\pdfbookmark[0]{Appendices}{appendices}
\renewcommand\thesection{\Alph{section}}
- \titleformat{\section}{\bfseries\sffamily\raggedright}{APPENDIX \thesection:}{0.5em}{\MakeTextUppercase} %\large
+ \titleformat{\section}{\bfseries\sffamily\raggedright}{APPENDIX \thesection:}{0.5em}{\MakeTextUppercase}
}
%%%%%%%%%%%%% hyperref %%%%%%%%%%%%%%%%%%%
@@ -232,7 +236,7 @@
bookmarksnumbered=true,%
bookmarksopen=true,%
bookmarksopenlevel=1,%
- colorlinks=true,%%% <=== can set false to get black type, in .tex file
+ colorlinks=true,%%% <=== set false to get black type, but do so in .tex file
linkcolor=blue, %
citecolor=blue, % SeaGreen4,%
urlcolor=blue, % Red3,%
@@ -245,19 +249,19 @@
pdfdisplaydoctitle=true%
]{hyperref}
-\urlstyle{same} % don't switch to typewriter font
+\urlstyle{same} % don't switch to typewriter font
\RequirePackage{doi} % provides hyperlinks for doi in bibliography
\renewcommand{\doitext}{DOI } % change the default value, {doi:}, to this per ASME specification
-%% since \bm is useful in headings, this fix will reduce frequency with which
-%% alternate strings must be given in revised section command as \section[pdfstring]{texstring}
+%% Since \bm is useful in headings, this fix will reduce frequency with which
+%% alternate pdfstrings must be given in revised section command as \section[pdfstring]{texstring}
\pdfstringdefDisableCommands{%
\def\bm#1#{\relax}%
}
-%% Let's make sure \NoCaseChange in section headings won't break pdf bookmarks
+%% Let's also make sure \NoCaseChange in section headings won't break pdf bookmarks
\pdfstringdefDisableCommands{%
\let\NoCaseChange\relax%
}
@@ -268,7 +272,6 @@
}
%% Let's make sure footnotes in section headings don't break pdf bookmarks.
-%% (Related warning messages in log can be ignored.)
\RequirePackage{etoolbox}
\robustify{\footnote}
\pdfstringdefDisableCommands{%
@@ -279,17 +282,15 @@
%% Let's also add \footnote to the \TextUppercase exception list, so that footnote text won't be capitalized
%% if given in section headings
\RequirePackage{xpatch}
-%\AtBeginDocument{%
\makeatletter
\xpatchcmd{\@uclcnotmath}{\@nonchangecase\ref}{\@nonchangecase\ref\@nonchangecase\footnote}{}{}
\makeatother
-%}
%%% Create an optional argument for unnumbered sections
-%%% the optional argument carries the pdf bookmark (since we use no table of contents or running head)
-%%% the optional argument 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.
+%%% The optional argument carries the pdf bookmark (since we use no table of contents or running head).
+%%% The optional argument 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.
\let\svsection\section
\RenewDocumentCommand{\section}{s o m}{%
\IfBooleanTF {#1}
@@ -305,11 +306,11 @@
}
}
-%%%%%%%%%%%%% Define special environments %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-%%% Abstract environment
+%%%%%%%%%%%%% Define special environments %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Abstract environment
+%% \keywords command should be given someplace before the \end{abstract} command.
\makeatletter
\providecommand{\@keywords}{\relax}
@@ -404,7 +405,7 @@
\NewCoffin{\authorblock}
%% Allows for up to nine author groups... if you need more authors, the edits should be obvious
-%% You can put multiple authors above a single affiliation to reduce number of author blocks
+%% You can put multiple authors above a single affiliation to reduce number of author blocks needed.
\NewCoffin{\firstrowauthorblock}
\SetHorizontalCoffin\firstrowauthorblock{}
\NewCoffin{\secondrowauthorblock}
@@ -415,7 +416,7 @@
\newcounter{authorno}
\setcounter{authorno}{0}
-\newlength{\coffinsep} %%% horizontal space between coffins
+\newlength{\coffinsep} %% horizontal space between coffins
\setlength{\coffinsep}{0.03\textwidth}
\DeclareDocumentCommand\SetAuthorBlock{m m}{%
@@ -471,10 +472,10 @@
\centerline{\TypesetCoffin\firstrowauthorblock} %% in this instance, \centerline is better than \centering
}
-%% To maintain compatibility with newtxtext superiors option
+%% To maintain compatibility with newtxtext superiors option if used
\let\savethefootnote\thefootnote
-%%%% flag for corresponding author (just one)
+%% Flag for corresponding author (expecting just one, but if two enter both email addresses and flag both authors)
\makeatletter
\newif\ifCA\CAfalse
\newcommand{\CAemail}[1]{\gdef\@CAemail{#1}}
@@ -486,7 +487,7 @@
\ignorespaces#1\ignorespaces\footnotemark[1]%
}
-%%% flag for joint first authors (two or more)
+%% Flag for joint first authors (two or more)
\makeatletter
\newif\ifJA\JAfalse
@@ -496,7 +497,7 @@
\ignorespaces\footnotemark[2]%
}
-%%%% make the title section
+%%%% Make the title section
\DeclareDocumentCommand{\MakeTitlePage}{}{%
\twocolumn[
@@ -522,11 +523,13 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
-%% Provide sf greek, following a suggestion by Michael Sharpe (March 2019),
-%% accessing some sans serif Greek from STIX fonts.
+%% Provide sans serif upright Greek letters, following
+%% a suggestion to class author by Michael Sharpe (March 2019).
+%% Accessing sans serif Greek from STIX fonts.
%%
%% These are for use in the sans serif captions and headings if needed.
%%
+
\DeclareSymbolFont{lettersAB}{U}{ntxsfmia}{m}{it}
\SetSymbolFont{lettersAB}{bold}{U}{ntxsfmia}{b}{it}
\DeclareFontSubstitution{U}{ntxsfmia}{m}{it}