stsewd/ieee-pandoc-template

IEEE paper template for pandoc

IEEE Paper Template for Pandoc

Requirements

• Pandoc
• Texlive

Ubuntu

sudo apt update
sudo apt install pandoc pandoc-citeproc texlive-full

Fedora

sudo dnf install pandoc pandoc-citeproc texlive-scheme-full

Quick Start Guide

• Clone or download this repo.
• Put all your paper content in paper.md.
• Change the title and author in metadata.yaml.
• Run make in a terminal.
• The pdf will be on build/paper.pdf.

Files

File	Description
metadata.yml	On this file put all your metadata (author, title, abstract, etc) that will be use for rendering the final pdf.
paper.md	Here you put all your paper content, if you wish, you could put your content on separate files, but you must edit the makefile.
bibliography.bib	Here put all the bibliography that is used in the paper.
bibliography.csl	This file is for specify to pandoc how to display the cites (ieee format).
template.latex	It is used to tell pandoc how to render the paper using the metadata and content of your paper.
makefile	It is used to compile the pdf, usually the default options are fine.
build/	On this directory will be final pdf. Make sure to add this to your .gitignore file if you are using git.

Recommended Tools

Editors

• Vim/Neovim + vim-pandoc extension
• Atom + language-pfm extension + autocomplete-bibtex extension

Bibliography manager

• Zotero + Better Bibtext extension

ieee-pandoc-template's Issues

How to add multiple authors.

Adding another author in the yaml file does not format the 2 authors as expected. Please could you tell me how one can do that .

! LaTeX Error: File `IEEEtran.cls' not found.

! LaTeX Error: File `IEEEtran.cls' not found.

Type X to quit or <RETURN> to proceed,
or enter new name. (Default extension: cls)

Enter file name: 
! Emergency stop.
<read *> 
         
l.2 \usepackage

pandoc: Error producing PDF
makefile:16: recipe for target 'pdf' failed
make: *** [pdf] Error 43

Undefined Control Sequence When Inserting Image

When I use the below code to insert a figure:

\begin{figure*}
  \centering
  \includegraphics[width=\textwidth,height=668px]{images/overall-architecture.png}
  \caption{The overall architecture.}
  \label{fig:overall-architecture}
\end{figure*}

I get the following error:

pandoc -o build/paper.pdf --bibliography=bibliography.bib --csl=bibliography.csl -s -f markdown --template=template.latex paper.md metadata.yaml                                                                
Error producing PDF.                                                                                                                                                                                            
! Undefined control sequence.                                                                                                                                                                                   
l.239     \includegraphics                                                                                                                                                                                      

make: *** [pdf] Error 43

Also, for some weird reason, the error regarding LaTeX gets resolved once I add an image via the Markdown syntax:

![]([PATH_TO_IMAGE])

What's causing this error? As far as I can see, this is all valid LaTeX.

Incorrect Variable Name

ieee-pandoc-template/metadata.yaml

Line 5 in 7d42758

affilation: Universidad de Cuenca

affilation -> affiliation

Name to be spelt as specified in the template:

ieee-pandoc-template/template.latex

Line 218 in 7d42758

$author.affiliation$ \\

Error citing reference

When using this template stock on Ubuntu 22.04 I get the following error.

Error producing PDF.
! LaTeX Error: Environment cslreferences undefined.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...                                              
                                                  
l.145 \begin{cslreferences}

make: *** [makefile:16: pdf] Error 43

removing the in text citation cite[@djangoproject_models_2016] fixes it. Any ideas?

error with citations with basictex

i am using basictex (https://www.tug.org/mactex/morepackages.html) rather than the heavy TexLive distribution. i have downloaded IEEEtran.cls file from https://www.ctan.org/tex-archive/macros/latex/contrib/IEEEtran/.

in this basic markdown file:

This is a reference to [@allen1957]

@altshuler2019 [p. 33] says blah.

with this .bib file:

@article{allen1957,
  title = {Symbolic {{Logic}}: {{A Razor-Edged Tool}} for {{Drafting}} and {{Interpreting Legal Documents}}},
  shorttitle = {Symbolic {{Logic}}},
  author = {Allen, Layman E.},
  date = {1957-05},
  journaltitle = {The Yale Law Journal},
  shortjournal = {The Yale Law Journal},
  volume = {66},
  number = {6},
  eprint = {794073},
  eprinttype = {jstor},
  pages = {833},
  issn = {00440094},
  doi = {10.2307/794073},
  url = {https://www.jstor.org/stable/794073?origin=crossref},
  urldate = {2023-10-09},
  langid = {english},
  file = {/Users/hamza/Zotero/storage/YI8TUGPL/Allen - 1957 - Symbolic Logic A Razor-Edged Tool for Drafting an.pdf}
}

@book{altshuler2019,
  title = {A Course in Semantics},
  author = {Altshuler, Daniel and Parsons, Terence and Schwarzschild, Roger},
  date = {2019},
  publisher = {{The MIT Press}},
  location = {{Cambridge, MA}},
  isbn = {978-0-262-04277-2},
  pagetotal = {225},
  keywords = {Semantics}
}

running pandoc --citeproc with the template.latex from this repo gives this error:

 $  >  pandoc --citeproc -o p.pdf t.md
[WARNING] Citeproc: citation allen1957 not found
[WARNING] Citeproc: citation altshuler2019 not found
 $  >  pandoc --bibliography=bibliography.bib --citeproc -o p.pdf t.md
 $  >  pandoc --csl=bibliography.csl --bibliography=bibliography.bib --citeproc -o p.pdf t.md
 $  >  pandoc --template=template.latex --csl=bibliography.csl --bibliography=bibliography.bib --citeproc -o p.pdf t.md
Error producing PDF.
! LaTeX Error: Lonely \item--perhaps a missing list environment.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...

l.97 \bibitem[\citeproctext]{ref-allen1957}

versions used;
pandoc: 3.1.8
basictex: 2023.0314

cslreferences error

I'm getting the following error when using with bibtext:

pandoc -o build/paper.pdf --bibliography=bibliography.bib --csl=bibliography.csl -s -f markdown --template=template.latex paper.md metadata.yaml
Error producing PDF.
! LaTeX Error: Environment cslreferences undefined.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...

l.530 \begin{cslreferences}

make: *** [makefile:16: pdf] Error 43

Using tables

I'm trying to use tables but it seems like the package longtable doesn't like the two column layout.

[a@tb ieee-pandoc-template (master)]$ make
pandoc -o build/paper.pdf --bibliography=bibliography.bib --csl=bibliography.csl -s -f markdown --template=template.latex paper.md metadata.yaml
Error producing PDF.
! Package longtable Error: longtable not in 1-column mode.

See the longtable package documentation for explanation.
Type  H <return>  for immediate help.
 ...

l.223 \begin{longtable}

make: *** [makefile:16: pdf] Error 43

Any recommendations?