asmeconf (5apr19)

git-svn-id: svn://tug.org/texlive/trunk@50785 c570f23f-e606-0410-a88d-b1316a301751

3 files changed, 77 insertions, 48 deletions

diff --git a/Master/texmf-dist/doc/latex/asmeconf/README.md b/Master/texmf-dist/doc/latex/asmeconf/README.md
index 7a685feebba..9bc006a6293 100644
--- a/Master/texmf-dist/doc/latex/asmeconf/README.md
+++ b/Master/texmf-dist/doc/latex/asmeconf/README.md
@@ -16,15 +16,39 @@
 
   The .tex and .cls files are commented and should be self-explanatory.
 
-  This is version 1.01 dated 2019/04/03.
+  This is version 1.02 dated 2019/04/04.
+  
+  
+
+  This template was designed to approach the following aims:
+
+  - match ASME's font specifications and layout precisely
+	
+  - match ASME's citation formats
+	
+  - support hyperlinks (for cross-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: John H. Lienhard V
+
+
+  Author: 
+  
+  John H. Lienhard V
   
-          Department of Mechanical Engineering
+  Department of Mechanical Engineering
           
-          Massachusetts Institute of Technology
+  Massachusetts Institute of Technology
           
-          Cambridge, MA 02139-4307 USA
+  Cambridge, MA 02139-4307 USA
 
 
  =========================================================
@@ -32,19 +56,19 @@
  
  LICENSE:
 
- Copyright (c) 2019 John Lienhard
+ Copyright (c) 2019 John H. 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, 
  including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
  and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 
- subject to the following conditions:
+ subject to the following two conditions:
 
  The above copyright notice and this permission notice shall be included in all copies or 
  substantial portions of the Software.
 
  The software is provided "as is", without warranty of any kind, express or implied, including but 
  not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. 
- in no event shall the authors or copyright holders be liable for any claim, damages or other liability, 
+ In no event shall the authors or copyright holders be liable for any claim, damages or other liability, 
  whether in an action of contract, tort or otherwise, arising from, out of or in connection with the 
  software or the use or other dealings in the software.
diff --git a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.pdf
index a9217c14650..6c76690d855 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 a493c17ee38..d346176a5ff 100644
--- a/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex
+++ b/Master/texmf-dist/doc/latex/asmeconf/asmeconf-template.tex
@@ -1,30 +1,34 @@
 %% 
-%%  This file is ASMEconf-class-template.tex, a template for ASME Conference papers the
-%%  requirements on ASME's conference web pages in March 2019.
-%%  (NB: ASME's journals follow specifications different from ASME conference papers.)
+%%  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.01 dated 2019/04/03
+%%  This file is version 1.02 dated 2019/04/04
 %%
 %%  Author: John H. Lienhard V
 %%          Department of Mechanical Engineering
 %%          Massachusetts Institute of Technology
 %%          Cambridge, MA 02139-4307 USA
 %%
-%%  Several new commands are defined by the asmeconf class; their use is illustrated below.
-%%  In particular, ASME requires capitalized, sans-serif section headings, and as a result some care  
-%%  is needed when using some macros in section headings, as also illustrated below.
-%%
 %%  Class options are described in the asmeconf.cls file. These include:
-%%          * math options from M. Sharpe's newtxmath package: upright integrals [upint]; and
+%%
+%%          * Math options from M. Sharpe's newtxmath package: upright integrals [upint]; and
 %%          *    varvw for a v and w that are better distinguished from greek nu; and also 
-%%          *    smallerops, varg, slantedGreek, frenchmath, varbb, cmbraces
-%%          * many options for calligraphic, script, and fraktur fonts from the mathalfa package; the
+%%          *    smallerops, varg, slantedGreek, frenchmath, varbb, cmbraces. Version 1.5 or higher
+%%          *    is recommended.
+%%
+%%          * Many options for calligraphic, script, and fraktur fonts from the mathalfa package; the
 %%          *    default values are: scr=dutchcal,cal=euler
-%%          * option to omit ASME copyright footer: nofoot
-%%          * option not to use newtxtext's superiors font for footnotes [nodefaultsups] and option
+%%
+%%          * An option to omit the ASME copyright footer: nofoot
+%%
+%%          * An option not to use newtxtext's superiors font for footnotes [nodefaultsups] and an option
 %%          *    for slightly larger small capitals, largesc
 %%
-%%  For details of newtxmath and mathalfa, see 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 
+%%  when using macros in section headings, as also illustrated below.
 %%
  %=========================================================
 %% 
@@ -43,7 +47,7 @@
 %%
 %% The software is provided "as is", without warranty of any kind, express or implied, including but 
 %% not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. 
-%% in no event shall the authors or copyright holders be liable for any claim, damages or other liability, 
+%% In no event shall the authors or copyright holders be liable for any claim, damages or other liability, 
 %% whether in an action of contract, tort or otherwise, arising from, out of or in connection with the 
 %% software or the use or other dealings in the software.
 %%
@@ -70,19 +74,19 @@
    City, State, Country}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%   Fields to be completed %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%   Fields to be completed   %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 %%%%%  pdf metadata and colors   %%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%  The user should edit as desired  %%%%%%%%%%%%
 
 \hypersetup{%
-	colorlinks=true,%%% <=== change to false to get black type for links (ASME sometimes requests this)
+	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},    % <=== add your pdf file title
-	pdfkeywords={ASME, Paper, Template, \LaTeX, Research}, % <=== add your pdf keywords
-	pdfauthor={John H. Lienhard},  % <=== change this to YOUR name[s]!!!
+	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]!!!
 }
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -100,9 +104,9 @@
 
 \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 for joint first authors and for corresponding author.
-% (Most of the example names below are not real people.)
+% 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.)
 
 \SetAuthorBlock{Luis Hern\'{a}ndez\JointFirstAuthor}{\Affiliation} 
 \SetAuthorBlock{Maria Silva\JointFirstAuthor}{\Affiliation}
@@ -123,7 +127,7 @@ Rohsenow Kendall Heat Transfer Lab \\ Department of Mechanical Engineering
 
 %%% Change these to your keywords.  Keywords are automatically printed at the end of the abstract.
 %%% This command must come BEFORE the end of the abstract.
-%%%    If you don't want keywords, delete the command.
+%%% If you don't want keywords, delete the command.
 
 \keywords{ASME, Paper, Template, \LaTeX, Research}
 
@@ -159,7 +163,7 @@ For a section heading that includes more complicated math (and macros), you may
 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!
+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 figure %%%%%%%%%%%%%%%%%
 
@@ -176,7 +180,7 @@ The rest of this text uses Latin to show layout and usage. Refer to the \texttt{
 %% 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}}$}
 
-\lipsum[6-7] %%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
+\lipsum[6-7] % <=== This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
 
 
 %%%%%%%%%%%%%%% begin simple table %%%%%%%%%%%%%%%%%%%%%%%%%% 
@@ -241,7 +245,7 @@ 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}}
 
-\lipsum[7-8] %%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
+\lipsum[7-8] % <=== This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
 
 
 
@@ -249,11 +253,12 @@ Our competitor's test                &  72.321   &  141.384 \\
 %% Note that \dot or \vec go outside \mathsf{..}
 \subsection*{Subsection with math: $\bm{\dot{\mathsf{S}}_{\textsf{gen}}}$ \cite{bejan}.}
 
-\lipsum[10] 
+\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}
-\lipsum[12-13] 
+\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}
 d\vec{w} =
    \begin{pmatrix}
@@ -297,19 +302,19 @@ d\vec{w} =
 \end{table*}
 %%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%% 
 
-\lipsum[16]%%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
+\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!
+\lipsum[17] % <=== This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
 
 
 
 %%%  NOMENCLATURE  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%
-%% To add more space between the symbols and their definitions, use \begin{nomenclature}[Xcm] where X is a number 
+%% 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.
 
 \begin{nomenclature}
 \entry{\textit{Roman letters}}{}
@@ -336,30 +341,30 @@ d\vec{w} =
 %% This specific .bst style allows: venue = {location of conference}, and confmonth = {Month days}
 %%
 
-\nocite{*} %% <=== delete this line unless you want to typeset the entire contents of your .bib file.
-\bibliographystyle{asmeconf}     %% .bst file following ASME conference format
+\nocite{*} %% <=== delete this line if you do not 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
 
 %%%  APPENDICES  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \appendix
 
 \section{First appendix}
-\lipsum[20]%%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
+\lipsum[20] % <=== This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
 
 
 %% 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}}$}
 
-\lipsum[21]%%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
+\lipsum[21] % <=== This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
 \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}
-\lipsum[22]%%% This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
+\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!
+\lipsum[23] % <=== This command generates paragraphs of fake Latin.  Delete it here and elsewhere!
 
 \end{document}