ASME Journal Article Template
OfficialAuthor
Last Updated
3 years ago
License
Other (as stated in the work)
Abstract
As linked to from the ASME (American Society of Mechanical Engineers) Author Resources.
As linked to from the ASME (American Society of Mechanical Engineers) Author Resources.
%%%%%%%%%%%%%%%%%%%%%%%%%%% asme2ej.tex %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Template for producing ASME-format journal articles using LaTeX %
% Written by Harry H. Cheng, Professor and Director %
% Integration Engineering Laboratory %
% Department of Mechanical and Aeronautical Engineering %
% University of California %
% Davis, CA 95616 %
% Tel: (530) 752-5020 (office) %
% (530) 752-1028 (lab) %
% Fax: (530) 752-4158 %
% Email: hhcheng@ucdavis.edu %
% WWW: http://iel.ucdavis.edu/people/cheng.html %
% May 7, 1994 %
% Modified: February 16, 2001 by Harry H. Cheng %
% Modified: January 01, 2003 by Geoffrey R. Shiflett %
% Use at your own risk, send complaints to /dev/null %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% use twocolumn and 10pt options with the asme2ej format
\documentclass[twocolumn,10pt]{asme2ej}
\usepackage{epsfig} %% for loading postscript figures
%% The class has several options
% onecolumn/twocolumn - format for one or two columns per page
% 10pt/11pt/12pt - use 10, 11, or 12 point font
% oneside/twoside - format for oneside/twosided printing
% final/draft - format for final/draft copy
% cleanfoot - take out copyright info in footer leave page number
% cleanhead - take out the conference banner on the title page
% titlepage/notitlepage - put in titlepage or leave out titlepage
%
%% The default is oneside, onecolumn, 10pt, final
\title{An ASME Journal Article Created Using
\LaTeX2\raisebox{-.3ex}{$\epsilon$}
in ASME Format for Testing Your Figures}
%%% first author
\author{Harry H. Cheng
\affiliation{
Professor, Fellow of ASMEs\\
Integration Engineering Laboratory\\
Department of Mechanical Engineering\\
University of California\\
Davis, California 95616\\
Email: hhcheng@ucdavis.edu
}
}
%%% second author
%%% remove the following entry for single author papers
%%% add more entries for additional authors
\author{J. Michael McCarthy\thanks{Address all correspondence related to ASME style format and figures to this author.} \\
\affiliation{ Editor, Fellow of ASME\\
Journal of Mechanical Design\\
Email: jmmccart@uci.edu
}
}
%%% third author
%%% remove the following entry for single author papers
%%% add more entries for additional authors
\author{Third Co-author\\
Graduate Research Assistan, Student Member of ASME\\
{\tensfb Fourth Co-author}\thanks{Address all correspondence for other issues to this author.}
\affiliation{Title, Member of ASME\\
Department or Division Name\\
Company or College Name\\
City, State (spelled out), Zip Code\\
Country (only if not U.S.)\\
Email address (if available)
}
}
\begin{document}
\maketitle
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{abstract}
{\it This is the abstract.
This article illustrates preparation of ASME paper using
\LaTeX2\raisebox{-.3ex}{$\epsilon$}.
An abstract for an ASME paper should be less than 150 words and is normally in italics.
%%%
Please use this template to test how your figures will look on the printed journal page of the Journal of Mechanical Design. The Journal will no longer publish papers that contain errors in figure resolution. These usually consist of unreadable or fuzzy text, and pixilation or rasterization of lines. This template identifies the specifications used by JMD some of which may not be easily duplicated; for example, ASME actually uses Helvetica Condensed Bold, but this is not generally available so for the purpose of this exercise Helvetica is adequate. However, reproduction of the journal page is not the goal, instead this exercise is to verify the quality of your figures. Notice that this abstract is to be set in 9pt Times Italic, single spaced and right justified.
}
\end{abstract}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{nomenclature}
\entry{A}{You may include nomenclature here.}
\entry{$\alpha$}{There are two arguments for each entry of the nomemclature environment, the symbol and the definition.}
\end{nomenclature}
The primary text heading is boldface and flushed left with the left margin. The spacing between the text and the heading is two line spaces.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Introduction}
This article illustrates preparation of ASME paper using \LaTeX2\raisebox{-.3ex}{$\epsilon$}. The \LaTeX\ macro \verb+asme2ej.cls+, the {\sc Bib}\TeX\ style file \verb+asmems4.bst+, and the template \verb+asme2ej.tex+ that create this article are available on the WWW at the URL address \verb+http://iel.ucdavis.edu/code/+. To ensure compliance with the 2003 ASME MS4 style guidelines \cite{asmemanual}, you should modify neither the \LaTeX\ macro \verb+asme2ej.cls+ nor the {\sc Bib}\TeX\ style file \verb+asmems4.bst+. By comparing the output generated by typesetting this file and the \LaTeX2\raisebox{-.3ex}{$\epsilon$} source file, you should find everything you need to help you through the preparation of ASME paper using \LaTeX2\raisebox{-.3ex}{$\epsilon$}. Details on using \LaTeX\ can be found in \cite{latex}.
In order to get started in generating a two-column version of your paper, please format the document with 0.75in top margin, 1.5in bottom margin and 0.825in left and right margins. Break the text into two sections one for the title heading, and another for the body of the paper.
The format of the heading is not critical, on the other hand formatting of the body of the text is the primary goal of this exercise. This will allow you to see that the figures are matched to the column width and font size of the paper. The double column of the heading section is set to 1.85in for the first column, a 0.5in spacing, and 4.5in for the second column. For the body of the paper, set it to 3.34in for both columns with 0.17in spacing, both are right justified.
The information that is the focus of this exercise is found in
section~\ref{sect_figure}.
Please use this template to format your paper in a way that is similar to the printed form of the Journal of Mechanical Design. This will allow you to verify that the size and resolution of your figures match the page layout of the journal. The ASME Journal of Mechanical Design will no longer publish papers that have the errors demonstrated here.
ASME simply requires that the font should be the appropriate size and not be blurred or pixilated, and that lines should be the appropriate weight and have minimal, preferably no, pixilation or rasterization.
The journal uses 10pt Times Roman Bold for headings, but Times Bold is good enough for this effort. The text is set at 9pt Times Roman, and again Times will be fine. Insert a new line after the heading, and two lines after each section. This is not exactly right but it is close enough.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Very Very Very Very Very Very Very Very Very Very Very Long Heading}
The heading is boldface with upper and lower case letters.
If the heading should run into more than one line, the run-over is not left-flushed.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Second-Level Heading}
The next level of heading is also boldface with upper and lower case letters.
The heading is flushed left with the left margin. The spacing to the next heading is two line spaces.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Third-Level Heading.}
The third-level of heading follows the style of the second-level heading.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Use of SI Units}
An ASME paper should use SI units. When preference is given to SI units, the U.S. customary units may be given in parentheses or omitted. When U.S. customary units are given preference, the SI equivalent {\em shall} be provided in parentheses or in a supplementary table.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Footnotes\protect\footnotemark}
\footnotetext{Examine the input file, asme2ej.tex, to see how a footnote is given in a head.}
Footnotes are referenced with superscript numerals and are numbered consecutively from 1 to the end of the paper\footnote{Avoid footnotes if at all possible.}. Footnotes should appear at the bottom of the column in which they are referenced.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Mathematics}
Equations should be numbered consecutively beginning with (1) to the end of the paper, including any appendices. The number should be enclosed in parentheses and set flush right in the column on the same line as the equation. An extra line of space should be left above and below a displayed equation or formula. \LaTeX\ can automatically keep track of equation numbers in the paper and format almost any equation imaginable. An example is shown in Eqn.~(\ref{eq_ASME}). The number of a referenced equation in the text should be preceded by Eqn.\ unless the reference starts a sentence in which case Eqn.\ should be expanded to Equation.
\begin{equation}
f(t) = \int_{0_+}^t F(t) dt + \frac{d g(t)}{d t}
\label{eq_ASME}
\end{equation}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Figures}
\label{sect_figure}
All figures should be positioned at the top of the page where possible. All figures should be numbered consecutively and centered under the figure as shown in Fig.~\ref{figure_ASME}. All text within the figure should be no smaller than 7~pt. There should be a minimum two line spaces between figures and text. The number of a referenced figure or table in the text should be preceded by Fig.\ or Tab.\ respectively unless the reference starts a sentence in which case Fig.\ or Tab.\ should be expanded to Figure or Table.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%%%%
\begin{figure}[t]
\begin{center}
\setlength{\unitlength}{0.012500in}%
\begin{picture}(115,35)(255,545)
\thicklines
\put(255,545){\framebox(115,35){}}
\put(275,560){Beautiful Figure}
\end{picture}
\end{center}
\caption{The caption of a single sentence does not have period at the end}
\label{figure_ASME}
\end{figure}
%%%%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
In the following subsections, I have inserted figures that have been provided by authors in order to demonstrate what to avoid. In each case the authors provided figures that are 3.25in wide and 600dpi in the .tif graphics format. The papers containing these figures have been held from production due to their poor quality.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{The 1st Example of Bad Figure}
%%%%%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%%%%
%%% 3.34in is the maximum width you can have for a figure
\begin{figure}
\centerline{\psfig{figure=figure/FMANU_MD_05_1107_11.ps,width=3.34in}}
\caption{Example taken from a paper that was held from production because the image quality is poor. ASME sets figures captions in 8pt, Helvetica Bold.}
\label{fig_example1.ps}
\end{figure}
%%%%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%
In order to place the figure in this template using MSWord, select ÎéÎíInsert Picture from File,ÎéÎí and use wrapping that is ÎéÎítop and bottom.ÎéÎí Make sure the figure is 3.25in wide.
Figure~`\ref{fig_example1.ps}
was taken from a recent paper that was held from publication, because the text is fuzzy and unreadable. It was probably obtained by taking a screen shot of the computer output of the author's software. This means the original figure was 72dpi (dots per inch) on a computer screen. There is no way to improve the quality such a low resolution figure.
In order to understand how poor the quality of this figure is, please zoom in slightly, say to 200\%. Notice that while the font of the paper is clear at this size, the font in the figures is fuzzy and blurred. It is impossible to make out the small symbol beside the numbers along the abscissa of the graph. Now consider the labels ÎéÎíTimeÎéÎí and ÎéÎíCost.ÎéÎí They are clearly in fonts larger that the text of the article, yet the pixilation or rasterization, associated with low resolution is obvious. This figure must be regenerated at higher resolution to ensure quality presentation.
The poor quality of this figure is immediately obvious on the printed page, and reduces the impact of the research contribution of the paper, and in fact detracts from the perceived quality of the journal itself.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{The 2nd Example of Bad Figure}
%%%%%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%%%%
\begin{figure}
\centerline{\psfig{figure=figure/FMANU_MD_05_1272_5.ps,width=3.34in}}
\caption{While this figures is easily readable at a double column width of 6.5in, when it is shrunk to 3.25in column width the text is unreadable. This paper was held from production.}
\label{fig_example2.ps}
\end{figure}
%%%%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%
Figure~\ref{fig_example2.ps}
demonstrates a common problem that arises when a figure is scaled down fit a single column width of 3.25in. The original figure had labels that were readable at full size, but become unreadable when scaled to half size. This figure also suffers from poor resolution as is seen in the jagged lines the ovals that form the chain.
This problem can be addressed by increasing the size of the figure to a double column width of 6.5in, so the text is readable. But this will not improve the line pixilation, and a large low resolution figure is less desirable than a small one. This also significantly expands the length of the paper, and may cause it to exceed the JMD nine page limit. Additional pages require page charges of \$200 per page. It is best to regenerate the figure at the resolution that ensures a quality presentation.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{The 3rd Example of Bad Figure}
%%%%%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%%%%
\begin{figure}
%\centerline{\psfig{figure=figure/FMANU_MD_04_1274_13.ps,width=3.34in}}
\centerline{\psfig{figure=figure/FMANU_MD_04_1274_13.ps,width=3.25in}}
\caption{Another example of a figure with unreadable text. Even when the paper was expanded to double column width the text as shown in Fig.~\ref{fig_example4.ps} was of such low quality that the paper was held from production.}
\label{fig_example3.ps}
\end{figure}
%%%%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%% begin figure %%%%%%%%%%%%%%%%%%%
%%% the maximum width in double column is 6.85in
\begin{figure*}
\centerline{\psfig{figure=figure/FMANU_MD_04_1274_13.ps,width=6.85in}}
\caption{A figure expanded to double column width the text from Figure~\ref{fig_example3.ps}}
\label{fig_example4.ps}
\end{figure*}
%%%%%%%%%%%%%%%% end figure %%%%%%%%%%%%%%%%%%%
An author provided the high resolution image
in Fig.~\ref{fig_example3.ps}
that was sized to a single column width of 3.25in. Upon seeing the poor quality of the text, the publisher scaled the image to double column width as shown in Fig.~\ref{fig_example4.ps}
at which point it took half of a page. The publisher went on to do this for all eight figures generating four pages of figures that the author did not expect. ASME stopped production of the paper even with the larger figures due to the pixilation of the font.
Clearly the text in this figure is unreadable, and it is doubtful that the author can print the output in a way that it is readable. This is a problem that the author must solve, not the publisher.
As you might expect, I have many more examples, but in the end the author is the best judge of what is needed in each figure. ASME simply requires that the image meet a minimum standard for font and line quality, specifically the font should be the appropriate size and not be blurred or pixilated, and that lines should be the appropriate weight and have minimal, preferably no, pixilation or rasterization.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Tables}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%% begin table %%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{table}[t]
\caption{Figure and table captions do not end with a period}
\begin{center}
\label{table_ASME}
\begin{tabular}{c l l}
& & \\ % put some space after the caption
\hline
Example & Time & Cost \\
\hline
1 & 12.5 & \$1,000 \\
2 & 24 & \$2,000 \\
\hline
\end{tabular}
\end{center}
\end{table}
%%%%%%%%%%%%%%%% end table %%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
All tables should be numbered consecutively and centered above the table as shown in Table~\ref{table_ASME}. The body of the table should be no smaller than 7 pt. There should be a minimum two line spaces between tables and text.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Citing References}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
The ASME reference format is defined in the authors kit provided by the ASME. The format is:
\begin{quotation}
{\em Text Citation}. Within the text, references should be cited in numerical order according to their order of appearance. The numbered reference citation should be enclosed in brackets.
\end{quotation}
The references must appear in the paper in the order that they were cited. In addition, multiple citations (3 or more in the same brackets) must appear as a `` [1-3]''. A complete definition of the ASME reference format can be found in the ASME manual \cite{asmemanual}.
The bibliography style required by the ASME is unsorted with entries appearing in the order in which the citations appear. If that were the only specification, the standard {\sc Bib}\TeX\ unsrt bibliography style could be used. Unfortunately, the bibliography style required by the ASME has additional requirements (last name followed by first name, periodical volume in boldface, periodical number inside parentheses, etc.) that are not part of the unsrt style. Therefore, to get ASME bibliography formatting, you must use the \verb+asmems4.bst+ bibliography style file with {\sc Bib}\TeX. This file is not part of the standard BibTeX distribution so you'll need to place the file someplace where LaTeX can find it (one possibility is in the same location as the file being typeset).
With \LaTeX/{\sc Bib}\TeX, \LaTeX\ uses the citation format set by the class file and writes the citation information into the .aux file associated with the \LaTeX\ source. {\sc Bib}\TeX\ reads the .aux file and matches the citations to the entries in the bibliographic data base file specified in the \LaTeX\ source file by the \verb+\bibliography+ command. {\sc Bib}\TeX\ then writes the bibliography in accordance with the rules in the bibliography .bst style file to a .bbl file which \LaTeX\ merges with the source text. A good description of the use of {\sc Bib}\TeX\ can be found in \cite{latex, goosens} (see how two references are handled?). The following is an example of how three or more references \cite{latex, asmemanual, goosens} show up using the \verb+asmems4.bst+ bibliography style file in conjunction with the \verb+asme2ej.cls+ class file. Here are some more \cite{art, blt, ibk, icn, ips, mts, mis, pro, pts, trt, upd} which can be used to describe almost any sort of reference.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Conclusions}
The only way to ensure that your figures are presented in the ASME Journal of Mechanical Design in the way you feel is appropriate and meets the requirement for quality presentation is for you to prepare a double column version of the paper in a form similar to that used by the Journal.
This gives you the opportunity to ensure that the figures are sized appropriately, in particular that the labels are readable and match the size of the text in the journal, and that the line weights and resolutions have no pixilation or rasterization. Poor quality figures are immediately obvious on the printed page, and this detracts from the perceived quality of the journal.
I am pleased to provide advice on how to improve any figure, but this effort must start with a two-column version of the manuscript. Thank you in advance for your patience with this effort, it will ensure quality presentation of your research contributions.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Discussions}
This template is not yet ASME journal paper format compliant at this point.
More specifically, the following features are not ASME format compliant.
\begin{enumerate}
\item
The format for the title, author, and abstract in the cover page.
\item
The font for title should be 24 pt Helvetica bold.
\end{enumerate}
\noindent
If you can help to fix these problems, please send us an updated template.
If you know there is any other non-compliant item, please let us know.
We will add it to the above list.
With your help, we shall make this template
compliant to the ASME journal paper format.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{acknowledgment}
ASME Technical Publications provided the format specifications for the Journal of Mechanical Design, though they are not easy to reproduce. It is their commitment to ensuring quality figures in every issue of JMD that motivates this effort to have authors review the presentation of their figures.
Thanks go to D. E. Knuth and L. Lamport for developing the wonderful word processing software packages \TeX\ and \LaTeX. We would like to thank Ken Sprott, Kirk van Katwyk, and Matt Campbell for fixing bugs in the ASME style file \verb+asme2ej.cls+, and Geoff Shiflett for creating
ASME bibliography stype file \verb+asmems4.bst+.
\end{acknowledgment}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% The bibliography is stored in an external database file
% in the BibTeX format (file_name.bib). The bibliography is
% created by the following command and it will appear in this
% position in the document. You may, of course, create your
% own bibliography by using thebibliography environment as in
%
% \begin{thebibliography}{12}
% ...
% \bibitem{itemreference} D. E. Knudsen.
% {\em 1966 World Bnus Almanac.}
% {Permafrost Press, Novosibirsk.}
% ...
% \end{thebibliography}
% Here's where you specify the bibliography style file.
% The full file name for the bibliography style file
% used for an ASME paper is asmems4.bst.
\bibliographystyle{asmems4}
% Here's where you specify the bibliography database file.
% The full file name of the bibliography database for this
% article is asme2e.bib. The name for your database is up
% to you.
\bibliography{asme2e}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\appendix %%% starting appendix
\section*{Appendix A: Head of First Appendix}
Avoid Appendices if possible.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section*{Appendix B: Head of Second Appendix}
\subsection*{Subsection head in appendix}
The equation counter is not reset in an appendix and the numbers will
follow one continual sequence from the beginning of the article to the very end as shown in the following example.
\begin{equation}
a = b + c.
\end{equation}
\end{document}