texlive[52679] Master/texmf-dist: asmeconf (7nov19)
commits+karl at tug.org
commits+karl at tug.org
Thu Nov 7 23:19:19 CET 2019
Revision: 52679
http://tug.org/svn/texlive?view=revision&revision=52679
Author: karl
Date: 2019-11-07 23:19:18 +0100 (Thu, 07 Nov 2019)
Log Message:
-----------
asmeconf (7nov19)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/asmeconf/README.md
trunk/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf
trunk/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex
trunk/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls
Modified: trunk/Master/texmf-dist/doc/latex/asmeconf/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/asmeconf/README.md 2019-11-07 22:19:07 UTC (rev 52678)
+++ trunk/Master/texmf-dist/doc/latex/asmeconf/README.md 2019-11-07 22:19:18 UTC (rev 52679)
@@ -1,7 +1,7 @@
#asmeconf: A template for ASME conference papers#
- Version 1.12 dated 2019/10/02.
+ Version 1.13 dated 2019/11/06.
####Overview####
This class provides a template to format ASME Conference papers according to
@@ -67,6 +67,8 @@
####Change log####
+ v1.13: add babel options for language support; minor text edits; adjust nomenclature list penalties
+
v1.12: add support for line numbers for editing; add support for final column balancing; edit skips in nomenclature; adjust \\tolerance and \\emergencystretch (for line breaking); improve support for equation tags in captions; adopt standard \\maketitle and \\title commands; include \\versionfootnote for tracking revisions of draft.
v1.11: minor adjustments to title, author, and affiliation layout
Modified: trunk/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex 2019-11-07 22:19:07 UTC (rev 52678)
+++ trunk/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex 2019-11-07 22:19:18 UTC (rev 52679)
@@ -6,7 +6,7 @@
%% The new guidelines have changed the request author block formatting.
%% Nomenclature follows the abstract. Abstract is in italics.
%%
-%% This file is version 1.12 dated 2019/10/02
+%% This file is version 1.13 dated 2019/11/06.
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -47,6 +47,11 @@
%% * An option to allow hyphenation of the typewriter font [hyphenate]
%% * Hyphenation is normally suppressed for typewriter mode because it is often used for code.
%%
+%% * Options to set (for the babel package) a primary language [lang= ], and secondary or tertiary
+%% * languages, [lang-second] and [lang-third]. English is the default when no language is set.
+%% * If a secondary or tertiary language is set, the main language must also be set.
+%% * The spanish module makes "." active, clashing with some code; \spanishdeactivate{.} stops this.
+%%
%% For details of newtxmath and mathalfa, refer to their documentation (available on CTAN: http://ctan.org).
%%
%% The use of commands defined or modified by the asmeconf class is illustrated below. In particular,
@@ -136,7 +141,7 @@
%%% For tracking various versions of your draft. Change text to suit your own needs. Remove from final version.
%%% \date{..} is the same command.
-\versionfootnote{Documentation for \texttt{asmeconf.cls}. Version 1.12; \today.}% <=== Delete before final submission.
+\versionfootnote{Documentation for \texttt{asmeconf.cls}. Version \versionno; \today.}% <=== Delete before final submission.
%%% Change these to your keywords. Keywords are automatically printed at the end of the abstract.
@@ -197,7 +202,7 @@
Author addresses are to be kept short. List the author institution, and the City, State (US authors), City, Province, Canada (Canadian authors), or City, Country (other international authors).
-One author (or more) may be designated as the \verb|\CorrespondingAuthor{email}| by placing the command after \verb|\affil{#}|. Two or more authors may be joint first authors by putting \verb|\JointFirstAuthor| after \verb|\affil{#}|.
+One author (or more) may be designated as the corresponding author by placing \verb|\CorrespondingAuthor{email}| after \verb|\affil{#}|. Two or more authors may be joint first authors by putting \verb|\JointFirstAuthor| after \verb|\affil{#}|.
After setting up the headers, authors, and title, issue the \verb|\maketitle| command.
@@ -230,13 +235,13 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Use title case for subsections and subsubsections
\section{Section Headings and Captions}
-ASME requires that section headings and captions be set in an uppercase, sans serif font. The class will do this automatically. You can place \verb|\cite{..}|, \verb|\ref{..}|, \verb|\label{..}|, and into headings and captions directly, as you would in the main text. Do not enclose them braces, e.g.\ \verb|{\cite{..}}|, which will cause errors. You can place \verb|\footnote{..}| into headings, but not into captions.\footnote{See \texttt{tex-stackexchange} for various approaches to footnotes in captions, if they seem necessary. For footnotes in tables, use the \texttt{tablefootnote} package.}\footnote{Sequential footnote.}
+ASME requires that section headings and captions be set in an uppercase, sans serif font. The class will do this automatically. You can place \verb|\cite{..}|, \verb|\ref{..}|, \verb|\label{..}|, and mathematics into headings and captions directly, as you would in the main text. Do not enclose them braces, e.g.\ \verb|{\cite{..}}|, which will cause errors. You can place \verb|\footnote{..}| into headings, but not into captions.\footnote{See \texttt{tex-stackexchange} for various approaches to footnotes in captions, if they seem necessary. For footnotes in tables, use the \texttt{tablefootnote} package.}\footnote{Sequential footnote.}
Text in section headings and captions will not be capitalized if enclosed in a \verb|\NoCaseChange{..}| command.
Sections may either be numbered or left unnumbered.
-Simple math can be used in either captions or section headings. For a section heading that includes more complicated math (and macros), you may use the optional argument of \verb|\section[..]{..}| to create a pdf bookmark without losing characters or producing warnings or errors. See the \texttt{asmeconf.tex} source file for examples of this. These bookmarks should usually be text expressions, although some math is supported.
+Simple math can be used in either captions or section headings. For a section heading that includes more complicated math (and macros), you may use the optional argument of \verb|\section[..]{..}| to create a pdf bookmark without losing characters or producing warnings or errors. See the \texttt{asmeconf-template.tex} source file for examples of this. These bookmarks should usually be text expressions, although some math is supported.
If you wish to override the default math format in captions, put \verb|\mathversion{normal}| in the caption.
@@ -272,7 +277,7 @@
\begin{table}[t]
\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}}}
+\begin{tabular}{!{\hspace*{0.5cm}} >{\raggedright\hangindent=1em} p{3cm} d{3.3} @{\hspace*{1cm}} d{3.3} !{\hspace*{0.5cm}}}
\toprule
Experiment & \multicolumn{1}{c@{\hspace*{1cm}}}{$u$ [m/s]} & \multicolumn{1}{c!{\hspace*{0.5cm}}}{$T$ [\textdegree C]} \\
\midrule
@@ -331,11 +336,11 @@
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.
%% subsubsections are not numbered
-\subsubsection*{DOI, URL, and eprint} Include DOI numbers when they are avaiable. URL's may alternatively be given.
+\subsubsection*{DOI, URL, and eprint} Include DOI numbers when they are available. URL's may alternatively be given.
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/}|.
-\subsubsection*{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.
+\subsubsection*{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{asmeconf-sample.bib} file.
\subsubsection*{Date Accessed} The \verb|urldate={..}| field may be used to provide the date on which a given url was accessed. By default, the text printed will be \texttt{accessed `date',}. The word ``accessed'' may be changed using the \verb|urltype={..}| field.
@@ -369,7 +374,7 @@
\end{equation}
To get additional symbols in bold math, you can use the \verb|\bm{..}| macro from the \texttt{bm} package, which is loaded by the class.
-The class file also provides upright sans-serif greek letters with \verb|\sfalpha| and similar expressions (e.g.\ $\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots \bm{\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots}$), in case they are needed (but note that the \verb|newtxmath| options \verb|frenchmath| and \verb|slantedGreek| also affect how Greek is presented).
+The class file also provides upright sans-serif greek letters with \verb|\sfalpha| and similar expressions (e.g.\ $\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots \bm{\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots}$), in case they are needed (but note that the \verb|newtxmath| options \verb|frenchmath| and \verb|slantedGreek| also affect how greek letters are presented).
\subsection{The \texttt{newtxmath} and \texttt{mathalpha} packages~\cite{sharpe1,sharpe2}} The \texttt{newtxmath} package~\cite{sharpe1}, loaded by default, includes a large number of options for mathematics. Most options 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}
@@ -391,7 +396,7 @@
\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.
-\subsection{Line Numbers} The option \texttt{[lineno]} invokes the the \texttt{lineno} package~\cite{bottcher}. This option will produce line numbers in the margins. You must run \LaTeX\ twice for proper placement of the numbers. Tables, captions, and footnotes will not be numbered. Line numbers can be helpful for review and editing, but should not be used in your final manuscript. See the documentation of the \texttt{lineno} package for further commands to control line numbering.
+\subsection{Line Numbers} The option \texttt{[lineno]} invokes the the \texttt{lineno} package~\cite{bottcher}. This option will produce line numbers in the margins. You must run \LaTeX\ \textit{twice} for proper placement of the numbers. Tables, captions, and footnotes will not be numbered. Line numbers can be helpful for review and editing, but should not be used in your final manuscript. See the documentation of the \texttt{lineno} package for further commands to control line numbering.
The \texttt{lineno} package is not compatible with the \texttt{flushend} package that makes final short columns the same height. Balancing is disabled when this option is called.
@@ -400,7 +405,7 @@
\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]}.
-\subsection{Old-style Author Grid} The option \texttt{[oldauthors]} invokes the old grid arrangement of author names. The authors and affiliations must be entered differently in this case. See Appendix \ref{appendix:b} for usage.
+\subsection{Old-style Author Grid} The option \texttt{[oldauthors]} invokes ASME's old grid-style arrangement of author names. The authors and affiliations must be entered differently in this case. See Appendix \ref{appendix:b} for usage.
\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.
@@ -497,6 +502,19 @@
\hbox{}\hfil\verb|}{lienhard at mit.edu}}{Institution \\ City, State}|
%% see after end document for usable code if you go this route.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{Language Support}
+
+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 specified explicitly if a secondary language is loaded. 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'', ``Nomenclature'', ``Corresponding author'', and ``Joint first authors'' by renewing the commands \verb|\keywordname|, \verb|\nomname|, \verb|\CAwords|, and \verb|\JAwords|. Changes to the page footer were described earlier. The pdf bookmark for ``Appendices'' may be changed by renewing \verb|\appendicesname|.
+
+No effort has been made to support customization of language-specific fonts, although this is possible by modifying the class file (examples are given in the \texttt{newtx} documentation). The bibliography style, \texttt{asmejour.bst}, is designed in English and aimed at \texttt{BibTeX}. Multilingual bibliographies can be supported using \texttt{BibLaTeX}.
+
\end{document}
Modified: trunk/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls
===================================================================
--- trunk/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls 2019-11-07 22:19:07 UTC (rev 52678)
+++ trunk/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls 2019-11-07 22:19:18 UTC (rev 52679)
@@ -5,7 +5,9 @@
%%
%% Please note that ASME's journals follow specifications different from ASME conference papers.
%%
-%% This file is version 1.12 dated 2019/10/02.
+%% This file is version 1.13 dated 2019/11/06.
+ \def\versionno{1.13}
+ \def\versiondate{2019/11/06\space}
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -31,7 +33,7 @@
%% This class is not designed for unicode-math or fontspec, given that the ASME conference style is
%% specific with respect to the font selections.
%%
-%% Options for the class are configured on lines 79-153.
+%% Options for the class are configured on lines 79-169.
%%
%% The class defines two environments: abstract and nomenclature. The latter has an optional argument to
%% control the space between the entries and the definitions.
@@ -67,7 +69,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{asmeconf}[2019/10/02 ASME Conference Paper Format]
+\ProvidesClass{asmeconf}[\versiondate ASME Conference Paper Format]
\LoadClass[twoside,twocolumn,10pt]{article}
% Two-sided layout not used in ASME's specs, although that's how the papers are printed
@@ -120,6 +122,21 @@
\setboolean{lineno}{#1}
}
+%%% set key [lang,lang-second,lang-third] to pass languages to babel.
+
+%% In case language options are dropped during editing, include this. Subsequent choice of lang= will override it.
+\PassOptionsToPackage{english}{babel}
+
+\define at key{asmeconf}{lang}[english]{%
+ \PassOptionsToPackage{main=#1}{babel}%
+}
+\define at key{asmeconf}{lang-second}[english]{%
+ \PassOptionsToPackage{#1}{babel}%
+}
+\define at key{asmeconf}{lang-third}[english]{%
+ \PassOptionsToPackage{#1}{babel}%
+}
+
\ProcessKeyvalOptions*
%% option to have colored hyperlinks
@@ -180,13 +197,14 @@
\RequirePackage{booktabs}
\RequirePackage{array}
-\RequirePackage{dcolumn} %%% alignment on decimal places
-\newcolumntype{d}[1]{D{.}{.}{#1}}
+\RequirePackage{dcolumn} %%% alignment on decimal places
+\newcolumntype{d}[1]{D{.}{.}{#1}} %% conflicts with babel's spanish language option.
%%%% FONT related %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\RequirePackage{mathtools} % extends amsmath
\RequirePackage[utf8]{inputenc}
+\RequirePackage[]{babel}
\RequirePackage[]{newtxtext}
\RequirePackage[varqu,varl]{inconsolata} % sans typewriter font
\RequirePackage[]{newtxmath}
@@ -269,9 +287,10 @@
\RequirePackage[labelfont={sf,bf},hypcap=false]{caption}
\RequirePackage[hypcap=false,list=true]{subcaption}
+\DeclareCaptionLabelFormat{uppercase}{\MakeTextUppercase{#1} #2}
\DeclareCaptionTextFormat{boldmath}{\mathversion{sansbold}#1}
-\captionsetup[figure]{name=FIGURE,labelfont={sf,bf,small},textfont={sf,bf,small},textformat=boldmath, labelsep=colon}
-\captionsetup[table]{name=TABLE,labelfont={sf,bf,small},textfont={sf,bf,small},textformat=boldmath, labelsep=colon,skip=0.5\baselineskip}
+\captionsetup[figure]{labelformat=uppercase, labelfont={sf,bf,small},textfont={sf,bf,small},textformat=boldmath, labelsep=colon}
+\captionsetup[table]{labelformat=uppercase, labelfont={sf,bf,small},textfont={sf,bf,small},textformat=boldmath, labelsep=colon,skip=0.5\baselineskip} %name=TABLE,
%% This construction avoids a failure of hyperref in relation to uppercase caption
%% Discussion: https://tex.stackexchange.com/questions/375695/maketextuppercase-inside-table-captions
@@ -280,7 +299,13 @@
\renewcommand*{\caption}[2][\shortcaption]{\def\shortcaption{#2}\scaption[#1]{\MakeTextUppercase{#2}}}%
}
-
+%%%%%% introduce some caption or section names %%%%%%%%%%%
+ \providecommand{\nomname}{Nomenclature}
+ \providecommand{\keywordname}{Keywords}
+ \providecommand{\appendicesname}{APPENDICES}
+ \providecommand{\JAwords}{Joint first authors}
+ \providecommand{\CAwords}{Corresponding author}
+
%%%%%%%%%%%%%%%%%% Section headings %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% wish to accommodate hyperref
@@ -303,9 +328,9 @@
%% Assumes that appendices are the last content in paper
\RenewDocumentCommand{\appendix}{}{%
\setcounter{section}{0}
- \pdfbookmark[0]{Appendices}{appendices}
+ \pdfbookmark[0]{\appendicesname}{appendices}
\renewcommand\thesection{\Alph{section}}
- \titleformat{\section}{\mathversion{sansbold}\bfseries\sffamily\raggedright}{APPENDIX \thesection.}{0.5em}{\MakeTextUppercase}
+ \titleformat{\section}{\mathversion{sansbold}\bfseries\sffamily\raggedright}{\MakeTextUppercase{\appendixname}\ \thesection.}{0.5em}{\MakeTextUppercase}
}
%%%%%%%%%%%%% hyperref %%%%%%%%%%%%%%%%%%%
@@ -429,12 +454,12 @@
\DeclareDocumentCommand{\keywords}{m}{%
\IfNoValueTF{#1}{%
\relax}{%
- \long\def\@keywords{\par\smallskip\noindent{\bfseries\sffamily Keywords:} #1}%
+ \long\def\@keywords{\par\smallskip\noindent{\bfseries\sffamily \keywordname:} #1}%
}
}
\DeclareDocumentEnvironment{abstract}{}{%
- \section*{Abstract}\itshape%
+ \section*{\abstractname}\itshape%
}
{\upshape\@keywords%\medskip%
}
@@ -453,13 +478,14 @@
\DeclareDocumentCommand{\entry}{m g}{%
\IfNoValueTF{#2}{%
\itemsep3\p@ plus 1\p@ minus 1\p@%
- \goodbreak\item[\itshape#1\hfill]\setlength\itemsep\savitemsep\nopagebreak% \smallskip
+ \goodbreak\item[\itshape#1\hfill]\setlength\itemsep\savitemsep\@itempenalty=1000%\nopagebreak% \smallskip
}{%
\item[#1\hfill]#2%
+ \@itempenalty=-\@lowpenalty%
}
}
-\DeclareDocumentEnvironment{nomenclature}{O{2em} O{Nomenclature}}{%
+\DeclareDocumentEnvironment{nomenclature}{O{2em} O{\nomname}}{%
\setlength\columnsep{2em}
\setlength{\nomenwidth}{#1}
\section*{#2}
@@ -664,11 +690,12 @@
%% Flag for corresponding author (expecting just one, but if two enter both email addresses and flag both authors)
\newif\ifCA\CAfalse
-% allow for NO email address to be given by omitting second argument
+% allow for NO email address to be given by omitting the argument (g argument is deprecated, seems to have trouble with \IfNoValueTF)
\DeclareDocumentCommand{\CorrespondingAuthor}{g}{%
\ignorespaces$\bm{^\ast}$%
\global\CAtrue%
- \IfNoValueTF{#1}{%
+ % \IfNoValueTF{#1}{%
+ \ifblank{#1}{%
\gdef\@CAsep{\relax}
\gdef\@CAemail{\relax}
}{%
@@ -734,10 +761,10 @@
\centerline{\TypesetCoffin\AuthorBlock}
\renewcommand*{\thefootnote}{\fnsymbol{footnote}}
\ifJA
- \footnotetext[2]{Joint first authors}
+ \footnotetext[2]{\JAwords}
\fi
\ifCA
- \footnotetext[1]{Corresponding author:\space\@CAemail}
+ \footnotetext[1]{\CAwords\@CAsep\@CAemail}
\fi
\let\thefootnote\savethefootnote
}
@@ -763,10 +790,10 @@
\let\@makefnmark\savemakefnmark
\renewcommand*{\thefootnote}{\fnsymbol{footnote}}
\ifJA
- \footnotetext[2]{Joint first authors}
+ \footnotetext[2]{\JAwords}
\fi
\ifCA
- \footnotetext[1]{Corresponding author\@CAsep \@CAemail}
+ \footnotetext[1]{\CAwords\@CAsep\@CAemail}
\fi
\let\thefootnote\savethefootnote
}
More information about the tex-live-commits
mailing list