diff options
author | Karl Berry <karl@freefriends.org> | 2021-12-26 21:19:19 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2021-12-26 21:19:19 +0000 |
commit | 6443f770c8ea5e1e1dd5a11bda55db60f199ee15 (patch) | |
tree | 26a68a9d42feacd92c44be18a01c64a4dd5d4004 /Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex | |
parent | 072ecf41200a568426414e62b729e04dde6cb879 (diff) |
asmeconf (26dec21)
git-svn-id: svn://tug.org/texlive/trunk@61412 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex | 284 |
1 files changed, 131 insertions, 153 deletions
diff --git a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex index c10d7069152..93e2621929f 100644 --- a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex +++ b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex @@ -4,7 +4,7 @@ %% This file is asmeconf-template.tex, a LaTeX template to format ASME Conference papers according to %% the requirements on ASME's conference web pages, and including hypertext support for the pdf. %% -%% This file is version 1.26 dated 2021/02/20 +%% This file is version 1.27 dated 2021/12/26 %% %% 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. @@ -19,19 +19,18 @@ %% Class options include: %% %% * Math options from M. Sharpe's newtxmath package: upright integrals [upint]; -%% * [varvw] for a v and w that are better distinguished from greek nu; and also +%% * [varvw] for a v and w that are better distinguished from Greek nu; and also %% * [subscriptcorrection, smallerops, varg, frenchmath, varbb, cmbraces, slantedGreek,...] -%% * See newtx documentation for descriptions (at CTAN: http://ctan.org, v1.6 or higher best). -%% -%% * Many options for calligraphic, script, and fraktur fonts from the mathalfa package; the -%% * example shown here is: [mathalfa=cal=euler] to use Euler font for \mathcal. -%% * Some other options for cal are: dutchcal, zapfc, cm (default), boondox,... -%% * frak (fraktur), bb (blackboard bold), scr (script) may also be chosen this way. -%% * For details, refer to mathalfa documentation (at CTAN: http://ctan.org). +%% * See newtx documentation for descriptions (at CTAN: http://ctan.org, v1.6 or higher is best). %% %% * Options to: omit the ASME copyright footer [nofoot]; -%% use government employee copyright notice [govt]; -%% use government contractor copyright notice [contractor] +%% * use government employee copyright notice [govt]; +%% * use government contractor copyright notice [contractor] +%% +%% * An option to use the traditional grid arrangement of author names [grid]. +%% * With this option, line breaks (\\) may be inserted into the address as needed. +%% * Author names that include commas should be enclosed in braces, e.g., {Joseph L. Smith, Jr.}. +%% * Authors may be grouped above a single affiliation using braces, e.g., {Henry Tudor, Catherine Parr}. %% %% * An option to balance the heights of columns on the last page [balance]. %% * This option is NOT compatible with the [lineno] option. @@ -44,11 +43,17 @@ %% * just leave a blank line above the displayed equation while you are editing and then remove the %% * blank line and [lineno] option when you move to your final version. %% -%% * An option to use the traditional grid arrangement of author names [authorgrid]. See Appendix B for usage, -%% * because the authors and affiliations must be entered differently in this case. (Same as former option [oldauthors]) -%% %% * 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 to use this.) +%% +%% * Many options for calligraphic, script, and fraktur fonts from the mathalfa package; the +%% * example shown here is: [mathalfa=cal=euler] to use Euler font for \mathcal. +%% * Some other options for cal are: dutchcal, zapfc, cm (default), boondox,... +%% * frak (fraktur), bb (blackboard bold), scr (script) may also be chosen this way. +%% * For details, refer to mathalfa documentation (at CTAN: http://ctan.org). %% %% * Option to use superiors font from newtxtext for footnotes [nodefaultsups] and %% * for slightly larger small capitals, [largesc], also from newtxtext. @@ -60,12 +65,15 @@ %% %% * Options (used by the babel package) to include passages in languages other than English (e.g., a translation %% * of the abstract). Languages are called as options, e.g. [french], [spanish], [greek], [russian], etc. -%% * See Appendix C for details. +%% * Language support is greatest when running LuaLaTeX with the [fontspec] option. +%% * See Appendix B for details. %% %% The use of commands defined or modified by the asmeconf class is illustrated throughout this file. In particular, %% ASME requires capitalized, sans-serif section headings, and as a result some care is needed when using macros %% in section headings, as also illustrated below. %% +%% Use an up-to-date and complete installation of LaTeX, such as TeX Live 2020 or later. Errors may occur with old set-ups. +%% %========================================================= %% %% LICENSE: @@ -74,30 +82,31 @@ %% %% Offered under the MIT license: https://ctan.org/license/mit %% -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% Class options are described above. If you are not using the languages options, remove them. +%% Class options are described above. Change these options as desired. +%% If you are not using the language options, remove them (together with Appendices B and C) +%% Remove the [colorlinks] option before *final* submission to ASME, to get black text for printing, +%% but keep that option for other uses. + +\documentclass[balance,upint,subscriptcorrection,varvw,mathalfa=cal=euler,spanish,french,greek,russian,vietnamese,pdf-a,colorlinks]{asmeconf} -\documentclass[upint,subscriptcorrection,varvw,mathalfa=cal=euler,pdf-a,balance,spanish,french,greek,russian,vietnamese,fontspec,japanese,colorlinks]{asmeconf} % <=== remove colorlinks before your *final* submission to ASME! But keep it for other purposes. -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%% Fields to be completed %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -%%%%% pdf metadata %%%%%%%%%%%% -%%%%% The user should edit %%%%%%%%%%%% +%%%%% pdf metadata %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \hypersetup{% + pdfauthor={John H. Lienhard}, % <=== change to YOUR name[s]! pdftitle={ASME Conference Paper LaTeX Template}, % <=== change to YOUR pdf file title pdfkeywords={ASME conference paper, LaTeX template, BibTeX style},% <=== change to YOUR pdf keywords - pdfauthor={John H. Lienhard}, % <=== change to YOUR name[s]! - pdfurl={https://ctan.org/pkg/asmeconf},% may delete + pdfsubject = {Describes the asmeconf LaTeX template}, % <=== change to YOUR subject +% pdfurl={https://ctan.org/pkg/asmeconf},% may delete pdflicenseurl={https://ctan.org/pkg/asmeconf},% may delete } -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \begin{document} + % Change these fields to the right content for your conference. % You can comment these out if for some reason you don't want a header. % Use title case (first letters capitalized), not all capitals @@ -108,8 +117,7 @@ \ConfCity{Virtual Conference, Online} \PaperNo{IMECE2021-XXXX} - -% Units of measure and other specialty lowercase terms in the title should be +% Units of measure (e.g., cm) and other specialty lowercase terms in the title should be % enclosed in \NoCaseChange{...} to maintain lower case type % LaTeX will automatically set the rest of the title in all capital letters. @@ -120,12 +128,20 @@ % \affil{#} tags the author's affiliation to the address in \SetAffiliation{#}. % No space between last name and \affil{#}, separate names with commas. % +% For a sole author or a single affiliation for all authors, {#} may be left empty, as \affil{} and \SetAffiliation{} (but not with [grid] option!) +% % \CorrespondingAuthor{email} follows that author's affiliation, no spaces. % If multiple corresponding authors, put both email addresses in the same command and place after both authors. % % \JointFirstAuthor, if applicable, follows the affiliation of the relevant authors, no spaces. -\SetAuthors{John H.\ Lienhard\affil{1}\CorrespondingAuthor{}, Luis Hern\'andez\affil{2}\JointFirstAuthor , Maria Silva\affil{3}\JointFirstAuthor, Henry Tudor\affil{4}, Catherine~Parr\affil{4}\CorrespondingAuthor{lienhard@mit.edu, kate@thepalace.gov}} +\SetAuthors{% + John H.\ Lienhard\affil{1}\JointFirstAuthor\CorrespondingAuthor{}, + Luis Hern\'andez\affil{2}\JointFirstAuthor, + Maria Silva\affil{3}, + Henry Tudor\affil{4}, + Catherine~Parr\affil{4}\CorrespondingAuthor{lienhard@mit.edu, kate@thepalace.gov} + } \SetAffiliation{1}{Massachusetts Institute of Technology, Cambridge, MA } \SetAffiliation{2}{Institution or Company Name, City, State} @@ -133,17 +149,13 @@ \SetAffiliation{4}{Hampton Court Palace, Richmond, England} % Note: Luis and Maria are not real people. Henry and Catherine have been dead for >450 years. - -% To instead use the [authorgrid] option, follow the syntax in Appendix B. - +% To switch from inline author names to gridded names, use the [grid] option. \maketitle %%% Use this footnote for tracking various versions of your draft. Change text to suit your own needs. -%%% REMOVE from final version of your paper. %%% \date{..} calls the same command. - -\versionfootnote{\texttt{asmeconf.cls}: version \versionno, \today, \href{https://ctan.org/pkg/asmeconf}{ctan.org/pkg/asmeconf}}% <=== Delete before final submission. +\versionfootnote{Documentation for \texttt{asmeconf.cls}: Version~\versionno, \today.}% <=== Delete before final submission. %%% Change these to your keywords. Keywords are automatically printed at the end of the abstract. @@ -152,14 +164,15 @@ \keywords{ASME conference paper, \LaTeX\ Template, \hologo{BibTeX}} -%%%%%%%%%%%%%%%%%%%%% End of fields to be completed. Now write! %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%% End of fields to be completed. Now write your paper. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%%%%%% Abstract %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%% ABSTRACT %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% -%% Abstract should be no more than 200 words +%% Abstract should be 200 words or less \begin{abstract} -This paper is an example of and a {\upshape\LaTeX} template for typesetting ASME conference papers using the {\upshape\texttt{asmeconf}} class. This {\upshape\LaTeX} template 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 for reference formatting, which is part of this distribution. The template produces pdfs that 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}}. + +This paper is an example of and a {\upshape\LaTeX} template for typesetting ASME conference papers using the {\upshape\texttt{asmeconf}} class. This {\upshape\LaTeX} template follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of 2021. The class is intended to be used with the {\upshape\texttt{asmeconf.bst} \hologo{BibTeX}} style for reference formatting, which is part of this distribution. The template produces pdfs that 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) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -167,9 +180,7 @@ This paper is an example of and a {\upshape\LaTeX} template for typesetting ASM %% To change space between the symbols and definitions, use \begin{nomenclature}[Xcm] where X is a number %% The unit cm can be replaced by any LaTeX unit of dimension: pt, in, ex, em, pc, etc. %% Default is 2em. - -%% \EntryHeading{Greek letters} produces an italicized subheading, e.g., \EntryHeading{Greek letters} -%% (Leaving off the second argument of \entry, e.g. \entry{Greek letters}, has the same effect) +%% \EntryHeading{..} produces an italicized subheading in the nomenclature list, e.g., \EntryHeading{Greek letters} \begin{nomenclature} \EntryHeading{Roman letters} @@ -193,11 +204,13 @@ This paper is an example of and a {\upshape\LaTeX} template for typesetting ASM %%%%%%%%% BODY OF PAPER %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Introduction} -The \texttt{\href{https://ctan.org/pkg/asmeconf}{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 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}). +The \texttt{\hrefurl{https://ctan.org/pkg/asmeconf}{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 \hrefurl{https://www.tug.org/texlive/}{\TeX\ Live}, \hrefurl{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 (\hrefurl{https://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{..}|. @@ -215,9 +228,10 @@ The abstract text must be placed into \verb|\begin{abstract}| \ldots \verb|\end{ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{Referring to Citations, Figures, and Equations} -Citations are automatically numbered \cite{ning2002}. They should be inserted at the appropriate point using a \verb|\cite{ref}| command~\cite{gibson2008,stevens1999}. The citations will be automatically sorted and compressed if they are given in a set \cite{stevens1999,ning2002,gibson2008,wions2005,smith2002,watson1982}. + +Citations are automatically numbered \cite{ning2002}. They should be inserted in the text using a \verb|\cite{ref}| command~\cite{gibson2008,stevens1999}. The citations will be automatically sorted and compressed if they are given in a set \cite{stevens1999,ning2002,gibson2008,wions2005,smith2002,watson1982}. A specific reference may be named with an abbreviation, as in Ref.~\cite{watson1982}. -See the \texttt{asmeconf-sample.bib} file and Sect.~\ref{sec:references} for examples of how to enter your references. +See the \texttt{asmeconf-sample.bib} file and Sect.~\ref{sec:references} for examples of entering references. For ASME conference papers, the labels Equation and Figure should be abbreviated when they do not start a sentence, as in Eq.~\eqref{eqn:dw} and Fig.~\ref{fig:1}. Figure~\ref{fig:1} is spelled out when it starts a sentence. Equation~\eqref{eqn:dw} is spelled out when it starts a sentence. @@ -235,7 +249,7 @@ ASME prefers SI units. (U.S.\ style units may follow in parentheses.) Be sure to \begin{figure} \centering\includegraphics[width=0.7\linewidth]{sample-figure-1.pdf} -\caption{Figure caption with math, eqn.~\eqref{eqn:fourier}: $z = (r,\phi)$ \cite{Lienhard2019b}\label{fig:1}} +\caption{Caption with math, eqn.~\eqref{eqn:fourier}: $z = (r,\phi)$ \cite{Lienhard2019b}\label{fig:1}} \end{figure} %%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%% @@ -243,9 +257,10 @@ ASME prefers SI units. (U.S.\ style units may follow in parentheses.) Be sure to %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% Use title case for subsections and subsubsections +%% Use title case for subsections and subsubsections (first letter of words capitalized) \section{Section Headings and Captions} + ASME requires that section headings and captions be set in an uppercase, sans serif font. The class will do this automatically. You can place \verb|\cite{..}|, \verb|\ref{..}|, \verb|\label{..}|, and mathematics into headings and captions directly, as you would in the main text. Do not enclose them braces, e.g.\ \verb|{\cite{..}}|, which will cause errors. You can place \verb|\footnote{..}| into headings, but not into captions.\footnote{See \texttt{tex-stackexchange} for various approaches to footnotes in captions, if they seem necessary. For footnotes in tables, use the \texttt{tablefootnote} package.}\footnote{Sequential footnotes are automatically separated by a comma.} Text in section headings and captions will not be capitalized if enclosed in a \verb|\NoCaseChange{..}| command. @@ -257,17 +272,20 @@ Simple mathematical expressions can be used in either captions or section headin To override the \texttt{sansbold} math version in captions, put \verb|\NoCaseChange{\mathversion{normal}}| in the caption. \subsection{Subsection and Sub-subsection Headings} + Subsections and sub-subsection headings should be entered in title case, with the first letter of primary words capitalized. Sub-subsections (i.e., paragraphs) are never numbered. %%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%% -%% captions go above tables +%% Captions go above tables +%% +%% Note that placement of figures and tables can managed with the [!tbhp] options. See: https://latexref.xyz/dev/latex2e.html#Floats \begin{table}[t] \caption[Table]{A simple table\label{tab:1}} \centering{% -\begin{tabular}{l l r} +\begin{tabular}{llr} \toprule Experiment & $u$ [m/s] & $T$ [\textdegree C] \\ \midrule @@ -303,7 +321,7 @@ Our competitor's test & 72.321 & 141.384 \\ \section{Tables and Figures} Table \ref{tab:1} is an example of a simple table. Table captions should be placed above tables. -The class loads the \texttt{booktabs} package (used for horizontal rules in both Table \ref{tab:1} and \ref{tab:2}), and the \texttt{array} and \texttt{dcolumn} packages which provide extended capabilities for columns in the \texttt{tabular} environment (used in Table \ref{tab:2}). Table \ref{tab:3} is an example of a table that spans two columns. Two column tables (and figures) will always float to the top of a later page. +The class loads the \texttt{booktabs} package (used for horizontal rules in Tables \ref{tab:1} and \ref{tab:2}), and the \texttt{array} and \texttt{dcolumn} packages which provide extended capabilities for columns in the \texttt{tabular} environment (see Table \ref{tab:2}). Table \ref{tab:3} is an example of a table that spans two columns. Two column tables (and figures) will always float to the top of a later page. Figure captions go below figures. Figure~\ref{fig:2} is an example of a figure that spans two columns and includes subfigures. The text in figures (and tables) should be no smaller than 6~point type. Images in figures are handled by the standard \texttt{graphicx} package. @@ -347,20 +365,20 @@ 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 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.} +The {\upshape\texttt{asmeconf.bst}} \hologo{BibTeX} style follows the reference styles shown on ASME's conference web site in 2021.\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 +%% sub-subsections should *not* be numbered according to ASME's style \subsubsection*{DOI, URL, and eprint} Include DOI numbers when they are available. URL's may alternatively be given. ASME requests that URLs point to a document's abstract. -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/}|. +Basic 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, google\-books, 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 = {https://another.url.org/}|. \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*{Conference Location and Date} For \verb|@inproceeedings{..| and \verb|@proceeedings{..|, you may include \verb|venue={..}| and \verb|eventdate={..}| to specify the city and 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 in the \texttt{.bib} file. @@ -374,17 +392,18 @@ Elementary support for \texttt{eprint} numbers is also included, generating a ur \vspace*{1.7em} \centering{ \includegraphics{sample-figure-2a.pdf} -} +}% \vspace*{1.7em} -} +}% \subcaption{Interior region\label{fig:interior-region}} \end{subfigure}% %%%%%%%%%%%%% no spaces or line breaks between these two subfigures \begin{subfigure}[t]{0.5\textwidth} \centering{% \includegraphics{sample-figure-2b.pdf} +}% \subcaption{Exterior region\label{fig:exterior-region}} -}\end{subfigure} +\end{subfigure} \caption{A figure with two subfigures \cite{Lienhard2019b}}\label{fig:2} \end{figure*} @@ -393,7 +412,7 @@ Elementary support for \texttt{eprint} numbers is also included, generating a ur %%%%%%%%%%%%%%% MORE ON MATH %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% Dealing with complicated math in a section or subsection heading: +%% Here is an example of managing complicated math in a section or subsection heading: %% the optional argument to \section will provide the pdf bookmark %% without losing characters or producing warnings/errors. %% @@ -412,15 +431,15 @@ An example using \texttt{align} appears in Appendix~\ref{appendix:a}. 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 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|: +Math italics are used for Roman and 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:dw} \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} -To get additional symbols in bold math, you can use \verb|\mathversion{bold}| or the \verb|\bm{..}| macro from the \texttt{bm} package, which is loaded by the class. +To get additional symbols in bold math, use the \verb|\bm{..}| macro from the \texttt{bm} package (which is loaded by the class) or, for longer passages, use \verb|{\mathversion{bold}|\ldots\texttt{\}}. -The class file also provides upright sans-serif greek letters with \verb|\sfalpha| and similar expressions (e.g., $\sfalpha, \sfbeta, \sfgamma, \sfdelta$ \ldots $\bm{\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots}$), in case they are needed (but note that the \verb|newtxmath| options \verb|frenchmath| and \verb|slantedGreek| also affect how greek letters are presented). +The class file also provides upright sans-serif Greek letters with \verb|\sfalpha| and similar expressions (e.g., $\sfalpha, \sfbeta, \sfgamma, \sfdelta$ \ldots $\bm{\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots}$), in case they are needed (but note that the \verb|newtxmath| options \verb|frenchmath| and \verb|slantedGreek| also affect how Greek letters are presented). -\subsection{The \texttt{newtxmath} and \texttt{mathalpha} Packages~\cite{sharpe1,sharpe2}} The \texttt{newtxmath} package~\cite{sharpe1}, loaded by default, includes a large number of options for mathematics, most 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): +\subsection{The \texttt{newtxmath} and \texttt{mathalpha} Packages~\cite{sharpe1,sharpe2}} The \texttt{newtxmath} package~\cite{sharpe1}, loaded by default, includes many options for mathematics, most of which can be called as options to \verb|\documentclass|. For example, the \texttt{upint} option selects upright integral signs (rather than slanted integral signs): \begin{quote} \verb|\documentclass[upint]{asmeconf}|. \end{quote} @@ -430,7 +449,7 @@ In addition, many options for calligraphic, fraktur, and script fonts are availa \begin{center} \verb|\documentclass[mathalfa=cal=euler]{asmeconf}| \end{center} -which selects the Euler font for \verb|\mathcal| (this is our default). To find all the font options, refer to the \texttt{mathalfa} package documentation \cite{sharpe2}. +which selects the Euler font for \verb|\mathcal|, as in $A \in \mathcal{P}(A)$. To find all the font options, refer to the \texttt{mathalfa} package documentation \cite{sharpe2}. The \texttt{asmeconf} class is designed to be used with \texttt{newtxmath} and does not support the \texttt{unicode-math} package. @@ -451,23 +470,28 @@ 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{Grid-Style Author Block} The option \texttt{[grid]} invokes ASME's grid-style arrangement of author names. Author names are recognized by the commas that separate them. (To include a comma in a name, enclose it in braces.) Line breaks (\verb|\\|) may be inserted into the address of \verb|\SetAffiliation{n}{address}| as needed. + +Note that ASME interprets the author order in the grid style by reading names from left-to-right in the top row, then left-to-right in each subsequent row. \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. +The footers are generated with the \texttt{fancyhdr} package~\cite{oostrum} and can be changed using the commands of that package. Only the default arrangement matches ASME's style, however. \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{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]}. +As of late 2021, the \LaTeX 3 team is phasing in native support for PDF/A in the \LaTeX\ kernel, which will make these +class options unnecessary when using up-to-date installations. + +\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (both numbers and letters) for use in footnote markers and text superscripts. To enable this font, use the option \texttt{[nodefaultsups]}. -\subsection{Typewriter Font Options} This font is the sans-serif \texttt{inconsolata}. By default, the word spacing is variable, but option \texttt{[mono]} ends this behavior. A slashed zero is default; option \texttt{[var0]} removes the slash. Option \texttt{[hyphenate]} enables hyphenation. (This option is not available if the \texttt{[fontspec]} option is used.) +\subsection{Typewriter Font Options} This font is the sans-serif \texttt{inconsolata}. By default, the word spacing is variable, but option \texttt{[mono]} ends this behavior. A slashed zero is default; option \texttt{[var0]} removes the slash. Option \texttt{[hyphenate]} enables hyphenation. (The hyphenation option is not available if the \texttt{[fontspec]} option is used.) -\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{Support for Other Languages} This package can be adapted to incorporate (or entirely use) languages other than English. See Appendix \ref{appendix:b} for details. %%%%% Conclusions %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -482,18 +506,17 @@ Provide a brief conclusion (3-4 lines). Place any acknowledgments here. - %%% REFERENCES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %% Put your references into your .bib file in the usual way. Run latex once, bibtex once, then latex twice. -%% The asmeconf.bst style allows: venue = {Location of Conference}, and eventdate = {Month, days} -%% for @inproceedings and @proceedings -%% +%% The asmeconf.bst style allows @inproceedings and @proceedings to include: +%% venue = {Location of Conference}, +%% eventdate = {Month, days}, -\nocite{*} %% <=== Delete this line unless you want to typeset the entire contents of your .bib file! +\nocite{*}%% <=== Delete this line unless you want to typeset the entire contents of your .bib file! -\bibliographystyle{asmeconf} %% .bst file following ASME conference format. Do not change. -\bibliography{asmeconf-sample} %% <=== change this to name of your bib file +\bibliographystyle{asmeconf} %% .bst file following ASME conference format. Do not change. +\bibliography{asmeconf-sample}%% <=== change this to name of your bib file %%% APPENDICES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -514,35 +537,8 @@ consecutively, following those in the paper. Consider $\rho \neq \textrm{fn}(p)$ &{}= \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. -This style is the default for this template. - -The traditional style of putting authors with affiliation into a grid of blocks may be invoked with -the option [\texttt{authorgrid}]. When using this form, the author names and addresses should be entered as below: - -\smallskip -\noindent\verb|\SetAuthorBlock{Name\JointFirstAuthor}{%| - \hbox{}\hfil\verb|Institution \\ City, State}| -\verb|\SetAuthorBlock{Name\JointFirstAuthor}{%| - \hbox{}\hfil\verb|Institution \\ City, Country}| -\verb|\SetAuthorBlock{Name, Name}{%|\hfil\hbox{} - \hbox{}\hfil\verb|Institution \\ City, Country}| -\verb|\SetAuthorBlock{John Lienhard\CorrespondingAuthor{%| - \hbox{\qquad}\hfil\verb|lienhard@mit.edu}}{Institution \\ City, State}| -\smallskip - -Directly usable code is contained at the very end of the \texttt{asmeconf-template.tex} file. - -Note that ASME interprets the author order in the grid style by reading names from left-to-right in the top row, then left-to-right in each -subsequent row. - -%% directly usable code follows the \end{document} command below. - -%\end{document} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Multilingual Support}\label{appendix:c} +\section{Multilingual Support}\label{appendix:b} ASME publishes in English, but the \texttt{babel} package is loaded for users who may wish to include other languages. For example, an author might wish to include an appendix that provides the @@ -554,34 +550,35 @@ If no language options are given, the package defaults to English. As examples, shown in \selectlanguage{french}\appendixname~\ref{app:fourier}\selectlanguage{english}, followed by \ifpdftex abstracts in Spanish, Greek, Russian, and Vietnamese.\else abstracts in other languages.\fi -Font encoding is set to T1 with utf-8 input supported: +The input encoding can be utf-8, as for these glyphs: %% 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. -\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.} +\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. Under LuaLaTeX, be sure to load the [fontspec] option}% àáâäæãåā èéęëêēė îïíīįì ôöòóœøōõ ûüùúū çćč ł ñń ßśš ÿ žźż. -Fonts similar to Times/Helvetica are automatically used when the Greek, Vietnamese, or selected cyrillic-alphabet languages are called as options under {\upshape\hologo{pdfLaTeX}}. Using {\upshape\hologo{LuaLaTeX}} with the \texttt{[fontspec]} option, many additional scripts are available; see the supplemental notes for such usage~\cite{lienhard2021}. Possibilities include Arabic, Bengali, Chinese, Devanagari (e.g., for Hindi), Hangul (for Korean), Kana (for Japanese), and Tamil. +Fonts similar to Times/Helvetica are automatically used when the Greek, Vietnamese, or selected cyrillic-alphabet languages are called as options under {\upshape\hologo{pdfLaTeX}}. Using {\upshape\hologo{LuaLaTeX}} with the \texttt{[fontspec]} option, many additional scripts are available; see the supplemental notes for such usage~\cite{lienhard2021}. Possibilities include Arabic, Bengali, Chinese, Devanagari (e.g., for Hindi), Hangul (for Korean), Kana (for Japanese), and Tamil. \textit{The {\upshape\texttt{[fontspec]}} option requires a \LaTeX\ installation dated October 2020 or later.} -The bibliography style, \texttt{asmeconf.bst}, is designed in English and aimed at \hologo{BibTeX}. Multilingual bibliographies -can be supported using \texttt{BibLaTeX}. +The bibliography style, \texttt{asmeconf.bst}, is designed in English and aimed at \hologo{BibTeX}. +% Multilingual bibliographies can be supported using \texttt{BibLaTeX}. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\begin{selectlanguage}{french} +\begin{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}. -\end{selectlanguage} +\end{selectlanguage}% -\begin{selectlanguage}{spanish} +\begin{selectlanguage}{spanish}% \begin{abstract*} Este es el resumen del artículo. Escribimos en español. Se describen el problema, los métodos y los resultados. También se incluyen referencias. \end{abstract*} \end{selectlanguage}% edited by Aarón Montoya-Moraga -%% If you have trouble with the following passages, your file may not be saved in utf-8 format. You can delete this stuff to resolve the issue. -\typeout{If you have trouble with the following passages, your file may not be saved in utf-8 format. You can delete those lines to resolve the issue.} -%% Examples of abstracts in other languages. The first two are intended for pdflatex, not lualatex. +%% If you have trouble with the following passages, you may deleting this stuff and remove the associated language option from \documentclass[..]. +\typeout{If you have trouble with the following passages, your file may not be saved in utf-8 format, or your LaTeX format may be old, or you may not have the assumed font installed. You can delete those lines to resolve the issue.} + +%% Examples of abstracts in other languages. The first three are intended for pdflatex, not lualatex. \ifpdftex \begin{selectlanguage}{greek}% \begin{abstract*} @@ -594,15 +591,15 @@ Este es el resumen del artículo. Escribimos en español. Se describen el proble Это резюме статьи. Пишем по русски. Описаны проблема, методы и результаты. Библиография также включена.% \end{abstract*} \end{selectlanguage}% edited by Steven Gerasimoff -\fi - -\begin{selectlanguage}{vietnamese} -\begin{abstract*} -Đây là phần tóm tắt của bài báo khoa học. Chúng tôi viết bằng tiếng Việt. Vấn đề, các phương pháp và các kết quả được mô tả trong phần này. Tài liệu tham khảo cũng được bao gồm. -\end{abstract*} -\end{selectlanguage}% Checked and edited by Nguyen Le and Thao Nguyen -\iffontspecloaded + \begin{selectlanguage}{vietnamese} + \begin{abstract*} + Đây là phần tóm tắt của bài báo khoa học. Chúng tôi viết bằng tiếng Việt. Vấn đề, các phương pháp và các kết quả được mô tả trong phần này. Tài liệu tham khảo cũng được bao gồm. + \end{abstract*} + \end{selectlanguage}% Checked and edited by Nguyen Le and Thao Nguyen +\fi + +\iffontspecloaded %%% requires lualatex % \begin{selectlanguage}{greek}% \begin{abstract*} @@ -616,12 +613,18 @@ Este es el resumen del artículo. Escribimos en español. Se describen el proble \end{abstract*} \end{selectlanguage}% edited by Steven Gerasimoff % - \begin{selectlanguage}{japanese}% be sure to call class option [japanese] + \begin{selectlanguage}{vietnamese} \begin{abstract*} - %論文の要約です。日本語で記述します。問題、方法、および結果について説明します。また、参考文献も含めます。 - この論文の日本語での要約は以下のとおりです。問題、方法、および結果が説明されています。参考資料も添付してあります。 + Đây là phần tóm tắt của bài báo khoa học. Chúng tôi viết bằng tiếng Việt. Vấn đề, các phương pháp và các kết quả được mô tả trong phần này. Tài liệu tham khảo cũng được bao gồm. \end{abstract*} - \end{selectlanguage}% Edited by Keiji Yano and Yoshiki Okamoto + \end{selectlanguage}% Checked and edited by Nguyen Le and Thao Nguyen +% +% \begin{selectlanguage}{japanese}% Use class option [japanese] if you uncomment this passage. +% \begin{abstract*} +% % 論文の要約です。日本語で記述します。問題、方法、および結果について説明します。また、参考文献も含めます。 +% この論文の日本語での要約は以下のとおりです。問題、方法、および結果が説明されています。参考資料も添付してあります。 +% \end{abstract*} +% \end{selectlanguage}% Edited by Keiji Yano and Yoshiki Okamoto % \begin{selectlanguage}{korean} \begin{abstract*} @@ -641,28 +644,3 @@ Este es el resumen del artículo. Escribimos en español. Se describen el proble \end{document} - -%%% This is the set-up for the traditional author block style (a grid of blocks) using option [authorgrid] - -% Change to your name[s] and addresses, in the desired order of authors. Up to nine author blocks. -% Note usage below for joint first authors and for corresponding author. -% First name, middle initial, last name -% Use title case (upper and lower case letters) -% (Most of the names below are not real people, just very common names.) - -\SetAuthorBlock{Luis Hern\'{a}ndez\JointFirstAuthor}{Institution or Company Name \\ City, State} -\SetAuthorBlock{Maria Silva\JointFirstAuthor}{Institution or Company Name \\ City, Province, Canada} - -\SetAuthorBlock{Henry Tudor, Catherine Parr\CorrespondingAuthor{}}{Hampton Court Palace \\ Richmond, England} -\SetAuthorBlock{Jinsoo Kim}{Institution or Company Name \\ City, Country} -\SetAuthorBlock{Yusuf Yilmaz}{Institution or Company Name \\ City, Country} - -% Give an empty argument for \CorrespondingAuthor{} if you are putting email into address block. -% Can also put multiple emails into the argument and use command more than once for multiple -% corresponding authors. Only the *last* set of emails issued will be printed. - -\SetAuthorBlock{John H.\ Lienhard V\CorrespondingAuthor{lienhard@mit.edu, kate@thepalace.com}\JointFirstAuthor}{% -Massachusetts Institute of Technology \\ Cambridge, MA} - -% be sure to issue [authorgrid] option when using this (otherwise your authorblock will not display!) - |