texlive[51567] Master/texmf-dist: asmejour (6jul19)
commits+karl at tug.org
commits+karl at tug.org
Sat Jul 6 22:41:10 CEST 2019
Revision: 51567
http://tug.org/svn/texlive?view=revision&revision=51567
Author: karl
Date: 2019-07-06 22:41:10 +0200 (Sat, 06 Jul 2019)
Log Message:
-----------
asmejour (6jul19)
Modified Paths:
--------------
trunk/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst
trunk/Master/texmf-dist/doc/latex/asmejour/README.md
trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-sample.bib
trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.pdf
trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex
trunk/Master/texmf-dist/tex/latex/asmejour/asmejour.cls
Modified: trunk/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst
===================================================================
--- trunk/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst 2019-07-06 20:40:57 UTC (rev 51566)
+++ trunk/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst 2019-07-06 20:41:10 UTC (rev 51567)
@@ -37,7 +37,7 @@
%%
%% Added fields: eventdate, urldate, urltype, venue, version, versiontype
%% Added: @online{...} for web publications (and aliased it to @www and @electronic)
- %% Added: urlprefix = {}, format.web.urldate, bbl.urldate; urltype fiedd changes "accessed" to something else.
+ %% 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.
%%
Modified: trunk/Master/texmf-dist/doc/latex/asmejour/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/asmejour/README.md 2019-07-06 20:40:57 UTC (rev 51566)
+++ trunk/Master/texmf-dist/doc/latex/asmejour/README.md 2019-07-06 20:41:10 UTC (rev 51567)
@@ -1,7 +1,7 @@
#asmejour: A template for ASME journal papers#
- Version 1.03 dated 2019/05/26.
+ Version 1.04 dated 2019/07/05.
####Overview####
This class provides a template to format preprints submitted to ASME journals in the style that
@@ -11,20 +11,20 @@
Files in this distribution are:
- README.md -- this file
- asmejour.cls -- the class file
- asmejour.bst -- bibtex style for ASME journal references
- asmejour-template.tex -- a latex template/example for this class
- asmejour-template.pdf -- documentation/sample paper
- asmejour-sample.bib -- a sample bibliography file
- *
- sample-figure-1.pdf, sample-figure-2a.pdf, sample-figure-2b.pdf -- figures for the example
+ ``` README.md -- this file
+ asmejour.cls -- the class file
+ asmejour.bst -- bibtex style for ASME journal references
+ asmejour-template.tex -- a latex template/example for this class
+ asmejour-template.pdf -- documentation/sample paper
+ asmejour-sample.bib -- a sample bibliography file
+ *
+ sample-figure-1.pdf,
+ sample-figure-2a.pdf,
+ sample-figure-2b.pdf -- figures for the example```
The .tex and .cls files are commented and should be self-explanatory.
-
-
This template was designed to approach the following aims:
- closely approximate ASME's fonts and layout
@@ -31,11 +31,11 @@
- follow ASME's current citation formats
-- support use of hyperref package (hyperlink references to figures, tables, citations, and web)
+- support hyperref package (hyperlinks for figures, tables, citations, and web)
- support pdf bookmarks
-- use the newtxtext and newtxmath font packages, which enable a variety of text and math features
+- use the features of the newtxtext and newtxmath font packages
- support bold face, math, and footnotes in section headings
@@ -56,6 +56,8 @@
---
####Change log####
+
+v1.04: edit documentation; add language support via babel
v1.03: expand documentation; fix conflict between lineno and balance packages; more footer options; edit \\entry
Modified: trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-sample.bib
===================================================================
--- trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-sample.bib 2019-07-06 20:40:57 UTC (rev 51566)
+++ trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-sample.bib 2019-07-06 20:41:10 UTC (rev 51567)
@@ -1,4 +1,24 @@
-%% Revised 28 April 2019.
+%% Revised 5 July 2019.
+
+ at online{fourierwiki,
+title = {Joseph Fourier---Wikip\'{e}dia{,} l'encyclop\'{e}die libre},
+year = {2019},
+author = {Wikipedia},
+url = {https://fr.wikipedia.org/wiki/Joseph_Fourier},
+urldate = {July 5, 2019},
+}
+%% Note ASME Journal discourage citations to Wikipedia.
+
+ at online{amsmath,
+author = {{American Mathematical Society} and {LATEX3 Project}},
+title = {User's Guide for the amsmath Package },
+year = {2018},
+organization = {Comprehensive \TeX\ Archive Network},
+url = {https://ctan.org/tex-archive/macros/latex/required/amsmath/amsldoc.pdf},
+urldate = {July 5, 2019},
+version = {2.1},
+}
+
@online{sharpe1,
author = {Michael Sharpe},
title = {New {TX} font package},
@@ -289,7 +309,6 @@
howpublished = {US Patent {\#}9700811},
}
-
@mastersthesis{smith1998,
author = {Robert Smith},
title = {Conformal Lubricated Contact of Cylindrical Surfaces Involved in a Steady Motion},
@@ -360,7 +379,6 @@
address={Lausannae},
}
% note={English translation by I.\ Bruce available here at \url{http://www.17centurymaths.com/contents/introductiontoanalysisvol1.htm}},
-
@BOOK{kirk2288a,
title = {Decline and Fall of the Romulan Empire},
Modified: trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex 2019-07-06 20:40:57 UTC (rev 51566)
+++ trunk/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex 2019-07-06 20:41:10 UTC (rev 51567)
@@ -1,8 +1,10 @@
+% !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 early 2019.
%%
-%% This file is version 1.03 dated 2019/05/26
+%% This file is version 1.04 dated 2019/07/05
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -34,6 +36,9 @@
%% * An optional to use newtxtext's superiors font for footnotes [nodefaultsups] and an option
%% * for slightly larger small capitals, largesc
%%
+%% * Options to set (for the babel package) a primary language [lang= ], and secondary or tertiary
+%% * languages, [lang-second] and [lang-third]. The primary language must be given last.
+%%
%% 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 asmejour class is illustrated below. In particular,
@@ -66,10 +71,10 @@
%% Class options are described above.
-\documentclass[largesc,upint,varvw,barcolor=Red4,nocopyright]{asmejour}
+\documentclass[largesc,upint,varvw,barcolor=Red4,nocopyright,lang-second=french,lang=english]{asmejour}
-%%%%% FIELDS TO BE COMPLETED FOLLOW %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%% FIELDS TO BE COMPLETED FOLLOW %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%% pdf metadata, the user should edit %%%%%%%%%%%%%%%%%%
@@ -142,7 +147,8 @@
%%%%%%%%%%%%%%%%%%%%% End of fields to be completed. Now write! %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section*{Introduction}
+\section{Introduction}
+
The \texttt{asmejour} class file will typeset papers with margins, fonts, headings, captions, and reference formats that follow those used in journals published by the American Society of Mechanical Engineers (ASME). Internal and external hyperlinks will be set automatically, and the pdf file will contain bookmarks and metadata.
This class is not a publication of ASME. The intended use of this package is to allow authors to format their papers in ASME style prior to submission to an ASME journal for peer review.
@@ -149,7 +155,7 @@
The \texttt{.tex} file may be written using standard \LaTeX\ commands, although some specific initial commands are needed to format the block containing the author[s], title, and abstract.
-\subsection*{Essential Initial Commands}
+\subsection{Essential Initial Commands}
To begin, fill in the fields to be completed at top of the \texttt{asmejour-template.tex} file. The pdf metadata will be placed into the pdf file itself.
For each author, put author names and affiliation (with line breaks) into a separate \verb|\SetAuthorBlock{name}{affiliation}| command; follow the syntax illustrated \texttt{asmejour-template.tex} file. One author (or more) may be designated as the \verb|\CorrespondingAuthor| by placing the command at the end of the name.
@@ -158,11 +164,13 @@
After setting up the authors, title, and abstract, issue the \verb|\MakeTitlePage| command.
-\subsection*{Optional to the Color Title Bar}
+\subsection{Optional to the Color Title Bar}
The vertical bar in the title block is black in all ASME journals. Since the \texttt{asmejour} class is only for preprints, we include the [fun] option to have the bar in color. Any color \texttt{name} recognized by the \texttt{xcolor} package may be invoked by including the option \texttt{barcolor=name} in the \verb|\documentclass[..]{asmejour}| command. The color name is \texttt{Red4} by default. (To have a black bar, either omit the option entirely or use the name \texttt{black}.)
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section*{References to Figures, Equations, and Citations}
+\section{References to Figures, Equations, and Citations}
+
For ASME papers, the labels Figure and Equation should be abbreviated when they do not start a sentence, as in Fig.~\ref{fig:1} and Eq.~\eqref{eqn:1}. Figure~\ref{fig:1} is spelled out when it starts a sentence. Equation~\eqref{eqn:1} is spelled out when it starts a sentence.
Citations will be numbered automatically \cite{DKE1969}. They should be inserted at the appropriate point using a \verb|\cite{ref}| command~\cite{toohey2007,gibson2008}. The citations will be automatically sorted and compressed, as well, if they are given in a set \cite{stevens1999, DKE1969, wions2005, oligaria2011,mollen2014,smith2014,apple2019}. Just refer to the number when naming a reference, as in \cite{smith2014}. Reference~\cite{smith2014} is appropriate at the beginning of a sentence.
@@ -173,8 +181,10 @@
\mathbf{q} = -k\nabla T
\end{equation}
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section*{Section Headings and Captions}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{Section Headings and Captions}
+
ASME requires that section headings and captions be set in bold face. In addition, the captions must be in sans serif type. The \texttt{asmejour} 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. 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.}
Sections may either be numbered or left unnumbered. ASME publishes papers in either style.
@@ -185,7 +195,7 @@
Single-sentence captions should not end with a period. Multi-sentence captions do include periods.
-\subsection*{Subsection Headings}
+\subsection{Subsection Headings}
Section, subsection, and subsubsection headings should be in title case (first letter of primary words capitalized). ASME does not use \verb|\paragraph|, so the class file treats this commands like \verb|\subsubsection|.
@@ -199,8 +209,10 @@
%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section*{More on Math}
+\section{More on Math}
+
To get bold math outside of the captions, you can use the \verb|\bm{..}| macro from the \texttt{bm} package, which is loaded by the class.
\begin{equation}
@@ -241,37 +253,20 @@
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.
-\subsubsection*{Units and Nomenclature} ASME requires SI units. U.S.\ style units may be follow in parentheses. Be sure to put your symbols into the nomenclature list, including the SI units.
+\subsection{Units and Nomenclature} ASME requires SI units. U.S.\ style units may be follow in parentheses. Be sure to put your symbols into the nomenclature list, including the SI units.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section*{Tables and Figures}
+\section{Tables and Figures}
+
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. Table~\ref{tab:4} shows a table that spans both text columns.
+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.
+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.
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\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.
-\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}
-\verb|note = {\doi{10.1115/1.4042912}}|
-\end{quote}
-Include doi numbers in references whenever possible.
-
-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/}|.
-
-\subsection*{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.
-
-\subsection*{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.
-
-\subsection*{Location and Date of Conference} For \verb|@inproceeedings{..| and \verb|@proceeedings{..|, you may include \verb|venue={..}| and \verb|eventdate={..}| to specify the city and the date of a conference.
-
-\subsection*{Version Number\footnote{Another longer footnote to show the leading and line breaking, and how it will sit at the bottom of a column. Another longer footnote to show the leading and line breaking, and how it will sit at the bottom of a column.}} The \verb|version={..}| field may be used with \verb|@book|, \verb|@online|, and \verb|@manual|. By default, the text will read \texttt{Version `number'} as in \cite{sharpe1,sharpe2}, but different wording may be selected using the \verb|versiontype={..}| field, to have ``Revision'' or something similar, as in \cite{GSL}. ASME often puts the version in the title, as in \cite{dlmf, texshop}, so I've left the final decision for discussion between the authors and the copy editor.
-
-
%%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%%
%% captions go above tables
@@ -292,6 +287,29 @@
%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\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.
+
+\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}
+\verb|note = {\doi{10.1115/1.4042912}}|
+\end{quote}
+Include doi numbers in references whenever possible.
+
+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/}|.
+
+\subsection{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.
+
+\subsection{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.
+
+\subsection{Conference Location and Date} For the entry types \verb|@inproceeedings{..| and \verb|@proceeedings{..|, you may include \verb|venue={..}| and \verb|eventdate={..}| to specify the city and the date of a conference.
+
+\subsection{Version Number\footnote{Another longer footnote to show the leading and line breaking, and how it will sit at the bottom of a column. Another longer footnote to show the leading and line breaking, and how it will sit at the bottom of a column.}} The \verb|version={..}| field may be used with \verb|@book|, \verb|@online|, and \verb|@manual|. By default, the text will read \texttt{Version `number'} as in \cite{sharpe1,sharpe2}, but different wording may be selected using the \verb|versiontype={..}| field, to have ``Revision'' or something similar, as in \cite{GSL}. ASME often puts the version in the title, as in \cite{dlmf, texshop}, so I've left the final decision for discussion between the authors and the copy editor.
+
+
%%%%%%%%%%%%%%% begin more complicated table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{table}[t]
@@ -312,7 +330,7 @@
%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%% begin wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%% begin two column figure %%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{figure*}[t]
\begin{minipage}[c]{0.5\textwidth}
@@ -326,26 +344,26 @@
\includegraphics{sample-figure-2b.pdf}
\subcaption{Exterior region\label{fig:exterior-region}}
}\end{minipage}
-\caption{A figure with two subfigures \cite{Lienhard2019b}}
+\caption{A figure with two subfigures \cite{Lienhard2019b}\label{fig:2}}
\end{figure*}
-%%%%%%%%%%%%%%%%%%% end wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%% end two column figure %%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section*{Additional Options for \texttt{asmejour.cls}}
+\section{Additional Options for \texttt{asmejour.cls}}
The class accepts a number of options in addition to those already described.
-\subsubsection*{Line Numbers} The option \texttt{[lineno]} invokes the the \texttt{lineno} package. This will produce line numbers in the margins. You must run \LaTeX\ twice for proper placement. The \texttt{lineno} package is not compatible with the \texttt{balance} package that makes final short columns the same height. Balancing will be disabled when this option is called. 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. This will produce line numbers in the margins. You must run \LaTeX\ twice for proper placement. The \texttt{lineno} package is not compatible with the \texttt{balance} package that makes final short columns the same height. Balancing will be disabled when this option is called. See the documentation of the \texttt{lineno} package for further commands to control line numbering.
-\subsubsection*{Changing the Footer Text} The option \texttt{[nofoot]} will omit everything other than a page number from the page footer. The option \texttt{nocopyright} will omit the ASME copyright from the first page footer. The command \verb|\PreprintString{..}| replaces the words \textsf{PREPRINT FOR REVIEW}. The final paper number may be added to the page number using \verb|\PaperNumber{..}|.
+\subsection{Changing the Footer Text} The option \texttt{[nofoot]} will omit everything other than a page number from the page footer. The option \texttt{nocopyright} will omit the ASME copyright from the first page footer. The command \verb|\PreprintString{..}| replaces the words \textsf{PREPRINT FOR REVIEW}. The final paper number may be added to the page number using \verb|\PaperNumber{..}|.
-\subsubsection*{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.
+\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}[b]
+\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{%
@@ -371,7 +389,7 @@
%%
%% Newtxmath provides the option for upright Greek letters as \upomega (vs. \omega), etc.
%%
-\section*[Math in a Section Heading: \omega\cdot U=0]{Math in a Section Heading: $\hat{\upomega}\cdot\hat{\mathrm{U}}=0$}
+\section[Math in a Section Heading: \omega\cdot U=0]{Math in a Section Heading: $\hat{\upomega}\cdot\hat{\mathrm{U}}=0$}
To include complicated math in a section heading without producing bookmark-related errors, use the optional argument of \verb|\section| to create the pdfbookmark. The heading above was set with the following command:
\begin{quote}\raggedright
@@ -379,11 +397,11 @@
\hspace*{1em}\verb|\omega\cdot U=0]{Math in a Section Heading:|
\hspace*{1em}\verb|$\hat{\upomega}\cdot\hat{\mathrm{U}}=0$}|
\end{quote}
-Note that bookmark can include simple math. Also note that \texttt{newtxmath} provides the option to obtain upright Greek letters as \verb|\upomega| (vs.\ \verb|\omega|), etc.
+Note that bookmarks can include simple math. Also note that \texttt{newtxmath} provides the option to obtain upright Greek letters as \verb|\upomega| (vs.\ \verb|\omega|), etc.
-%%%%%%%%%%%%%%% begin table %%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%% begin two column table %%%%%%%%%%%%%%%%%%
\begin{table*}[t]
\caption{A table spanning two columns}\label{tab:4}%
\centering{%
@@ -412,11 +430,11 @@
\end{tabular*}
}
\end{table*}
-%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%% end two column table %%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\section*{Summary}
+\section{Summary}
The class \texttt{asmejour} and associated files are for typesetting preprints in the style of ASME journals.
Documentation is provided in this file and by comments in the \texttt{.tex} source code. Examples of entering references are shown in the \texttt{asmejour-sample.bib} file. The \texttt{asemjour.bst} file produces references following ASME's current formats. This package is not a publication of ASME and is offered without charge under the terms of the \href{https://ctan.org/license/mit}{MIT license}.
@@ -424,13 +442,12 @@
\item First conclusion
\item Second conclusion
\item Third conclusion
-\item Fourth conclusion
-
\end{enumerate}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section*{Acknowledgment} %% ASME requests this exact spelling, singular.
+
Acknowledge individuals, institutions, or companies that supported the authors in preparing the work. Those mentioned might have provided technical support, insightful comments or conversations, materials used in the work, or access to facilities.
@@ -441,12 +458,15 @@
\end{itemize}
-%%%%%%%%% NOMENCLATURE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%% NOMENCLATURE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%
+%% Name of nomenclature can be changed using an optional argument to the environment.
+%%
%% Leave off second argument of \entry to produce a subheading (e.g., \entry{Greek letters} )
%% Must run latex twice to align the columns.
\begin{nomenclature}
+
\entry{$\overline{h}$}{average heat transfer coefficient (W m$^{-2}$ K$^{-1}$)}
\entry{$k$}{thermal conductivity (W m$^{-1}$ K$^{-1}$)}
\entry{$\mathbf{q}$}{heat flux vector (W m$^{-2}$)}
@@ -472,12 +492,17 @@
%% The equation counter is reset for each appendix
%% Figures will be numbered consecutively
+\appendix %%% starting appendices
-\appendix %%% starting appendices
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\section{Dealing with Wide Equations}
+In most cases, the need for a wide equation can be eliminated by using one of the multiline equation environments defined by \texttt{amsmath}, such as \texttt{align}, \texttt{split}, or \texttt{multline}~\cite{amsmath}. An example appears in Appendix~\ref{app:zetafunction}. An alternative solution may be to set large equations into two-column-wide tables or figures. While some code exists for setting equations to span two columns, such code has performed fairly erratically with this package.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Incomplete Zeta Function~\cite{Lienhard2019c}\label{app:zetafunction}}
-This text is just an illustration of an appendix. The radiation fractional function may be written in terms of the incomplete zeta function for convenience:
+This text is just an illustration. The radiation fractional function may be written in terms of the incomplete zeta function for convenience:
\begin{align}
f(\lambda T) = {}& \frac{1}{\sigma T^4} \int_0^\lambda\frac{2\pi h c_o^2}{\lambda^5 \left[ \exp (h c_o/k_B T \lambda) - 1\right] } \, d\lambda \\
= {}& \frac{1}{\sigma T^4}\frac{2\pi k_B^4 T^4}{h^3c_o^2}\int^\infty_{c_2/\lambda T}\frac{t^3}{e^t -1}\, dt\label{eqn:zeta}
@@ -486,8 +511,31 @@
\begin{equation}
{\sigma T^4} =\frac{2\pi k_B^4 T^4}{h^3c_o^2} \underbrace{\int_0^\infty \frac{t^3}{e^t - 1} \, dt}_{\equiv \zetaup(4)\Gamma(4)}
\end{equation}
-where the Gamma function $\Gamma(4) = 3!$ and the Riemann zeta function, $\zetaup(4)$, has the indicated integral representation \cite[\S13.12]{ww1927}. A classical result due to Euler \cite{euler1740} gives $\zetaup(4) = \pi^4/90$ (see also \cite[\S167]{euler1748}), from which we recover the usual definition of the Stefan-Boltzmann constant, $\sigma$.
+where the Gamma function $\Gamma(4) = 3!$ and the Riemann zeta function, $\zetaup(4)$, has the indicated integral representation \cite[\S13.12]{ww1927}. A classical result due to Euler \cite{euler1740} gives $\zetaup(4) = \pi^4/90$ (see also \cite[\S167]{euler1748}), from which we recover the usual definition of the Stefan-Boltzmann constant, $\sigma$.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\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 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.
+
+An example of use is shown in \selectlanguage{french}\appendixname\ \ref{app:fourier}.\selectlanguage{english}
+
+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}.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\selectlanguage{french}
+\section{Joseph Fourier}\label{app:fourier}
+
+Joseph Fourier est connu pour avoir déterminé, par le calcul, la diffusion de la chaleur en utilisant la décomposition d'une fonction quelconque en une série trigonométrique convergente. De telles fonctions sont appelées séries de Fourier. La méthode de calcul permettant de passer, de façon réversible, d'une fonction à la série trigonométrique correspondante est la transformation de Fourier~\cite{fourierwiki}.
+\selectlanguage{english}
+
+
%%%%%%%%%%%%% BIBLIOGRAPHY %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\balance %<=== this command, from the balance package, attempts to balance column heights on last page.
@@ -494,7 +542,7 @@
% performance is a bit variable, however...
% The [lineno] option will disable this command
-\nocite{*} %% <=== delete this line - unless you want to typeset the entire contents of your .bib file.
+\nocite{*} %% <=== delete this line - unless you wish to typeset the entire contents of your .bib file.
\bibliographystyle{asmejour} %% .bst file that follows ASME journal format. Do not change.
@@ -501,7 +549,7 @@
\bibliography{asmejour-sample} %% <=== change this to name of your bib file
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%% LIST OF FIGURES and LIST OF TABLES %%%%%%%%%%%%%%%%
\clearpage
%% ASME requires these lists for production.
Modified: trunk/Master/texmf-dist/tex/latex/asmejour/asmejour.cls
===================================================================
--- trunk/Master/texmf-dist/tex/latex/asmejour/asmejour.cls 2019-07-06 20:40:57 UTC (rev 51566)
+++ trunk/Master/texmf-dist/tex/latex/asmejour/asmejour.cls 2019-07-06 20:41:10 UTC (rev 51567)
@@ -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.03 dated 2019/05/26.
+%% This file is version 1.04 dated 2019/07/05.
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -20,7 +20,7 @@
%% The Times/Helvetica style fonts are from Michael Sharpe's excellent newtxtext and newtxmath packages.
%% This class is not designed for unicode-math or fontspec.
%%
-%% Options for the class are described on lines 73-133.
+%% Options for the class are described on lines 63-145.
%%
%% The class defines an environment for nomenclature. LaTeX must be run twice to align those columns.
%%
@@ -52,7 +52,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{asmejour}[2019/05/26 asmejour paper format]
+\ProvidesClass{asmejour}[2019/07/05 asmejour paper format]
\LoadClass[twoside,9pt,twocolumn]{extarticle}
@@ -95,6 +95,17 @@
\setboolean{lineno}{#1}
}
+%%% set key [lang,lang-second,lang-third] to pass languages to babel.
+\define at key{asmejour}{lang}[english]{%
+ \PassOptionsToPackage{#1}{babel}%
+}
+\define at key{asmejour}{lang-second}[english]{%
+ \PassOptionsToPackage{#1}{babel}%
+}
+\define at key{asmejour}{lang-third}[english]{%
+ \PassOptionsToPackage{#1}{babel}%
+}
+
\ProcessKeyvalOptions*
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -170,6 +181,7 @@
\RequirePackage{mathtools} % extends amsmath
\RequirePackage[utf8]{inputenc}
+\RequirePackage[]{babel}
\RequirePackage[]{newtxtext}
\RequirePackage[varqu,varl]{inconsolata} % sans typewriter font
\RequirePackage[]{newtxmath}
@@ -209,7 +221,15 @@
\newcommand*{\CondSansBold}{\renewcommand\bfdefault{b}\selectfont\fontfamily{qhvc}\selectfont\bfseries}
\renewcommand\Huge{\@setfontsize\Huge{26.5}{26.5}} %... for title font only
+\addto{\captionsenglish}{%
+ \renewcommand{\figurename}{Fig.}
+ \renewcommand{\tablename}{Table}
+}
+ \providecommand{\nomname}{Nomenclature}
+ \providecommand{\keywordname}{Keywords}
+
+
%%%%%%%%%%%%%%%%% LINE AND EQUATION NUMBERING %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ifthenelse{\boolean{lineno}}{%
@@ -216,6 +236,7 @@
\RequirePackage[switch]{lineno}
\renewcommand{\linenumberfont}{\normalfont\footnotesize\color{red}}
\AtBeginDocument{\linenumbers}
+ \ClassWarningNoLine{asmejour}{Package lineno loaded, so \protect\balance\space will be disabled}
}{%
\RequirePackage{balance}% balance is NOT compatible with lineno
}
@@ -299,8 +320,8 @@
\DeclareCaptionTextFormat{boldmath}{\mathversion{sansbold}#1}
-\captionsetup[figure]{name=Fig.,labelfont={sf,bf},textfont={sf,bf},textformat=boldmath,labelsep=quad}
-\captionsetup[table]{name=Table,labelfont={sf,bf},textfont={sf,bf},textformat=boldmath,labelsep=quad,skip=0.5\baselineskip}
+\captionsetup[figure]{labelfont={sf,bf},textfont={sf,bf},textformat=boldmath,labelsep=quad}
+\captionsetup[table]{labelfont={sf,bf},textfont={sf,bf},textformat=boldmath,labelsep=quad,skip=0.5\baselineskip}
%%%%%%%%%%%% SECTION HEADINGS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -329,7 +350,7 @@
\renewcommand\thesection{\Alph{section}}
\setcounter{equation}{0}
\renewcommand\theequation{\Alph{section}\arabic{equation}}
- \titleformat{\section}[block]{\mathversion{bold}\bfseries\large\raggedright}{Appendix \thesection:}{0.5em}{}[\setcounter{equation}{0}]
+ \titleformat{\section}[block]{\mathversion{bold}\bfseries\large\raggedright}{\appendixname\ \thesection:}{0.5em}{}[\setcounter{equation}{0}]
}
% natbib's \bibsection controls section heading for References.
@@ -442,7 +463,7 @@
\AtBeginDocument{\setlength{\nomenwidth}{\totvalue{savedlength}sp}}
% value is the length in scaled points (sp)
-\DeclareDocumentEnvironment{nomenclature}{O{\nomenwidth} O{Nomenclature}}{%
+\DeclareDocumentEnvironment{nomenclature}{O{\nomenwidth} O{\nomname}}{%
\setlength{\widest}{0em}
\section*{#2}
\raggedright
@@ -528,7 +549,7 @@
\DeclareDocumentCommand{\keywords}{g}{%
\IfNoValueTF{#1}{%
\relax}{%
- \long\def\@keywords{\par\vskip\baselineskip\noindent{Keywords:} #1}%
+ \long\def\@keywords{\par\vskip\baselineskip\noindent{\keywordname:} #1}%
}
}
@@ -562,7 +583,6 @@
%%%% Flag for corresponding author (just one expected, although code supports more than one)
%%%% for more than one, if including email in footnote, place in final command
-\makeatletter
\newif\ifCA\CAfalse
\newcommand{\CAemail}[1]{\gdef\@CAemail{#1}}
@@ -599,7 +619,7 @@
\footnotetext{Corresponding author\@CAsep \@CAemail}
\fi
}
-\makeatother
+%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
More information about the tex-live-commits
mailing list