Thursday 9 February 2017

Peer review template based on IEEEtran and pandoc

When you start to be involved in scientific publishing, one of the side-effects is to become a reviewer for some journals. This side-effect is an extremely important part of the scientific publishing process, which should ensure the quality of the published papers. It has also some other advantages, as to be able to view the papers few months before they would be published. The major downside is the time required for a good review, even days.

To simplify the writing process I decided to create a simple workflow which is based on \(\LaTeX\), IEEEtran and pandoc. The final output will be made up of a .pdf file, formatted as an IEEEtran journal, and a .rst file, formatted as a reStructuredText. The .pdf is ideal for viewing the math, figures, etc., while the .rst file is ideal to be pasted in the comments part, which is the part that will be sent in the email to the authors.

The template is quite simple:

%% Template made by Alex Pacini V1.1.0
%% IEEE template adapted for reviews

\documentclass[journal]{IEEEtran}
%\usepackage[a-1b]{pdfx} %% Use this if you want a pdf/a
%\usepackage[T1]{fontenc} %% Use the T1 font encoding if you write in a language other than english.
\usepackage[utf8]{inputenc}
\usepackage{cite}
\usepackage[pdftex]{graphicx}
\graphicspath{{./images/}} %% Put your images in an "images" folder
\usepackage{amsmath,amsfonts}
\interdisplaylinepenalty=2500
\usepackage{array}
\usepackage{url}
\usepackage{microtype}
\usepackage[keeplastbox]{flushend}


%% SET HERE {
\newcommand{\revnum}{V:1.0.0} % Version of the review (Main number, 1:First Round, 2:Second Round)
\newcommand{\MID}{MID-XX-00-000} %% MID of the paper in revision
\title{Review \revnum: \\
    Wonderful Paper in a Wonderful Journal} % Title of the paper.
%%}

%% Some redefinitions for the title DO NOT CHANGE {
\newcommand{\rversion}{\MID~-~\revnum~\pdfcreationdate}
\newcommand{\rheader}{\rversion}
%\author{\rversion}
\author{}
%% }

\markboth{\rheader}{\rheader}

\begin{document}
\maketitle

\section*{\textbf{Version}}
\noindent
\textbf{\rversion}

\section{Summary}
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas laoreet, leo ac congue mattis, justo sem feugiat ex, id ornare dui nibh id mi. Vivamus ut sapien porta risus blandit euismod. Ut lobortis, dui ac accumsan luctus, mi velit venenatis sem, et dignissim ex nisl a sem. Mauris molestie blandit risus faucibus aliquet. Curabitur a dictum dui. Proin eu urna risus. Proin at sagittis metus. Cras ac tellus lorem. Aliquam consequat dui vestibulum consectetur sodales. Curabitur cursus convallis sem eget sollicitudin. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.

Sed eleifend pulvinar convallis. Sed porta ligula in ornare interdum. Cras gravida est arcu, at ultrices dolor ullamcorper nec. Fusce sapien lacus, lacinia feugiat metus sit amet, scelerisque hendrerit odio. Curabitur sit amet dui id diam maximus faucibus. Ut fermentum quam id congue ornare. Nam placerat rutrum auctor. Cras commodo viverra nunc id venenatis.

Nunc id odio quis justo ullamcorper facilisis. Vivamus luctus eros ornare tellus mollis tincidunt. Donec eget justo tempus, consequat ante vel, tincidunt odio. Sed sagittis nisl at velit volutpat, nec sagittis nunc aliquet. Vestibulum laoreet congue pharetra. Quisque semper, sem et dapibus fringilla, purus lacus euismod nunc, eu mattis odio purus sed tortor. Curabitur eleifend, tortor vitae facilisis malesuada, felis est ullamcorper tortor, eget faucibus quam tellus a felis. Curabitur sed orci vel est vehicula ornare. Sed pharetra arcu nec euismod varius. Quisque lobortis massa sem, in ultrices leo tempus ut. Vestibulum vestibulum enim varius orci porta aliquam. Etiam tincidunt sed nulla at convallis. Nunc diam leo, laoreet ac tortor eget, vehicula tempor lectus. Quisque sit amet justo dictum, vulputate nulla in, scelerisque eros.

\section{General Comments}

Maecenas a tellus tincidunt, porttitor dui vel, varius metus. Donec vitae sem leo. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed laoreet nulla urna, eu interdum dui consectetur sed. Fusce ligula risus, egestas ac quam et, porttitor tempus turpis. Mauris rhoncus ante vitae risus tempor pulvinar et sed tortor. Donec interdum mauris sed dui tincidunt, et porta metus sodales. Aliquam id eros tortor. Donec suscipit elit ut nisl laoreet, in tempus nunc elementum. Vivamus tempor, lorem ut tincidunt pulvinar, massa nunc vestibulum neque, in convallis mauris erat non dolor. Nulla scelerisque dapibus tortor nec convallis. Donec vitae dictum est. Proin a mauris ut purus blandit rhoncus. Pellentesque tincidunt malesuada eros id tempus. Nullam eget diam eu neque tincidunt sollicitudin.

In varius lorem et ante fringilla, at sodales turpis porttitor. Praesent tempor enim ac tellus facilisis, sed lacinia metus commodo. Nunc id condimentum ipsum. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Morbi a ante dapibus, elementum ipsum id, convallis turpis. In ut orci in justo auctor tristique vitae in elit. Vivamus finibus purus a tellus venenatis, convallis dictum metus iaculis. Etiam feugiat fermentum augue sit amet suscipit.

Cras eu feugiat felis. Etiam a elit velit. Ut a purus vehicula est fermentum auctor. Suspendisse eu nunc sed elit convallis venenatis. Duis id finibus tellus. Nam sed ligula vitae tortor pulvinar mollis eu eu velit. Donec ultricies quam quis est sollicitudin vulputate. Morbi lacinia, sem ac congue rutrum, turpis ante porttitor libero, in semper purus orci in magna. Aliquam varius, justo eget sodales cursus, nisl mi condimentum tellus, rhoncus ultrices tellus diam id purus.

Vivamus a lacus ultrices, consectetur felis nec, viverra tortor. Nulla ac maximus leo. In scelerisque rutrum ornare. Proin convallis quam velit, eget mattis tellus egestas eget. Duis sagittis metus elit, quis lacinia odio fermentum non. Sed eget nulla quam. Curabitur felis leo, suscipit at porta eget, fermentum vel nulla. Quisque sollicitudin eros purus, eget ornare urna lobortis ac. Vestibulum at ultrices lacus, sed eleifend nibh. Suspendisse vitae eros vitae justo ornare pulvinar. Ut eu vestibulum neque, vitae mollis nunc. Nunc quis ullamcorper dolor. Phasellus efficitur eros a velit consectetur lobortis.

\section{Specific Comments}

Quisque volutpat non tortor non malesuada. Ut nec lacus sed ante pretium faucibus sed quis magna. Donec vel consectetur turpis, a maximus lectus. Vivamus sodales velit non nisi tempor dapibus. Suspendisse potenti. Sed viverra venenatis metus, id viverra ante ultrices lacinia. Nulla vestibulum magna sed felis efficitur lacinia et et est. Fusce sit amet neque elit. Sed dolor massa, sagittis vel bibendum nec, porttitor quis arcu. Sed interdum eros sed pellentesque commodo. Donec ultricies nisl enim, ac tempus dolor accumsan in. Aliquam erat volutpat. In hac habitasse platea dictumst. Praesent vel tempor lorem.

Nam id efficitur urna. Duis efficitur nunc urna, in placerat enim malesuada mattis. Mauris a tortor efficitur, pellentesque lacus vitae, vehicula risus. Praesent sit amet pulvinar felis. Etiam porttitor, mi ac tincidunt fermentum, lacus justo ultrices nunc, et placerat dolor nunc non sapien. Pellentesque at tellus eros. Duis iaculis ultrices erat ultricies dictum. In faucibus in ante quis auctor. Cras convallis aliquet augue in sollicitudin. Praesent sed laoreet lacus, eu iaculis mi. Nunc tincidunt lectus eget orci pharetra, eget lobortis leo condimentum. Cras at vestibulum ligula. Cras vehicula sed tellus vitae malesuada. Suspendisse potenti.

Aenean id mollis ante. Aliquam erat volutpat. Nunc ultrices, erat nec condimentum tristique, lorem sapien porta orci, eu commodo augue elit convallis dolor. Integer viverra lobortis rutrum. Sed vitae lorem neque. Suspendisse eget scelerisque sem, ut egestas nisi. Vestibulum pulvinar ornare dolor, in eleifend mi accumsan eu. Duis lobortis, libero vestibulum viverra auctor, odio turpis facilisis ante, ac congue nunc lacus vitae nisl.

Vivamus eros ipsum, dictum sit amet convallis pharetra, elementum ut nibh. Nunc eleifend urna turpis, luctus aliquet massa blandit ac. Fusce convallis nisl in diam tincidunt, semper mattis sem blandit. In tortor lectus, egestas ut pharetra ac, suscipit sed elit. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed interdum orci eget odio aliquet finibus congue pulvinar libero. Aenean ex urna, aliquet sed lacus a, finibus pharetra quam.

\section{Conclusions}
I recommend to \textbf{ACCEPT} the paper with a \textbf{MAJOR} revision.

%\bibliographystyle{IEEEtran} % Enable these if you want to add some bibliography
%\bibliography{ref}

% that's all folks 
\end{document}

Which will result in the following .pdf:

Your browser does not support embedded pdfs: download the file from this link.



And then, by running:
 pandoc -f latex -t rst MID-XX-00-000_R1.0.0.tex > MID-XX-00-000_R1.0.0.rst
the following .rst is obtained, which can be copied in the comments section:
**Version**
===========

**MID-XX-00-000 - V:1.0.0 **

Summary
=======

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas
laoreet, leo ac congue mattis, justo sem feugiat ex, id ornare dui nibh
id mi. Vivamus ut sapien porta risus blandit euismod. Ut lobortis, dui
ac accumsan luctus, mi velit venenatis sem, et dignissim ex nisl a sem.
Mauris molestie blandit risus faucibus aliquet. Curabitur a dictum dui.
Proin eu urna risus. Proin at sagittis metus. Cras ac tellus lorem.
Aliquam consequat dui vestibulum consectetur sodales. Curabitur cursus
convallis sem eget sollicitudin. Pellentesque habitant morbi tristique
senectus et netus et malesuada fames ac turpis egestas.

Sed eleifend pulvinar convallis. Sed porta ligula in ornare interdum.
Cras gravida est arcu, at ultrices dolor ullamcorper nec. Fusce sapien
lacus, lacinia feugiat metus sit amet, scelerisque hendrerit odio.
Curabitur sit amet dui id diam maximus faucibus. Ut fermentum quam id
congue ornare. Nam placerat rutrum auctor. Cras commodo viverra nunc id
venenatis.

Nunc id odio quis justo ullamcorper facilisis. Vivamus luctus eros
ornare tellus mollis tincidunt. Donec eget justo tempus, consequat ante
vel, tincidunt odio. Sed sagittis nisl at velit volutpat, nec sagittis
nunc aliquet. Vestibulum laoreet congue pharetra. Quisque semper, sem et
dapibus fringilla, purus lacus euismod nunc, eu mattis odio purus sed
tortor. Curabitur eleifend, tortor vitae facilisis malesuada, felis est
ullamcorper tortor, eget faucibus quam tellus a felis. Curabitur sed
orci vel est vehicula ornare. Sed pharetra arcu nec euismod varius.
Quisque lobortis massa sem, in ultrices leo tempus ut. Vestibulum
vestibulum enim varius orci porta aliquam. Etiam tincidunt sed nulla at
convallis. Nunc diam leo, laoreet ac tortor eget, vehicula tempor
lectus. Quisque sit amet justo dictum, vulputate nulla in, scelerisque
eros.

General Comments
================

Maecenas a tellus tincidunt, porttitor dui vel, varius metus. Donec
vitae sem leo. Pellentesque habitant morbi tristique senectus et netus
et malesuada fames ac turpis egestas. Sed laoreet nulla urna, eu
interdum dui consectetur sed. Fusce ligula risus, egestas ac quam et,
porttitor tempus turpis. Mauris rhoncus ante vitae risus tempor pulvinar
et sed tortor. Donec interdum mauris sed dui tincidunt, et porta metus
sodales. Aliquam id eros tortor. Donec suscipit elit ut nisl laoreet, in
tempus nunc elementum. Vivamus tempor, lorem ut tincidunt pulvinar,
massa nunc vestibulum neque, in convallis mauris erat non dolor. Nulla
scelerisque dapibus tortor nec convallis. Donec vitae dictum est. Proin
a mauris ut purus blandit rhoncus. Pellentesque tincidunt malesuada eros
id tempus. Nullam eget diam eu neque tincidunt sollicitudin.

In varius lorem et ante fringilla, at sodales turpis porttitor. Praesent
tempor enim ac tellus facilisis, sed lacinia metus commodo. Nunc id
condimentum ipsum. Cum sociis natoque penatibus et magnis dis parturient
montes, nascetur ridiculus mus. Morbi a ante dapibus, elementum ipsum
id, convallis turpis. In ut orci in justo auctor tristique vitae in
elit. Vivamus finibus purus a tellus venenatis, convallis dictum metus
iaculis. Etiam feugiat fermentum augue sit amet suscipit.

Cras eu feugiat felis. Etiam a elit velit. Ut a purus vehicula est
fermentum auctor. Suspendisse eu nunc sed elit convallis venenatis. Duis
id finibus tellus. Nam sed ligula vitae tortor pulvinar mollis eu eu
velit. Donec ultricies quam quis est sollicitudin vulputate. Morbi
lacinia, sem ac congue rutrum, turpis ante porttitor libero, in semper
purus orci in magna. Aliquam varius, justo eget sodales cursus, nisl mi
condimentum tellus, rhoncus ultrices tellus diam id purus.

Vivamus a lacus ultrices, consectetur felis nec, viverra tortor. Nulla
ac maximus leo. In scelerisque rutrum ornare. Proin convallis quam
velit, eget mattis tellus egestas eget. Duis sagittis metus elit, quis
lacinia odio fermentum non. Sed eget nulla quam. Curabitur felis leo,
suscipit at porta eget, fermentum vel nulla. Quisque sollicitudin eros
purus, eget ornare urna lobortis ac. Vestibulum at ultrices lacus, sed
eleifend nibh. Suspendisse vitae eros vitae justo ornare pulvinar. Ut eu
vestibulum neque, vitae mollis nunc. Nunc quis ullamcorper dolor.
Phasellus efficitur eros a velit consectetur lobortis.

Specific Comments
=================

Quisque volutpat non tortor non malesuada. Ut nec lacus sed ante pretium
faucibus sed quis magna. Donec vel consectetur turpis, a maximus lectus.
Vivamus sodales velit non nisi tempor dapibus. Suspendisse potenti. Sed
viverra venenatis metus, id viverra ante ultrices lacinia. Nulla
vestibulum magna sed felis efficitur lacinia et et est. Fusce sit amet
neque elit. Sed dolor massa, sagittis vel bibendum nec, porttitor quis
arcu. Sed interdum eros sed pellentesque commodo. Donec ultricies nisl
enim, ac tempus dolor accumsan in. Aliquam erat volutpat. In hac
habitasse platea dictumst. Praesent vel tempor lorem.

Nam id efficitur urna. Duis efficitur nunc urna, in placerat enim
malesuada mattis. Mauris a tortor efficitur, pellentesque lacus vitae,
vehicula risus. Praesent sit amet pulvinar felis. Etiam porttitor, mi ac
tincidunt fermentum, lacus justo ultrices nunc, et placerat dolor nunc
non sapien. Pellentesque at tellus eros. Duis iaculis ultrices erat
ultricies dictum. In faucibus in ante quis auctor. Cras convallis
aliquet augue in sollicitudin. Praesent sed laoreet lacus, eu iaculis
mi. Nunc tincidunt lectus eget orci pharetra, eget lobortis leo
condimentum. Cras at vestibulum ligula. Cras vehicula sed tellus vitae
malesuada. Suspendisse potenti.

Aenean id mollis ante. Aliquam erat volutpat. Nunc ultrices, erat nec
condimentum tristique, lorem sapien porta orci, eu commodo augue elit
convallis dolor. Integer viverra lobortis rutrum. Sed vitae lorem neque.
Suspendisse eget scelerisque sem, ut egestas nisi. Vestibulum pulvinar
ornare dolor, in eleifend mi accumsan eu. Duis lobortis, libero
vestibulum viverra auctor, odio turpis facilisis ante, ac congue nunc
lacus vitae nisl.

Vivamus eros ipsum, dictum sit amet convallis pharetra, elementum ut
nibh. Nunc eleifend urna turpis, luctus aliquet massa blandit ac. Fusce
convallis nisl in diam tincidunt, semper mattis sem blandit. In tortor
lectus, egestas ut pharetra ac, suscipit sed elit. Cum sociis natoque
penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed
interdum orci eget odio aliquet finibus congue pulvinar libero. Aenean
ex urna, aliquet sed lacus a, finibus pharetra quam.

Conclusions
===========

I recommend to **ACCEPT** the paper with a **MAJOR** revision.

No comments:

Post a Comment