john02139/asmeconf

Latex template for ASME Conference papers

asmeconf: A LaTeX template for ASME conference papers

Reporting Issues

This GitHub site is for reporting issues (bugs, feature requests) for the asmeconf LaTeX template.

For general questions about LaTeX (or Tex Live, Overleaf, etc.), tex-stackexchange is an excellent source of advice.

Downloading the code

The asmeconf files may be downloaded from CTAN: ctan.org/pkg/asmeconf.

This class is also included in standard distributions such as TeX Live, MikTeX, and Overleaf.

Overview

This LaTeX class and BibTeX style provide a template to format ASME Conference papers according to the current requirements on ASME's web pages: www.asme.org/publications-submissions/proceedings/formatting-the-paper

The asmeconf class provides access to many features not available in older LaTeX templates for ASME papers. It is designed to approach the following aims:

• match ASME's font current specifications and layout

• match ASME's current reference formats, and add support for DOI and URL fields (asmeconf.bst replaces asmems4.bst)

• support hyperlinks to figures, tables, equations, references, and external URLs

• support pdf bookmarks and metadata

• set author names and addresses in either the traditional grid or the more recent inline style

• provide line numbers for editing and review

• support balancing of columns on last page

• support PDF/A (archival) standards if desired

• support copyright footer for federal employees and contractors

• enable various math and text features with newtxmath and newtxtext packages

• support bold face, sans serif math in section headings

• support footnotes in section headings

• enable passages in other languages, e.g., for a translation of the abstract or a quotation

• support for many scripts: Latin, Arabic, Bengali, Chinese, Cyrillic, Devanagari, Greek, Hangul, Japanese, Tamil

  The .tex and .cls files are commented and should be self-explanatory.

  The files in this distribution are:

      README.md              --  this file
      asmeconf.cls           --  the class file
      asmeconf.bst           --  bibtex style for current 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 sample paper
      *
      examples/              -- a directory of examples: 
                                  -- nonlinear ode integration within LaTeX using Lua code
                                  -- fontspec for abstracts in 25 languages in one paper
                                  -- grid-style layout of author names/addresses
                                  -- footers for government employees
                                  -- asmewide.sty and example of use, for two-column equations
  

Author

John H. Lienhard V, Department of Mechanical Engineering, MIT, Cambridge, Massachusetts, USA

asmeconf's Issues

Package hyperxmp Error

Describe the bug
When compiling I get the error: "Package hyperxmp Error: hyperref must be loaded before hyperxmp. }", which seems to be caused by the sequence in which the packages hyperref hyperxmp. There are workarounds suggested online but when implemented they throw new errors. Interestingly this error does not exist on Overleaf, which suggests that this is caused by a different version of the some packages.

Screenshots

Platform (please complete the following information):

• OS: Windows 10
• Distribution MikTex Latest update
• TeX Program: TeXstudio 4.6.3
• hyperref version: 17/07/23
• hyperxmp version: 22/09/2023

Additional context
N/A

asmewide.sty has old version of cuted.sty

Describe the bug
When compiling asmeconf-template-widetext.tex multiple errors are produced that all originate from asmewide.sty (see screenshot for errors).

Steps To Reproduce Error

1. Go to CTAN asmeconf page
2. Download latest version
3. Import downloaded ZIP into Overleaf as a new project
4. Compile asmeconf-template-widetext.tex

Screenshots

Platform (please complete the following information):

• OS: Windows Version 21H1 (OS Build 19043.1706)
• asmeconf Version: 1.30 2022-03-14
• Tex Package: Overleaf
• Browser: Chrome, Brave, and Microsoft Edge

LaTeX Error: Unknown option '\MyColorOption' for package xcolor.

Cannot compile a document. I get a warning and error thrown by the xcolor package.

Package xcolor Warning: Package option `hyperref' is obsolete and ignored on input line 266.

C:\Users\rob5i\AppData\Local\Programs\MiKTeX\tex/latex/xcolor\xcolor.sty:266: LaTeX Error: Unknown option '\MyColorOption' for package xcolor.

The line in question in xcolor is: \edef\Gin@driver{\Gin@driver}

June 2022 update of LaTeX kernel produce errors in capitalized captions and headings

With the June 2022 release of LaTeX, the case-changing commands formerly controlled by the textcase package have been absorbed into the kernel, as described in ltnews35, page 4. There was a bug in this change leading to error messages when certain commands are used in uppercased text, affecting the captions and section headings of asmeconf. The LaTeX Team are now working on a correction that will be distributed in 2022.

The issue is discussed further at these two links:

https://tex.stackexchange.com/questions/649016/changes-to-textcase-and-latex-kernel-in-the-june-2022-release-affecting-uppercas

latex3/latex2e#881

This bug does not affect users who have not rolled forward to the June 2022 release of LaTeX.

Screenshots
For example, when running asmeconf-template.tex, the following error message will be seen:

Recommended Work Around
Until the LaTeX kernel is updated, users of asmeconf can avoid errors as follows:

1. Place \label{..} after \caption{..}, not inside \caption{..}. In other words, do \caption{My caption}\label{My caption label}
2. Inside captions, do (\ref{eqn:number}) instead of using \eqref{eqn:number}
3. Do not put footnotes inside section headings.

For example, if these changes are made to asmeconf-template.tex, the code will run without errors and will produce the expected output.

Figure and Table Captions should not be bold according to reviewers

Describe the bug
The figure and table captions are made in all caps and bold by the template. However after submission reviewers said, that the captions should not be bold. The provided word template implements this already. (https://www.asme.org/publications-submissions/proceedings/author-guidelines/elements-of-a-paper/author-templates)

Screenshots

Template output:

Format as wished by the reviewers:

Word template:

Platform (please complete the following information):

• OS: No os, using Overleaf
• Distribution: TexLive 2022
• TeX Program: Overleaf

Additional context
I changed the following lines to achieve the normal font captions:

\captionsetup[figure]{labelformat=uppercase, labelfont={sf,bf,small},textfont={sf,md,small},textformat=boldmath,labelsep=colon}
\captionsetup[table]{labelformat=uppercase, labelfont={sf,bf,small},textfont={sf,md,small},textformat=boldmath,labelsep=colon,skip=0.5\baselineskip}

Texmaker Compilation Error

Describe the bug
!Undefined control sequence \DocumentMetadata{

Screenshots
! Undefined control sequence.
l.154 \tag_if_active:T
The control sequence at the end of the top line
of your error message was never \def'ed. If you have
misspelled it (e.g., \hobx'), type I' and the correct
spelling (e.g., I\hbox'). Otherwise just continue, and I'll forget about whatever was undefined. \BKM@id=\count315 )) (C:\Users\vomsh\AppData\Local\Programs\MiKTeX\tex/latex/hyperxmp\hyperxmp.sty Package: hyperxmp 2023/09/10 v5.12 Store hyperref metadata in XMP format ! Undefined control sequence. l.26 \IfDocumentMetadataTF {% The control sequence at the end of the top line of your error message was never \def'ed. If you have misspelled it (e.g., \hobx'), type I' and the correct spelling (e.g., I\hbox'). Otherwise just continue,
and I'll forget about whatever was undefined.
Package hyperxmp Warning: Disabling hyperxmp because it is incompatible with PD
F management on input line 29.

Platform (please complete the following information):

• OS: [wINDOWS 11]
• TeX Program [e.g. Texmaker 5.1.4]

Here's a sample bug report

Describe the bug
A clear and concise description of what the bug is.

Screenshots
If applicable, add screenshots to help explain your problem.

Platform (please complete the following information):

• OS: [e.g. Mac OS Big Sur]
• Distribution [e.g. TexLive 2020]
• TeX Program [e.g. TeXShop]

Additional context
Add any other context about the problem here.