summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-08-17 21:49:47 +0000
committerKarl Berry <karl@freefriends.org>2019-08-17 21:49:47 +0000
commit2d45bbc3808e2279c0692dbc1d9fabd5df78aa9b (patch)
treec582f9781651679cb6007b70db8d0fa15287bafc /Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex
parentdda9c46d07ac6ba3d9b27ed0093379975e66282d (diff)
asmejour (17aug19)
git-svn-id: svn://tug.org/texlive/trunk@51892 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex')
-rw-r--r--Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex72
1 files changed, 38 insertions, 34 deletions
diff --git a/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex b/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex
index 724e8fd680a..fb4dad7fba9 100644
--- a/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex
+++ b/Master/texmf-dist/doc/latex/asmejour/asmejour-template.tex
@@ -2,9 +2,9 @@
%%
%% This file is asmejour-template.tex, a template to format papers in the style of ASME journal papers
-%% as they are being published in early 2019.
+%% as they are being published in 2019.
%%
-%% This file is version 1.04 dated 2019/07/05
+%% This file is version 1.05 dated 2019/08/17
%%
%% Author: John H. Lienhard V
%% Department of Mechanical Engineering
@@ -17,7 +17,7 @@
%% * where colorname is any name def'd by xcolor package; omit barcolor option to get black
%%
%% * Option to include line numbers [lineno]. The lineno package does not number equation
-%% * lines, captions, etc. You must run twice for proper placement.
+%% * lines, captions, etc. You must run twice for proper placement of the line numbers.
%% * This option will disable balancing column height on final page.
%%
%% * Math options from M. Sharpe's newtxmath package: upright integrals [upint]; and
@@ -33,11 +33,16 @@
%% * An option to omit all the ASME text fields from the footer: nofoot
%% * An option to omit only the ASME copyright field from the footer: nocopyright
%%
-%% * An optional to use newtxtext's superiors font for footnotes [nodefaultsups] and an option
+%% * An option to use newtxtext's superiors font for footnotes [nodefaultsups] and an option
%% * for slightly larger small capitals, largesc
%%
%% * Options to set (for the babel package) a primary language [lang= ], and secondary or tertiary
-%% * languages, [lang-second] and [lang-third]. The primary language must be given last.
+%% * languages, [lang-second] and [lang-third]. The primary language must be the last option given.
+%%
+%% * Option to omit the list of figures and list of tables [nolists]
+%%
+%% * Option to allow hyphenation of the typewriter font [hyphenate]
+%% * Hyphenation is normally suppressed for typewriter mode because it is often used for code.
%%
%% For details of newtxmath and mathalfa, refer to their documentation (available on CTAN: http://ctan.org).
%%
@@ -71,7 +76,9 @@
%% Class options are described above.
-\documentclass[largesc,upint,varvw,barcolor=Red4,nocopyright,lang-second=french,lang=english]{asmejour}
+\documentclass[largesc,upint,varvw,barcolor=Red4,nocopyright,hyphenate,lang-second=french,lang=english]{asmejour}
+
+\pdfminorversion=7 % This selection is not required.
%%%%% FIELDS TO BE COMPLETED FOLLOW %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -80,7 +87,7 @@
%%%%% pdf metadata, the user should edit %%%%%%%%%%%%%%%%%%
\hypersetup{%
pdftitle={ASME Journal Paper Template}, % <=== change to YOUR pdf file title
- pdfkeywords={ASME, Paper, Template, LaTeX, BibTeX}, % <=== change to YOUR pdf keywords
+ pdfkeywords={ASME, Paper, Template, LaTeX, BibTeX, asmejour class}, % <=== change to YOUR pdf keywords
pdfauthor={John H. Lienhard}, % <=== change to YOUR name[s]!!!
}
@@ -91,11 +98,11 @@
%% If Journal Name is quite long, use \\ to insert a line break
\JourName{Heat Transfer} %<=== change to name of your journal
-\PaperYear % defaults to current year if no argument or omitted;
+\PaperYear % defaults to current year if no argument given or if command is omitted;
% \PaperYear{} omits year; \PaperYear{2018} sets 2018.
-
-
-%%%%%%%%% End of Preamable %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+
+%%%%%%%%% End of Preamble %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}
@@ -160,7 +167,7 @@ To begin, fill in the fields to be completed at top of the \texttt{asmejour-temp
For each author, put author names and affiliation (with line breaks) into a separate \verb|\SetAuthorBlock{name}{affiliation}| command; follow the syntax illustrated \texttt{asmejour-template.tex} file. One author (or more) may be designated as the \verb|\CorrespondingAuthor| by placing the command at the end of the name.
-The title should be placed into \verb|\SetTitle{..}|, and line breaks may be included if desired. 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.
+The title should be placed into \verb|\SetTitle{..}|, and line breaks may be included if desired. 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 italicized.
After setting up the authors, title, and abstract, issue the \verb|\MakeTitlePage| command.
@@ -307,7 +314,8 @@ Elementary support for \texttt{eprint} numbers is also included, generating a ur
\subsection{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.
-\subsection{Version Number\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.}} The \verb|version={..}| field may be used with \verb|@book|, \verb|@online|, and \verb|@manual|. By default, the text will read \texttt{Version `number'} as in \cite{sharpe1,sharpe2}, but different wording may be selected using the \verb|versiontype={..}| field, to have ``Revision'' or something similar, as in \cite{GSL}. ASME often puts the version in the title, as in \cite{dlmf, texshop}, so I've left the final decision for discussion between the authors and the copy editor.
+\subsection{Version Number\protect\footnote{Footnotes can appear in \texttt{\string\section} commands. However, when the \texttt{[lineno]} option is used either: i) write \texttt{\string\protect\string\footnote\{..\}}; or ii) include the optional argument, as in \texttt{\string\section[Foo]\{Foo\string\footnote\{..\}\}}.\label{ftnt:3}}}
+The \verb|version={..}| field may be used with \verb|@book|, \verb|@online|, and \verb|@manual|. By default, the text will read \texttt{Version `number'} as in \cite{sharpe1,sharpe2}, but different wording may be selected using the \verb|versiontype={..}| field, to have ``Revision'' or something similar, as in \cite{GSL}. ASME often puts the version in the title, as in \cite{dlmf, texshop}, so I've left the final decision for discussion between the authors and the copy editor.
%%%%%%%%%%%%%%% begin more complicated table %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -333,13 +341,18 @@ Our competitor's data & 72.321 & 141.384 \\[1pt]
%%%%%%%%%%%%%%%%% begin two column figure %%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{figure*}[t]
-\begin{minipage}[c]{0.5\textwidth}
+\begin{minipage}[t]{0.497\textwidth}
+\vbox{
+\vspace*{1.7em}
\centering{
\includegraphics{sample-figure-2a.pdf}
+}
+\vspace*{1.7em}
+}
\subcaption{Interior region\label{fig:interior-region}}
-}\end{minipage}
+\end{minipage}
%%%%%%%% don't leave a break here
-\begin{minipage}[c]{0.5\textwidth}
+\begin{minipage}[t]{0.497\textwidth}
\centering{
\includegraphics{sample-figure-2b.pdf}
\subcaption{Exterior region\label{fig:exterior-region}}
@@ -354,9 +367,12 @@ Our competitor's data & 72.321 & 141.384 \\[1pt]
\section{Additional Options for \texttt{asmejour.cls}}
The class accepts a number of options in addition to those already described.
-\subsection{Line Numbers} The option \texttt{[lineno]} invokes the the \texttt{lineno} package. This will produce line numbers in the margins. You must run \LaTeX\ twice for proper placement. The \texttt{lineno} package is not compatible with the \texttt{balance} package that makes final short columns the same height. Balancing will be disabled when this option is called. See the documentation of the \texttt{lineno} package for further commands to control line numbering.
+\subsection{Line Numbers} The option \texttt{[lineno]} invokes the the \texttt{lineno} package~\cite{bottcher}. This will produce line numbers in the margins. You must run \LaTeX\ twice for proper placement. The \texttt{lineno} package is not compatible with the \texttt{flushend} package that makes final short columns the same height. Balancing is disabled when this option is called. See the documentation of the \texttt{lineno} package for further commands to control line numbering. See footnote~\ref{ftnt:3} with regard to footnotes in section headings while this option is in~effect.
+
+\subsection{Changing the Footer Text} The option \texttt{[nofoot]} will omit everything other than a page number from the page footer. The option \texttt{nocopyright} will omit the ASME copyright from the first page footer. The command \verb|\PreprintString{..}| replaces the words \textsf{PREPRINT FOR REVIEW}. The left and right preprint strings can be changed separately using an optional argument: \verb|\PreprintString{..}[L]| and \verb|\PreprintString{..}[R]|.
+The final paper number may be added to the page number using \verb|\PaperNumber{..}|.
-\subsection{Changing the Footer Text} The option \texttt{[nofoot]} will omit everything other than a page number from the page footer. The option \texttt{nocopyright} will omit the ASME copyright from the first page footer. The command \verb|\PreprintString{..}| replaces the words \textsf{PREPRINT FOR REVIEW}. The final paper number may be added to the page number using \verb|\PaperNumber{..}|.
+The footers are all generated with the \texttt{fancyhdr} package~\cite{oostrum}, so you can change them in any way you like using the commands of that package.
\subsection{Superiors Font} The \texttt{newtxtext} package includes a superiors font (both numbers and letters) for use in footnote markers and superscripts. To enable this font, use the option \texttt{[nodefaultsups]}. The corresponding author mark in the author block will not change.
@@ -383,7 +399,7 @@ q_\textrm{gray} & q_\textrm{int, $T_1$} & q_\textrm{int, $T_m$} & q_\textrm{exa
%%%%%%%%%%%%%%%%%%%% end linewidth table %%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Dealing with complicated math in a section heading: optional argument of \section provides the pdfbookmark
%% without losing characters or producing warnings/errors. Note that bookmark can include simple math.
%%
@@ -497,7 +513,7 @@ Acknowledge individuals, institutions, or companies that supported the authors i
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Dealing with Wide Equations}
-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}. An example appears in Appendix~\ref{app:zetafunction}. An alternative solution may be to set large equations into two-column-wide tables or figures. While some code exists for setting equations to span two columns, such code has performed fairly erratically with this package.
+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}. An example appears in Appendix~\ref{app:zetafunction}. An alternative solution may be to set large equations into two-column-wide tables or figures. While a package exists for setting equations that span two columns (\texttt{widetext.sty}), that code is erratic in relation to floats and page breaks.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Incomplete Zeta Function~\cite{Lienhard2019c}\label{app:zetafunction}}
@@ -538,10 +554,6 @@ Joseph Fourier est connu pour avoir déterminé, par le calcul, la diffusion de
%%%%%%%%%%%%% BIBLIOGRAPHY %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\balance %<=== this command, from the balance package, attempts to balance column heights on last page.
- % performance is a bit variable, however...
- % The [lineno] option will disable this command
-
\nocite{*} %% <=== delete this line - unless you wish to typeset the entire contents of your .bib file.
\bibliographystyle{asmejour} %% .bst file that follows ASME journal format. Do not change.
@@ -549,17 +561,9 @@ Joseph Fourier est connu pour avoir déterminé, par le calcul, la diffusion de
\bibliography{asmejour-sample} %% <=== change this to name of your bib file
-%%%%%%%%%%%%%%% LIST OF FIGURES and LIST OF TABLES %%%%%%%%%%%%%%%%
-\clearpage
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%% ASME requires these lists for production.
-\twocolumn[
- \begin{@twocolumnfalse}
-\listoffigures
-\listoftables
- \end{@twocolumnfalse}
-]
+%% To omit final list of figures and tables, use the class option [nolists]
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\end{document}
\ No newline at end of file