path: root/macros/latex/contrib/h2020proposal/manual/h2020proposal.tex

\documentclass[pdftext]{article}

\usepackage{url}

\title{H2020 Proposal Class\\
  A LaTeX class for writing EU RIA H2020 proposals.}
\author{Giacomo Indiveri\\
  Institute for Neuroinformatics\\
  University of Zurich and ETH Zurich\\
  \texttt{giacomo@ini.uzh.ch} } 
\date{\today}

\begin{document}

\maketitle

\begin{abstract}
This class provides macros and commands for automating the creation of cross-referenced tables in Grant Proposals for the EU Research and Innovation Actions (RIA). The appropriate tables are created, updated and (re)sorted using the data entered in the class commands, across the document. 
\end{abstract}

\tableofcontents

\section{Introduction}
\label{sec:introduction}

The proposals submitted to the H2020 EU program have a very well defined structure, with well defined sections and several cross-references among sections and tables. The templates are available at the EU H2020 Participant Portal \url{http://ec.europa.eu/research/participants/portal/desktop/en/funding/reference_docs.html#h2020-call_ptef-pt}

The \texttt{h2020proposal} class implements a series of macros and commands to simplify the formatting of the document and automate the creation of the several cross-referenced tables required by the template.  This class was inspired by the 2009 fet-workpackage.sty  file developed by Dennis Goehlsdorf and by the 2008 EU proposal LaTeX template files developed by Elisabetta Chicca and Chiara Bartolozzi in 2009. It is the extension of the ICTProposal class, designed by Giacomo Indiveri to create large and complex Integrated-Project proposals of the past FP7 program. 

\subsection{Template document structure}

The document structure should have a Cover page, an Table of Contents (for ICT proposals) or an Abstract (for FET proposals), and five main sections. The first three sections are: Excellence (Section 1.), Impact (Section 2.), and Implementation (Section 3.). The total length of these three sections, including the cover page, has strict page limits. 
The last two sections include a part dedicated to the description of the ``Members of the consortium'' (Section 4.) and one related to ``Ethics and Security'' (Section  5.) These two sections are not covered by page limit.

The \texttt{h2020proposal} class commands start with the data that needs to appear in the cover page, and most of the other commands manage the cross-referenced tables and lists that appear in Section 3. The other Sections do not require any special commands, and can be created using the standard LaTeX commands.

\subsection{Class Options}
The user can specify the option ``draft''. In this case, 
guidelines from the EU \emph{Guide for Applicants} are printed,
latex labels are displayed on the side, and page-breaks are added between work-packages.

\subsection{Class Requirements}

The \texttt{h2020proposal} class is based on (and requires) the extremely feature rich and configurable \texttt{memoir} class. Additional packages required by the \texttt{h2020proposal} class are:
\begin{itemize}
\item \texttt{coolstr} package
\item \texttt{longtable} package
\item \texttt{colortbl} package
\end{itemize}

The \texttt{h2020proposal} class also supports the automated creation of the required Gantt chart. For this, it is necessary to include the pgfgantt package.

By using different \texttt{memoir} class options, it is possible to configure and personalize most of the proposal aspects.

\section{Class commands}
\label{sec:class-commands}

\subsection{\textbackslash maketitle}
\label{sec:maketitle}

The \texttt{\textbackslash maketitle} command has been redefined to create the proposal title-page. It uses the data obtained from the following macros:
\begin{description}
\item[\texttt{\textbackslash title\{\}}] This macro requires one   argument: the full title of the proposal.\\
  \emph{E.g.}, \textbf{\textbackslash title\{Future Emerging Technologies\}}
\item[\texttt{\textbackslash  shortname\{\}}] This macro require as   argument the proposal short name.\\
  \emph{E.g.}, \textbf{\textbackslash shortname\{FET\}}
\item[\texttt{\textbackslash fundingscheme\{\}}] This macro require one single argument, which should be either the text  ``\texttt{Small
    or medium scale focused research project (STREP)}'', or the text  ``\texttt{Large-scale integrating projects (IP)}''.
\item[\texttt{\textbackslash topic\{\}}] The argument of this macro should be a text string with the specific Work-Program topic addressed.
\item[\texttt{\textbackslash  coordinator\{\}\{\}\{\}}] This macro requires three arguments. The first argument should be the full name of the coordinator, the second argument should be the coordinator's email address, and the third argument should have the coordinator's fax number.\\
  \emph{E.g.}, \textbf{\textbackslash coordinator\{John Doe\}\{j.doe@null.com\}\{+41 44 11223344\}}
\item[\texttt{\textbackslash participant\{\}\{\}\{\}}] This macro requires three arguments as well. The first argument should be the full name of the participant's institution, the second argument should be the institution short name, and the third argument should be the participant's Country. There should be as many \textbackslash participant\{\}\{\}\{\} macros as the number of participants. The first instance of this macro should be reserved for the coordinator.\\
  \emph{E.g.}, \textbf{\textbackslash participant\{University of Zurich\}\{UZH\}\{Switzerland\}}
\item[\texttt{\textbackslash  titlelogo\{\}\{\}}] This is an optional macro to include an image as logo on the title page. It has two arguments: the first argument is the name (and path) of the image file, and the second argument is the image scaling factor.\\
  \emph{E.g.}, \textbf{\textbackslash titlelogo\{logo.png\}\{0.25\}}
\end{description}

\subsection{\textbackslash makewplist}
This command creates the work package (wp) list required as Table 3.1b in the EU proposal template. It is a table with a list of work packages with their details (\emph{e.g.}, wp leader, wp start-month, wp end-month, \emph{etc.}). The list is compiled automatically by using the data defined in each \texttt{workpackage} environment (see Section~\ref{sec:wp-envir}). As this data is typically defined later in the document, the \texttt{h2020proposal} class creates an auxiliary file ($<$jobname$>$.lwp) and uses it at the second round of compilation to generate the table.  In order to comply with the table numbering provided by the template, it is necessary to redefine the \texttt{table} counter before issuing this command: \emph{e.g.}\\
\textbf{\texttt{\textbackslash renewcommand\{\textbackslash thetable\}\{\textbackslash thesection\textbackslash alph\{table\}\}}}\\
\textbf{\texttt{\textbackslash makewplist}}

\subsection{\textbackslash makedeliverablelist}
This command creates the List of Deliverables Table 3.1c required by
the EU template. As for the wp list, it uses the data defined
(typically later) in each \texttt{workpackage} environment. The
required information is saved in the auxiliary file $<$jobname.ldl$>$
and used in subsequent compilation runs to create the table. This
command sorts the table rows by delivery date.

\subsection{\textbackslash makemilestonelist}
This command creates the List of Milestones Table 3.2a required by the
EU template. Milestones need to be be defined before this command is
issued, by using the  \texttt{\textbackslash
  milestone} macro:
\begin{description}
\item[\texttt{\textbackslash milestone$[\;]$\{\}\{\}\{\}}] This macro
  has four arguments. The first (optional) argument is the milestone
  delivery month; the second argument is the name of the milestone;
  the third argument is the means of verification, and the last
  argument is the list of work packages involved. The list of work
  packages can use the latex \texttt{\textbackslash ref} command.
\end{description}
Example: \texttt{\textbackslash milestone[24]\{Completed algorithmic
  model\}\{Software package released and
  validated\}\{WP\,\textbackslash ref\{wp:modeling\}\}}

\subsection{\textbackslash makerisklist}
This command creates the Critical risks for implementation Table 3.2b required by the
EU template. Critical risks relating to project implementation need to be be defined before this command is issued, by using the  \texttt{\textbackslash
 criticalrisk} macro:
\begin{description}
\item[\texttt{\textbackslash criticalrisk\{\}\{\}\{\}}] This macro
  has three arguments. The first argument is the description of the risk; the second is the list of work packages involved, and the third should describe any risk mitigation measures, and the actions planned for it. The list of work
  packages involved can use the latex \texttt{\textbackslash ref} command.
\end{description}
Example: \texttt{\textbackslash criticalrisk\{The dedicated chip sent to fabrication is not functional.\}\{WP\,\textbackslash ref\{wp:testwp1\}\}\{Resort to Software simulations\}}


\subsection{\textbackslash makesummaryofefforttable}
This command is typically issued after defining the various work
packages (via the \texttt{workpackage} environment). It uses the data
defined in each \texttt{workpackage} environment, saves it to the
auxiliary file $<$jobname$>$.lse and creates the table in subsequent
compilation runs. The WP leader is identified in the table by showing
the relevant person-months figure in bold (as specified in the EU
template).

\subsection{\textbackslash maketasklist}
This command is not required by the EU template, but it can be
useful to have an overview of who is responsible for which task, in
which WP. The command creates an ordered list of tasks with Task ID,
PI name (in case it is defined in the \texttt{\textbackslash wptask}
macro), start and end dates, and task title. The required information
is saved in the auxiliary file $<$jobname.ltk$>$ and used in
subsequent compilation runs to create the table.

\subsection{\textbackslash makecoststable}
This command creates a summary of costs table, for each participant, if the sum of the costs for ``travel'', ``equipment'', and ``goods and services'' exceeds 15\% of the personnel costs for that participant. In order to enter the data for these tables it is necessary to use the following macros:
\begin{description}
\item[\texttt{\textbackslash costsTravel\{\}\{\}\{\}}] This macro accepts three arguments. The first is the participant short name; the second has to be a number indicating the total amount of euro requested for travel expenses; and the third argument is a text string describing the justification for the requested budget.
\item[\texttt{\textbackslash costsEquipment\{\}\{\}\{\}}] Similar to the previous macro, this one accepts three arguments: the participant short name, the total amount of euro requested for equipment expenses, and  a text string describing the justification for the requested budget.
\item[\texttt{\textbackslash costsOther\{\}\{\}\{\}}] This macro is equivalent to the previous two, with the exception that the costs and justification apply to ``other goods and services''.
\end{description}


\subsection{\textbackslash makelritable}
This command creates a table for every participant that declares costs of large research infrastructure irrespective of the percentage of personnel costs (see Article 6.2 of the General Model Agreement). To enter the data for the table you must use the following macro:
\begin{description}
\item[\texttt{\textbackslash costslri\{\}\{\}\{\}}] This macro accepts as arguments the participant short name; the costs of the large research infrastructure, and the justification.
\end{description}
In case no costs are declared (in case the macro is not instantiated), no tables are generated.

\section{The \texttt{workpackage} environment}
\label{sec:wp-envir}

Each proposal work package should be defined using the
\texttt{workpackage} environment. If multiple work packages are
described as separate files and included in the proposal using the
\texttt{\textbackslash include} command, use the
\texttt{\textbackslash input} command for the first file.  The
\texttt{workpackage} environment has an optional argument which is the
wp title. The syntax of this
environment is (without or with optional argument):\\
\begin{center}
\begin{tabular}{l | l}
\textbf{\texttt{\textbackslash begin\{workpackage\}}} &
\textbf{\texttt{\textbackslash begin\{workpackage\}\{WP Title\}}} \\
\ldots & \ldots \\
\textbf{\texttt{\textbackslash end\{workpackage\}}} & 
\textbf{\texttt{\textbackslash end\{workpackage\}}}
\end{tabular}
\end{center}

The standard way of defining labels (\emph{e.g.}, \textbackslash
label\{wp:management\}) can be used, so that different wps can be
referenced within the proposal document using the standard
\textbackslash ref\{\} command.

The following macros can be used within the \texttt{workpackage}
environment:
\begin{description}
\item[\texttt{\textbackslash wptitle\{\}}] This macro specifies the wp
  title.
\item[\texttt{\textbackslash wpstart\{\}}] This macro specifies the wp
  start month.
\item[\texttt{\textbackslash wpend\{\}}] This macro specifies the wp
  end month.
\item[\texttt{\textbackslash wptype\{\}}] This macro specifies the wp
  activity type, and should be one of: ``RTD'', ``DEM'', ``MGT'', or
  ``OTHER''.
\item[\texttt{\textbackslash personmonths\{\}\{\}}] This macro
  specifies the person months used for each participant. It has two
  required arguments. The first one is the participant short name,
  defined with the \texttt{\textbackslash participant} macro. The
  second argument is an integer specifying the person-months allocated
  to the specified participant. This command can have a ``*'' appended
  at the end, to indicate that the participant specified is the wp
  leader. \emph{E.g.}\\
  \textbf{\texttt{\textbackslash personmonths*\{UZH\}\{24\}}}\\
  \textbf{\texttt{\textbackslash personmonths\{ETHZ\}\{18\}}}\\
  (the UZH partner is the wp leader and will use 24 person months,
  while ETHZ is an additional wp participant that will use 18 person
  months).
\end{description}


\subsection{\texttt{\textbackslash makewptable} command}
\label{sec:makewptable}

This command creates the top table in the wp environment with all the
info specified using the macros described above. The WP leader data is
shown in boldface.

Three additional environments need to be defined within the
\texttt{workpackage} environment, to complete the wp description: the
Objectives (\texttt{wpobjectives}), the Description of work
(\texttt{wpdescription}), and the Deliverables
(\texttt{wpdeliverables}) environments.

\subsection{The \texttt{wpobjectives} environment}
\label{sec:object-envir}

This environment has no specific macros. It is useful for creating a
framed paragraph, in which the user can write arbitrary
text. \emph{E.g.}
\begin{verbatim}
  \begin{wpobjectives}
    This work package has the following objectives:
    \begin{enumerate}
    \item To develop ....
    \item To apply this ....
    \item etc.
    \end{enumerate}
  \end{wpobjectives}
\end{verbatim}

\subsection{The \texttt{wpdescription} environment}
\label{sec:descr-work-envir}

This environment creates a separate framed paragraph, in which the
details of the wp are specified. Within this environment it is
possible to define multiple Tasks, using the \texttt{\textbackslash
  wptask} macro:
%{start-m}{end-m}{title}{description}   
\begin{description}
\item[\texttt{\textbackslash wptask\{\}\{\}\{\}\{\}\{\}\{\}}] This
  macro has 6 arguments. The first argument specifies
  the name of the Task leader responsible for the task using the short name defined with the
  \texttt{\textbackslash participant} macro. The
  second argument specifies the list of contributor partners. The third and fourth
  arguments specify task start and end date respectively. The fifth
  argument represents the Task title, while the last one is text with
  a short description of the task.
\end{description}
The \texttt{\textbackslash wptask} macro creates an ordered list of
tasks within the \texttt{wpdescription} environment and stores the
data relative to the WP tasks. The information specified here is used
also by the \texttt{\textbackslash maketasklist} macro, which creates an
ordered list of tasks to show which PI is responsible for which task.

The information gathered with this macro could also be used to
automatically create Gantt charts or timing diagrams (not implemented
currently).

\subsection{The \texttt{wpdeliverables} environment}
\label{sec:deliv-envir}

This environment creates a third framed paragraph, with a list of
deliverables. To specify the information associated to each
deliverables, it is necessary to use the  \texttt{\textbackslash
  wpdeliverable} macro:
\begin{description}
\item[\texttt{\textbackslash wpdeliverable$[\,]$\{\}\{\}\{\}\{\}}] This
  macro has 5 arguments. The first optional argument specified the
  delivery date (month). The second argument specifies the participant responsible for producing the deliverable. The third argument specifies the deliverable
  nature, and should be one of ``R'', ``P'', ``D'', or ``O'' (R =
  Report, P = Prototype, D = Demonstrator, O = Other). The fourth
  argument specified the deliverable dissemination level, and should
  be one of ``PU'', ``PP'', ``RE'', or ``CO'' (PU = Public, PP =
  Restricted to other program participants, including the Commission
  Services, RE = Restricted to a group specified by the consortium,
  including the Commission Services, CO = Confidential, only for
  members of the consortium, including the Commission Services.
  The last argument specifies the deliverable title.
\end{description}


\section{Labels and References}
\label{sec:labels-references}

All proposal environments have their own internal labels and counters,
which get generated automatically. If you want to reference an
environment explicitly (e.g., reference a specific deliverable or work
package with a custom name) you should use the commands
\texttt{\textbackslash label\{\}} and \texttt{\textbackslash ref\{\}}.

Environments that use the \texttt{\textbackslash begin\{\}} and
\texttt{\textbackslash end\{\}} constructs can have the label defined
within the constructs. Environments defined with single commands
(e.g. \texttt{\textbackslash wpdeliverable}) should have the label
defined just after the environment definition.

\section{Conclusions}
\label{sec:conclusions}

The \texttt{h2020proposal} class should be useful for automating the
process of creating complex proposal documents with many work packages
and inter dependencies. If one uses separate files to include multiple
work packages (\emph{e.g.}, using the \texttt{\textbackslash
  input\{\}} or \texttt{\textbackslash include\{\}} commands), it is
going to be easy to re-shuffle the order of work packages, and the
\texttt{h2020proposal} class will take care of re-assigning wp and
deliverable counters, re-ordering deliverables and resorting the
tables. Also last-minute changes to person-months allocated in any of
the work packages will be automatically accounted for in the various
tables. The \texttt{h2020proposal} class was designed to maintain
consistency across the whole document, and quickly (automatically)
update the proposal tables.

The class is still in a beta-testing stage. Please do not
distribute. If you have suggestions or find bugs and problems, please
report them to Giacomo Indiveri \url{giacomo@ini.uzh.ch}.

\section*{Copyright and license}
The \texttt{h2020proposal} Class\\
Copyright 2015 \copyright, Giacomo Indiveri 

 This latex class is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 h2020proposal.cls is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with h2020proposal.  If not, see <http://www.gnu.org/licenses/>.

\section*{Disclaimer}
\label{sec:disclaimer}
Use the original source and the http://ec.europa.eu/ documentation for reference. We make no representations or warranties of any kind, express or implied, about the completeness, accuracy, reliability, suitability or availability with respect to the original template. In no event will we be liable for any loss or damage including without limitation, indirect or consequential loss or damage, or any loss or damage whatsoever arising out of, or in connection with, the use of this template and/or class.

\end{document}