diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex')
| -rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex | 56 |
1 files changed, 35 insertions, 21 deletions
diff --git a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex index bc2fb371c01..4010bd1f0e7 100644 --- a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex +++ b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex @@ -1,12 +1,13 @@ +% !TEX encoding = UTF-8 Unicode %% %% This file is asmeconf-template.tex, a template to format ASME Conference papers according to -%% the requirements on ASME's conference web pages. As of version 1.11, 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. +%% the requirements on ASME's conference web pages. %% -%% This file is version 1.15 dated 2020/01/24. +%% This file is version 1.17 dated 2020/02/29 +%% +%% 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 (old format is also supported) +%% Nomenclature now follows the abstract. Abstract is in italics. %% %% Author: John H. Lienhard V %% Department of Mechanical Engineering @@ -62,7 +63,7 @@ %% %% LICENSE: %% -%% Copyright (c) 2019 John Lienhard +%% Copyright (c) 2020 John Lienhard %% %% Permission is hereby granted, free of charge, to any person obtaining a copy of this software and %% associated documentation files (the "Software"), to deal in the Software without restriction, @@ -83,9 +84,9 @@ %% Class options are described above. + \documentclass[varvw,largesc,upint,mathalfa=cal=euler,colorlinks,hyphenate,balance]{asmeconf} % <=== remove colorlinks for submission to ASME -\pdfminorversion=7 % This selection is not required. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%% Fields to be completed %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -116,7 +117,7 @@ % 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. +% LaTeX will automatically set the title in all capital letters. \title{Place Title Here: Place Subtitle After Colon} % <=== change to YOUR title @@ -130,7 +131,7 @@ %% %% \JointFirstAuthor, if applicable, follows the affiliation of the relevant authors, no spaces. -\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}} +\SetAuthors{Luis Hern\'andez\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} @@ -157,7 +158,7 @@ %% %% Abstract should be no more than 200 words \begin{abstract} -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 December 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\ Live and on CTAN. +This paper is an example and template for typesetting ASME Conference Papers in {\upshape\LaTeX} using the {\upshape\texttt{asmeconf}} class. This class follows ASME guidelines for margins, fonts, headings, captions, and reference formats as of early 2020. The class is 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} \hologo{BibTeX}} 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 {\upshape\TeX\ Live} and on CTAN. The class is compatible with {\upshape\hologo{pdfLaTeX}} or {\upshape\hologo{LuaLaTeX}}. \end{abstract} %%%%%%%%% NOMENCLATURE (OPTIONAL) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -248,9 +249,6 @@ If you wish to override the default math format in captions, put \verb|\mathvers \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. -\subsection{Colored hyperlinks} -ASME requires that all text be in black when the paper is submitted for publication. For other uses, authors may -obtain colored hyperlinks with the [\texttt{colorlinks}] option. %%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%% @@ -297,7 +295,7 @@ Our competitor's test & 72.321 & 141.384 \\ 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. -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. +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 handles by the standard \texttt{graphicx} package. Landscape figures and tables may be produced at full-page size by putting \verb|\usepackage[figuresright]{rotating}| in your \texttt{.tex} file's preamble and using the \texttt{sidewaystable*} and \texttt{sidewaysfigure*} environments~\cite{fairbairns}. @@ -331,9 +329,9 @@ 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.}} -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. +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. Citations and references are managed by the standard \texttt{natbib} package. -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. +The {\upshape\texttt{asmeconf.bst}} \hologo{BibTeX} style follows the reference styles posted on ASME's conference web site in early 2020. Examples for these and many other cases are given in the \texttt{asmeconf-sample.bib} file, which is part of this distribution. Nevertheless, a few comments are necessary. %% subsubsections are not numbered \subsubsection*{DOI, URL, and eprint} Include DOI numbers when they are available. URL's may alternatively be given. @@ -390,8 +388,15 @@ which selects the Euler font for \verb|\mathcal| (this is our default). To find 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. + +%%%%%%%%%%%%%%% ADDITIONAL PACKAGE OPTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{Additional Options for \NoCaseChange{\texttt{asmeconf.cls}}} -The class accepts a number of options in addition to those already described. +The class accepts a number of options in addition to those already described. These options are discussed next. + +\subsection{Colored hyperlinks} +ASME requires that all text be in black when the paper is submitted for publication. For other uses, authors may +obtain colored hyperlinks with the [\texttt{colorlinks}] option. \subsection{Final Column Balancing} The option \texttt{[balance]} invokes the the \texttt{flushend} package~\cite{tolusis}. This package will attempt to give equal height to the two columns on the last page. The performance of this package is sometimes inconsistent (with odd page layout or, very rarely, errors), so use this option with caution. @@ -410,6 +415,8 @@ The footers are generated with the \texttt{fancyhdr} package~\cite{oostrum}, so \subsection{Hyphenation of Typewriter Font} The option \texttt{[hyphenate]} will allow hyphenation of the typewriter font. Hyphenation is normally suppressed for typewriter mode because this font is often used for code. +\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. + %%%%%%%%%%%%%%% begin two column table %%%%%%%%%%%%%%%%%% \begin{table*}[t] @@ -501,11 +508,11 @@ the option [\texttt{oldauthors}]. When using this form, the author names and ad \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. +%% directly usable code follows \end{document}, below. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\section{Language Support} +\section{Language Support}\label{appendix:c} ASME publishes in English, but the \texttt{babel} package is loaded for users who may wish to include other languages. Options are supported to load a primary language, \texttt{lang=}, as well @@ -513,11 +520,18 @@ as a secondary and tertiary language, \texttt{lang-second} and \texttt{lang-thir The standard caption and section names will follow \texttt{babel}'s dictionary for primary languages other than English. Users may additionally change ``Keywords'', ``Nomenclature'', ``Corresponding author'', and ``Joint first authors'' by renewing the commands \verb|\keywordname|, \verb|\nomname|, \verb|\CAwords|, and \verb|\JAwords|. Changes to the page footer were described earlier. The pdf bookmark for ``Appendices'' may be changed by renewing \verb|\appendicesname|. -No effort has been made to support customization of language-specific fonts, although this is possible by modifying the class file (examples are given in the \texttt{newtx} documentation). The bibliography style, \texttt{asmeconf.bst}, is designed in English and aimed at \texttt{BibTeX}. Multilingual bibliographies can be supported using \texttt{BibLaTeX}. +Font encoding is set to T1 with utf-8 input supported: +%% 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.} +àáâäæãåā èéęëêēė îïíīįì ôöòóœøōõ ûüùúū çćč ł ñń ßśš ÿ žźż. + +No effort has been made to support customization of language-specific fonts, although this is possible by modifying the class file (examples are given in the \texttt{newtx} documentation). The bibliography style, \texttt{asmeconf.bst}, is designed in English and aimed at \hologo{BibTeX}. Multilingual bibliographies can be supported using \texttt{BibLaTeX}. \end{document} +%%% This is the set-up for the old author block style, a grid of blocks. + % 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. |