summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-12-11 21:47:38 +0000
committerKarl Berry <karl@freefriends.org>2020-12-11 21:47:38 +0000
commit7a35ddea2c89a32714b0ee82b0d7b897b2e239ec (patch)
treeec81dc6583963b2b5079f947565bd8d21a1b3691 /Master/texmf-dist/doc
parent3bdcee46068093dea8aeff84697e9207eed0ced7 (diff)
asmeconf (11dec20)
git-svn-id: svn://tug.org/texlive/trunk@57113 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/asmeconf/README.md58
-rw-r--r--Master/texmf-dist/doc/latex/asmeconf/asmeconf-sample.bib194
-rw-r--r--Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdfbin548197 -> 588137 bytes
-rw-r--r--Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex71
4 files changed, 171 insertions, 152 deletions
diff --git a/Master/texmf-dist/doc/latex/asmeconf/README.md b/Master/texmf-dist/doc/latex/asmeconf/README.md
index 9b612624c5b..af7db563724 100644
--- a/Master/texmf-dist/doc/latex/asmeconf/README.md
+++ b/Master/texmf-dist/doc/latex/asmeconf/README.md
@@ -1,54 +1,32 @@
#asmeconf: A template for ASME conference papers#
- Version 1.20 dated 2020/11/08.
+ Version 1.21 dated 2020/12/10.
####Overview####
This class provides a template to format ASME Conference papers according to
- the requirements on ASME's web pages (as posted in early 2020).
+ the requirements on ASME's web pages (as posted in 2020).
[www.asme.org/publications-submissions/proceedings/formatting-the-paper](https://www.asme.org/publications-submissions/proceedings/formatting-the-paper)
- This work is not a publication of ASME itself.
+ The asmeconf class provides access to many features not available in older LaTeX templates for ASME papers. It is designed to approach the following aims:
- Files in this distribution are:
+- match ASME's font current specifications and layout
- README.md -- this file
- asmeconf.cls -- the class file
- asmeconf.bst -- bibtex style for ASME conference format
- asmeconf-template.tex -- a latex template/example for this class
- asmeconf-template.pdf -- documentation/sample paper
- asmeconf-sample.bib -- a sample bibliography file
- *
- sample-figure-1.pdf,
- sample-figure-2a.pdf,
- sample-figure-2b.pdf -- figures for the example
- *
- author-grid-style.pdf -- example of title page with "authorgrid" option
-
- The .tex and .cls files are commented and should be self-explanatory.
-
-
-
-
- This template was designed to approach the following aims:
-
-- match ASME's font current specifications and layout, including the most recent author layout
-
-- match ASME's current citation formats
+- match ASME's current reference formats, and add support for DOI and URL fields
-- support hyperref package (hyperlinks to figures, tables, references, web)
+- support hyperlinks to figures, tables, equations, references, and external URLs
- support pdf bookmarks and metadata
+- set author names and addresses in either the traditional grid or the more recent inline style
+
- enable various math and text features with newtxmath and newtxtext packages
- support bold face, sans serif math in section headings
- support footnotes in section headings
-- provide automatic layout of author and addresses in one of two styles
-
- provide line numbers for editing and review
- support balancing of columns on last page
@@ -57,7 +35,25 @@
- support copyright footer for federal employees and contractors
+ The .tex and .cls files are commented and should be self-explanatory.
+ The files in this distribution are:
+
+ README.md -- this file
+ asmeconf.cls -- the class file
+ asmeconf.bst -- bibtex style for ASME conference format
+ asmeconf-template.tex -- a latex template/example for this class
+ asmeconf-template.pdf -- documentation/sample paper
+ asmeconf-sample.bib -- a sample bibliography file
+ *
+ sample-figure-1.pdf,
+ sample-figure-2a.pdf,
+ sample-figure-2b.pdf -- figures for the example
+ *
+ author-grid-style.pdf -- example of title page with "authorgrid" option
+
+ This work is not a publication of ASME itself.
+
####Author####
John H. Lienhard V
@@ -73,6 +69,8 @@
####Change log####
+ v1.21 (2020/12/10): Edit documentation; update some usage of xparse under the hood; confirm compliance with substitutefont package.
+
v1.20 (2020/11/08): Add options to change copyright notice for federal employees and contractors; rename option "oldauthors" as "authorgrid"; other minor edits. Thanks to Bret Van Poppel for suggesting the federal copyright.
v1.19 (2020/08/12): Add support for PDF/A archival standards (1b, 2b, 2u, 3b, 3u), as the newtx fonts have recently gained complete unicode maps; set pdf to load with single-page display rather than 2-page spread; add example of grid-style author block.
diff --git a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-sample.bib b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-sample.bib
index d7af55a758c..7fa393f4130 100644
--- a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-sample.bib
+++ b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-sample.bib
@@ -1,5 +1,8 @@
-%% Revised 7 November 2020
-%% John H. Lienhard, MIT
+%% Sample bibliography file for asmeconf.bst and asmeconf.cls
+%%
+%% Revised 10 December 2020
+%% Copyright John H. Lienhard, MIT
+%% Offered under the MIT license: https://ctan.org/license/mit
@article{ning2002,
author = {Xiang Ning and Mary Rose Lovell},
@@ -11,8 +14,9 @@
pages = {2000--2008},
doi = {10.1115/1.4042912},
}
-%% article supports these fields: author, year, title, journal, volume, number, pages OR eid (and numpages),
-%% doi, url, eprint with archive, note.
+%% article supports these fields: author, year, title, journal, volume, number, pages OR eid (and numpages),
+%% doi, url, eprint with archive, note.
+%%
%% There's no need to give the URL if it is simply the DOI, since the DOI itself will be hyperlinked.
%% url = {https://doi.org/10.1115/1.4042912}. ASME requests that a URL point to the abstract.
@@ -23,8 +27,8 @@
author = {Tom A. Gibson and Matthew A. Tucker},
address = {New York},
}
-%% book supports these fields: author OR editor, year, title, edition, series, volume OR number
-%% publisher, address, doi, url, eprint with archive, note.
+%% book supports these fields: author OR editor, year, title, edition, series, volume OR number
+%% publisher, address, doi, url, eprint with archive, note.
@INCOLLECTION{stevens1999,
author = {Thomas T. Stevens},
@@ -36,9 +40,10 @@
pages = {22--36},
}
%% incollection supports these fields: author, year, title, booktitle, edition, editor, series,
-%% volume OR number, publisher, address, type,
-%% chapter, pages, doi, note, eprint with archive, url, urldate.
-%% type = { } changes default "Chap." to something else.
+%% volume OR number, publisher, address, type, chapter,
+%% pages, doi, note, eprint with archive, url, urldate.
+%%
+%% type = { }, changes default "Chap." to something else.
@inproceedings{wions2005,
author = {Thomas Wions and Christopher D. Mills},
@@ -55,8 +60,9 @@
%% inproceedings supports these fields: author, year, title, booktitle, edition, editor, volume,
%% organization OR publisher, address, venue, eventdate,
%% [paper] number, pages, doi, note, eprint with archive, url, urldate.
+%%
%% Note that venue and eventdate are specific to the asmeconf.bst style.
-%% There's really no need to give the URL if it is simply the DOI because the DOI itself will be hyperlinked.
+%% There's actually no need to give the URL if it is simply the DOI because the DOI itself will be hyperlinked.
%% ASME requests that the URL point to the abstract.
@phdthesis{smith2002,
@@ -68,9 +74,11 @@
doi = {10.1115/1.4042912},
url = {https://doi.org/10.1115/1.4042912},
}
-% type = {Sc{D} {T}hesis}, could be added to change the type of thesis. See two examples below.
-% There's no need to give the URL if it is simply the DOI; the DOI itself will be hyperlinked.
-% eprint with archive is also supported.
+%% phdthesis supports these fields: author, title, school, address, year, type, note.
+%% doi, eprint with archive, url, urldate, urltype
+%%
+%% type = {Sc{D} {T}hesis}, could be added to change the type of thesis.
+%% There's really no need to give the URL if it is simply the DOI; the DOI itself will be hyperlinked.
%% ASME requests that the URL point to the abstract.
@mastersthesis{smith1998,
@@ -80,9 +88,11 @@
address = {Rochester, NY},
year = {1998},
}
-%% mastersthesis supports these fields: author, year, title, type, school, address, note.
-%% These fields are also supported, but don't use them all: doi, eprint with archive, url, urldate, urltype
-%% type={} can optionally be used to change the type of thesis. Default is "Master's thesis"
+%% mastersthesis supports these fields: author, title, school, address, year, type, note,
+%% doi, eprint with archive, url, urldate, urltype
+%%
+%% type={} can optionally be used to change the type of thesis, as in next example. Default is "Master's thesis".
+%% ASME requests that the URL point to the abstract.
@mastersthesis{smith1996,
author = {Robert Smith},
@@ -106,10 +116,11 @@
}
%% techreport supports the fields: author, title, number, institution, address, year, doi, url,
%% eprint with archive, note.
-% if type = is omitted, it will default to "Tech. Rep." See the example below for changing this.
+%%
+%% if type = is omitted, it will default to "Tech. Rep." See the example below for changing this.
@techreport{reynolds58,
- author = {W. C. Reynolds and W. M. Kays and S. J. Kline},
+ author = {William C. Reynolds and William M. Kays and Stephen J. Kline},
title = {Heat Transfer in the Incompressible Turbulent Boundary Layer. {I}--{C}onstant Wall Temperature},
type = {Memorandum},
institution = {NASA},
@@ -136,7 +147,7 @@
note = {Published by the Advisory Group for Aerospace Research and Development of {NATO}},
}
%% If you need to change "Chap." to something else, use for example: type = {{C}hapter},
-%% It's uncommon to have the "series" field as above.
+%% It's very uncommon to have the "series" field as above.
@article{Lienhard2019b,
author = {Lienhard, V, John H.},
@@ -152,6 +163,57 @@
%% May include numpages = {} to get "eid (numpages pages)"
%% Note use of jht macro for title title (produces "ASME J. Heat Transfer"). All ASME journals have macros.
+@online{milde,
+ author = {G\"{u}nter Milde},
+ title = {{\texttt{substitutefont}}---Easy font substitution, Version 0.1.4},
+ organization = {Comprehensive \TeX\ Archive Network},
+ year = {2013},
+ url = {https://www.ctan.org/pkg/substitutefont},
+ urldate = {December 9, 2020},
+}
+%% online supports these fields: author OR editor, year, title, organization, address,
+%% note, url OR eprint with archive, urldate, urltype
+%% You can change "Accessed" with "urltype", e.g., urltype = {retrieved},
+
+@book{fourier1822,
+ author = {Jean Baptiste Joseph Fourier},
+ year = {1822},
+ title = {Th\'{e}orie Analytique de la Chaleur},
+ publisher = {Firmin Didot, P\`{e}re et Fils},
+ address = {Paris},
+ url = {https://books.google.com/books?id=1TUVAAAAQAAJ},
+}
+%% English translation is here:
+%% url = {https://archive.org/details/analyticaltheory00fourrich},
+
+@BOOK{johnson1980,
+ editor = {Howard Johnson},
+ title = {Title of Edited Book},
+ publisher = {John Wiley and Sons, Inc.},
+ address = {New York, NY},
+ year = {1980},
+}
+%% edited book
+
+@proceedings{proceedings,
+ title = {The Title of the Proceedings},
+ year = 2015,
+ editor = {Al Yankovich and Howard Stern},
+ volume = {15},
+ organization = {Organization},
+ venue = {Boston, MA},
+ eventdate = {April 27--28},
+ url = {http://web.mit.edu},
+ note = {Optional note},
+}
+%% proceedings supports these fields: author OR editor, year, title, edition, editor,
+%% series, volume OR number, organization, publisher,
+%% address [of organization or publisher], venue, eventdate,
+%% doi, url, eprint with archive.
+%%
+%% The organization will appear as author/editor if those fields are both empty.
+%% In most instances, the publisher is the organization so only one of these two fields should be used
+
@misc{govindan2017,
author = {Prakash Narayan Govindan and Steven Lam and Maximus G. {St. John}},
title = {Systems Including a Condensing Apparatus Such As a Bubble Column Condenser},
@@ -159,6 +221,7 @@
year = {2017},
url = {https://patents.google.com/patent/US9700811B2},
}
+%% US Patent
@misc{Fong2015,
title = {Analytical Methods for Squaring the Disc},
@@ -168,8 +231,7 @@
eprint = {1509.06344},
archive = arxiv,
}
-% eprint + arxiv produces the same result as: url = {https://arxiv.org/abs/1509.06344v3},
-
+%% eprint + arxiv produces the same result as: url = {https://arxiv.org/abs/1509.06344v3},
@manual{GSL,
title = {{GNU} Scientific Library Release 2.4},
@@ -187,47 +249,9 @@
year = 2017,
url = {https://www.gnu.org/software/gsl/},
}
-%% manual supports these fields: author, year, title, edition, organization, address, doi, eprint with archive, urldate, url, note.
-
-
-@online{mpl,
- title = {mpl colormaps},
- author = {St{\'e}fan {van der Walt} and Nathaniel Smith},
- organization = {GitHub},
- address = {San Francisco, CA},
- year = 2015,
- url = {http://bids.github.io/colormap/},
- urldate = {August 26, 2018},
-}
-%% online supports these fields: author OR editor, year, title, organization, address,
-%% note, url OR eprint with archive, urldate, urltype
-%% You can change "Accessed" with "urltype", e.g., urltype = {retrieved},
-
-@BOOK{johnson1980,
- editor = {Howard Johnson},
- title = {Title of Edited Book},
- publisher = {John Wiley and Sons, Inc.},
- address = {New York, NY},
- year = {1980},
-}
+%% manual supports these fields: author, year, title, edition, organization, address,
+%% doi, eprint with archive, urldate, url, note.
-@proceedings{proceedings,
- title = {The Title of the Proceedings},
- year = 2015,
- editor = {Al Yankovich and Howard Stern},
- volume = {15},
- organization = {Organization},
- venue = {Boston, MA},
- eventdate = {April 27--28},
- url = {http://web.mit.edu},
- note = {Optional note},
-}
-%% proceedings supports these fields: author OR editor, year, title, edition, editor,
-%% series, volume OR number, organization, publisher,
-%% address [of organization or publisher], venue, eventdate,
-%% doi, url, eprint with archive.
-%% The organization will appear as author/editor if those fields are empty.
-%% In most instances, the publisher is the organization so only one should be given
@online{amsmath,
author = {{American Mathematical Society} and {LATEX3 Project}},
@@ -291,18 +315,15 @@
url = {https://www.ctan.org/pkg/rotating},
urldate = {October 2, 2019},
}
-
-@BOOK{book,
- author = {James Tiberius Kirk},
- year = {2288},
- title = {Decline and Fall of the Romulan Empire},
- edition = {7},
- series = {Humankind's Greatest Writings},
- volume = {23},
- url = {http://web.mit.edu},
- publisher = {Vulcan Free Press},
- address = {T'Paal},
- note = {to appear},
+
+@online{mpl,
+ title = {mpl colormaps},
+ author = {St{\'e}fan {van der Walt} and Nathaniel Smith},
+ organization = {GitHub},
+ address = {San Francisco, CA},
+ year = 2015,
+ url = {http://bids.github.io/colormap/},
+ urldate = {August 26, 2018},
}
@inbook{inbook,
@@ -318,14 +339,23 @@
address = {Boston},
note = {{``The Locust Years''}},
}
-%% inbook supports these fields: author OR editor, year, title, edition, version, series, volume OR number, doi, url, eprint with archive, publisher, address, note. type={} field changes "Chap." to something else.
+%% inbook supports these fields: author OR editor, year, title, edition, version, series,
+%% volume OR number, doi, url, eprint with archive, publisher,
+%% address, note.
+%%
+%% type={} field changes "Chap." to something else.
-@book{fourier1822,
- author = {Jean Baptiste Joseph Fourier},
- year = {1822},
- title = {Th\'{e}orie Analytique de la Chaleur},
- publisher = {Firmin Didot, P\`{e}re et Fils},
- address = {Paris},
- url = {https://archive.org/details/analyticaltheory00fourrich},
+
+@BOOK{book,
+ author = {James Tiberius Kirk},
+ year = {2288},
+ title = {Decline and Fall of the Romulan Empire},
+ edition = {7},
+ series = {Humankind's Greatest Writings},
+ volume = {23},
+ url = {http://web.mit.edu},
+ publisher = {Vulcan Free Press},
+ address = {T'Paal},
+ note = {to appear},
}
-
+
diff --git a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf
index 07ffba0dae1..3e1a594226e 100644
--- a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf
+++ b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex
index 81615a54aa1..f9860ccbc8f 100644
--- a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex
+++ b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex
@@ -3,11 +3,11 @@
%% This file is asmeconf-template.tex, a template to format ASME Conference papers according to
%% the requirements on ASME's conference web pages.
%%
-%% This file is version 1.20 dated 2020/11/08
+%% This file is version 1.21 dated 2020/12/10
%%
%% As of version 1.11, this template follows ASME's newer conference guidelines first posted July 2019.
%% The new guidelines have changed the requested author block formatting to be inline.
-%% (This template continues to support the old grid format as a package option.)
+%% (This template continues to support the traditional grid format as a package option.)
%% Nomenclature now follows the abstract. Abstract is in italics.
%%
%% Author: John H. Lienhard V
@@ -71,20 +71,7 @@
%%
%% Copyright (c) 2020 John Lienhard
%%
-%% Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
-%% associated documentation files (the "Software"), to deal in the Software without restriction,
-%% including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
-%% and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
-%% subject to the following conditions:
-%%
-%% The above copyright notice and this permission notice shall be included in all copies or
-%% substantial portions of the Software.
-%%
-%% The software is provided "as is", without warranty of any kind, express or implied, including but
-%% not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement.
-%% In no event shall the authors or copyright holders be liable for any claim, damages or other liability,
-%% whether in an action of contract, tort or otherwise, arising from, out of or in connection with the
-%% software or the use or other dealings in the software.
+%% Offered under the MIT license: https://ctan.org/license/mit
%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -163,7 +150,7 @@
%%
%% Abstract should be no more than 200 words
\begin{abstract}
-This paper is an example of and a template for typesetting ASME Conference Papers in {\upshape\LaTeX} using the {\upshape\texttt{asmeconf}} class. This class follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of early 2020. The class is intended to be used with the {\upshape\texttt{asmeconf.bst} \hologo{BibTeX}} style, which is part of this distribution. The class is compatible with the {\upshape\texttt{hyperref}} package, so that pdfs will contain internal and external hyperlinks, pdf bookmarks, and metadata. Links may be colored, for online use, or black, for publication. Section headers may contain mathematics, references, citations, and footnotes. The class enables inline author names, following ASME's current style, but is backward compatible to the traditional block style. The class includes many options, e.g., for math fonts. The class calls a number of packages, all of which are in {\upshape\TeX\ Live} and on CTAN. The class is compatible with {\upshape\hologo{pdfLaTeX}} or {\upshape\hologo{LuaLaTeX}}.
+This paper is an example of and a template for typesetting ASME Conference Papers in {\upshape\LaTeX} using the {\upshape\texttt{asmeconf}} class. This class follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of 2020. The class is intended to be used with the {\upshape\texttt{asmeconf.bst} \hologo{BibTeX}} style, which is part of this distribution. The class incorporates the {\upshape\texttt{hyperref}} package, so that pdfs will contain hyperlinks, bookmarks, and metadata, and references can include the DOI and URL fields. Links may be colored, for online use, or black, for publication. The class enables inline author names, following ASME's current style, but can also produce the traditional grid style. Options include line numbering, final column balancing, various math options, government copyright, and archivability (PDF/A). In addition, section headers may contain mathematics, references, citations, and footnotes. The class is compatible with {\upshape\hologo{pdfLaTeX}} or {\upshape\hologo{LuaLaTeX}}.
\end{abstract}
%%%%%%%%% NOMENCLATURE (OPTIONAL) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -196,19 +183,19 @@ This paper is an example of and a template for typesetting ASME Conference Paper
%%%%%%%%% BODY OF PAPER %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Introduction}
-The \texttt{asmeconf} class file will typeset papers with margins, fonts, headings, captions, and reference formats that follow those specified for conference papers of 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 \texttt{asmeconf} class typesets papers with margins, fonts, headings, captions, and reference formats that follow the specifications for conference papers of the American Society of Mechanical Engineers (ASME). In contrast to older ASME \LaTeX\ templates, \texttt{asmeconf} will set internal and external hyperlinks, and the pdf file will contain bookmarks and metadata. Many other useful features have been incorporated. This class is not a publication of ASME, but the author has published in ASME conferences since 1983.
-The \texttt{.tex} file may be written using standard \LaTeX\ commands, although some specific initial commands are needed to format the blocks containing the author[s], title, and abstract. This class loads a number of other packages, all of which are contained in up-to-date versions of \href{https://www.tug.org/texlive/}{\TeX\ Live}, \href{http://www.tug.org/mactex/}{Mac\TeX}, and similar distributions. If you find you are missing one of these packages, you may obtain it at no cost from CTAN (\href{http://ctan.org}{ctan.org}).
+The \texttt{.tex} file may be written using standard \LaTeX\ commands, although some specific initial commands are needed to format the blocks containing the author[s], title, and abstract. This class loads a number of other packages, all of which are contained in up-to-date versions of \href{https://www.tug.org/texlive/}{\TeX\ Live}, \href{http://www.tug.org/mactex/}{Mac\TeX}, and similar platforms. If you find that you are missing one of these packages, you may obtain it at no cost from CTAN (\href{http://ctan.org}{ctan.org}).
\subsection{Essential Initial Commands}
To begin, fill in the fields to be completed at top of the \texttt{asmeconf-template.tex} file. These fields include the headers for your conference and your paper number. Specified metadata will be placed into the pdf file itself.
The title should be placed into \verb|\title{..}|.
-Put author names into the \verb|\SetAuthors{name, name,...}| command in the desired order; follow the syntax illustrated \texttt{asmeconf-template.tex} file. Put each distinct address sequentially into a separate \verb|\SetAffiliation{n}{address}|, where $n = 1,2,\ldots$ Tag each author with the right affiliation by putting \verb|\affil{n}| after that author's name inside the \verb|\SetAuthors{..| command.
+Put author names into the \verb|\SetAuthors{name, name,...}| command in the desired order; follow the syntax illustrated \texttt{asmeconf-template.tex} file. Put each distinct address sequentially into a separate \verb|\SetAffiliation{n}{address}|, where $n = 1,2,\ldots$ Tag each author with an affiliation by putting \verb|\affil{n}| after that author's name inside the \verb|\SetAuthors{..| command.
-Author addresses are to be kept short. List the author institution, and the City, State (US authors), City, Province, Canada (Canadian authors), or City, Country (for other international authors).
+Keep author addresses short. List the author institution, and the City, State (US authors), City, Province, Canada (Canadian authors), or City, Country (other international authors).
-One author (or more) may be designated as the corresponding author by placing \verb|\CorrespondingAuthor{email}| after \verb|\affil{#}|. Two or more authors may be joint first authors by putting \verb|\JointFirstAuthor| after \verb|\affil{#}|.
+One author (or more) may be designated as the corresponding author by placing \verb|\CorrespondingAuthor{email}| after \verb|\affil{n}|. Two or more authors may be joint first authors by putting \verb|\JointFirstAuthor| after \verb|\affil{n}|.
After setting up the headers, authors, and title, issue the \verb|\maketitle| command.
@@ -350,7 +337,8 @@ Landscape figures and tables may be produced at full-page size by putting \verb|
\section{Reference Formatting with \NoCaseChange{\texttt{asmeconf.bst}}\footnote{If you have text in a section heading or caption that you do not want to be capitalized, such as an SI unit, enclose it in a \texttt{\textbackslash NoCaseChange} command.}}\label{sec:references}
-The {\upshape\texttt{asmeconf.bst}} \hologo{BibTeX} style follows the reference styles shown on ASME's conference web site in early 2020. Examples for these and many other cases are given in the \texttt{asmeconf-sample.bib} file, which is part of this distribution. Citations and references are managed by the standard \texttt{natbib} package. Nevertheless, a few comments are necessary.
+The {\upshape\texttt{asmeconf.bst}} \hologo{BibTeX} style follows the reference styles shown on ASME's conference web site in 2020.\footnote{\texttt{asmeconf.bst} is intended as a replacement for the old \texttt{asmems4.bst}, which does not follow ASME's current reference formats or support DOI and URL.}
+Examples for these and many other cases are given in the \texttt{asmeconf-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.
%% sub-subsections should *not* be numbered
@@ -358,13 +346,13 @@ The {\upshape\texttt{asmeconf.bst}} \hologo{BibTeX} style follows the reference
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, hdl, jstore, oclc}, or \texttt{pubmed} (e.g., \texttt{archive=hdl}, \textit{without} braces). Both \texttt{eprint} and \texttt{archive} fields \textit{must} be given. Other root urls may be invoked using \verb|archive = {http://another.url.org/}|.
-\subsubsection*{Online Sources} A bibliography field \verb|@online{..| is included for citation of online sources, such as web pages. A \texttt{url} or \texttt{eprint} with \texttt{archive} must be included. See the examples of use in the \texttt{asmeconf-sample.bib} file.
+\subsubsection*{Online Sources} A bibliography entry \verb|@online{..| is included for citation of online sources, such as web pages. A \texttt{url} or \texttt{eprint} with \texttt{archive} must be included. See the examples of use in the \texttt{asmeconf-sample.bib} file.
\subsubsection*{Date Accessed} The \verb|urldate={..}| field may be used to provide the date on which a given url was accessed. By default, the text printed will be \texttt{Accessed `date',}. The word ``Accessed'' may be changed using the \verb|urltype={..}| field.
\subsubsection*{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.
-\subsubsection*{Capitalization of Titles} ASME's bibliography style requires that document titles be in title case. The first letters of principal words are capitalized. Do this when writing the \texttt{.bib} file.
+\subsubsection*{Capitalization of Titles} ASME's bibliography style requires that document titles be in title case. The first letters of principal words are capitalized. Do this in the \texttt{.bib} file.
@@ -455,25 +443,25 @@ This package will attempt to give equal height to the two columns on the last pa
The \texttt{lineno} package is not compatible with the \texttt{flushend} package that makes final short columns the same height. Balancing is automatically disabled when this option is called.
+\subsection{Grid-Style Author Block} The option \texttt{[authorgrid]} invokes ASME's grid-style arrangement of author names. The authors and affiliations must be entered differently in this case. See Appendix \ref{appendix:b} for usage.
+
\subsection{Changing the Copyright Footer} The option \texttt{[nofoot]} will omit the ASME copyright from the page footer. The option \texttt{[govt]} will produce a copyright notice for authors who are employees of the U.\ S.\ Government. The option \texttt{[contractor]} will produce a copyright
notice for authors who are employed by a U.\ S.\ Government contractor.
The footers are generated with the \texttt{fancyhdr} package~\cite{oostrum}, so you can change them in any way you like using the commands of that package. Only the default arrangement of footers matches ASME's style, however.
-\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (both numbers and letters) for use in footnote markers and superscripts. To enable this font, use the option \texttt{[nodefaultsups]}.
+\subsection{Archivability:~PDF/A} Compliance with PDF/A standards can be enabled using the option \texttt{[pdf-a]}
+when running with \hologo{pdfLaTeX}. The default setting is for PDF/A-3u with sRGB OutputIntent (\texttt{sRGB.icc}).
+If levels 1b, 2b, 2u, or 3b are preferred, use the 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{Grid-Style Author Block} The option \texttt{[authorgrid]} invokes ASME's grid-style arrangement of author names. The authors and affiliations must be entered differently in this case. See Appendix \ref{appendix:b} for usage.
+\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (both numbers and letters) for use in footnote markers and superscripts. To enable this font, use the option \texttt{[nodefaultsups]}.
\subsection{Hyphenation of Typewriter Font} The option \texttt{[hyphenate]} will allow hyphenation of the typewriter font.
-Hyphenation is normally suppressed for typewriter mode because this font is often used for code.
+Hyphenation is normally suppressed for typewriter mode because this font is often used for computer code.
\subsection{Support for Other Languages} The package can be adapted to incorporate (or entirely use) languages other than English. See Appendix \ref{appendix:c} for details.
-\subsection{Archivability:~PDF/A} Compliance with PDF/A standards can be enabled using the option \texttt{[pdf-a]}
-when running with \hologo{pdfLaTeX}. The default setting is for PDF/A-3u with sRGB OutputIntent (\texttt{sRGB.icc}).
-If levels 1b, 2b, 2u, or 3b are preferred, use the 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.
-
%%%%% Conclusions %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -511,7 +499,7 @@ Place any acknowledgments here.
\section[The Vector Product A\times B]{The vector product $\vec{A}\times\vec{B}$}\label{appendix:a}
This brief illustration of an appendix shows the numbering of the appendix and equations. Equations are numbered
-consecutively, following those in the paper.
+consecutively, following those in the paper. Consider $\rho \neq \textrm{fn}(p)$:
\begin{align}
\frac{d\Gamma}{dt} &{}= \frac{d}{dt} \int_{\mathcal{C}} \mathbf{u} \cdot d\mathbf{r}\\
&{}= \int_{\mathcal{C}} \frac{D\mathbf{u}}{Dt} \cdot d\mathbf{r} + \underbrace{\int_{\mathcal{C}} \mathbf{u}\cdot d\biggl( \frac{d\mathbf{r}}{dt}\Biggr)}_{=\, 0} \\[-2pt]
@@ -519,7 +507,6 @@ consecutively, following those in the paper.
&{}= \iint_{\mathcal{S}} \nabla p \times \nabla \left( \frac{1}{\rho}\right) \cdot d\mathbf{A}
\end{align}
-
\section{Option to Use an Author Grid}\label{appendix:b}
ASME's most recent templates place author names inline, with affiliations for all authors in rows below.
@@ -551,11 +538,11 @@ subsequent row.
\section{Language Support}\label{appendix:c}
ASME publishes in English, but the \texttt{babel} package is loaded for
-users who may wish to include other languages. Options are supported to load a primary language, \texttt{lang=},
-as well as a secondary and tertiary language, \texttt{lang-second} and \texttt{lang-third}.
+users who may wish to include other languages. Class options allow loading a primary language, \texttt{lang=},
+as well as secondary and tertiary languages, \texttt{lang-second} and \texttt{lang-third}.
The primary language must be specified explicitly if a secondary language is loaded.
-If no language option is given, the package defaults to English. An example of use is
-shown in \selectlanguage{french}\appendixname\ \ref{app:fourier}.\selectlanguage{english}
+If no language option is given, the package defaults to English. An example of including a passage in French is
+shown in \selectlanguage{french}{\appendixname\ \ref{app:fourier}.\selectlanguage{english}
The standard caption and section names will follow \texttt{babel}'s dictionary for primary languages other than English. Users may additionally change ``Keywords'', ``Nomenclature'', ``Corresponding author'', and ``Joint first authors'' by renewing the commands \verb|\keywordname|, \verb|\nomname|, \verb|\CAwords|, and \verb|\JAwords|. Changes to the page footer were described earlier. The pdf bookmark for ``Appendices'' may be changed by renewing \verb|\appendicesname|.
@@ -564,7 +551,7 @@ Font encoding is set to T1 with utf-8 input supported:
\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.}
àáâäæãåā èéęëêēė îïíīįì ôöòóœøōõ ûüùúū çćč ł ñń ßśš ÿ žźż.
-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{asmeconf.bst}, is designed in English and aimed at \hologo{BibTeX}. Multilingual bibliographies can be supported using \texttt{BibLaTeX}.
+The \texttt{substitutefont} package \cite{milde} may be loaded in the preamble to enable the selection of language-specific fonts. Examples for Greek and Cyrillic are included in that package's documentation. The bibliography style, \texttt{asmeconf.bst}, is designed in English and aimed at \hologo{BibTeX}. Multilingual bibliographies can be supported using \texttt{BibLaTeX}.
\selectlanguage{french}
\section{Discours Préliminaire de Fourier}\label{app:fourier}
@@ -575,6 +562,10 @@ La chale ur pénètre, comme la gravité, toutes les substances de l'univers, se
\selectlanguage{english}
+\textsc{Translation:} \textit{Primary causes are unknown to us; but are subject to simple and constant laws, which may be discovered by observation, the study of them being the object of natural philosophy}.
+
+\textit{Heat, like gravity, penetrates every substance of the universe, its rays occupy all parts of space. The object of our work is to set forth the mathematical laws which this element obeys. The theory of heat will hereafter form one of the most important branches of general physics}.
+
\end{document}