IEEE Transaction Quarto journal template

Overview

quarto-ieee provide a IEEEtran template for journal format with your Quarto documents. quarto-ieee use the IEEEtran.cls document class that is used for most IEEE transaction articles. It supports both PDF and HTML output.

Creating a New Article

To create a new article using this format:

quarto use template dfolio/quarto-ieee

This will create a new directory with an example document that uses this format.

Using with an Existing Document

To add this format to an existing document:

quarto add dfolio/quarto-ieee

Then, add the format to your document options:

format:
  ieee-pdf: default

Usage

Most basic IEEEtran.cls command are supported. For these commands, there are some (few) limitations¹ for the HTML output. For PDF output, using the LaTeX command is often the solution.
Additionally, quarto-ieee template also supports the mhchem (for chemical equation) and physics (for flexible macros for typesetting equations) LaTeX packages and Mathjax(v3) extensions.

For the HTML output, quarto-ieee tries to mimic as closely as possible the layout seen on IEEEXplore^®.

Front Matter

Most Quarto's authors and affiliations scheme are supported. When provided, note is used as \thanks{} in PDF output (ignored in HTML output). Additionally, photo with bio allows generating a IEEEbiography, while a sole bio generates a IEEEbiographynophoto (this is used both in PDF and HTML outputs).
The following front matter entries are also supported:

• funding (see https://quarto.org/docs/authoring/front-matter.html)
• citation (see https://quarto.org/docs/authoring/create-citeable-articles.html)

Similarly, you can manage the page header from the front matter:

pageheader:
  left: Journal XXX, Month Year
  right: 'First Author et al.: Short title'

Examples

The source code for a minimal sample document is given in template.qmd. You have a preview of the rendering of this basic template at template.pdf or template.html.
Incomplete articles (i.e. more advanced examples) are available in the examples folder.

Unsuported features and limitations

• If you are using Quarto, it is strongly recommended to use TexLive from the LaTeX distribution instead of the one provided by your Linux distribution. Otherwise, you may encounter a missing package problem.
• Several authors with same affiliation. In such case use note and tex-author-no-affiliation: true.
• For PDF output
  • quarto-ieee use a hack to handle the longtable issue with 2-column LaTeX documents². In some cases, a page overflow may occur.
• For HTML output
  • The default Quarto toc is used, so the display is not the same as on IEEEXplore^®.
  • Footnote are put at the end of document, while on IEEEXplore^® there are placed in the accordion.
  • Figures are not placed in the accordion.
  • IEEEXplore^® specifics (e.g. citation metrics, etc.)
  • The HTML output is a Quarto citeable article, so a citation appendix is automatically added to the article end.

Important

The quarto-ieee template are intended to only approximate the final look and page length of the articles/papers either in PDF output or HTML output. They are NOT intended to be the final produced work that is displayed in print or on IEEEXplore^®. They will help to give the authors an approximation of the number of pages and layout that will be in the final version.

Contributing

If you want to improve the quarto-ieee template or need some specific features do not hesitate to submit Pull Request (PR) (it is considered good practice to open an issue for discussion before working on a pull request for a new feature).

Footnotes

1. If there are some IEEEtran.cls command that are not supported in HTML output, you may raise an issue about it. ↩

2. "longtable not compatible with 2-column LaTeX documents", see this issue https://github.com/jgm/pandoc/issues/1023 ↩