diff options
author | Karl Berry <karl@freefriends.org> | 2019-04-07 21:26:15 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2019-04-07 21:26:15 +0000 |
commit | d578aaf87d2c19066d0ab502d7d2fbce79edf15e (patch) | |
tree | 7e5bcacb966ea30f54077c8366b432ac2a172fd2 /Master/texmf-dist/doc/latex/asmeconf | |
parent | d7b336d29865600e490cf2c0a4e209e13cb2988c (diff) |
asmeconf (7apr19)
git-svn-id: svn://tug.org/texlive/trunk@50845 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/asmeconf')
-rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/README.md | 21 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf | bin | 277139 -> 276707 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex | 54 |
3 files changed, 43 insertions, 32 deletions
diff --git a/Master/texmf-dist/doc/latex/asmeconf/README.md b/Master/texmf-dist/doc/latex/asmeconf/README.md index 9bc006a6293..1f5e07798e1 100644 --- a/Master/texmf-dist/doc/latex/asmeconf/README.md +++ b/Master/texmf-dist/doc/latex/asmeconf/README.md @@ -6,27 +6,28 @@ 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.02 dated 2019/04/04. + This is version 1.03 dated 2019/04/06. This template was designed to approach the following aims: - - match ASME's font specifications and layout precisely + - match ASME's font current specifications and layout - - match ASME's citation formats + - match ASME's current citation formats - - support hyperlinks (for cross-references to figures, tables, citations, and web) + - support use of hyperref package (hyperlink references to figures, tables, citations, and web) - support pdf bookmarks 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 6c76690d855..005127e2316 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 d346176a5ff..cb71473a054 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.02 dated 2019/04/04 +%% This file is version 1.03 dated 2019/04/06 %% %% Author: John H. Lienhard V %% Department of Mechanical Engineering @@ -151,7 +151,8 @@ Equations are typeset in the usual way. The class file loads the \texttt{amsmat ASME does not specify a standard nomenclature list. Be sure to put your symbols into the nomenclature list, including SI units. -\subsection*{Section headings and captions} +%% 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.} 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. @@ -160,31 +161,39 @@ To get bold math, you can use the \verb|\bm{..}| macro from the \texttt{bm} pack 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. -Text in section headings and captions will not be capitalized if enclosed in a \verb|\NoCaseChange{...}| command. - -\subsubsection*{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! +Text in section headings and captions will not be capitalized if enclosed in a \verb|\NoCaseChange{...}| command. %%%%%%%%%%%%% 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: \upphi is upright \phi under the newtxmath package used here. +%% note: \sfphi is sans serif \phi, defined by the class file. \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: a=0]{Math in a section heading: $\bm{\vec{\mathsf{a}}=\mathsf{0}}$} +\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! %%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%% - + +%% captions go above tables + \begin{table}[t] \caption[Table]{A simple table\label{tab:1}} \centering{% @@ -203,7 +212,7 @@ Run 12 & 24 & 68.3 \\ %%%%%%%%%%%%%%% begin more complicated table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - + \begin{table}[t] \caption{Table with more complicated columns}\label{tab:2}% \centering{% @@ -249,14 +258,14 @@ Our competitor's test & 72.321 & 141.384 \\ -%% Subsections with math do not need special handling because they are neither uppercase nor bookmarked -%% Note that \dot or \vec go outside \mathsf{..} -\subsection*{Subsection with math: $\bm{\dot{\mathsf{S}}_{\textsf{gen}}}$ \cite{bejan}.} +%% 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! -\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} +\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} \lipsum[12-13] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! \begin{equation}\label{eqn:dw} @@ -341,19 +350,18 @@ d\vec{w} = %% This specific .bst style allows: venue = {location of conference}, and confmonth = {Month days} %% -\nocite{*} %% <=== delete this line if you do not want to typeset the entire contents of your .bib file. +\nocite{*} %% <=== delete this line unless you want to typeset the entire contents of your .bib file. \bibliographystyle{asmeconf} %% .bst file following ASME conference format. Do not change. -\bibliography{asmeconf-sample} %% name of your bib file +\bibliography{asmeconf-sample} %% <=== change this to name of your bib file %%% APPENDICES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \appendix -\section{First appendix} -\lipsum[20] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! - +%% 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. %% Here we use the optional argument for the pdf bookmark. -\section[The vector product AxB]{The vector product $\bm{\vec{\mathsf A}\times\vec{\mathsf B}}$} +\section[The vector product A\times B]{The vector product $\bm{\vec{\mathsf A}\times\vec{\mathsf B}}$} \lipsum[21] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! \begin{align} @@ -361,10 +369,12 @@ d\vec{w} = &{}= \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} + +%% Subsection headings are no numbered in appendices +\subsection*{Subsection Heading} + \lipsum[22] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! -\subsection*{A subsection in an appendix} -\lipsum[23] % <=== This command generates paragraphs of fake Latin. Delete it here and elsewhere! \end{document} |