diff options
-rw-r--r-- | Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst | 36 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/asmejour/README.md | 15 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/asmejour/asmejour-sample.bib | 37 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/asmejour/asmejour-template.pdf | bin | 730733 -> 670705 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex | 150 | ||||
-rw-r--r-- | Master/texmf-dist/tex/latex/asmejour/asmejour.cls | 344 |
6 files changed, 386 insertions, 196 deletions
diff --git a/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst b/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst index babfdabbaa5..d3cb99b2e15 100644 --- a/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst +++ b/Master/texmf-dist/bibtex/bst/asmejour/asmejour.bst @@ -4,13 +4,13 @@ %% *** This bibtex style follows ASME journals *** %% %% - %% This file is asmejour.bst, fourth 1.04 dated 2020/04/15. + %% This file is asmejour.bst, version 1.05 dated 2021/12/23. %% %% 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 the formats that ASME is using in - %% published journal papers in early 2020. Details of the modifications follow. + %% published journal papers in early 2022. Details of the modifications follow. %% %% Created entry: @online{...} for web publications (and aliased it to @www and @electronic) %% Created fields: eventdate, urldate, urltype, venue, fourth, fourthtype @@ -64,12 +64,18 @@ %% provide format.alt.link to print the hyperlink if the report number is empty. %% provide institution.address function %% - %% Modifications in v1.04 ( ) + %% Modifications in v1.04 (2020/04/15) %% add hdl macro as a synonym for hndl %% separate format.serial.volume from format.bvolume; %% arrange format.bvolume to order vol and series as ", Vol. X of Series Title", which affects %% @book, @inbook, @incollection, and @proceedings. %% + %% Modifications in v1.05 (2021/12/23) + %% convert remaining http:// prefixes to https:// + %% replace \href{}{} in \eprint by \url + %% provide \hrefurl for compatibility with LaTeX3 pdfmanagement + %% use \hrefurl in doilink, rather than \href + %% add macro text for "ASME J. Heat Transfer-Trans. ASME" %% %% Author: John H. Lienhard V %% Department of Mechanical Engineering @@ -487,16 +493,16 @@ FUNCTION {eng.ord} MACRO {arxiv} {"https://arxiv.org/abs/"} -MACRO {googlebooks} {"http://books.google.com/books?id="} +MACRO {googlebooks} {"https://books.google.com/books?id="} -MACRO {hdl} {"http://hdl.handle.net/"} -MACRO {hndl} {"http://hdl.handle.net/"} +MACRO {hdl} {"https://hdl.handle.net/"} +MACRO {hndl} {"https://hdl.handle.net/"} -MACRO {jstor} {"http://www.jstor.org/stable/"} +MACRO {jstor} {"https://www.jstor.org/stable/"} -MACRO {oclc} {"http://www.worldcat.org/oclc/"} +MACRO {oclc} {"https://www.worldcat.org/oclc/"} -MACRO {pubmed} {"http://www.ncbi.nlm.nih.gov/pubmed/"} +MACRO {pubmed} {"https://www.ncbi.nlm.nih.gov/pubmed/"} MACRO {amr} {"Appl. Mech. Rev."} @@ -529,7 +535,7 @@ MACRO {jfe} {"ASME J. Fluids Eng."} MACRO {jfcst} {"ASME J. Fuel Cell Sci. Tech."} -MACRO {jht} {"ASME J. Heat Transfer"} +MACRO {jht} {"ASME J. Heat Transfer-Trans. ASME"} MACRO {jmse} {"ASME J. Manuf. Sci. E."} @@ -835,13 +841,13 @@ FUNCTION {doilink} { url empty$ { eprint empty$ { skip$ } - { "\href{" archive eprint * * "}{" * swap$ * "}" * } + { "\hrefurl{" archive eprint * * "}{" * swap$ * "}" * } if$ } - { "\href{" url * "}{" * swap$ * "}" * } + { "\hrefurl{" url * "}{" * swap$ * "}" * } if$ } - { "\href{https://doi.org/" doi * "}{" * swap$ * "}" * } + { "\hrefurl{https://doi.org/" doi * "}{" * swap$ * "}" * } if$ } if$ @@ -1912,7 +1918,9 @@ FUNCTION {begin.bib} write$ newline$ " \providecommand{\doi}{doi:\discretionary{}{}{}\begingroup \urlstyle{rm}\Url}\fi" write$ newline$ - "\providecommand{\eprint}[2][]{\href{#1#2}{#1#2}}" + "\providecommand{\eprint}[2][]{\urlprefix\url{#1#2}}" + write$ newline$ + "\providecommand{\hrefurl}[2][]{\href{#1}{#2}}" write$ newline$ } EXECUTE {begin.bib} diff --git a/Master/texmf-dist/doc/latex/asmejour/README.md b/Master/texmf-dist/doc/latex/asmejour/README.md index 18a7f825f0e..067d79afe30 100644 --- a/Master/texmf-dist/doc/latex/asmejour/README.md +++ b/Master/texmf-dist/doc/latex/asmejour/README.md @@ -1,11 +1,11 @@ #asmejour: A template for ASME journal papers# - Version 1.15 dated 2021/02/01. + Version 1.16 dated 2021/12/23. ####Overview#### This class provides a template to format preprints in the style of journal papers published by the American Society of Mechanical Engineers. - The layout and reference formats follow the style of published papers in 2020. + The layout and reference formats follow the style of published papers in 2021. This work is not a publication of ASME. @@ -29,7 +29,7 @@ - closely approximate ASME's fonts and layout, including author/title/abstract design - - match ASME's current reference formats, including hyperlinked DOI and URL fields + - match ASME's current reference formats, including hyperlinked DOI and URL (replaces asmems4.bst) - support hyperlinks to figures, tables, equations, references, and external URLs @@ -64,6 +64,15 @@ --- ####Change log#### +v1.16 (2021/12/23): + - suppress warnings about unused options when calling mathalfa and/or barcolor + - eliminate use of \\entry{} with a single argument to produce subheadings in nomenclature; use \\EntryHeading{} instead. (**not backward compatible**) + - incorporate pending changes to LaTeX pdf management in relation to pdf-a color profile loading and recently deprecated \\pdfcatalog command + - load xparse only for older kernels + - edit documentation; mention \\mathversion sans and sansbold + - add upright, sans serif Greek letters for math + - minor edits to class file code; correct calls for pdfminorversion; edit warnings + - minor edits to asmejour.bst in relation to hyperlinks, \\href, \\hrefurl; update jht macro to latest style v1.15 (2021/02/01): - fix issue with math accents in mathversion sansbold (for captions) diff --git a/Master/texmf-dist/doc/latex/asmejour/asmejour-sample.bib b/Master/texmf-dist/doc/latex/asmejour/asmejour-sample.bib index 864e8f51fba..7f6e8d353d7 100644 --- a/Master/texmf-dist/doc/latex/asmejour/asmejour-sample.bib +++ b/Master/texmf-dist/doc/latex/asmejour/asmejour-sample.bib @@ -1,6 +1,6 @@ %% Sample bibliography file for asmejour.bst and asmejour.cls %% -%% Revised: 30 January 2021 +%% Revised: 22 December 2022 %% Copyright John H. Lienhard, MIT %% Offered under the MIT license: https://ctan.org/license/mit @@ -12,7 +12,7 @@ author = {D. K. Edwards}, year = {1969}, title = {Radiative Transfer Characteristics of Materials}, - journal = {{ASME} J. Heat Transfer}, + journal = {{ASME} J. Heat Transfer-Trans. {ASME}}, volume = 91, number = 1, pages = {1--15}, @@ -128,14 +128,24 @@ %% note, url, urldate, urltype %% These additional fields are also supported, but are intended as alternatives to url: doi, eprint with archive +@online{kern, + author = {Uwe Kern}, + year = {2021}, + title = {Extending \LaTeX's color facilities: the \textsf{xcolor} package}, + version = {2.13}, + organization = {Comprehensive \TeX\ Archive Network}, + url = {https://ctan.org/pkg/xcolor}, + urldate = {Dec. 22, 2021}, +} + @online{sharpe1, author = {Michael Sharpe}, - year = {2018}, + year = {2021}, title = {New {TX} Font Package}, - version = {1.554}, + version = {1.659}, organization = {Comprehensive \TeX\ Archive Network}, url = {https://ctan.org/pkg/newtx}, - urldate = {Apr. 27, 2019}, + urldate = {Dec. 22, 2021}, } @article{Lienhard2019b, @@ -212,7 +222,7 @@ R. F. Boisvert and C. W. Clark and B. R. Miller and B. V. Saunders}, organization = {National Institute of Standards and Technology}, address = {Gaithersburg, MD}, - url = {http://dlmf.nist.gov/}, + url = {https://dlmf.nist.gov/}, urldate = {Dec. 22, 2018}, } @@ -220,7 +230,7 @@ author = {Richard Koch}, title = {{\TeX}{S}hop, Version 4.01}, year = {2018}, - url = {http://pages.uoregon.edu/koch/texshop/obtaining.html}, + url = {https://pages.uoregon.edu/koch/texshop/obtaining.html}, urldate = {Apr. 16, 2018}, organization = {University of Oregon}, address = {Eugene, OR}, @@ -341,7 +351,7 @@ eprint = {2060/19980228020}, } %% Equivalent links for this case: url = {https://ntrs.nasa.gov/archive/nasa/casi.ntrs.nasa.gov/19980228020.pdf}, -%% url = {http://hdl.handle.net/2060/19980228020} +%% url = {https://hdl.handle.net/2060/19980228020} @incollection{clauser56, author = {Francis H. Clauser}, @@ -433,7 +443,7 @@ @online{mpl, title = {mpl Colormaps}, author = {St{\'e}fan {van der Walt} and Nathaniel Smith}, - url = {http://bids.github.io/colormap/}, + url = {https://bids.github.io/colormap/}, urldate = {Aug. 26, 2018}, year = 2015, organization = {GitHub}, @@ -452,7 +462,7 @@ edition = {5}, month = aug, version = {5.00}, - url = {http://ahtt.mit.edu}, + url = {https://ahtt.mit.edu}, } @@ -497,14 +507,14 @@ } @proceedings{johnson2015, - editor = {Howard Johnson}, + editor = {Howard W. Johnson}, title = {The Title of the Proceedings}, year = 2015, volume = 2, organization = {Organization}, venue = {City, State}, eventdate = {April 27--28}, - url = {http://web.mit.edu}, + url = {https://news.mit.edu/2009/obit-johnson}, note = {Optional note}, } %% proceedings supports these fields: author OR editor, year, title, edition, editor, @@ -524,6 +534,7 @@ number = {23}, publisher = {Vulcan Free Press}, address = {T'Paal}, + note = {To appear.}, } %% One book in a series of books @@ -536,7 +547,7 @@ volume = {1}, chapter = {5}, pages = {66--89}, - url = {http://web.mit.edu}, + url = {https://www.worldcat.org/oclc/3025315}, publisher = {Houghton Mifflin Co.}, address = {Boston}, note = {{``The Locust Years''}}, diff --git a/Master/texmf-dist/doc/latex/asmejour/asmejour-template.pdf b/Master/texmf-dist/doc/latex/asmejour/asmejour-template.pdf Binary files differindex 2951bf48e78..8d6ee337d44 100644 --- a/Master/texmf-dist/doc/latex/asmejour/asmejour-template.pdf +++ b/Master/texmf-dist/doc/latex/asmejour/asmejour-template.pdf diff --git a/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex b/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex index b822063f694..9aba31970cb 100644 --- a/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex +++ b/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex @@ -3,7 +3,7 @@ %% %% This file is asmejour-template.tex, a template to format papers in the style of ASME journal papers. %% -%% This file is version 1.15 dated 2021/02/01 +%% This file is version 1.16 dated 2021/12/23 %% %% Author: John H. Lienhard V %% Department of Mechanical Engineering @@ -18,7 +18,7 @@ %% * Option to omit the list of figures and list of tables at the end [nolists] %% %% * Math options from M. Sharpe's newtxmath package: upright integrals [upint]; -%% * [varvw] for a v and w that are better distinguished from greek nu; [subscriptcorrection] +%% * [varvw] for a v and w that are better distinguished from Greek nu; [subscriptcorrection] %% * to fine-tune the placement of math subscripts; and also additional options such as %% * [smallerops, varg, slantedGreek, frenchmath, varbb, cmbraces]. Version 1.6 or higher %% * is recommended. @@ -31,17 +31,21 @@ %% * misbehaves, so use it with an awareness that it can create unexpected problems. %% * This option is not compatible with line numbering. %% -%% * Options for PDF/A compliance. [pdf-a] will produce PDF/A-3u compliance with sRGB OutputIntent. -%% * [pdfapart= 1 or 2 or 3] and [pdfaconformance= b or u] allow other levels: 1b, 2b, 2u, and 3b. -%% -%% * An option to omit all the ASME text fields from the footer [nofoot]. -%% %% * Options for copyright notices: %% * Omit the ASME copyright from the footer [nocopyright] %% * Copyright footnote if all authors are government employees [govt] %% * Copyright footnote if some authors are government employees [govtsome] %% * Copyright footnote for government contractors [contractor] %% +%% * Option to omit all ASME text fields from the footer [nofoot]. +%% +%% * Options for PDF/A compliance. [pdf-a] will produce PDF/A-3u compliance with sRGB OutputIntent. +%% * [pdfapart= 1 or 2 or 3] and [pdfaconformance= b or u] can enable levels 1b, 2b, 2u, and 3b. +%% * +%% * The most recent versions of LaTeX (2021 and later) are moving toward integrated support for pdf-a, +%% * through \DeclareDocumentMetadata{..}. The asmeconf class supports these new features, which can +%% * replace the aforementioned class options. (An up-to-date LaTeX installation is required.) +%% %% * Many options for calligraphic, script, and fraktur fonts from the mathalfa package; the %% * example value used is: mathalfa=cal=euler (use Euler font for \mathcal) %% * some other options for cal are: dutchcal, zapfc, cm (default), boondox,... @@ -59,7 +63,7 @@ %% * abstract in an appendix), e.g. [french]. The main language will default to English %% * unless a different main language is selected, e.g. [main=spanish]. See Appendix C for details. %% -%% For details of the newtxmath and mathalfa packages, refer to their documentation (available at CTAN: http://ctan.org). +%% For details of the newtx and mathalfa packages, refer to their documentation (available at CTAN: http://ctan.org). %% %% The use of commands defined or modified by the asmejour class is illustrated below. In particular, some care %% is needed when using complicated math and macros in section headings, to avoid problems with pdf bookmarks, @@ -75,28 +79,30 @@ %% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - %% Class options are described above. -\documentclass[subscriptcorrection,upint,varvw,mathalfa=cal=euler,barcolor=Goldenrod3,balance,hyphenate,french,pdf-a]{asmejour} +\documentclass[subscriptcorrection,upint,varvw,barcolor=Goldenrod3,mathalfa=cal=euler,balance,hyphenate,french,pdf-a]{asmejour} % + -%%%%% FIELDS TO BE COMPLETED FOLLOW %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%% pdf metadata %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%% pdf metadata, the user should edit %%%%%%%%%%%%%%%%%% \hypersetup{% - pdftitle={ASME Journal Paper Template}, % <=== change to YOUR pdf file title - pdfkeywords={ASME, Paper, Template, LaTeX, BibTeX, asmejour class}, % <=== change to YOUR pdf keywords - pdfauthor={John H. Lienhard}, % <=== change to YOUR name[s]!!! + pdfauthor={John H. Lienhard}, % <=== change to YOUR name[s]! + pdftitle={ASME Journal Paper LaTeX Template}, % <=== change to YOUR pdf file title + pdfkeywords={ASME journal paper, LaTeX template, BibTeX style, asmejour class},% <=== change to YOUR pdf keywords + pdfsubject = {Describes the asmejour LaTeX template}, % <=== change to YOUR subject + pdfurl={https://ctan.org/pkg/asmejour},% may delete + pdflicenseurl={https://ctan.org/pkg/asmejour},% may delete } -%%%% Journal name and optional copyright year %%%%%%%%%%%%%% +%%%% Journal name and optional copyright year %%%%%%%%%%%%%% %% Omit "Journal of". If Journal Name is quite long, use \\ to insert a line break \JourName{Heat Transfer}%<=== change to the name of your journal %% The default copyright year is the current year -%% \PaperYear{2020} sets 2020; and \PaperYear{} omits the year entirely. +%% \PaperYear{2022} sets 2022; and \PaperYear{} omits the year entirely. -%%%%%%%%% End of Preamble %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%% end of preamble %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \begin{document} @@ -152,12 +158,11 @@ This paper is an example and {\upshape\LaTeX} template for the {\upshape\texttt{ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%% End of fields to be completed. Now write! %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - \section{Introduction} The \texttt{asmejour} class typesets 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. Many other useful features are supported. -This class is not a publication of ASME, although the author has published in ASME journals since 1984. 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. +This class is not a publication of ASME, although the author has published in ASME journals since 1984. The intended use of this package is to enable authors to format their papers in ASME style prior to submission to an ASME journal for peer review. 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. The class calls a number of packages, all of which are contained in up-to-date versions of \TeX~Live, Mac\TeX, and similar platforms. If you find that you are missing a package, you may obtain it at no cost from CTAN (\href{http://ctan.org}{ctan.org}). @@ -168,12 +173,12 @@ For each author, put author names and affiliation (with line breaks) into a sepa The title should be placed into \verb|\title{..}|, and line breaks may be specified if desired. Keywords may optionally be including using the \verb|\keywords{..}| command; this command \textit{must} be issued before the abstract. To omit keywords, just omit this command. Next, the abstract text must be placed into \verb|\begin{abstract}|\ldots\verb|\end{abstract}|. The abstract will automatically be italicized. -The date is automatically given as an unnumbered footnote, which deafults to \verb|\today|. Different text may be given using \verb|\date{..}|. Putting \verb|\date{}| will suppress the date footnote. +The date is automatically given as an unnumbered footnote, which defaults to \verb|\today|. Different text may be given using \verb|\date{..}|. Putting \verb|\date{}| will suppress the date footnote. After setting up the authors, title, and abstract, issue the \verb|\maketitle| command. The introduction section comes next. -\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 for this example is \texttt{Goldenrod3}. To have a black bar, either omit \texttt{barcolor} entirely or use the name \texttt{black}. +\subsection{Option to Color the 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~\cite{kern} may be invoked by including the option \texttt{[barcolor=name]} in the \verb|\documentclass[..]{asmejour}| command. The color for this example is \texttt{Goldenrod3}. To have a black bar, either omit \texttt{barcolor} entirely or use the name \texttt{black}. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -261,7 +266,7 @@ Landscape figures and tables may be produced at full-page size by putting \verb| %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Reference Formatting with \texttt{asmejour.bst}} -The {\upshape\texttt{asmejour.bst}} \hologo{BibTeX} style follows the reference styles observed in ASME journals in 2020.\footnote{\texttt{asmejour.bst} is intended as a replacement for the older style \texttt{asmems4.bst}, which does not follow ASME's current reference formats or support DOI and URL.} The vast majority of published references are to journal papers and books. Examples for these and many other entry types 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. +The {\upshape\texttt{asmejour.bst}} \hologo{BibTeX} style follows the reference styles observed in ASME journals in 2021.\footnote{\texttt{asmejour.bst} is intended as a replacement for the older style \texttt{asmems4.bst}, which does not follow ASME's current reference formats or support DOI and URL.} The vast majority of published references are to journal papers and books. Examples for these and many other entry types 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{Capitalization of Titles} ASME's bibliography style requires that titles be in title case. The first letters of principal words are capitalized. This must be done when writing the \texttt{.bib} file. @@ -291,6 +296,9 @@ Run 12 & 24 & 68.3 \\ }% \end{table} +%% Note: location of tables and figures can be adjusted with the options [!tbhp] +%% see: https://latexref.xyz/dev/latex2e.html#Floats + %%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%% begin more complicated table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -327,10 +335,23 @@ The \verb|version={..}| field may be used with \verb|@book|, \verb|@online|, and %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{More on Math} -Math italics are used for roman and lower-case greek letters by default. If you want an upright letter in math, you can use the relevant math alphabet, e.g., \verb|\mathrm, \mathbf, \mathsf|: + +In most cases, long equations can be kept below the column width by using one of the multiline equation environments defined by \texttt{amsmath}, +such as \texttt{align}, \texttt{split}, or \texttt{multline}~\cite{amsmath}. The following equation is set with the \texttt{multline} environment: +\begin{multline} +\frac{\partial}{\partial t}\left[\rho\Bigl(e + \lVert\mathbf{u}\rVert^2\mspace{-3mu}\big/2\Bigr)\right] + \nabla\cdot\left[\rho\Bigl(h + \lVert\mathbf{u}\rVert^2\mspace{-3mu}\big/2 \Bigr)\mathbf{u}\right]\\ + ={}-\nabla \cdot \mathbf{q} + \rho \mathbf{u}\cdot\mathbf{g}+ \frac{\partial}{\partial x_j}\bigl(d_{ji}u_i\bigr) + \dot{Q}_v\label{eqn:energy} +\end{multline} +An example using \texttt{align} appears in Appendix~\ref{app:zetafunction}. + +An alternative solution may be to set large equations into two-column-wide tables or figures. While a package exists for setting equations that span two columns (\texttt{widetext.sty}), that code is erratic in relation to floats and page breaks. + +Math italics are used for Roman and lower-case Greek letters by default. If you want an upright letter in math, you can use the relevant math alphabet, e.g., \verb|\mathrm, \mathbf, \mathsf|: \begin{equation}\label{eqn:newton2} \vec{F} = m \vec{a} \quad\textrm{or}\quad \vec{\mathrm{F}} = m \vec{\mathrm{a}} \quad\textrm{or}\quad \mathbf{F} = m \mathbf{a} \quad\textrm{or}\quad \vec{\mathsf{F}} = m \vec{\mathsf{a}} \end{equation} +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}$). +% (Note that the \verb|newtxmath| options \verb|frenchmath| and \verb|slantedGreek| also affect how Greek letters are presented.) ASME typesets vectors in upright bold, like the third instance in Eq.\ \eqref{eqn:newton2}, and sets matrices in bold italic. In the next equation, $\mathbf{w}$ is a vector and $\bm{J}_1$ is a matrix: \begin{equation}\label{eqn:dw} @@ -350,21 +371,12 @@ To get additional symbols in bold math, you can use the \verb|\bm{..}| macro fro \begin{equation} \mathbf{u}_r = u_r\bm{\hat{\textbf{\i}}}+v_r\bm{\hat{\textbf{\j}}}+w_r\bm{\hat{\textbf{k}}} \end{equation} -or, \textit{very} rarely, \verb|\mathversion{bold}| for an entire equation: +or, \textit{very} rarely, \verb|\mathversion{bold}| for an entire equation\footnote{For sans-serif math expressions, \texttt{asmejour.cls} provides \texttt{\string\mathversion \{sans\}} and \texttt{\string\mathversion \{sansbold\}}. These fonts can act as engineering gothic for figures.}: \mathversion{bold}\begin{equation} S = k \ln w = k \ln \biggl(\frac{N!}{\prod_i N_i!}\biggr) \end{equation} \mathversion{normal}% avoid extra line break with % -In most cases, long equations can be kept below the column width by using one of the multiline equation environments defined by \texttt{amsmath}, -such as \texttt{align}, \texttt{split}, or \texttt{multline}~\cite{amsmath}. The following equation is set with the \texttt{multline} environment: -\begin{multline} -\frac{\partial}{\partial t}\left[\rho\Bigl(e + \lVert\mathbf{u}\rVert^2\mspace{-3mu}\big/2\Bigr)\right] + \nabla\cdot\left[\rho\Bigl(h + \lVert\mathbf{u}\rVert^2\mspace{-3mu}\big/2 \Bigr)\mathbf{u}\right]\\ - ={}-\nabla \cdot \mathbf{q} + \rho \mathbf{u}\cdot\mathbf{g}+ \frac{\partial}{\partial x_j}\bigl(d_{ji}u_i\bigr) + \dot{Q}_v\label{eqn:energy} -\end{multline} -An example using \texttt{align} appears in Appendix~\ref{app:zetafunction}. - -An alternative solution may be to set large equations into two-column-wide tables or figures. While a package exists for setting equations that span two columns (\texttt{widetext.sty}), that code is erratic in relation to floats and page breaks. \subsection{\texttt{newtxmath} and \texttt{mathalpha}} The \texttt{newtxmath} package~\cite{sharpe1}, loaded by default, includes a large number of options for mathematics, most of which 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} @@ -381,12 +393,12 @@ To see all the font options, refer to the \texttt{mathalfa} documentation \cite{ The class is designed for use with \texttt{newtxmath} and does not support the \texttt{unicode-math} package. -%% Dealing with complicated math in a section heading: optional argument of \section provides the pdfbookmark +%% Dealing with complicated math in a section heading: optional argument of \section provides the pdf bookmark %% 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. \subsection[Math in a Section Heading: \omega\cdot U=0]{Math in a Section Heading: $\tilde{\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: +To include complicated math in a section heading without producing bookmark-related errors, use the optional argument of \verb|\section| to create the pdf bookmark. The heading above was set with the following command: \begin{quote}\raggedright \verb|\subsection[Math in a Section Heading:| \hspace*{1em}\verb|\omega\cdot U=0]{Math in a Section Heading:| @@ -395,7 +407,27 @@ To include complicated math in a section heading without producing bookmark-rela Note that bookmarks can include simple math. Also note that \texttt{newtxmath} provides the option to obtain upright Greek letters, such as \verb|\upomega| (vs.\ \verb|\omega|). -\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. +\subsection{Units and Nomenclature} ASME requires SI units. U.~S.\ style units may follow in parentheses. Be sure to put your symbols into the nomenclature list, including the SI units. + + +%%%%%%%%%%%%%%%%%%% begin linewidth table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\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} +\begin{tabular*}{\linewidth}{@{\extracolsep{\fill}}CCCC@{\extracolsep{\fill}}} +\toprule +X_{z} & X_{c} & X_{c,m} & X_{c,2}\rule{0pt}{8pt}\\ + 3.92069 & 5.70943 & 6.32429 & 7.08757\\[2pt] +\varepsilon (T_1) & \varepsilon^i (T_1) & \varepsilon^i (T_m) & \alpha (T_1, T_2)\\ +0.7258 & 0.6237 & 0.6807 & 0.7964 \\[2pt] +q_\textrm{gray} & q_\textrm{int, $T_1$} & q_\textrm{int, $T_m$} & q_\textrm{exact}\\ +400.2 & 462.1 & 371.0 & 371.8 \\ +\bottomrule +\end{tabular*} +\end{table} + +%%%%%%%%%%%%%%%%%%%% end linewidth table %%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -424,30 +456,12 @@ default setting is for PDF/A-3u with sRGB OutputIntent (\texttt{sRGB.icc}). If l options \texttt{[pdfapart=1 or 2 or 3]} and \texttt{[pdfaconformance=b or u]}. Note that accessible conformance~(\texttt{a}) is not currently possible with \LaTeX. -\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (numbers and letters) for use in footnote markers and superscripts. The option \texttt{[nodefaultsups]} enables this font. (The corresponding author mark in the author block will not change.) - -\subsection{Typewriter Font Options} This font is the sans-serif, monospaced font \texttt{inconsolata}. By default, the word spacing is variable, but option \texttt{[mono]} ends this behavior. A slashed zero is the default; option \texttt{[var0]} removes the slash. Option \texttt{[hyphenate]} enables hyphenation of the typewriter font.%(This option is not available if the \texttt{[fontspec]} option is used.) - - -%%%%%%%%%%%%%%%%%%% begin linewidth table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +As of late 2021, the \LaTeX 3 team is phasing in native support for PDF/A in the \LaTeX\ kernel, which eventually will make these +class options unnecessary when using an up-to-date installation. -\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} -\begin{tabular*}{\linewidth}{@{\extracolsep{\fill}}CCCC@{\extracolsep{\fill}}} -\toprule -X_{z} & X_{c} & X_{c,m} & X_{c,2}\rule{0pt}{8pt}\\ - 3.92069 & 5.70943 & 6.32429 & 7.08757\\[2pt] -\varepsilon (T_1) & \varepsilon^i (T_1) & \varepsilon^i (T_m) & \alpha (T_1, T_2)\\ -0.7258 & 0.6237 & 0.6807 & 0.7964 \\[2pt] -q_\textrm{gray} & q_\textrm{int, $T_1$} & q_\textrm{int, $T_m$} & q_\textrm{exact}\\ -400.2 & 462.1 & 371.0 & 371.8 \\ -\bottomrule -\end{tabular*} -\end{table} - -%%%%%%%%%%%%%%%%%%%% end linewidth table %%%%%%%%%%%%%%%%%%%%%%% +\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (numbers and letters) for use in footnote markers and superscripts. The option \texttt{[nodefaultsups]} enables this font. (The corresponding author mark in the author block will not change.) +\subsection{Typewriter Font Options} This font is the sans-serif, monospaced font \texttt{inconsolata}. By default, the word spacing is variable, but option \texttt{[mono]} ends this behavior. A slashed zero is the default; option \texttt{[var0]} removes the slash. Option \texttt{[hyphenate]} enables hyphenation of the typewriter font. %%%%%%%%%%%%%%% begin two column table %%%%%%%%%%%%%%%%%% @@ -483,8 +497,9 @@ q_\textrm{gray} & q_\textrm{int, $T_1$} & q_\textrm{int, $T_m$} & q_\textrm{exa %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Conclusions} + 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 references are shown in the \texttt{asmejour-sample.bib} file. The \texttt{asemjour.bst} file produces references following ASME's current formats. The code is compatible with both {\hologo{pdfLaTeX}} and \LuaLaTeX. This package is not a publication of ASME and is offered at no cost under the terms of the \href{https://ctan.org/license/mit}{MIT license}. +Documentation is provided in this file and by comments in the \texttt{.tex} source code. Examples of references are shown in the \texttt{asmejour-sample.bib} file. The \texttt{asemjour.bst} file produces references following ASME's current formats. The code is compatible with both {\hologo{pdfLaTeX}} and \LuaLaTeX. This package is not a publication of ASME and is offered at no cost under the terms of the \hrefurl{https://ctan.org/license/mit}{MIT license}. \begin{enumerate} \item First conclusion @@ -501,6 +516,7 @@ Acknowledge individuals, institutions, or companies that supported the authors i %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section*{Funding Data} + \begin{itemize} \item U.S.\ Department of Heat Transfer, Office of Important Ideas (DOHT-OII Award No.\ 3.14159265) \end{itemize} @@ -536,7 +552,7 @@ Acknowledge individuals, institutions, or companies that supported the authors i \end{nomenclature} -%%%%%%%%%%%%%%% APPENDICES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%% APPENDICES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% Note that appendices will be "numbered" A, B, C, ... etc. Use \section, not \section* %% Subsections need not be numbered, use \subsection* @@ -576,21 +592,25 @@ The standard caption and section names will follow \texttt{babel}'s dictionary f The font encoding is set to T1 and utf-8 input is supported: %% If you have trouble with the next line (or the French text that follows), your file may not be saved in utf-8 format. You can delete these lines to resolve the issue. \typeout{If you have trouble with the next line, your file may not be saved in utf-8 format. You can delete that line to resolve the issue.} -àáâäæãåā èéęëêēė îïíīįì ôöòóœøōõ ûüùúū çćč ł ñń ßśš ÿ žźż - +\ifluatex\typeout{Under LuaLaTeX, some of these accents must be obtained as escaped characters, with \=a, \c{e}, \l, \.o, \oe, \v{z}, \'z, etc.}\fi +àáâäæãåā èéęëêēė îïíīįì ôöòóœøōõ ûüùúū çćč ł ñń ßśš ÿ žźż + No effort has been made to support customization of language-specific fonts (some fonts can be implemented using the \texttt{substitutefont} package~\cite{milde}). 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{Discours Préliminaire de Fourier}\label{app:fourier} + Les causes primordiales ne nous sont point connues; mais elles sont assujetties à des lois simples et constantes, que l'on peut découvrir par l'observation, et dont l'étude est l'objet de la philosophie naturelle. La chale ur pénètre, comme la gravité, toutes les substances de l'univers, ses rayons occupent toutes les parties de l'espace. Le but de notre ouvrage est d'exposer les lois mathématiques que suit cet élément. Cette théorie formera désormais une des branches les plus importantes de la physique générale~\cite{fourier1822}. \selectlanguage{english} +% When you drop the [french] option, delete your .aux file as well, since [french] sets ":" as an active character. + -%%%%%%%%%%%%% BIBLIOGRAPHY %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%% BIBLIOGRAPHY %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \nocite{*} %% <=== delete this line - unless you wish to typeset the entire contents of your .bib file. diff --git a/Master/texmf-dist/tex/latex/asmejour/asmejour.cls b/Master/texmf-dist/tex/latex/asmejour/asmejour.cls index e5a6b6bdc12..48c33b0ed88 100644 --- a/Master/texmf-dist/tex/latex/asmejour/asmejour.cls +++ b/Master/texmf-dist/tex/latex/asmejour/asmejour.cls @@ -6,8 +6,8 @@ %% %% %% This file's version and date are: - \def\versionno{1.15} - \def\versiondate{2021/02/01\space} + \def\versionno{1.16} + \def\versiondate{2021/12/23\space} %% %% Author: John H. Lienhard V %% Department of Mechanical Engineering @@ -28,7 +28,8 @@ %% 10. Support inclusion of passages in languages other than English %% %% This class is compatible with either pdfLaTeX or LuaLaTeX. All packages required by the class -%% are in standard distributions, such as TeXLive, and are also available at CTAN (https://ctan.org/). +%% are in standard distributions, such as TeXLive, and are also available at CTAN (https://ctan.org/). +%% The use of an up-to-date, complete distribution is strongly recommended. %% %% The title block is set by specific commands that are described in the asmejour-template.tex file. %% @@ -66,11 +67,24 @@ \LoadClass[twoside,9pt,twocolumn]{extarticle} -\RequirePackage{xparse}% \entry{} command uses deprecated g argument; will drop this eventually -\RequirePackage{etoolbox}% dropped xpatch 28/02/20 +\ifdefined\NewDocumentCommand\else + \RequirePackage{xparse} +\fi + +\RequirePackage{etoolbox}% dropped xpatch 2020/02/28 \RequirePackage{ifthen} \RequirePackage{iftex}% check whether pdftex or another engine is used +\providecommand\IfFormatAtLeastTF{\@ifl@t@r\fmtversion}% backward compatibility (Thanks Ulrike Fischer) + +\DeclareDocumentCommand\LogNote{m}{% + \IfFormatAtLeastTF{2021/11/15}{% + \ClassNoteNoLine{asmejour}{#1}% New with this recent format + }{% + \ClassWarningNoLine{asmejour}{#1}% + } +} + %%%%%%%%%%%%%% Options for the class %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \RequirePackage{kvoptions}% this package calls kvsetkeys @@ -107,7 +121,7 @@ \aj@mainsettrue \ifthenelse{\equal{#1}{english}}{% \PassOptionsToPackage{pdflang=en}{hyperref}}{% - \ClassWarningNoLine{asmejour}{Selecting #1 as the primary language}% + \LogNote{Selecting #1 as the primary language} }% } @@ -118,7 +132,7 @@ \aj@mainsettrue% \ifthenelse{\equal{#1}{english}}{% \relax}{% - \ClassWarningNoLine{asmeconf}{Selecting #1 as the primary language}% + \LogNote{Selecting #1 as the primary language}% }% } \define@key{asmejour}{lang-second}[english]{% deprecated option @@ -132,9 +146,12 @@ \ifaj@mainset\relax\else \PassOptionsToPackage{main=english}{babel}% \PassOptionsToPackage{pdflang=en}{hyperref} - %\ClassWarningNoLine{asmejour}{Selecting English as the primary language, since main= not set}% + \ClassInfo{Selecting English as the primary language, since main= not set}% \fi +%% Suppress warnings about unused global options, 2021/12/01 +\DeclareDefaultOption{}% suppress warning about unused mathalfa and barcolor options + \ProcessKeyvalOptions{asmejour} %% Turn off these keys now that we're done with them @@ -149,36 +166,40 @@ \@DisableKeys{nodefaultsups;mathalfa;barcolor;main;lang;lang-second;lang-third} -%%%%%%% PDF/A Compliance Options %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%% PDF/A Compliance Keys %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \newif\ifaj@setpdfa\aj@setpdfafalse \newif\ifaj@pdfaone\aj@pdfaonefalse -\ifpdftex %% PDF/A compliance has only been configured for pdflatex +\ifpdftex %% pdf/a compliance has only been configured for pdflatex % -%%% set key [pdfa] to activate pdf/a compliance (default is pdf/A-3u) + %%% set key [pdfa] to activate pdf/a compliance (default is pdf/A-3u) \define@key{pdfaopt}{pdf-a}[true]{% \aj@setpdfatrue \PassOptionsToPackage{pdfa,pdfapart=3,pdfaconformance=u}{hyperref}% -} -%%% to select part 1, 2 or 3 + } + %%% to select part 1, 2 or 3 \define@key{pdfaopt}{pdfapart}[3]{% \PassOptionsToPackage{pdfapart=#1}{hyperref}% \ifthenelse{\equal{#1}{1}}{\aj@pdfaonetrue}{\relax}% -} -%% to select conformance b or u. NB: a is not possible with pdfLaTeX, and u is not possible with 1. + } + %% to select conformance b or u. NB: a is not possible with pdfLaTeX, and u is not possible with 1. \define@key{pdfaopt}{pdfaconformance}[u]{% \PassOptionsToPackage{pdfaconformance=#1}{hyperref}% -} - \ProcessKeyvalOptions{pdfaopt} + } \else - \ifaj@pdfaone\ClassWarningNoLine{asmejour}{PDF/A compliance option requires pdfLaTeX engine}\fi% + \define@key{pdfaopt}{pdf-a}[true]{% + \aj@setpdfatrue + } \fi +\ProcessKeyvalOptions{pdfaopt} + %% Done with these keys, so we can now disable them \def\@KeyFamily{pdfaopt} \@DisableKeys{pdf-a;pdfapart;pdfaconformance} + %%%%%%%%%% Further class options %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%% Option to obtain line numbers [lineno] @@ -225,11 +246,11 @@ \newif\ifaj@contractor\aj@contractorfalse \DeclareOption{contractor}{\aj@contractortrue} -%% Option for slightly larger small capitals font [largesc], corrected 29 Jan 2021 +%% Option for slightly larger small capitals font [largesc], corrected 2021/01/29 \DeclareOption{largesc}{\PassOptionsToPackage{largesc=true}{newtxtext}}% largesc is a boolean key in newtxtext %% ASME word separation is greater than newtxtext defaults so change these parameters. -\PassOptionsToPackage{spacing=0.3em, stretch=0.18em, shrink=0.10em}{newtxtext}% increased shrink from 0.08, 30 Jan 21 +\PassOptionsToPackage{spacing=0.3em, stretch=0.18em, shrink=0.10em}{newtxtext}% increased shrink from 0.08, 2021/01/30 %% Option not to use latex default superscripts, instead using the newtxtext superiors font [nodefaultsups] \ifthenelse{\boolean{DefaultSups}}{\PassOptionsToPackage{defaultsups}{newtxtext}}{\relax} @@ -242,7 +263,7 @@ %% Option to hyphenate the typewriter font [hyphenate] \DeclareOption{hyphenate}{% \PassOptionsToPackage{hyphenate}{inconsolata}% - \ClassWarningNoLine{asmejour}{Allowing hyphenation of typewriter font}% + \LogNote{Allowing hyphenation of typewriter font}% } %% Option to enforce monospacing of words the typewriter font [mono] \DeclareOption{mono}{% @@ -253,7 +274,7 @@ \PassOptionsToPackage{var0}{inconsolata}% var0 is a key via xkeyval in inconsolata } -%% Suppress warnings about mathalfa keys as unused global options +%% Suppress warnings about keys as unused global options \DeclareOption*{} \ProcessOptions \relax @@ -266,7 +287,7 @@ %% ASME's pdf pages are 11.25 in. tall, not 11.00 in. \RequirePackage[sort&compress,numbers]{natbib} -\AtBeginDocument{\def\NAT@space{\relax}}% ASME puts no space between numerical references (4/5/20) +\AtBeginDocument{\def\NAT@space{\relax}}% ASME puts no space between numerical references (2020/04/05) \setlength\bibsep{0pt plus 1pt minus 0pt}% ASME keeps this tight \renewcommand*{\bibfont}{\footnotesize} @@ -295,10 +316,9 @@ \renewcommand*{\midrule}{\specialrule{0.5pt}{2pt}{3pt}} \renewcommand*{\bottomrule}{\specialrule{0.5pt}{1pt}{\doublerulesep}\specialrule{0.5pt}{0pt}{0pt}} -%%%%%%%%%%%%% Font related %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - +%%%%%%%%%%%%% PDF/A related %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \ifpdftex - \ifaj@setpdfa + \ifaj@pdfaone \pdfminorversion=4 % for pdf/a-1 need version 4, not 7 \else \pdfminorversion=7 % this selection is not required @@ -306,9 +326,25 @@ \RequirePackage[T1]{fontenc} \RequirePackage[utf8]{inputenc}% for backward compatibility with pre-2018 LaTeX distributions \else - \relax % will lose some accented characters this way... better to use fontspec... if the systems fonts exist... + \ifaj@setpdfa\ClassWarningNoLine{asmejour}{pdf-a option requires pdfLaTeX engine. Under LuaLaTeX, use % + \protect\DeclareDocumentMetadata{pdfstandard=A-3b} before \protect\begin{document}}\fi% + \ifluatex + \directlua{ + if pdf.getminorversion() \string~= 7 then + if (status.pdf_gone and status.pdf_gone > 0) + or (status.pdf_ptr and status.pdf_ptr > 0) then + tex.error("PDF version cannot be changed anymore") + else + pdf.setminorversion(7) + end + end + \fi + }% will lose some accented characters this way... better to use fontspec, if the systems fonts exist. \fi + +%%%%%%%%%%%%% Font related %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \RequirePackage{mathtools}% loads and extends amsmath \RequirePackage[]{babel} @@ -340,14 +376,13 @@ \tolerance 2500 \emergencystretch 3em -\setlength{\jot}{10pt}% <== default is 3pt - -%% multline has an "extra line" above it, so subtract from \abovedisplayskip to remove imbalance -\BeforeBeginEnvironment{multline}{\addtolength\abovedisplayskip{-7pt}} -\AfterEndEnvironment{multline}{\addtolength\abovedisplayskip{+7pt}} - -\allowdisplaybreaks % ASME allows these breaks - +%% TeX Gyre Heros Condensed is qhvc (regular is qhv). +\newcommand*{\CondSans}{\selectfont\fontfamily{qhvc}\selectfont} +\renewcommand\huge{\@setfontsize\huge{14}{14}} %... for author names only +\newcommand*{\CondSansBold}{\renewcommand\bfdefault{b}\selectfont\fontfamily{qhvc}\selectfont\bfseries} +\renewcommand\Huge{\@setfontsize\Huge{26.5}{26.5}} %... for title font only + +\RequirePackage{metalogo,hologo}% Access to various LaTeX logos (for use in the documentation) %% This provides sans serif italic and sans serif bold italic math. %% It's intended for use in the figure and table captions. @@ -356,13 +391,13 @@ \SetSymbolFont{letters}{sansbold}{OML}{ntxsfmi}{b}{it} \SetSymbolFont{lettersA}{sansbold}{U}{ntxsfmia}{b}{it} \SetSymbolFont{symbols}{sansbold}{LMS}{ntxsy}{b}{n} -\SetSymbolFont{largesymbols}{sansbold}{LMX}{ntxexx}{b}{n}% added 26 Jan 2021 -\SetSymbolFont{largesymbolsTXA}{sansbold}{U}{ntxexa}{b}{n}% added 26 Jan 2021 +\SetSymbolFont{largesymbols}{sansbold}{LMX}{ntxexx}{b}{n}% added 2021/01/26 +\SetSymbolFont{largesymbolsTXA}{sansbold}{U}{ntxexa}{b}{n}% added 2021/01/26 \SetSymbolFont{operators}{sansbold}{\encodingdefault}{\sfdefault}{\bfdefault}{n} \SetMathAlphabet{\mathsf}{sansbold}{\encodingdefault}{\sfdefault}{b}{n}% \mathsf is upright %% These lines are to provide math accents for the sans and sansbold math versions. -%% The accents from ntxsfmi work normally with regular times fonts. Added 27 Jan 2021 +%% The accents from ntxsfmi work normally with regular times fonts. Added 2021/01/27 \DeclareSymbolFont{lettersAB}{U}{ntxsfmia}{m}{it} \SetSymbolFont{lettersAB}{normal}{U}{ntxsfmia}{m}{it} \SetSymbolFont{lettersAB}{bold}{U}{ntxsfmia}{b}{it} @@ -379,8 +414,66 @@ \DeclareMathAccent{\dot}{\mathord}{lettersAB}{224} \DeclareMathAccent{\tilde}{\mathord}{lettersAB}{219} +%% Provide sans-serif *upright* Greek letters, following a suggestion by Michael Sharpe. 2021/12/22 +%% Following Sharpe's newtxsf implementation of the STIX fonts, under the LaTeX Project Public License. +%% (Note that \mathversion{sansbold} provides sans-serif *italic* Greek letters.) + +\DeclareMathSymbol{\sfGamma}{\mathalpha}{lettersAB}{0}% adjust to avoid overwriting newtxmath commands, +\DeclareMathSymbol{\sfDelta}{\mathalpha}{lettersAB}{1} +\DeclareMathSymbol{\sfTheta}{\mathalpha}{lettersAB}{2} +\DeclareMathSymbol{\sfLambda}{\mathalpha}{lettersAB}{3} +\DeclareMathSymbol{\sfXi}{\mathalpha}{lettersAB}{4} +\DeclareMathSymbol{\sfPi}{\mathalpha}{lettersAB}{5} + +\DeclareMathSymbol{\sfSigma}{\mathalpha}{lettersAB}{6} +\DeclareMathSymbol{\sfUpsilon}{\mathalpha}{lettersAB}{7} +\DeclareMathSymbol{\sfPhi}{\mathalpha}{lettersAB}{8} +\DeclareMathSymbol{\sfPsi}{\mathalpha}{lettersAB}{9} +\DeclareMathSymbol{\sfOmega}{\mathalpha}{lettersAB}{10} + +\DeclareMathSymbol{\sfalpha}{\mathalpha}{lettersAB}{11} +\DeclareMathSymbol{\sfbeta}{\mathalpha}{lettersAB}{12} +\DeclareMathSymbol{\sfgamma}{\mathalpha}{lettersAB}{13} +\DeclareMathSymbol{\sfdelta}{\mathalpha}{lettersAB}{14} +\DeclareMathSymbol{\sfepsilon}{\mathalpha}{lettersAB}{15} + +\DeclareMathSymbol{\sfzeta}{\mathalpha}{lettersAB}{16} +\DeclareMathSymbol{\sfeta}{\mathalpha}{lettersAB}{17} +\DeclareMathSymbol{\sftheta}{\mathalpha}{lettersAB}{18} +\DeclareMathSymbol{\sfiota}{\mathalpha}{lettersAB}{19} +\DeclareMathSymbol{\sfkappa}{\mathalpha}{lettersAB}{20} + +\DeclareMathSymbol{\sflambda}{\mathalpha}{lettersAB}{21} +\DeclareMathSymbol{\sfmu}{\mathalpha}{lettersAB}{22} +\DeclareMathSymbol{\sfnu}{\mathalpha}{lettersAB}{23} +\DeclareMathSymbol{\sfxi}{\mathalpha}{lettersAB}{24} +\DeclareMathSymbol{\sfpi}{\mathalpha}{lettersAB}{25} + +\DeclareMathSymbol{\sfrho}{\mathalpha}{lettersAB}{26} +\DeclareMathSymbol{\sfsigma}{\mathalpha}{lettersAB}{27} +\DeclareMathSymbol{\sftau}{\mathalpha}{lettersAB}{28} +\DeclareMathSymbol{\sfUpsilon}{\mathalpha}{lettersAB}{29} +\DeclareMathSymbol{\sfphi}{\mathalpha}{lettersAB}{30} + +\DeclareMathSymbol{\sfchi}{\mathalpha}{lettersAB}{31} +\DeclareMathSymbol{\sfpsi}{\mathalpha}{lettersAB}{32} +\DeclareMathSymbol{\sfomega}{\mathalpha}{lettersAB}{33} +\DeclareMathSymbol{\sfvarepsilon}{\mathalpha}{lettersAB}{34} +\DeclareMathSymbol{\sfvartheta}{\mathalpha}{lettersAB}{35} + +\DeclareMathSymbol{\sfvarpi}{\mathord}{lettersAB}{36} +\DeclareMathSymbol{\sfvarrho}{\mathord}{lettersAB}{37} +\DeclareMathSymbol{\sfvarsigma}{\mathord}{lettersAB}{38} +\DeclareMathSymbol{\sfvarphi}{\mathord}{lettersAB}{39} +\DeclareMathSymbol{\sfitvarkappa}{\mathalpha}{lettersAB}{40} +\DeclareMathSymbol{\sfvarkappa}{\mathalpha}{lettersAB}{40} +\DeclareMathSymbol{\sfitnabla}{\mathalpha}{lettersAB}{42} +\DeclareMathSymbol{\sfnabla}{\mathalpha}{lettersAB}{43} +\DeclareMathSymbol{\sfhslash}{\mathalpha}{lettersAB}{52}% this is not upright +\DeclareMathSymbol{\sfhbar}{\mathalpha}{lettersAB}{53}% this is not upright + %%% sans math version, potential value with PGFPlots, and provisionally called in subfigure captions. -%%% this is experimental, still needs stress testing. 30/01/2021 +%%% this is experimental, still needs stress testing. 2021/01/30 \DeclareMathVersion{sans} \SetSymbolFont{letters}{sans}{OML}{ntxsfmi}{m}{it} \SetSymbolFont{lettersA}{sans}{U}{ntxsfmia}{m}{it} @@ -391,13 +484,17 @@ \SetSymbolFont{operators}{sans}{\encodingdefault}{\sfdefault}{m}{n} \SetMathAlphabet{\mathsf}{sans}{\encodingdefault}{\sfdefault}{m}{n} -%% TeX Gyre Heros Condensed is qhvc (regular is qhv). -\newcommand*{\CondSans}{\selectfont\fontfamily{qhvc}\selectfont} -\renewcommand\huge{\@setfontsize\huge{14}{14}} %... for author names only -\newcommand*{\CondSansBold}{\renewcommand\bfdefault{b}\selectfont\fontfamily{qhvc}\selectfont\bfseries} -\renewcommand\Huge{\@setfontsize\Huge{26.5}{26.5}} %... for title font only - -\RequirePackage{metalogo,hologo}% Access to various LaTeX logos (for use in the documentation) + +%%%%%%%%%%%%%%%%% Some adjustments to math layout %%%%%%%%%%%%%%%%%%%%%%%%%%% + +\setlength{\jot}{10pt}% <== default is 3pt + +%% multline has an "extra line" above it, so subtract from \abovedisplayskip to remove imbalance +\BeforeBeginEnvironment{multline}{\addtolength\abovedisplayskip{-7pt}} +\AfterEndEnvironment{multline}{\addtolength\abovedisplayskip{+7pt}} + +\allowdisplaybreaks % ASME allows these breaks + %%%%%%%%%%%%%%%%% Equation and Line Numbering %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -414,7 +511,7 @@ \renewcommand{\linenumberfont}{\normalfont\footnotesize\color{red}}% \AtBeginDocument{\linenumbers}% \ifaj@balance - \ClassWarningNoLine{asmejour}{Package lineno loaded, so final column balancing will be disabled}% + \ClassWarningNoLine{asmejour}{Package lineno loaded, so final column balancing will be disabled}% \fi %%% Allow line numbering in AMS math environments. %%% postdisplaypenalty adjusted to avoid extra line number at end, see discussion here: https://tex.stackexchange.com/a/461192/ @@ -437,7 +534,7 @@ \ifaj@balance % balancing through flushend can produce weird errors \RequirePackage{flushend}% flushend package is NOT compatible with lineno \AtEndDocument{\flushcolsend}% - \ClassWarningNoLine{asmejour}{Calling flushend package to balance column height on last page}% + \LogNote{Calling flushend package to balance column height on last page}% \fi% \fi @@ -517,9 +614,9 @@ %% Produces an unmarked footnote about the revision date. %% This command is invoked by \date as part of \MakeTitlePage below. %% Text can be anything given as the argument to \date{..}. -\NewDocumentCommand{\revfootnote}{m}{\begin{NoHyper}\gdef\@thefnmark{}\@footnotetext{\hspace{-3pt}#1}\end{NoHyper}} +\NewDocumentCommand{\revfootnote}{m}{\begin{NoHyper}\def\@thefnmark{}\@footnotetext{\hspace{-3pt}#1}\end{NoHyper}}% \gdef -->\def 2021/12/23 -%% The above has been offset per style and modified to eliminate missing anchor warning from hyperref that following causes +%% The above has been offset per style and modified to eliminate missing anchor warning from hyperref that the following version causes %%\def\revfootnote{\gdef\@thefnmark{}\@footnotetext} @@ -603,36 +700,61 @@ %%%%%%%%%%%%%%%%% Hyperref %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\ifaj@setpdfa -% - %%% to assist with unicode glyph mapping, following M. Sharpe's recommendation in newtx documentation. - \pdfgentounicode=1 %% enable CMaps - \input glyphtounicode.tex %% lists of mappings - \InputIfFileExists{glyphtounicode-cmr.tex}{}{} %% additional mappings - \InputIfFileExists{glyphtounicode-ntx.tex}{}{} %% additional mappings -% -%%% a fairly generic RGB color profile, aimed at on-screen rendering (not print production) -\immediate\pdfobj stream attr{/N 3} file{sRGB.icc} -\pdfcatalog{% - /OutputIntents [ - << - /Type /OutputIntent - /S /GTS_PDFA1 - /DestOutputProfile \the\pdflastobj\space 0 R - /OutputConditionIdentifier (sRGB) - /Info (sRGB) - >> - ] -} +\newif\if@asme@pdfmanagement% Thanks to Ulrike Fischer +\ExplSyntaxOn +\bool_if:nTF + { + \bool_lazy_and_p:nn + {\cs_if_exist_p:N \pdfmanagement_if_active_p:} + { \pdfmanagement_if_active_p: } + } + { + \@asme@pdfmanagementtrue + } + { + \@asme@pdfmanagementfalse + } +\ExplSyntaxOff + +\ifpdftex + %%% to assist with unicode glyph mapping, following M. Sharpe's recommendation in the newtx documentation. + \IfFormatAtLeastTF{2020/10/01}{\relax}{% + \pdfgentounicode=1 %% enable CMaps; has moved into the latex kernel Oct 2020 + \input glyphtounicode.tex %% lists of mappings; has moved into the latex kernel Oct 2020 + } + \InputIfFileExists{glyphtounicode-cmr.tex}{}{} %% additional mappings + \InputIfFileExists{glyphtounicode-ntx.tex}{}{} %% additional mappings + + \ifaj@setpdfa + %%%% the pdfmanagement options are experimental, from Ulrike Fischer 2021/06/12 + \if@asme@pdfmanagement + \ClassInfo{asmejour}{pdfmanagement is defined. Class file will not load a color profile} + \else + \ClassInfo{asmejour}{pdfmanagement not defined. Class file will load a color profile}% + %%% a fairly generic RGB color profile, aimed at on-screen rendering (not print production) + \immediate\pdfobj stream attr{/N 3} file{sRGB.icc} + \pdfcatalog{% + /OutputIntents [ + << + /Type /OutputIntent + /S /GTS_PDFA1 + /DestOutputProfile \the\pdflastobj\space 0 R + /OutputConditionIdentifier (sRGB) + /Info (sRGB) + >> + ] + } + \fi + \fi \fi \RequirePackage{hyperxmp} %% to fix transfer of metadata to Acrobat pdf -\RequirePackage[% +\RequirePackage[psdextra]{hyperref} % recent kernel transition suggests providing most hyperref options via \hypersetup, + % but setting psdextra here (for additional math support in bookmarks) 2021/12/23 +\hypersetup{% unicode, % Unicode encoded PDF strings - psdextra, % additional support for math in pdf bookmarks pdfborder={0 0 0},% - bookmarks=true, % bookmarksnumbered=true,% bookmarksopen=true,% bookmarksopenlevel=1,% @@ -640,29 +762,32 @@ linkcolor=blue, % citecolor=blue, % urlcolor=blue, % - breaklinks=true,% - pdftitle={}, % <=== add in .tex file - pdfkeywords={}, % <=== add in .tex file + filecolor=red, % added 2021/12/23, to make certain broken links more apparent pdfnewwindow=true,% - pdfpagelayout=SinglePage, %TwoPageRight,% changed 12/08/2020 - pdfauthor={}, % <=== add in .tex file + pdfpagelayout=SinglePage, %TwoPageRight,% changed 2020/08/12 pdfdisplaydoctitle=true% - ]{hyperref} +} \urlstyle{same} % don't switch to typewriter font \RequirePackage{doi} % supports nasty characters in some doi's \renewcommand{\doitext}{doi:~} % change the default, {doi:}, to this for ASME specification \RequirePackage{bookmark} % improves handling of pdf bookmarks +\providecommand\hrefurl[2]{\href{#1}{#2}}% to address certain issues around URL recognition with new pdf management code, 2021/12/22 +%% This alias is also incorporated into asmejour.bst + %%%%%% Adjustments to accommodate hyperref bookmarks %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% ==> recent and evolving development of \pdfstring removes all robust commands from bookmarks, so +%%% the following interventions may become unnecessary over time (2021/12/23). + %% Since \bm is useful in headings, this fix will reduce frequency with which %% alternate pdfstrings must be given in section command as \section[pdfstring]{texstring} \pdfstringdefDisableCommands{% \def\bm#1#{\relax}% } -%% Let's disable \( and \) in pdf bookmarks, 28/2/20 +%% Let's disable \( and \) in pdf bookmarks, 2020/02/28 \pdfstringdefDisableCommands{% \def\({\relax}% \def\){\relax}% @@ -673,7 +798,7 @@ \def\cite{\@gobble}% } -%% Ensure that tag color does not follow \eqref into bookmarks, 28/2/20 +%% Ensure that tag color does not follow \eqref into bookmarks, 2020/02/28 \pdfstringdefDisableCommands{% \def\eqref#1{(\ref{#1})}% } @@ -694,7 +819,7 @@ {\svsection*{#3}\phantomsection% {\IfNoValueTF {#2} {\addcontentsline{toc}{section}{#3}} - {\addcontentsline{toc}{section}{#2}}% remove trailing space 28/2/20 + {\addcontentsline{toc}{section}{#2}}% remove trailing space 2020/02/28 }% } {\IfNoValueTF {#2} @@ -722,21 +847,36 @@ \newlength\nomenwidth \newlength\savitemsep +%% ==> xparse "g" argument used in this version of \entry is deprecated; so have phased out this version, 2021/12/22 %% If the second argument of \entry is omitted, a bold section heading is produced, e.g. \entry{Greek Letters} -\NewDocumentCommand{\entry}{m g}{% - \IfNoValueTF{#2}{% - \itemsep12\p@ plus 4\p@ minus 4\p@% \bigskip - \goodbreak\item[\bfseries#1\hfill]\itemsep3\p@ plus 1\p@ minus 1\p@\@itempenalty=1000% - }{% - \item[\hfill#1${} = {}$]#2% - \@itempenalty=-\@lowpenalty% - \setlength\itemsep\savitemsep% - \settowidth\@widest{#1${} = {}$}% - \ifdim\@widest>\widest \global\setlength\widest\@widest\fi% - } +%\NewDocumentCommand{\entry}{m g}{% +% \IfNoValueTF{#2}{% +% \itemsep12\p@ plus 4\p@ minus 4\p@% \bigskip +% \goodbreak\item[\bfseries#1\hfill]\itemsep3\p@ plus 1\p@ minus 1\p@\@itempenalty=1000% +% }{% +% \item[\hfill#1${} = {}$]#2% +% \@itempenalty=-\@lowpenalty% +% \setlength\itemsep\savitemsep% +% \settowidth\@widest{#1${} = {}$}% +% \ifdim\@widest>\widest \global\setlength\widest\@widest\fi% +% } +%} + +\NewDocumentCommand{\entry}{m m}{% +\ifblank{#2}{% + \ClassWarningNoLine{asmejour}{The command \protect\entry should have two arguments. For subheadings, \protect\EntryHeading is preferred} + \itemsep12\p@ plus 4\p@ minus 4\p@% \bigskip + \goodbreak\item[\bfseries#1\hfill]\itemsep3\p@ plus 1\p@ minus 1\p@\@itempenalty=1000% + }{% + \item[\hfill#1${} = {}$]#2% + \@itempenalty=-\@lowpenalty% + \setlength\itemsep\savitemsep% + \settowidth\@widest{#1${} = {}$}% + \ifdim\@widest>\widest \global\setlength\widest\@widest\fi% + } } -%% A separate command command for nomenclature subheadings (xparse "g" argument used in \entry is deprecated) +%% A separate command command for nomenclature subheadings \NewDocumentCommand\EntryHeading{m}{% \itemsep12\p@ plus 4\p@ minus 4\p@% \bigskip \goodbreak\item[\bfseries#1\hfill]\itemsep3\p@ plus 1\p@ minus 1\p@\@itempenalty=1000% @@ -783,7 +923,7 @@ ]% }% \else - \ClassWarningNoLine{asmejour}{Omitting lists of figures and tables}% + \LogNote{Omitting lists of figures and tables}% \fi %%%%%%%%%%%%%%%% Author/Title/Abstract block %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -796,7 +936,9 @@ \NewCoffin{\Title} \NewCoffin{\firstrowauthorblock} -\SetHorizontalCoffin\firstrowauthorblock{} +\AtBeginDocument{% + \SetHorizontalCoffin\firstrowauthorblock{}% +}% corrected 2021/12/22 \newlength{\coffinsep}%%% space between coffins \setlength{\coffinsep}{4.5mm} @@ -836,11 +978,11 @@ } \providecommand{\@keywords}{\relax} -\NewDocumentCommand{\keywords}{m}{% changed to remove g option, 30/01/21 +\NewDocumentCommand{\keywords}{m}{% changed to remove g option, 2021/01/30 \long\def\@keywords{\par\vskip\baselineskip\noindent{\keywordname:} #1}% } -\NewDocumentCommand\@SetAbstract{+m}{% add + to enable blank lines, etc. 31/01/2021 +\NewDocumentCommand\@SetAbstract{+m}{% add + to enable blank lines, etc. 2021/01/31 \SetVerticalCoffin{\Abstract}{114mm}{% \noindent\itshape% #1 @@ -872,7 +1014,7 @@ \newcommand{\CAemail}[1]{\gdef\@CAemail{#1}}% legacy code, drop eventually -%% ASME prefers email to be in address block, not CA footnote; removed option 30/01/21 +%% ASME prefers email to be in address block, not CA footnote; removed option 2021/01/30 \NewDocumentCommand{\CorrespondingAuthor}{}{% \global\aj@CAtrue% \gdef\@CAsep{\relax}% legacy code, drop eventually @@ -898,7 +1040,7 @@ ] \ifaj@CA \addtocounter{footnote}{1} - \footnotetext{\CAwords\@CAsep \@CAemail}% includes legacy code, remove \@CA commands eventually + \footnotetext{\CAwords\@CAsep \@CAemail}% includes legacy code, will remove \@CA commands eventually \fi \ifaj@Date\revfootnote{\@Date}\else\relax\fi \ifaj@contractor\revfootnote{The United States Government retains, and by accepting the article for publication, the publisher acknowledges that the United States Government retains, a non-exclusive, paid-up, irrevocable, worldwide license to publish or reproduce the published form of this work, or allow others to do so, for United States Government purposes.}% |