diff options
| -rw-r--r-- | Master/texmf-dist/bibtex/bst/asmeconf/asmeconf.bst | 104 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/README.md | 20 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/asmeconf-sample.bib | 56 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf | bin | 288095 -> 362316 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex | 352 | ||||
| -rw-r--r-- | Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls | 210 |
6 files changed, 529 insertions, 213 deletions
diff --git a/Master/texmf-dist/bibtex/bst/asmeconf/asmeconf.bst b/Master/texmf-dist/bibtex/bst/asmeconf/asmeconf.bst index f7d3a5d46b9..961645f7fef 100644 --- a/Master/texmf-dist/bibtex/bst/asmeconf/asmeconf.bst +++ b/Master/texmf-dist/bibtex/bst/asmeconf/asmeconf.bst @@ -4,7 +4,7 @@ %%%%% *** https://www.asme.org/shop/proceedings/conference-publications/references *** %%%%% *** The examples given by ASME do not cover all possibilities *** %%%%% -%%%%% This file is version 1.0 dated 2019/03/24 +%%%%% This file is version 1.1 dated 2019/07/07 %%%%% %%%%% Author: John H. Lienhard V %%%%% Department of Mechanical Engineering @@ -15,13 +15,16 @@ %%%%% conformance to ASME specifications. Two new fields have been introduced for ASME %%%%% conference papers: %%%%% -%%%%% venue = {city of conference}, -%%%%% confmonth = {month, day[s] on which conference was held}, +%%%%% venue = {city of conference}, +%%%%% eventdate = {month, day[s] on which conference was held}, %% called confmonth in version 1.0 %%%%% %%%%% This approach leaves the address field as publisher's address, %%%%% and it leaves the notes field open for other uses. %%%%% -%%%%% A simple version of eprint can be used with @misc. +%%%%% Added fields: eventdate, urldate, urltype, venue +%%%%% Added: @online{...} for web publications (and aliased it to @www and @electronic) +%%%%% Added: urlprefix = {}, format.web.urldate, bbl.urldate; urltype field changes "accessed" to something else. +%%%%% Added: venue and eventdate to @inproceedings %%%%% %%%%% Feel free to edit this file to suit your own needs, but please make note of changes in this header. %%%%% @@ -89,17 +92,16 @@ ENTRY { address archive - archivePrefix author booktitle chapter collaboration - confmonth doi edition editor eid eprint + eventdate howpublished institution journal @@ -110,14 +112,15 @@ ENTRY numpages organization pages - primaryClass publisher school series title type url - venue + urldate + urltype + venue volume year } @@ -364,6 +367,10 @@ FUNCTION {bbl.rd} FUNCTION {bbl.th} { "th" } +FUNCTION {bbl.urldate} + { "accessed" } + + MACRO {jan} {"Jan."} MACRO {feb} {"Feb."} @@ -409,6 +416,17 @@ FUNCTION {eng.ord} if$ } +MACRO {arxiv} {"https://arxiv.org/abs/"} + +MACRO {googlebooks} {"http://books.google.com/books?id="} + +MACRO {hndl} {"http://hdl.handle.net/"} + +MACRO {jstor} {"http://www.jstor.org/stable/"} + +MACRO {pubmed} {"http://www.ncbi.nlm.nih.gov/pubmed/"} + + MACRO {acmcs} {"ACM Computing Surveys"} MACRO {acta} {"Acta Informatica"} @@ -488,22 +506,47 @@ FUNCTION {bibinfo.warn} FUNCTION {format.eprint} -{ eprint empty$ - { ""} - {"\href{http://arxiv.org/abs/" eprint * "}{" * eprint "}" * *} - if$ +{ eprint duplicate$ empty$ + 'skip$ + { "\eprint" + archive empty$ + { "there's an eprint but no archive in " cite$ * warning$ } + { "[" * archive * "]" * } + if$ + "{" * swap$ * "}" * + } + if$ } +FUNCTION {format.web.urldate} +{ urldate empty$ + {""} + {urldate "urldate" bibinfo.check + urltype duplicate$ empty$ + { pop$ bbl.urldate } + 'skip$ + if$ + "urltype" bibinfo.check + swap$ duplicate$ empty$ + { pop$ "t" change.case$ } + { tie.or.space.prefix * * } + if$ + ", " * + } + if$ +} + FUNCTION {format.url} { url duplicate$ empty$ { pop$ "" } - { "\urlprefix\url{" swap$ * "}" * } + { "\urlprefix\url{" swap$ * "}" * + format.web.urldate swap$ * + } if$ } - INTEGERS { nameptr namesleft numnames } @@ -1290,7 +1333,7 @@ FUNCTION {inproceedings} format.pages "pages" output.check new.sentence venue output - confmonth output + eventdate output format.thesis.year "year" output.check new.sentence publisher empty$ @@ -1478,6 +1521,35 @@ FUNCTION {techreport} fin.entry } +FUNCTION {online} +{ output.bibitem + author empty$ + { format.editors "author and editor" output.check + } + { format.authors output.nonnull + crossref missing$ + { "author and editor" editor either.or.check } + 'skip$ + if$ + } + if$ + format.title + "title" output.check + new.block + organization "organization" bibinfo.warn output + address "address" bibinfo.check output + format.date "year" output.check + format.doi output + format.note output + format.eprint output + format.url "url" bibinfo.warn output + fin.entry +} + +FUNCTION {electronic} { online } + +FUNCTION {www} { online } + FUNCTION {unpublished} { output.bibitem format.authors "author" output.check @@ -1533,7 +1605,7 @@ FUNCTION {begin.bib} write$ newline$ " \providecommand{\doi}{DOI \discretionary{}{}{}\begingroup \urlstyle{rm}\Url}\fi" write$ newline$ - "\providecommand{\eprint}[2][]{\url{#2}}" + "\providecommand{\eprint}[2][]{\urlprefix\href{#1#2}{#1#2}}" write$ newline$ } EXECUTE {begin.bib} diff --git a/Master/texmf-dist/doc/latex/asmeconf/README.md b/Master/texmf-dist/doc/latex/asmeconf/README.md index a8237c6e3ec..54508416aca 100644 --- a/Master/texmf-dist/doc/latex/asmeconf/README.md +++ b/Master/texmf-dist/doc/latex/asmeconf/README.md @@ -1,13 +1,13 @@ #asmeconf: A template for ASME conference papers# - Version 1.07 dated 2019/04/20. + Version 1.11 dated 2019/07/08. ####Overview#### This class provides a template to format ASME Conference papers according to - the requirements on ASME's web pages (as posted in March 2019). + the requirements on ASME's web pages (as posted in July 2019). - [www.asme.org/shop/proceedings/conference-publications/author-guidelines](https://www.asme.org/shop/proceedings/conference-publications/author-guidelines) + [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. @@ -20,7 +20,9 @@ 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 + sample-figure-1.pdf, + sample-figure-2a.pdf, + sample-figure-2b.pdf -- figures for the example The .tex and .cls files are commented and should be self-explanatory. @@ -33,17 +35,17 @@ - match ASME's current citation formats -- support use of hyperref package (hyperlink references to figures, tables, citations, and web) +- support hyperref package (hyperlinks to figures, tables, references, web) - support pdf bookmarks -- use the newtxtext and newtxmath font packages, which enable a variety of text and math features +- 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 blocks for up to nine addresses +- provide automatic layout of author and addresses in one of two styles ####Author#### @@ -61,6 +63,10 @@ ####Change log#### + v1.11: minor adjustments to title, author, and affiliation layout + + v1.1: revise several parts of the layout to match ASME's updated specifications from Summer 2019 (including author block, abstract font, placement of nomenclature, and minor spacings); add .bst support for online references and eprints; expand documentation significantly; guidance on fitting equations into columns. + v1.07: improve support for numbered section headings; allow omission of corresponding author email; edit documentation v1.06: automate bold sans math in captions and headings; small adjustments to default spacings; adjust font of paper number to 18 pt; edit documentation diff --git a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-sample.bib b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-sample.bib index 153f913c5d4..c1969347499 100644 --- a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-sample.bib +++ b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-sample.bib @@ -1,3 +1,5 @@ +%% Revised 7 July 2019 + @article{ning2002, title = {On the Sliding Friction Characteristics of Unidirectional Continuous FRP Deposits}, journal = {ASME Journal of Tribology}, @@ -17,11 +19,8 @@ year = {2008}, author = {Tom A. Gibson and Matthew A. Tucker}, address = {New York}, - doi = {10.1115/1.4042912}, - URL = {https://doi.org/10.1115/1.4042912}, } -%% There's no need to give the URL if it is simply the DOI; the DOI itself will be hyperlinked. - +%% If a URL or DOI is available, it may be included as in the article above. @INCOLLECTION{stevens1999, title = {Stochastic Fields and Their Digital Simulation}, @@ -31,10 +30,8 @@ booktitle = {Stochastic Methods}, author = {Thomas T. Stevens}, address = {Dordrecht}, - doi = {10.1115/1.4042912}, - URL = {https://doi.org/10.1115/1.4042912}, } -%% There's no need to give the URL if it is simply the DOI; the DOI itself will be hyperlinked. +%% If a URL or DOI is available, it may be included as in the article above. @inproceedings{wions2005, @@ -149,11 +146,13 @@ type = {NASA Technical Memorandum No.} @article{Lienhard2019b, title = "Exterior Shape Factors from Interior Shape Factors", - journal = "ASME Journal of Heat Transfer", + journal = {J. Heat Transfer}, year = "2019", doi = "10.1115/1.4042912", - author = {John H. Lienhard}, - note = {In press}, + author = {Lienhard, V, John H.}, + eid = {061301}, + volume = {141}, + number = {6}, } @misc{narayan2017, @@ -174,15 +173,18 @@ type = {NASA Technical Memorandum No.} venue ={S{\~a}o Paulo, Brazil}, confmonth = {October 15--20}, number = {IDA17WC-58334}, - url = {http://hdl.handle.net/1721.1/111971}, + eprint = {1721.1/111971}, + archive = hndl, } % number = {Paper No.\ IDA17WC-58334}, could be used instead. +% url = {http://hdl.handle.net/1721.1/111971}, @misc{Fong2015, title = {Analytical Methods for Squaring the Disc}, author = {Chamberlain Fong}, howpublished = {{\itshape ArXiv e-prints}}, eprint = {1509.06344}, + archive=arxiv, year = {2015}, month = {sep}, } @@ -208,11 +210,11 @@ type = {NASA Technical Memorandum No.} } -@manual{mpl, +@online{mpl, title={mpl colormaps}, author={St{\'e}fan {van der Walt} and Nathaniel Smith}, URL = {http://bids.github.io/colormap/}, - note = {Accessed 26 August 2018}, + urldate = {26 August 2018}, year = 2015, organization = {GitHub}, address = {San Francisco, CA}, @@ -240,4 +242,32 @@ type = {NASA Technical Memorandum No.} } % series = {Series A, +@online{amsmath, +author = {{American Mathematical Society} and {LATEX3 Project}}, +title = {User's Guide for the \textsf{amsmath} Package, Version 2.1}, +year = {2018}, +organization = {Comprehensive \TeX\ Archive Network}, +url = {https://ctan.org/tex-archive/macros/latex/required/amsmath/amsldoc.pdf}, +urldate = {5 July 2019}, +} +%% urltype = {retrieved}, + +@online{sharpe1, +author = {Michael Sharpe}, +title = {New {TX} font package, Version 1.554}, +year = {2018}, +organization = {Comprehensive \TeX\ Archive Network}, +url = {https://ctan.org/pkg/newtx}, +urldate = {27 April 2019}, +} + +@online{sharpe2, +author = {Michael Sharpe}, +title = {The \textsf{mathalfa} package, Version 1.10}, +year = {2018}, +organization = {Comprehensive \TeX\ Archive Network}, +url = {https://ctan.org/pkg/mathalfa}, +urldate = {27 April 2019}, +} + diff --git a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf Binary files differindex 2c258f382d8..998ba989a77 100644 --- a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf +++ b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf diff --git a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex index c5221e74a5a..a6c50517b70 100644 --- a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex +++ b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex @@ -1,8 +1,12 @@ %% %% This file is asmeconf-template.tex, a template to format ASME Conference papers according to -%% the requirements on ASME's conference web pages (as posted in March 2019). +%% the requirements on ASME's conference web pages. As of version 1.1, this template follows ASME's +%% newer conference guidelines as posted in July 2019. +%% +%% The new guidelines have changed the request author block formatting. +%% Nomenclature follows the abstract. Abstract is in italics. %% -%% This file is version 1.07 dated 2019/04/20 +%% This file is version 1.11 dated 2019/07/08 %% %% Author: John H. Lienhard V %% Department of Mechanical Engineering @@ -26,6 +30,9 @@ %% * An optional to use newtxtext's superiors font for footnotes [nodefaultsups] and an option %% * for slightly larger small capitals, largesc %% +%% * An option to use the old grid arrangement of author names [oldauthors]. See Appendix B for usage, +%% * because the authors and affiliations must be entered different in this case. +%% %% For details of newtxmath and mathalfa, refer to their documentation (available on CTAN: http://ctan.org). %% %% The use of commands defined or modified by the asmeconf class is illustrated below. In particular, @@ -57,34 +64,16 @@ %% Class options are described above. -\documentclass[varvw,largesc,upint,mathalfa=cal=euler]{asmeconf} - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% The following are editing tools, can delete if not using them +\documentclass[varvw,largesc,upint,mathalfa=cal=euler,colorlinks]{asmeconf} % <=== remove colorlinks for submission to ASME -\usepackage{lipsum} % Generates paragraphs of gibberish latin for checking layout ... e.g. \lipsum[2-4] produces - % paragraphs 2 through 4 of the text. -\usepackage{comment} % for commenting out passages. See package documentation for usage. - -%% Filler names for Author and affiliation blocks on title page -\def\AuthorName{Name[s] of Author[s]} -\long\def\Affiliation{Institution or Company Name \\ -Department of Mechanical Engineering\\ -Street address\\ -City, State, Country} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%% Fields to be completed %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%% pdf metadata and colors %%%%%%%%%%%%%%%%%%%%%%%%%% -%%%%% The user should edit as desired %%%%%%%%%%%% +%%%%% pdf metadata %%%%%%%%%%%% +%%%%% The user should edit %%%%%%%%%%%% \hypersetup{% - colorlinks=true,% <=== change to false to get black type for links (ASME may request this) - linkcolor=blue, % - citecolor=blue, % SeaGreen4, - urlcolor=blue, % Red3, pdftitle={ASME Conference Paper Template}, % <=== change to YOUR pdf file title pdfkeywords={ASME, Paper, Template, \LaTeX, Research}, % <=== change to YOUR pdf keywords pdfauthor={John H. Lienhard}, % <=== change to YOUR name[s]!!! @@ -96,46 +85,37 @@ City, State, Country} % 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 -\ConfName{Proceedings of the ASME 2018 \linebreak International Mechanical Engineering Congress and Exposition} -\ConfAcronym{IMECE18} -\ConfDate{November 9--15, 2018} -\ConfCity{Pittsburgh, Pennsylvania, USA} -\PaperNo{IMECE2018-XXXX} +\ConfName{Proceedings of the ASME 2019 \linebreak International Mechanical Engineering Congress and Exposition} +\ConfAcronym{IMECE19} +\ConfDate{November 11-14, 2019} +\ConfCity{Salt Lake City, UT, USA} +\PaperNo{IMECE2019-XXXX} % Units of measure and other specialty lowercase terms in the title should be % enclosed in \NoCaseChange{...} to maintain lower case type +% LaTeX will automatically set this in all capital letters. -\PaperTitle{Our research paper: the latest developments in cutting-edge engineering} +\PaperTitle{Place Title Here: Place Subtitle After Colon} -% 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 example names below are not real people, just very common names.) - -\SetAuthorBlock{Luis Hern\'{a}ndez\JointFirstAuthor}{\Affiliation} -\SetAuthorBlock{Maria Silva\JointFirstAuthor}{\Affiliation} - -\SetAuthorBlock{Henry Tudor, Catherine Parr}{Hampton Court Palace \\ Richmond, England} -\SetAuthorBlock{Jinsoo Kim}{\Affiliation} -\SetAuthorBlock{Yusuf Yilmaz}{\Affiliation} -%\SetAuthorBlock{Amelia Smith}{\Affiliation} -%\SetAuthorBlock{Aadhya Acharya}{\Affiliation} -%\SetAuthorBlock{Ahmed Mohammed}{\Affiliation} - - -% Can omit second argument of \CorrespondingAuthor if putting email into address -% i.e., can just use \CorrespondingAuthor{name}. -% Can also put multiple emails and use command more than once for multiple corresponding authors. +%% Put author names into the order you want. Use the same order for affiliations. +%% \affil{#} tags the author's affiliation to the address in \SetAffiliation{#}. +%% No space between last name and \affil{#}, separate names with commas. +%% +%% \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. -\SetAuthorBlock{\CorrespondingAuthor{John H.\ Lienhard V}{lienhard@mit.edu}}{% -Massachusetts Institute of Technology \\ Rohsenow Kendall Heat Transfer Lab -\\ Department of Mechanical Engineering -\\ Cambridge, MA 02139 USA} +\SetAuthors{Luis Hern\'{a}ndez\affil{1}\JointFirstAuthor , Maria Silva\affil{2}\JointFirstAuthor, Henry Tudor\affil{3}, Catherine~Parr\affil{3}, John H.\ Lienhard V\affil{4}\CorrespondingAuthor{lienhard@mit.edu}} +\SetAffiliation{1}{Institution or Company Name, City, State} +\SetAffiliation{2}{Institution or Company Name, City, Province, Canada} +\SetAffiliation{3}{Hampton Court Palace, Richmond, England} +\SetAffiliation{4}{Massachusetts Institute of Technology, Cambridge, MA } \MakeTitlePage @@ -149,54 +129,71 @@ Massachusetts Institute of Technology \\ Rohsenow Kendall Heat Transfer Lab %%%%%%%%%%%%%%%%%%%%% End of fields to be completed. Now write! %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%% Abstract %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% %% Abstract should be no more than 200 words \begin{abstract} -This paper is an example and template for the \texttt{asmeconf} class. Papers typeset in this class will follow ASME Conference guidelines for margins, fonts, headings, captions, and reference formats. Standard \LaTeX\ commands are used. The class is compatible with the \texttt{hyperref} package. The class defines new environments for abstract and nomenclature. The optional argument of \verb|\section| has been modified for manually setting pdf bookmarks when macros or complicated mathematics are included in section headings. The class is intended to be used with the \texttt{asmeconf.bst} \textsc{Bib}\negthinspace\TeX\ style, which is part of this distribution. The class may be invoked with several options, most of which address math fonts. The class calls a number of packages, all of which are in \TeX\textsc{live}\ and on CTAN (\href{http://ctan.org}{ctan.org}). +This paper is an example and template for typesetting ASME Conference Papers in \LaTeX\ using the {\upshape\texttt{asmeconf}} class. This class follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of July 2019. The class is compatible with the {\upshape\texttt{hyperref}} package for producing pdf files with links. The optional argument of \verb|\section| has been modified for manually setting pdf bookmarks when macros or complicated mathematics are included in section headings. The class is intended to be used with the {\upshape\texttt{asmeconf.bst}} \textsc{Bib}\negthinspace\TeX\ style, which is part of this distribution. The class may be invoked with several options, most of which address math fonts. The class calls a number of packages, all of which are in \TeX\textsc{live}\ and on CTAN (\href{http://ctan.org}{ctan.org}). \end{abstract} +%%%%%%%%% NOMENCLATURE (OPTIONAL) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% +%% 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. -\section*{Introduction} -For ASME conference papers, the labels Figure and Equation should be abbreviated when they do not start a sentence, as in Fig.~\ref{fig:1} and Eq.~\eqref{eqn:dw}. Figure~\ref{fig:1} is spelled out when it starts a sentence. Equation~\eqref{eqn:dw} is spelled out when it starts a sentence. +%% Leave off second argument of \entry to produce a subheading (e.g., \entry{Greek letters} ) -References are automatically numbered \cite{ning2002}. They should be inserted at the appropriate point using a \verb|\cite{ref}| command~\cite{gibson2008,stevens1999}. The references will be automatically sorted and compressed as well if they are given in a set \cite{stevens1999,ning2002,gibson2008,wions2005,smith2002,watson1982,smith1998}. See the \texttt{asmeconf-sample.bib} file for examples of how to enter your references. +\begin{nomenclature} +\entry{Roman letters} +\entry{$k$}{Thermal conductivity [W m$^{-1}$ K$^{-1}$]} +\entry{$\vec{q}$}{Heat flux vector [W m$^{-2}$]} -Equations are typeset in the usual way. The class file loads the \texttt{amsmath} and \texttt{mathtools} packages. Further, the \texttt{newtxmath} package used for the math fonts includes many additional features. -\begin{equation}\label{eqn:fourier} -\vec{q} = -k\nabla T -\end{equation} -ASME does not specify a standard nomenclature list. Be sure to put your symbols into the nomenclature list, including SI units. +\entry{Greek letters} +\entry{$\alpha$}{Thermal diffusivity [m$^2$ s$^{-1}$]} +\entry{$\nu$}{Kinematic viscosity [m$^2$ s$^{-1}$]} +\entry{Dimensionless groups} +\entry{Pr}{Prandtl number, $\nu/\alpha$} +\entry{Sc}{Schmidt number, $\nu/\mathcal{D}_{1,2}$} -%% Use title case for subsections and subsubsections -\section*{Section Headings and Captions} -ASME requires that section headings and captions be set in an uppercase, bold face, sans serif font. The class will do this automatically. You can place \verb|\cite{..}|, \verb|\ref{..}|, \verb|\label{..}|, and into headings and captions directly, as you would in the main text. Do not enclose them braces, e.g.\ \verb|{\cite{..}}|, which will cause errors. You can place \verb|\footnote{..}| into headings, but not into captions.\footnote{See \texttt{tex-stackexchange} for various approaches to footnotes in captions, if they seem necessary. For footnotes in tables, use the \texttt{tablefootnote} package.} +\entry{Superscripts and subscripts} +\entry{b}{bulk value} +\entry{$\infty$}{free stream value} +\end{nomenclature} -Text in section headings and captions will not be capitalized if enclosed in a \verb|\NoCaseChange{...}| command. -Sections may either be numbered or left unnumbered. +%%%%%%%%% BODY OF PAPER %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -Simple math can be used in either captions or section headings. For a section heading that includes more complicated math (and macros), you may use the optional argument of \verb|\section[..]{..}| to create a pdf bookmark without losing characters or producing warnings or errors. See the \texttt{asmeconf.tex} source file for examples of this. These bookmarks should usually be text expressions, although some math is supported. +\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. -If you wish to override the default math format in captions, put \verb|\mathversion{normal}| in the caption. +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. -\subsection*{Subsection Headings in Title Case} -Subsections and sub-subsection headings should be in title case (first letter of primary words capitalized). +\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|\PaperTitle{..}|. -\section*{More on math} -To get bold math outside of the captions, you can use the \verb|\bm{..}| macro from the \texttt{bm} package, which is loaded by the class. +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. Author addresses are to be kept short. List the author institution, and the City, State (US authors), City, Province, Canada (Canadian authors), or City, Country (other international authors). -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} -\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}} +One author (or more) may be designated as the \verb|\CorrespondingAuthor{email}| by placing the command at the end of the name. Two or more authors may be joint first authors with \verb|\JointFirstAuthor|. Either of these commands should come after \verb|\affil{#}|. + +After setting up the headers, authors, and title, issue the \verb|\MakeTitlePage| command. + +Keywords may optionally be including using the \verb|\keywords{..}| command; this command \textit{must} be issued before the abstract. The abstract text must be placed into \verb|\SetAbstract{..}|. The abstract will automatically be italized. + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\section{Equations and Nomenclature} +Equations are typeset in the usual way. The class file loads the \texttt{amsmath} and \texttt{mathtools} packages. Further, the \texttt{newtxmath} package used for the math fonts includes many additional features (see Sect.~\ref{sec:moremath}). +\begin{equation}\label{eqn:fourier} +\vec{q} = -k\nabla T \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}$), in case they are needed (but note that the \verb|newtxmath| options \verb|frenchmath| and \verb|slantedGreek| also affect how Greek is presented). +ASME prefers SI units. U.S.\ style units may follow in parentheses. Be sure to put your symbols into the nomenclature list, including the units. -\section*{Tables} -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}). +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. -The text in tables and figures should be no smaller than 7~point type. %%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%% @@ -209,9 +206,25 @@ The text in tables and figures should be no smaller than 7~point type. %%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%% -\subsection*{Latin for Layout} The rest of this text uses Latin to show layout and usage. Refer to the \texttt{.tex} file for further details. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Use title case for subsections and subsubsections +\section{Section Headings and Captions} +ASME requires that section headings and captions be set in an uppercase, sans serif font. The class will do this automatically. You can place \verb|\cite{..}|, \verb|\ref{..}|, \verb|\label{..}|, and into headings and captions directly, as you would in the main text. Do not enclose them braces, e.g.\ \verb|{\cite{..}}|, which will cause errors. You can place \verb|\footnote{..}| into headings, but not into captions.\footnote{See \texttt{tex-stackexchange} for various approaches to footnotes in captions, if they seem necessary. For footnotes in tables, use the \texttt{tablefootnote} package.}\footnote{Sequential footnote.} + +Text in section headings and captions will not be capitalized if enclosed in a \verb|\NoCaseChange{..}| command. + +Sections may either be numbered or left unnumbered. + +Simple math can be used in either captions or section headings. For a section heading that includes more complicated math (and macros), you may use the optional argument of \verb|\section[..]{..}| to create a pdf bookmark without losing characters or producing warnings or errors. See the \texttt{asmeconf.tex} source file for examples of this. These bookmarks should usually be text expressions, although some math is supported. + +If you wish to override the default math format in captions, put \verb|\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. -\lipsum[4-5] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +\subsection{Colored hyperlinks} +ASME requires that all text be in black when the paper is submitted for publication. For other uses, authors make +obtain colored hyperlinks with the [\texttt{colorlinks}] option. %%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%% @@ -252,13 +265,13 @@ Our competitor's test & 72.321 & 141.384 \\ %%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\section{Tables and Figures} -%% Dealing with complicated math in a section heading: optional argument provides the pdfbookmark -%% without losing characters or producing warnings/errors. -%% In this heading, u is forced to be upright with \mathrm{u} -\section*[Math in a section heading: u\cdot\omega=0]{Math in a section heading: $\vec{\mathrm{u}}\cdot\vec{\omega}=0$} +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. -\lipsum[6] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +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. %%%%%%%%%%%%%%%%% begin wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -275,45 +288,75 @@ Our competitor's test & 72.321 & 141.384 \\ \includegraphics{sample-figure-2b.pdf} \subcaption{Exterior region\label{fig:exterior-region}} }\end{minipage} -\caption{A figure with two subfigures \cite{Lienhard2019b}} +\caption{A figure with two subfigures \cite{Lienhard2019b}}\label{fig:2} \end{figure*} %%%%%%%%%%%%%%%%%%% end wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section*{Entropy generation\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.} is always interesting and important \cite{bejan}} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\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.}} + +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 as well if they are given in a set \cite{stevens1999,ning2002,gibson2008,wions2005,smith2002,watson1982,smith1998}. See the \texttt{asmeconf-sample.bib} file for examples of how to enter your references. + +The {\upshape\texttt{asmeconf.bst}} \textsc{Bib}\negthinspace\TeX\ style follows the reference styles posted on ASME's conference web site in mid-2019. Examples for these and many other cases are given in the \texttt{asmeconf-sample.bib} file, which is part of this distribution. Nevertheless, a few comments are necessary. -\lipsum[5] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +%% subsubsections are not numbered +\subsubsection*{DOI, URL, and eprint} Include DOI numbers when they are avaiable. URL's may alternatively be given. +Elementary support for \texttt{eprint} numbers is also included, generating a url at the end of the citation. The \texttt{archive} type may be specified using the macros \texttt{arxiv, googlebooks, hndl, jstore}, or \texttt{pubmed} (e.g., \texttt{archive=hndl}, \textit{without} braces). Both \texttt{eprint} and \texttt{archive} fields \textit{must} be given. Other root urls may be invoked using \verb|archive = {http://another.url.org/}|. -%% Unumbered subsections with math do not need any special handling because they are neither uppercased nor bookmarked -\subsection*{Subsection with Math: $\dot{S}_{\textsf{gen}}$ \cite{bejan}.} +\subsubsection*{Online Sources} A bibliography field \verb|@online{..| is included for citation of online sources, such as web pages. See the examples of use in the \texttt{asmejour-sample.bib} file. -%% Numbered subsections with math are bookmarked may require special handling to produce the right bookmark -%\subsection[Subsection with Math: A\times B]{Subsection with Math: $\vec{A}\times\vec{B}$.} +\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. -\lipsum[10] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +%%%%%%%%%%%%%%% MORE ON MATH %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\subsubsection*{Sub-subsection\footnote{Another longer footnote to show the leading and line breaking, and how it will sit at the bottom of a column. Another longer footnote to show the leading and line breaking, and how it will sit at the bottom of a column.} Heading} +%% Dealing with 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. +%% +%% In this heading, u is forced to be upright with \mathrm{u} +%% +\section[More on math: u\cdot\omega=0]{More on math: $\vec{\mathrm{u}}\cdot\vec{\omega}=0$}\label{sec:moremath} -\lipsum[12-13] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +In most cases, the need for a wide equation can be eliminated by using one of the multiline equation environments defined by \texttt{amsmath}, such as \texttt{align}, \texttt{split}, or \texttt{multline}~\cite{amsmath}. The following equation is set with the \texttt{multline} environment: +\begin{multline} +\frac{\partial}{\partial t}\left[\rho\bigl(e + \lvert\vec{u}\rvert^2\big/2\bigr)\right] + \nabla\cdot\left[\rho\bigl(h + \lvert\vec{u}\rvert^2\big/2 \bigr)\vec{u}\right] \\ + ={}-\nabla \cdot \vec{q} + \rho \vec{u}\cdot\vec{g}+ \frac{\partial}{\partial x_j}\left(d_{ji}u_i\right) + \dot{Q}_v +\end{multline} +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. (You can find code online that sets equations across two columns, but the results may be sketchy.) + +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} -d\vec{w} = - \begin{pmatrix} - du \\ dv - \end{pmatrix} = - \underbrace{\begin{pmatrix} - \partial u/\partial x & \partial u/\partial y \\ - \partial v/\partial x & \partial v/\partial y - \end{pmatrix}}_{=\,\mathbf{J}_1} \begin{pmatrix} - dx \\ dy - \end{pmatrix} +\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 the \verb|\bm{..}| macro from the \texttt{bm} package, which is loaded by the class. + +The class file also provides upright sans-serif greek letters with \verb|\sfalpha| and similar expressions (e.g.\ $\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots \bm{\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots}$), in case they are needed (but note that the \verb|newtxmath| options \verb|frenchmath| and \verb|slantedGreek| also affect how Greek is presented). + +\subsection{The \texttt{newtxmath} and \texttt{mathalpha} packages~\cite{sharpe1,sharpe2}} The \texttt{newtxmath} package~\cite{sharpe1}, loaded by default, includes a large number of options for mathematics. Most options can be called as options to \verb|\documentclass|. For example, the \texttt{upint} option of \texttt{newtxmath} selects upright integral signs (rather than slanted integral signs): +\begin{quote} +\verb|\documentclass[upint]{asmeconf}|. +\end{quote} +These math options are discussed further in the \texttt{asmejour-template.tex} file. + +In addition, many options for calligraphic, script, and fraktur fonts are available as options to the \texttt{mathalfa} package, which is also loaded. These may be invoked, for example, as +\begin{quote} +\verb|\documentclass[mathalfa=cal=euler]{asmeconf}| +\end{quote} +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}. -%%%%%%%%%%%%%%% begin table %%%%%%%%%%%%%%%%%% +The typewriter font loaded is \texttt{inconsolata} (which is sans serif), as suggested by the \texttt{newtx} package documentation. The class is not set up for use with the \texttt{fontspec} or \texttt{unicode-math} packages. + + +%%%%%%%%%%%%%%% begin two column table %%%%%%%%%%%%%%%%%% \begin{table*}[t] \caption{A table spanning two columns}\label{tab:3}% \centering{% @@ -341,41 +384,17 @@ d\vec{w} = \bottomrule\end{tabular*} } \end{table*} -%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%% - -\lipsum[16] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! - - -\section*{Acknowledgements} -\lipsum[17] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +%%%%%%%%%%%%%%%% end two column table %%%%%%%%%%%%%%%%%%% -%%%%%%%%% NOMENCLATURE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% -%% 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. - -%% Leave off second argument of \entry to produce a subheading (e.g., \entry{Greek letters} ) - -\begin{nomenclature} -\entry{Roman letters} -\entry{$k$}{Thermal conductivity [W m$^{-1}$ K$^{-1}$]} -\entry{$\vec{q}$}{Heat flux vector [W m$^{-2}$]} - -\entry{Greek letters} -\entry{$\alpha$}{Thermal diffusivity [m$^2$ s$^{-1}$]} -\entry{$\nu$}{Kinematic viscosity [m$^2$ s$^{-1}$]} -\entry{Dimensionless groups} -\entry{Pr}{Prandtl number, $\nu/\alpha$} +\section{Conclusion} +Provide a brief conclusion (3-4 lines). -\entry{Superscripts and subscripts} -\entry{b}{bulk value} -\entry{$\infty$}{free stream value} +\section*{Acknowledgment} +Place any acknowledgments here. -\end{nomenclature} %%% REFERENCES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -385,8 +404,12 @@ d\vec{w} = %% \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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \appendix @@ -395,20 +418,57 @@ d\vec{w} = %% Equations should be numbered sequentially following those in the paper. Don't reset the equation counter. %% Here we use the optional argument for the pdf bookmark. -\section[The vector product A\times B]{The vector product $\vec{A}\times\vec{B}$} - -\lipsum[21] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +\section[The vector product A\times B]{The vector product $\vec{A}\times\vec{B}$}\label{appendix:a} +This is just a brief illustration of an appendix, showing numbering of the appendix and equations. Equations are numbered +consecutively, following those in the paper. \begin{align} \frac{d\Gamma}{dt} &{}= \int_{\mathcal{C}} \frac{D\mathbf{u}}{Dt} \cdot d\mathbf{r}\\ &{}= \iint_{\mathcal{S}} \nabla \times \frac{D\mathbf{u}}{Dt} \cdot d\mathbf{A}\\ &{}= \iint_{\mathcal{S}} \nabla p \times \nabla \left( \frac{1}{\rho}\right) \cdot d\mathbf{A} \end{align} -%% This subsection heading is not numbered -\subsection*{Subsection Heading} -\lipsum[22] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +\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 historical style of authors with affiliation in a grid of blocks may be invoked with +the option [\texttt{oldauthors}]. 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{} + \noindent\hbox{}\hfil\verb|Institution \\ City, Country}| +\verb|\SetAuthorBlock{\CorrespondingAuthor{John Lienhard%| + \hbox{}\hfil\verb|}{lienhard@mit.edu}}{Institution \\ City, State}| + +%% see after end document for usable code if you go this route. \end{document} + +% Can also put multiple emails and use command more than once for multiple corresponding authors. +% 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 example 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}{Hampton Court Palace \\ Richmond, England} +\SetAuthorBlock{Jinsoo Kim}{Institution or Company Name, City, Country} +\SetAuthorBlock{Yusuf Yilmaz}{Institution or Company Name, City, Country} + +% Can omit second argument of \CorrespondingAuthor if putting email into address +% i.e., can just use \CorrespondingAuthor{name}. +% Can also put multiple emails and use command more than once for multiple corresponding authors. + +\SetAuthorBlock{\CorrespondingAuthor{John H.\ Lienhard V}{lienhard@mit.edu}}{% +Massachusetts Institute of Technology \\ Cambridge, MA} + + diff --git a/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls b/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls index e9ba3700990..0453465e485 100644 --- a/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls +++ b/Master/texmf-dist/tex/latex/asmeconf/asmeconf.cls @@ -5,7 +5,7 @@ %% %% Please note that ASME's journals follow specifications different from ASME conference papers. %% -%% This file is version 1.07 dated 2019/04/20. +%% This file is version 1.11 dated 2019/07/08. %% %% Author: John H. Lienhard V %% Department of Mechanical Engineering @@ -18,7 +18,7 @@ %% 2. With the associated amseconf.bst, match ASME's reference formats %% 3. Maintain hyperref compatibility for pdf bookmarks and hyperlinks %% 4. Use the newtxtext and newtxmath font packages, including relevant features -%% 5. Provide automatic layout of author blocks for up to nine addresses +%% 5. Provide automatic layout of author names and addresses %% 6. Support bold face, sans serif math in headings %% %% This class is compatible with either pdfLaTeX or LuaLaTeX. The class uses a number of packages, @@ -31,7 +31,7 @@ %% This class is not designed for unicode-math or fontspec, given that the ASME conference style is %% specific with respect to the font selections. %% -%% Options for the class are described on lines 87-107. +%% Options for the class are described on lines 79-126. %% %% The class defines two environments: abstract and nomenclature. The latter has an optional argument to %% control the space between the entries and the definitions. @@ -39,6 +39,9 @@ %% New commands are described in the asmeconf-template.tex file. The \section[]{} command's optional %% argument is changed to better support pdf bookmarks, and \section* is modified similarly. %% +%% Commands for entering conference headers, title, abstract, and author names are specific to this class. +%% See asmeconf-template.tex for details. +%% %% % ========================================================= %% @@ -64,7 +67,7 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \NeedsTeXFormat{LaTeX2e} -\ProvidesClass{asmeconf}[2019/04/20 ASME Conference Paper Format] +\ProvidesClass{asmeconf}[2019/07/08 ASME Conference Paper Format] \LoadClass[twoside,twocolumn,10pt]{article} % Two-sided layout not used in ASME's specs, although that's how the papers are printed @@ -75,6 +78,9 @@ \RequirePackage{ifthen} \newboolean{DefaultSups} \setboolean{DefaultSups}{true} +\newboolean{Oldauthors} +\setboolean{Oldauthors}{false} + \RequirePackage{kvoptions} \RequirePackage{kvsetkeys} @@ -96,6 +102,11 @@ \ProcessKeyvalOptions* +%% option to have colored hyperlinks +\DeclareOption{colorlinks}{% + \PassOptionsToPackage{colorlinks=true}{hyperref}% + } + %% option to omit ASME footer \DeclareOption{nofoot}{% \AtBeginDocument{\pagestyle{plain}}% @@ -110,6 +121,11 @@ %% Option not to use latex default superscripts, instead using the newtxtext superiors font [nodefaultsups] \ifthenelse{\boolean{DefaultSups}}{\PassOptionsToPackage{defaultsups}{newtxtext}}{\relax} +%% option to use old authors +\DeclareOption{oldauthors}{% + \setboolean{Oldauthors}{true}% + } + %% Suppress warnings about mathalfa keys as unused global options \DeclareOption*{} @@ -130,6 +146,7 @@ \RequirePackage{graphicx} \RequirePackage[hyperref,fixpdftex,dvipsnames,svgnames,x11names]{xcolor} \RequirePackage{xparse} +\RequirePackage{comment} %%%%%%%%%%%%%%%%%%%%%%%% @@ -144,9 +161,13 @@ \RequirePackage{mathtools} % extends amsmath \RequirePackage[utf8]{inputenc} \RequirePackage[]{newtxtext} +\RequirePackage[varqu,varl]{inconsolata} % sans typewriter font \RequirePackage[]{newtxmath} % See package documentation +%% override \textsu if using default superiors +\ifthenelse{\boolean{DefaultSups}}{\let\textsu\textsuperscript}{\relax} + \RequirePackage[]{mathalfa} % load optional fonts for Calligraphy, Script, etc. % See package documentation for capabilities of this package. % Option format: mathalfa=cal=euler (etc.) @@ -157,8 +178,9 @@ %%%% font size selection %%%%%%%% %%%% ASME's specs differ slightly from latex standard article-10 class %%% -\renewcommand\LARGE{\@setfontsize\LARGE{18}{21.6}} %... default is 17.28/22 ... for paper number -\renewcommand\large{\@setfontsize\large{11}{13.6}} %... default is 12/14 ... for headings +\renewcommand\LARGE{\@setfontsize\LARGE{16}{19.2}} %{18}{21.6}} updated 7/7/19 to match new ASME spec. + % ...default is 17.28/22 ... used for paper# +\renewcommand\large{\@setfontsize\large{11}{13.6}} %... default is 12/14 ... used for headings %\renewcommand\Large{\@setfontsize\Large{14.4}{18}} % same as default %\renewcommand\normalsize{\@setfontsize\normalsize{10}{12}} % same as default @@ -212,8 +234,8 @@ \RequirePackage[hypcap=false,list=true]{subcaption} \DeclareCaptionTextFormat{boldmath}{\mathversion{sansbold}#1} -\captionsetup[figure]{name=FIGURE,labelfont={sf,bf,small},textfont={sf,bf,small},textformat=boldmath, labelsep=period} -\captionsetup[table]{name=TABLE,labelfont={sf,bf,small},textfont={sf,bf,small},textformat=boldmath, labelsep=period,skip=0.5\baselineskip} +\captionsetup[figure]{name=FIGURE,labelfont={sf,bf,small},textfont={sf,bf,small},textformat=boldmath, labelsep=colon} +\captionsetup[table]{name=TABLE,labelfont={sf,bf,small},textfont={sf,bf,small},textformat=boldmath, labelsep=colon,skip=0.5\baselineskip} %% This construction avoids a failure of hyperref in relation to uppercase caption %% Discussion: https://tex.stackexchange.com/questions/375695/maketextuppercase-inside-table-captions @@ -236,9 +258,9 @@ \titleformat{\subsection}{\mathversion{sansbold}\bfseries\sffamily\raggedright}{\thesubsection}{0.5em}{} \titleformat{\subsubsection}[runin]{\mathversion{sansbold}\bfseries\sffamily}{\thesubsubsection}{0.5em}{}[.\hspace*{0.5em}] -\titlespacing\section{0pt}{12pt plus 4pt minus 2pt}{2pt plus 2pt minus 1pt} +\titlespacing\section{0pt}{12pt plus 4pt minus 2pt}{1pt plus 1pt minus 1pt} % from 2 pt 2 pt 1 pt, 7/7/19 \titlespacing\subsection{0pt}{12pt plus 4pt minus 2pt}{0pt plus 2pt minus 1pt} -\titlespacing\subsubsection{\parindent}{12pt plus 4pt minus 2pt}{0pt plus 2pt minus 1pt} +\titlespacing\subsubsection{\parindent}{6pt plus 3pt minus 2pt}{0pt plus 2pt minus 1pt} % from 12 4 3, 7/7/19 %% Special handling of the appendices @@ -262,10 +284,10 @@ bookmarksnumbered=true,% bookmarksopen=true,% bookmarksopenlevel=1,% - colorlinks=true,%%% <=== set false to get black type, but do so in .tex file +% colorlinks=true,%%% <=== set true to get colored type, but do so via package options linkcolor=blue, % - citecolor=blue, % SeaGreen4,% - urlcolor=blue, % Red3,% + citecolor=blue, % + urlcolor=blue, % breaklinks=true,% pdftitle={}, % <=== add in .tex file pdfkeywords={}, % <=== add in .tex file @@ -341,14 +363,14 @@ \DeclareDocumentCommand{\keywords}{m}{% \IfNoValueTF{#1}{% \relax}{% - \long\def\@keywords{\par\medskip\noindent{\bfseries\sffamily Keywords:} #1}% + \long\def\@keywords{\par\smallskip\noindent{\bfseries\sffamily Keywords:} #1}% } } \DeclareDocumentEnvironment{abstract}{}{% - \section*{Abstract}% + \section*{Abstract}\itshape% } - {\@keywords\bigskip% + {\upshape\@keywords%\medskip% } %%%%%%%%%%%% Nomenclature environment %%%%%%%%%%%%%%%%%% @@ -363,7 +385,7 @@ %% \DeclareDocumentCommand{\entry}{m g}{% \IfNoValueTF{#2}{% - \item[\itshape#1\hfill\rule{0pt}{13pt}]% + \item[\itshape#1\hfill]\par\smallskip% }{% \item[#1\hfill]#2% } @@ -429,10 +451,21 @@ } -%%%%%%%%%%% Author block %%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%% Author and affiliation block %%%%%%%%%%%%%%%%%%%%%%%%%%%% \RequirePackage{xcoffins} +%% To maintain compatibility with newtxtext superiors option, if used, save the definition +\let\savethefootnote\thefootnote +\let\savemakefnmark\@makefnmark + + +%%%% option to retain original grid layout of authors +\ifthenelse{\boolean{Oldauthors}}{% + +%%%%%%%%%%%%%%%%%%%% Old author layout %%%%%%%%%%%%%%%%%%%%%%%%% + \NewCoffin{\authorblock} %% Allows for up to nine author groups... if you need more authors, the edits should be obvious @@ -503,47 +536,163 @@ \centerline{\TypesetCoffin\firstrowauthorblock} %% in this instance, \centerline is better than \centering } -%% To maintain compatibility with newtxtext superiors option, if used, save the definition -\let\savethefootnote\thefootnote - %% Flag for corresponding author (expecting just one, but if two enter both email addresses and flag both authors) \newif\ifCA\CAfalse % allow for NO email address to be given by omitting second argument \DeclareDocumentCommand{\CorrespondingAuthor}{m g}{% -\global\CAtrue% - \IfNoValueTF{#2}{% + \global\CAtrue% + \IfNoValueTF{#2}{% \gdef\@CAsep{\relax} \gdef\@CAemail{\relax} }{% \gdef\@CAsep{:\space} \gdef\@CAemail{#2} } -\renewcommand*{\thefootnote}{\fnsymbol{footnote}} -\ignorespaces#1\ignorespaces\footnotemark[1]% + \renewcommand*{\thefootnote}{\fnsymbol{footnote}} + \ignorespaces#1\ignorespaces\footnotemark[1]% } %% Flag for joint first authors (two or more) \newif\ifJA\JAfalse \DeclareDocumentCommand{\JointFirstAuthor}{}{% + \global\JAtrue% + \renewcommand*{\thefootnote}{\fnsymbol{footnote}}% + \ignorespaces\footnotemark[2]% +} + +%%% otherwise use new compact layout of authors +}{% i.e., this begins "else" + +%%%%%%%%%%%%%%%%%%%%%% New author layout %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\NewCoffin{\AuthorBlock} +\NewCoffin{\AffiliationBlock} +\NewCoffin{\AffiliationsBlock} + +%% NB: \parbox width to \textwidth (full page) not \linewidth (single column) +\SetHorizontalCoffin\AffiliationsBlock{} +\DeclareDocumentCommand{\SetAuthors}{m}{% + \SetHorizontalCoffin\AuthorBlock{% + \parbox{\textwidth}{\centering\sffamily\bfseries\ignorespaces#1\ignorespaces}% + } +} + + +\def\@makefnmark{\hbox{\@textsuperscript{\sffamily\@thefnmark}}}% + +\DeclareDocumentCommand{\SetAffiliation}{m m}{% + \SetVerticalCoffin\AffiliationBlock{\textwidth}{% + \centering\sffamily\footnotemark[#1]#2\ignorespaces% + } + \JoinCoffins\AffiliationsBlock[hc,b]\AffiliationBlock[hc,t](0pt,-1pt) +} + + +%%% flag for corresponding author (usually just one, although you can have two by putting both email addresses +%%% into field and attaching to both authors -- footnote will only print only the email in the last occurrence) + +%% Flag for corresponding author (expecting just one, but if two enter both email addresses and flag both authors) +\newif\ifCA\CAfalse + +% allow for NO email address to be given by omitting second argument +\DeclareDocumentCommand{\CorrespondingAuthor}{g}{% + \ignorespaces$\bm{^\ast}$% + \global\CAtrue% + \IfNoValueTF{#1}{% + \gdef\@CAsep{\relax} + \gdef\@CAemail{\relax} + }{% + \gdef\@CAsep{:\space} + \gdef\@CAemail{#1} + } +} + +%%% Flag for joint first authors (two or more) +\newif\ifJA\JAfalse + +\DeclareDocumentCommand{\JointFirstAuthor}{}{% \global\JAtrue% -\renewcommand*{\thefootnote}{\fnsymbol{footnote}}% -\ignorespaces\footnotemark[2]% + $\bm{^\dagger}$% +} + +%%% Affiliation mark +\DeclareDocumentCommand{\affil}{m}{% + {\bfseries\footnotemark[#1]}% +} + +%%% to deal with sequential notes as, e.g., "1,*", or "1,2,*" %%%%%%%%%% +\let\oldaffil\affil +\newcommand\nextToken\relax + +\renewcommand\affil[1]{% + \oldaffil{#1}\futurelet\nextToken\isOthernote} + +\newcommand\isOthernote{% + \ifx\CorrespondingAuthor\nextToken\textsuperscript{\sffamily\bfseries,}% + \else% + \ifx\JointFirstAuthor\nextToken\textsuperscript{\sffamily\bfseries,}% + \else + \ifx\affil\nextToken\textsuperscript{\sffamily\bfseries,}% + \fi% + \fi% + \fi% + \ignorespaces% } -%%%% Make the title section +\let\oldCorrespondingAuthor\CorrespondingAuthor +\renewcommand\CorrespondingAuthor[1]{% + \oldCorrespondingAuthor{#1}\futurelet\nextToken\isOthernote} + +\let\oldJointFirstAuthor\JointFirstAuthor +\renewcommand\JointFirstAuthor{% + \oldJointFirstAuthor\futurelet\nextToken\isOthernote} + +\let\oldfootnote\footnote +\renewcommand\footnote[1]{% + \oldfootnote{#1}\futurelet\nextToken\isOtherfnote} + +\newcommand\isOtherfnote{% + \ifx\footnote\nextToken\textsu{\mdseries,}% + \fi% +} + +%%% + +\DeclareDocumentCommand{\SetAuthorBlock}{}{% + \let\savethefootnote\thefootnote + \JoinCoffins\AuthorBlock[hc,b]\AffiliationsBlock[hc,t](0pt,-\baselineskip) + \centerline{\TypesetCoffin\AuthorBlock} + \renewcommand*{\thefootnote}{\fnsymbol{footnote}} + \ifJA + \footnotetext[2]{Joint first authors} + \fi + \ifCA + \footnotetext[1]{Corresponding author:\space\@CAemail} + \fi + \let\thefootnote\savethefootnote +} + +} %% end ifthenelse for Oldauthors +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +%%%% Make the title and author section \DeclareDocumentCommand{\MakeTitlePage}{}{% \twocolumn[ \begin{@twocolumnfalse} \HeaderConfName \paperno \papertitle - \vspace*{1\baselineskip} % <=== an additional line is embedded in \papertitle -\ConstructAuthorBlock + \vspace*{2\baselineskip} + \ifthenelse{\boolean{Oldauthors}}{% + \ConstructAuthorBlock}{% + \SetAuthorBlock} \vspace*{3\baselineskip} \end{@twocolumnfalse} ] +\let\@makefnmark\savemakefnmark \renewcommand*{\thefootnote}{\fnsymbol{footnote}} \ifJA \footnotetext[2]{Joint first authors} @@ -554,7 +703,6 @@ \let\thefootnote\savethefootnote } - %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% Provide sans serif upright Greek letters, following a suggestion |