Code Monkey home page Code Monkey logo

quarto-ieee's Introduction

IEEE Transaction Quarto journal template

Tested on Quarto-1.3 Tested on Quarto-1.4

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) limitations1 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:

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 documents2. 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

quarto-ieee's People

Contributors

dfolio avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

quarto-ieee's Issues

Not available to render example qmd file without installing additional components

Hi, thanks for nice work.

Problem

Recently I tried to use this template for practice my self.

Here's what I did.

  1. install and load template using command quarto use tempalte dfolio/quarto-ieee
  2. Just render ieee.qmd with Rstudio

However, this will return error message:

LaTeX Error: File orcidlink.sty not found.

Solution

and I found solution to solve this problem.

  1. install tinytex via Console: tinytex::install_tinytex(), then check whether result of tinytex::is_tinytex() is TRUE
  2. install orcidlink.sty via Console using tinytex
tinytex::parse_packages(
    text = "! LaTeX Error: File `orcidlink.sty' not found."
)

and it will return 'orcidlink' like below image

  1. and then render qmd file again and it will work.

I think this process added into readme, this template will look much better. (If you don't mind i'll modify this and make PR)

Thanks.

Kim

state relation to official IEEE templates

Thanks for this extremely useful extension!
Could you please state its relation to the official IEEE templates:

I mean to state:

  • when and where you got the files from, so I can assess the freshness of your extension.
  • whether it works for both journals and conferences (seems it does)

I'm comparing your extension to https://github.com/gael-close/ieeetran for submitting to a conference, and it seems yours is the one I need.

Cheers!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.