A Sample Article Using `quarto-ieee` for IEEE Journal and Transactions

David Folio; John Doe

A Sample Article Using `quarto-ieee` for IEEE Journal and Transactions

Cite This PDF

Abstract:

This document describes the most common article elements and how to use the quarto-ieee class with Pandoc/Quarto-Markdown to produce files that are suitable for submission to IEEE journals. quarto-ieee can produce conference, journal, and technical note (correspondence) papers with a suitable choice of class options. It intends to generate PDF and HTML outputs that closely mimick what IEEE would generate.

Published in: GitHUB ( 2023-06-23)

Page(s): 1-3

Date of Publication: 23 June 2023

Funding Agency

The quarto-ieee template is freely available under the MIT license on github: https://github.com/dfolio/quarto-ieee.

1 Introduction

This file is intended to serve as a “sample article file” for IEEE journal papers produced with (Pandoc/Quarto)-Markdown using IEEEtran.cls version 1.8b and later for the PDF output. It is based on bare_jrnl_new_sample4.tex provided by IEEE Publication Technology, Staff and available from https://template-selector.ieee.org/. The most common elements are covered in the simplified and updated instructions in New_IEEEtran_how-to.pdf. For less common elements you can refer back to the original IEEEtran_HOWTO.pdf. It is assumed that the reader has a basic working knowledge of $\LaTeX$ [1] and of (Pandoc/Quarto)-Markdown [2], [3] markup.

2 The Design, Intent, and Limitations of this Templates

The quarto-ieee template is intended to 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.

2.1 Unsuported feature and limitations

Although most of the $\LaTeX$ and IEEEtran.cls commands and environment are supported, there are some limitations when trying to export to a format other than PDF (e.g. HTML output). For PDF output, the reader can use the $\LaTeX$ command directly. However, this may break other output formats.
It can be can reported the following limitations of the quarto-ieee template: - Several authors with same affiliation produce weird output. In such case, it is recommended to 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¹. But, in some cases, a page overflow may occur (see also Section 5.2.4). - For HTML output - The default Quarto toc is used, so the table of contents (toc) 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 [4], so a citation appendix is automatically added to the article end.

2.2 Contributing

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

3 Some random text

For some of the remainder of this sample we will use dummy text to fill out paragraphs rather than use live text that may violate a copyright.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis cursus nisl eget tempor porta. Proin dapibus dictum quam a commodo. Mauris congue scelerisque eros a porta. Proin blandit nulla sapien, et pretium justo dictum non. Vivamus ultricies, elit eu posuere placerat, sapien est condimentum nisl, at tincidunt tortor dolor ac ligula. Suspendisse pulvinar libero quis eros finibus sodales. Vivamus mattis est eget imperdiet luctus. Morbi eget posuere metus. Nam egestas elit lectus, eu tincidunt odio viverra sed. Sed sit amet metus rutrum, ultricies elit in, finibus felis. Integer lobortis dui ante, eget placerat lorem laoreet eu.

Nullam mi ligula, luctus a orci ut, tincidunt varius augue. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Donec sed sem risus. Nam eleifend ultrices elit, vitae posuere tellus interdum et. Nam id nisl at elit malesuada malesuada. Suspendisse viverra ipsum libero, vel pharetra sem maximus sed. Nunc vel est fringilla, rutrum diam eu, egestas quam. Vivamus lobortis blandit velit, commodo finibus mauris. Quisque vel lacus ipsum. Pellentesque quis nulla ipsum.

Aenean in hendrerit quam. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam tincidunt vehicula dignissim. In quis aliquet lectus, ac vestibulum elit. Quisque a magna viverra quam viverra faucibus. Nulla ornare tortor at mollis viverra. Curabitur vel porta dui. Etiam ipsum elit, egestas eget lacus nec, laoreet iaculis lacus. In iaculis risus ac tincidunt viverra. Maecenas tempor iaculis odio quis aliquet.
Maecenas ac posuere turpis. Fusce est dui, dapibus sed odio eget, eleifend facilisis felis. Nam gravida varius enim, ornare tincidunt urna ullamcorper ut. Donec sit amet eros ac lacus placerat rutrum ut non dolor. Nulla tincidunt nunc massa, sed euismod dui feugiat vitae. Integer tempus risus rutrum tellus interdum, eu aliquet sapien rutrum. Nunc feugiat varius lacus sed laoreet. Integer euismod tellus nisi, id scelerisque sem sagittis eu. Suspendisse at orci vel neque varius tempor nec vitae odio. Integer elementum elementum fermentum. Morbi in turpis cursus, lacinia arcu et, semper orci.

4 Front matter

Most Quarto’s authors and affiliations schemes [5] are supported in the YAML front matter to render authors as requested by IEEE journals in PDF and HTML outputs. When provided to an author, the note entry is rendered as a \thanks{} in PDF output (ignored in HTML output). Additionally, the reader may add to an author a photo: path/to/photograph.png with a bio metadata entries to generate a IEEEbiography, while a sole bio generates a IEEEbiographynophoto (these features is used both in PDF and HTML outputs).
The funding entry is also used in both PDF and HTML outputs [5]. At version v1.1.1, only the funding.statement is used. Similarly, citation entry is supported to make the HTML output a “citeable article” [4].

5 Some Common Elements

5.1 Sections and Subsections

As stated in the IEEEtran template enumeration of section headings is desirable, but not required. When numbered, it should be consistent throughout the article, that is, all headings and all levels of section headings in the article should be enumerated. Primary headings are designated with Roman numerals, secondary with capital letters, tertiary with Arabic numbers; and quaternary with lowercase letters. References and Acknowledgment headings are unlike all other section headings in text. They are never enumerated. They are simply primary headings without labels, regardless of whether the other headings in the article are enumerated.

The following Section 5.2 shows some basic usage and capabilities of quarto-ieee.

5.2 Markdown basics

The reader can easily find many documentations on how to write using the (Pandoc/Quarto) Markdown syntax. The quarto-ieee template relies mainly on the Markdown markup supported by Quarto [6], which is build based on Pandoc [2], [3]. Below are some basic examples of usage of the Markdown markup (to save space, it is better to consult the original Quarto document template.qmd).

5.2.1 Display equations

To write equations use $ delimiters for inline formula or $$ for block one. To number the equations, it is recommended to use classic equation environments provided by $\LaTeX$ and to use \eqref{} (or \ref{}) for cross-referencing. For example: \[\begin{equation}\label{eq:1} {{\chi}_a}=\text{diag}\left(\frac{{\chi}}{1+n_a{\chi}},\frac{{\chi}}{1+n_b{\chi}},\frac{{\chi}}{1+n_b{\chi}}\right), \end{equation}\] \[\begin{align} a & = b + c \label{eq:2} \\ c & = d + e \label{eq:3} \end{align}\]

\[\begin{equation}\label{eq:4} \begin{cases} 1&=n_a+2n_b \\ n_a&=\dfrac{1-{\varepsilon}^2}{2{\varepsilon}^3}\left(\log\left(\dfrac{1+{\varepsilon}}{1-{\varepsilon}}\right)-2{\varepsilon}\right) \end{cases} \end{equation}\] The above equation is cross-referenced as $\eqref{eq:1}$, $\eqref{eq:2}$, $\eqref{eq:3}$ and $\eqref{eq:4}$.

For now, avoid using the Quarto cross-references that use of $$ $$ with #eq- label. It works properly only for PDF output, but there are some issues with HTML³ output.

Remark. quarto-ieee template also supports the mhchem (for chemical equation) and physics (for flexible macros for typesetting equations) $\LaTeX$ packages and Mathjax extensions.

5.2.2 Theorems, Proofs and Remarks

To include a reference-able theorem, create a div with a #thm- label. A theorem name is specified via the first heading in the block. For example:

Theorem 1 (Line) The equation of any straight line, called a linear equation, can be written as:

\[ y = mx + b \]

The theorem is cross-referenced as Theorem 1.

There are a number of theorem variations supported by Quarto, each with their own label prefix:

#thm- for Theorem;
#lem- for Lemma;
#cor- for Corollary
#prp- for Proposition;
#cnj- for Conjecture;
#def- for Definition;
#exm- for Example;
#exr- for Exercise.

The proof, remark and solution environments generally receive similar typesetting as theorems. However they are not numbered (and therefore cannot be cross-referenced). To create these environments just use them as the class name of a div such as:

Solution (The solution). An example of solution environment.

5.2.3 Figures

An image with nonempty alt text will be rendered as a figure with a caption with Pandoc and Quarto. Quarto includes a different features to simplify the use of figures and subfigures. Here, it is recommended to use div block with #fig- label to embed your Figures.

The figures is cross-referenced as Fig. 2 and even the sub-figures as Fig. 2 (b).

5.2.4 Tables

Similarly, many kind of tables may be used with Pandoc and Quarto. The latter also includes different features to simplify the table output. To make tables cross-referenceable use a label with a #tbl- prefix.
However, it is recommended to avoid using the commonly used single Markdown table known as a ‘pipe table’. In fact, Pandoc Markdown uses the $\LaTeX$ longtable package, which does not support the two-column mode, which is required for most IEEEtran journals. quarto-ieee uses a hack to temporarily switch to one-column mode. However, this hack may break the page layout. To overcome this issue, a basic way is to use code cells (as for Table 2). Quarto is a multi-language and it uses Knitr to execute R code and can execute Python code blocks within Markdown.

Table 1: Main Caption

(a) First Table

Col1	Col2	Col3
A	B	C
E	F	G
A	G	G

(b) Second Table

Col1	Col2	Col3
A	B	C
E	F	G
A	G	G

The Tables are cross-referenced as Table 1 for details, especially Table 1 (b). There is also Table 2.

Table 2: A table

Col1	Col2	Col3
A	D	G
B	E	H
C	F	I

5.3 Bibliography

IEEE journal should normally use IEEEtran⁴ BibT_EX style. Nevertheless, Pandoc and Quarto do support BibT_EX with natbib or biblatex. However, neither is officially recommended for normal IEEE use. For this reason, quarto-ieee uses citeproc with the ieee CSL style sheet.

6 Conclusions

The conclusion goes here.

Acknowledgment

This should be a simple paragraph before the References to thank those individuals and institutions who have supported your work on this article.

Use []{.appendix options="An Appendix"} markup if you have a single appendix. IEEEtran state that to do not use \section{} anymore after \appendix.

Authors

David Folio

Laboratoire Prisme, INSA Centre Val de Loire, Bourges, 18800 France, Unknown affiliation

Use IEEEbiography with figure as option and the author name as the argument followed by the biography text.

John Doe

Anonymous University

Use IEEEbiographynophoto and the author name as the argument followed by the biography text.

References

[1]

F. Mittelbach and U. Fischer, The LaTeX companion, 3rd ed. Addison Wesley Professional, 2023.

[2]

J. MacFarlane, A. Krewinkel, and J. Rosenthal, “Pandoc.” [Online]. Available: https://github.com/jgm/pandoc

[3]

J. J. Allaire, C. Teague, C. Scheidegger, Y. Xie, and C. Dervieux, “Quarto.” Jan-2022 [Online]. Available: https://github.com/quarto-dev/quarto-cli

[4]

“Quarto - Creating Citeable Articles.” [Online]. Available: https://quarto.org/docs/authoring/create-citeable-articles.html. [Accessed: 25-Oct-2023]

[5]

“Quarto - Front Matter.” [Online]. Available: https://quarto.org/docs/authoring/front-matter.html#funding. [Accessed: 25-Oct-2023]

[6]

“Quarto - Markdown Basics.” [Online]. Available: https://quarto.org/docs/authoring/markdown-basics. [Accessed: 25-Oct-2023]

Keywords

Author Keywords

Citation

BibTeX citation:

@software{folio2023,
  author = {Folio, David and Doe, John},
  title = {A {Sample} {Article} {Using} `Quarto-Ieee` for {IEEE}
    {Journal} and {Transactions}},
  pages = {1-3},
  date = {2023-06-23},
  url = {https://github.com/dfolio/quarto-ieee},
  langid = {en},
  abstract = {This document describes the most common article elements
    and how to use the `quarto-ieee` class with Pandoc/Quarto-Markdown
    to produce files that are suitable for submission to IEEE journals.
    `quarto-ieee` can produce conference, journal, and technical note
    (correspondence) papers with a suitable choice of class options. It
    intends to generate PDF and HTML outputs that closely mimick what
    IEEE would generate.}
}

For attribution, please cite this work as:

D. Folio and J. Doe, “A Sample Article Using `quarto-ieee` for IEEE Journal and Transactions,” GitHUB. pp. 1–3, 23-Jun-2023 [Online]. Available: https://github.com/dfolio/quarto-ieee