diff options
Diffstat (limited to 'Master/texmf-dist/doc')
| -rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/README.md | 75 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf | bin | 276707 -> 288095 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex | 140 |
3 files changed, 133 insertions, 82 deletions
diff --git a/Master/texmf-dist/doc/latex/asmeconf/README.md b/Master/texmf-dist/doc/latex/asmeconf/README.md index 1f5e07798e1..a8237c6e3ec 100644 --- a/Master/texmf-dist/doc/latex/asmeconf/README.md +++ b/Master/texmf-dist/doc/latex/asmeconf/README.md @@ -1,47 +1,52 @@ + #asmeconf: A template for ASME conference papers# + + Version 1.07 dated 2019/04/20. + + ####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). + [www.asme.org/shop/proceedings/conference-publications/author-guidelines](https://www.asme.org/shop/proceedings/conference-publications/author-guidelines) + This work is not a publication of ASME itself. Files in this distribution are: - README.md -- this file - asmeconf.cls -- the class file - asmeconf.bst -- bibtex style for ASME conference format - asmeconf-template.tex -- a latex template/example for this class - asmeconf-template.pdf -- documentation/sample paper - asmeconf-sample.bib -- a sample bibliography file + README.md -- this file + asmeconf.cls -- the class file + asmeconf.bst -- bibtex style for ASME conference format + asmeconf-template.tex -- a latex template/example for this class + asmeconf-template.pdf -- documentation/sample paper + asmeconf-sample.bib -- a sample bibliography file * sample-figure-1.pdf, sample-figure-2a.pdf, sample-figure-2b.pdf -- figures for the example The .tex and .cls files are commented and should be self-explanatory. - This is version 1.03 dated 2019/04/06. This template was designed to approach the following aims: - - match ASME's font current specifications and layout - - - match ASME's current citation formats - - - support use of hyperref package (hyperlink references to figures, tables, citations, and web) - - - support pdf bookmarks - - - use the newtxtext and newtxmath font packages, which enable a variety of text and math features - - - support math and footnotes in section headings - - - include sans serif greek font for use in captions and headings - - - provide automatic layout of author blocks for up to nine addresses - - - - Author: +- match ASME's font current specifications and layout + +- match ASME's current citation formats + +- support use of hyperref package (hyperlink references to figures, tables, citations, and web) + +- support pdf bookmarks + +- use the newtxtext and newtxmath font packages, which enable a variety of text and math features + +- 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 + + + ####Author#### John H. Lienhard V @@ -52,10 +57,22 @@ Cambridge, MA 02139-4307 USA - ========================================================= - + --- + + ####Change log#### + + 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 + + v1.05: minor code clean-up; change to keyvalue for to control font for superiors + + v1.04: fix option passing for mathalfa package; adjust \\entry to create nomenclature subheadings efficiently. + + + --- - LICENSE: + ####License#### Copyright (c) 2019 John H. Lienhard 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 005127e2316..2c258f382d8 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 cb71473a054..c5221e74a5a 100644 --- a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex +++ b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex @@ -2,7 +2,7 @@ %% 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). %% -%% This file is version 1.03 dated 2019/04/06 +%% This file is version 1.07 dated 2019/04/20 %% %% Author: John H. Lienhard V %% Department of Mechanical Engineering @@ -17,14 +17,16 @@ %% * is recommended. %% %% * Many options for calligraphic, script, and fraktur fonts from the mathalfa package; the -%% * default values are: scr=dutchcal,cal=euler +%% * example value used is: mathalfa=cal=euler (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 controlled. %% %% * An option to omit the ASME copyright footer: nofoot %% -%% * An option not to use newtxtext's superiors font for footnotes [nodefaultsups] and an option +%% * An optional to use newtxtext's superiors font for footnotes [nodefaultsups] and an option %% * for slightly larger small capitals, largesc %% -%% For details of newtxmath and mathalfa, refer to their documentation (available on CTAN: http://ctan.org) +%% 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, %% ASME requires capitalized, sans-serif section headings, and as a result some care is needed @@ -54,13 +56,12 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - %% Class options are described above. -\documentclass[varvw,largesc,upint]{asmeconf} +\documentclass[varvw,largesc,upint,mathalfa=cal=euler]{asmeconf} -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -%% Editing tools, can delete if not using them +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% The following are editing tools, can delete if not using them \usepackage{lipsum} % Generates paragraphs of gibberish latin for checking layout ... e.g. \lipsum[2-4] produces % paragraphs 2 through 4 of the text. @@ -68,10 +69,10 @@ %% Filler names for Author and affiliation blocks on title page \def\AuthorName{Name[s] of Author[s]} -\long\def\Affiliation{Department of Mechanical Engineering\\ - Institution or Company Name\\ - Street address\\ - City, State, Country} +\long\def\Affiliation{Institution or Company Name \\ +Department of Mechanical Engineering\\ +Street address\\ +City, State, Country} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%% Fields to be completed %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -98,15 +99,22 @@ \ConfName{Proceedings of the ASME 2018 \linebreak International Mechanical Engineering Congress and Exposition} \ConfAcronym{IMECE18} -\ConfDate{November 9-15, 2018} -\ConfCity{Pittsburgh, PA, USA} +\ConfDate{November 9--15, 2018} +\ConfCity{Pittsburgh, Pennsylvania, USA} \PaperNo{IMECE2018-XXXX} + +% Units of measure and other specialty lowercase terms in the title should be +% enclosed in \NoCaseChange{...} to maintain lower case type + \PaperTitle{Our research paper: the latest developments in cutting-edge engineering} + % 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. -% (Most of the example names below are not real people, just very common names.) +% 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} @@ -116,11 +124,18 @@ \SetAuthorBlock{Yusuf Yilmaz}{\Affiliation} %\SetAuthorBlock{Amelia Smith}{\Affiliation} %\SetAuthorBlock{Aadhya Acharya}{\Affiliation} -%\SetAuthorBlock{Omar Abu Bakr}{\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. \SetAuthorBlock{\CorrespondingAuthor{John H.\ Lienhard V}{lienhard@mit.edu}}{% -Rohsenow Kendall Heat Transfer Lab \\ Department of Mechanical Engineering -\\ Massachusetts Institute of Technology \\ Cambridge, MA 02139 USA} +Massachusetts Institute of Technology \\ Rohsenow Kendall Heat Transfer Lab +\\ Department of Mechanical Engineering +\\ Cambridge, MA 02139 USA} + \MakeTitlePage @@ -134,6 +149,7 @@ Rohsenow Kendall Heat Transfer Lab \\ Department of Mechanical Engineering %%%%%%%%%%%%%%%%%%%%% End of fields to be completed. Now write! %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% 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}). \end{abstract} @@ -152,43 +168,50 @@ ASME does not specify a standard nomenclature list. Be sure to put your symbols %% Use title case for subsections and subsubsections -\subsection*{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 you really want to have them.} +\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.} + +Text in section headings and captions will not be capitalized if enclosed in a \verb|\NoCaseChange{...}| command. -Simple math can be used in either captions or section headings, but see the \texttt{asmeconf.tex} source file for examples of how to deal with more complicated expressions. +Sections may either be numbered or left unnumbered. -To get bold math, you can use the \verb|\bm{..}| macro from the \texttt{bm} package, which is loaded by the class. To get sans serif math, you can use \verb|\mathsf{..}|. So, you can write \verb|\bm{\mathsf{A+B}}| to put a bold, sans serif expression in a caption. The class file provides for sans serif greek letters by using \verb|\sfalpha| and similar expressions (e.g.\ $\sfalpha, \sfbeta, \sfgamma, \sfdelta \ldots$) for use in captions and headings (see Fig.\ \ref{fig:1}). +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. -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. -Text in section headings and captions will not be capitalized if enclosed in a \verb|\NoCaseChange{...}| command. +\subsection*{Subsection Headings in Title Case} +Subsections and sub-subsection headings should be in title case (first letter of primary words capitalized). + +\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. + +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}} +\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). + +\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}). + +The text in tables and figures should be no smaller than 7~point type. %%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%% %% captions go below figures - \begin{figure} \centering\includegraphics[width=0.7\linewidth]{sample-figure-1.pdf} -\caption{A figure caption with math, $\bm{\mathsf{z = (r,\sfphi)}}$ \cite{Lienhard2019b}\label{fig:1}} -%% note: \sfphi is sans serif \phi, defined by the class file. +\caption{A figure caption with math, $z = (r,\phi)$ \cite{Lienhard2019b}\label{fig:1}} \end{figure} %%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%% -\subsubsection*{Subsection Headings in Title Case} -Subsections and sub-subsection headings should be in title case (first letter of primary words capitalized). -The rest of this text uses Latin to show layout and usage. Refer to the \texttt{.tex} file for further details. -\subsubsection*{Latin for Layout} -\lipsum[4-5] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! - - -%% Dealing with complicated math in a section heading: optional argument provides the pdfbookmark -%% without losing characters or producing warnings/errors. -\section*[Math in a section heading: u\cdot\omega=0]{Math in a section heading: $\bm{\vec{\mathsf{u}}\cdot\vec{\sfomega}=\mathsf{0}}$} - -\lipsum[6-7] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +\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. +\lipsum[4-5] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! %%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%% @@ -210,7 +233,6 @@ Run 12 & 24 & 68.3 \\ %%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - %%%%%%%%%%%%%%% begin more complicated table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \begin{table}[t] @@ -231,6 +253,14 @@ Our competitor's test & 72.321 & 141.384 \\ %%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% 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$} + +\lipsum[6] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! + + %%%%%%%%%%%%%%%%% begin wide figure %%%%%%%%%%%%%%%%%%%%%%%%%%% \begin{figure*}[t] @@ -252,15 +282,17 @@ Our competitor's test & 72.321 & 141.384 \\ -\section*{Entropy generation\footnote{If you have text in a section heading or caption that you do not want to be capitalized, enclose it in a \texttt{\textbackslash NoCaseChange} command.} is always interesting and important \cite{bejan}} +\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}} -\lipsum[7-8] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +\lipsum[5] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! +%% 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}.} + +%% 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}$.} -%% Subsections with math do not need any special handling because they are neither uppercased nor bookmarked -%% Note that \dot or \vec must go outside of \mathsf{..} -\subsection*{Subsection with Math: $\bm{\dot{\mathsf{S}}_{\textsf{gen}}}$ \cite{bejan}.} \lipsum[10] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! @@ -319,25 +351,27 @@ d\vec{w} = -%%% NOMENCLATURE %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%% 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{\textit{Roman letters}}{} +\entry{Roman letters} \entry{$k$}{Thermal conductivity [W m$^{-1}$ K$^{-1}$]} \entry{$\vec{q}$}{Heat flux vector [W m$^{-2}$]} -\entry{\textit{Greek letters}\rule{0pt}{13pt}}{} +\entry{Greek letters} \entry{$\alpha$}{Thermal diffusivity [m$^2$ s$^{-1}$]} \entry{$\nu$}{Kinematic viscosity [m$^2$ s$^{-1}$]} -\entry{\textit{Dimensionless groups}\rule{0pt}{13pt}}{} +\entry{Dimensionless groups} \entry{Pr}{Prandtl number, $\nu/\alpha$} -\entry{\textit{Superscripts and subscripts}\rule{0pt}{13pt}}{} +\entry{Superscripts and subscripts} \entry{b}{bulk value} \entry{$\infty$}{free stream value} @@ -358,10 +392,10 @@ d\vec{w} = \appendix %% Note that appendices will be "numbered" A, B, C, ... etc. Use \section, not \section* -%% Equations should be numbered sequentially following those in the paper. Don't reset the counter. +%% 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 $\bm{\vec{\mathsf A}\times\vec{\mathsf B}}$} +\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! \begin{align} @@ -370,7 +404,7 @@ d\vec{w} = &{}= \iint_{\mathcal{S}} \nabla p \times \nabla \left( \frac{1}{\rho}\right) \cdot d\mathbf{A} \end{align} -%% Subsection headings are no numbered in appendices +%% This subsection heading is not numbered \subsection*{Subsection Heading} \lipsum[22] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! |