Commit 66ae4066 authored by Dirk Brömmel's avatar Dirk Brömmel
Browse files

Adding DOI placeholder

Currently white papers are uploaded to Zenodo with their publication on
the PRACE website. Zenodo can reserve a DOI prior to finalising an
entry. This way the final document can display the correct DOI. Please
make use of this possibility, otherwise omit the DOI.
parent 4c41dd57
[![pipeline status](https://repository.prace-ri.eu/git/latex-templates/prace-whitepaper/badges/master/pipeline.svg)](https://repository.prace-ri.eu/git/latex-templates/prace-whitepaper/-/commits/master) (compiling the example)
# LaTeX package for a PRACE whitepaper
# LaTeX package for a PRACE white paper
(c) CSC - IT Center for Science Ltd.
original author: Martti Louhivuori (martti.louhivuori@csc.fi)
......@@ -16,13 +16,13 @@ Enable the writing of a PRACE project report in LaTeX with minimal typographical
## FILES
`prace.cls` : LaTeX document class
`template.tex` : PRACE whitepaper template
`template.tex` : PRACE white paper template
`prace-logo.[pdf|eps|png]` : logo of PRACE (used by prace.cls)
The `example` directory contains a full example:
`example.tex` : example of a filled-in template
`example.pdf` : example PRACE whitepaper
`example.[eps|png]` : figure used in the example whitepaper
`example.pdf` : example PRACE white paper
`example.[eps|png]` : figure used in the example white paper
## REQUIREMENTS
Some LaTeX packages are assumed to be present for this class to work: `mathptmx` (for the correct font), `siunitx` (for properly formatted numbers+units), and `fancyhdr` (which should be updated at some point).
......@@ -55,5 +55,5 @@ Defines the name and address of an affiliation. The syntax should be 'Name, Stre
```
Defines the e-mail address of the corresponding author.
All these macros should be used in the pre-amble of the document, so that all the required information is defined before calling `\maketitle`. In the main body of the document you can use default LaTeX commands for sections, figures etc., but you should refer to the comments in the `template.tex` for further information regarding the required structure, syntax and nomenclature in a PRACE whitepaper.
All these macros should be used in the pre-amble of the document, so that all the required information is defined before calling `\maketitle`. In the main body of the document you can use default LaTeX commands for sections, figures etc., but you should refer to the comments in the `template.tex` for further information regarding the required structure, syntax and nomenclature in a PRACE white paper.
No preview for this file type
%%% Partnership for Advanced Computing in Europe
%%% www.prace-ri.eu
%%%
%%% LaTeX template for a PRACE whitepaper.
%%% LaTeX template for a PRACE white paper.
%%%
%%% (c) CSC - IT Center for Science Ltd.
%%% author: Martti Louhivuori (martti.louhivuori@csc.fi)
......@@ -14,6 +14,8 @@
\title{Example project report}
\date{xx.yy.zzzz}
\doi{DOI:xx.yyyy/zenodo.zzzzzzz}
% AUTHORS
\author[1]{First Author}
\corresponding\author[1]{Second Author}
......@@ -137,7 +139,7 @@ On top of that, we also have some schematic pictures to explain something
\includegraphics[width=0.4\textwidth]{example.png}\hfill{}
\includegraphics[width=0.4\textwidth]{example.png}
\caption{(a) Example picture for the first time; (b) the same picture
side-by-side with the first one.}
side-by-side with the first one. Please use vector graphics where possible.}
\label{fig: example}
\end{center}
\end{figure}
......
%%% Partnership for Advanced Computing in Europe
%%% www.prace-ri.eu
%%%
%%% LaTeX document class for a PRACE whitepaper.
%%% LaTeX document class for a PRACE white paper.
%%%
%%% (c) CSC - IT Center for Science Ltd.
%%% author: Martti Louhivuori (martti.louhivuori@csc.fi)
......@@ -42,16 +42,21 @@
% page numbering
\pagenumbering{arabic}
% date on bottom right, page number in the middle
% default values
\def\authoremail{author@example.com}
\def\refdoi{}
% date on bottom right, page number in the middle, DOI on the left
\RequirePackage{fancyhdr}
\pagestyle{fancy}
\fancyhead[L,C,R]{}
\renewcommand{\headrulewidth}{0pt}
\fancyfoot[C]{\thepage}
\fancyfoot[R]{\@date}
\fancyfoot[L]{\refdoi{}}
% default values
\def\authoremail{author@example.com}
% DOI as obtained from Zenodo or alike (PMO will reserve one first, then add here)
\newcommand{\doi}[1]{\renewcommand\refdoi{#1}}
% internal counters
\newcounter{praceauth}
......
%%% Partnership for Advanced Computing in Europe
%%% www.prace-ri.eu
%%%
%%% LaTeX template for a PRACE whitepaper.
%%% LaTeX template for a PRACE white paper.
%%%
%%% (c) CSC - IT Center for Science Ltd.
%%% author: Martti Louhivuori (martti.louhivuori@csc.fi)
......@@ -26,6 +26,10 @@
\title{}
\date{xx.yy.zzzz}
% Please inquire about a reserved DOI for the white paper. Then add
% the DOI prior to producing a final version
\doi{DOI:xx.yyyy/zenodo.zzzzzzz}
% AUTHORS
% - include all people involved in the effort
% - depending on their contribution, include PRACE experts as authors
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment