| 1 |
% \iffalse meta-comment |
| 2 |
% A class for preparing FP7 proposals for collaborative projects |
| 3 |
% |
| 4 |
% Copyright (c) 2011 Michael Kohlhase, all rights reserved |
| 5 |
% |
| 6 |
% This file is distributed under the terms of the LaTeX Project Public |
| 7 |
% License from CTAN archives in directory macros/latex/base/lppl.txt. |
| 8 |
% Either version 1.0 or, at your option, any later version. |
| 9 |
% |
| 10 |
% The development version of this file can be found at |
| 11 |
% https://github.com/KWARC/LaTeX-proposal |
| 12 |
% \fi |
| 13 |
% |
| 14 |
% \iffalse |
| 15 |
%<cls|pdata|reporting>\NeedsTeXFormat{LaTeX2e}[1999/12/01] |
| 16 |
%<cls>\ProvidesClass{euproposal}[2016/04/15 v1.5 EU Proposal] |
| 17 |
%<pdata>\ProvidesPackage{eupdata}[2016/04/15 v1.5 EU Project Data] |
| 18 |
%<reporting>\ProvidesPackage{eureporting}[2016/04/15 v1.5 EU Project Reporting] |
| 19 |
%<*driver> |
| 20 |
\documentclass[twoside]{ltxdoc} |
| 21 |
\DoNotIndex{\def,\long,\edef,\xdef,\gdef,\let,\global} |
| 22 |
\DoNotIndex{\begin,\AtEndDocument,\newcommand,\newcounter,\stepcounter} |
| 23 |
\DoNotIndex{\immediate,\openout,\closeout,\message,\typeout} |
| 24 |
\DoNotIndex{\section,\scshape,\arabic} |
| 25 |
\EnableCrossrefs |
| 26 |
%\CodelineIndex |
| 27 |
%\OnlyDescription |
| 28 |
\RecordChanges |
| 29 |
\usepackage{textcomp,url,paralist,a4wide,xspace} |
| 30 |
\usepackage[show]{ed} |
| 31 |
\usepackage[maxnames=6,hyperref=auto,style=alphabetic,backend=bibtex]{biblatex} |
| 32 |
\addbibresource{../lib/proposal.bib} |
| 33 |
\usepackage[bookmarks=true,linkcolor=blue, |
| 34 |
citecolor=blue,urlcolor=blue,colorlinks=true, |
| 35 |
breaklinks=true, bookmarksopen=true]{hyperref} |
| 36 |
\makeindex |
| 37 |
\newcommand\subversion{\textsc{Subversion}\xspace} |
| 38 |
\begin{document} |
| 39 |
\DocInput{euproposal.dtx} |
| 40 |
\end{document} |
| 41 |
%</driver> |
| 42 |
% \fi |
| 43 |
% |
| 44 |
%\CheckSum{639} |
| 45 |
% |
| 46 |
% \changes{v0.1}{2007/05/07}{used in the SciML proposal} |
| 47 |
% \changes{v0.2}{2007/05/09}{First Version with Documentation} |
| 48 |
% \changes{v0.3}{2007/06/04}{staff effort table finally works, released} |
| 49 |
% \changes{v0.3a}{2008/01/18}{error corrections and more documentation} |
| 50 |
% \changes{v1.3}{2011/05/18}{basing this on proposal.cls} |
| 51 |
% \changes{v1.4}{2012/01/18}{various tweaks for the Jan 2012 proposal deadline} |
| 52 |
% \changes{v1.4}{2015/01/14}{lots of tweaks} |
| 53 |
% |
| 54 |
% \GetFileInfo{euproposal.cls} |
| 55 |
% |
| 56 |
% \MakeShortVerb{\|} |
| 57 |
% \title{Preparing FP7 EU Proposals and Reports in {\LaTeX} with \texttt{euproposal.cls}} |
| 58 |
% \author{Michael Kohlhase\\ |
| 59 |
% Computer Science, Jacobs University Bremen\\ |
| 60 |
% \url{http://kwarc.info/kohlhase}} |
| 61 |
% \maketitle |
| 62 |
% |
| 63 |
% \begin{abstract} |
| 64 |
% The |euproposal| class supports many of the specific elements of a Framework 7 |
| 65 |
% Proposal. It is optimized towards collaborative projects. The package comes with an |
| 66 |
% extensive example (a fake EU proposal) that shows all elements in action. |
| 67 |
% \end{abstract} |
| 68 |
% |
| 69 |
% \tableofcontents\newpage |
| 70 |
% |
| 71 |
% \section{Introduction}\label{sec:intro} |
| 72 |
% |
| 73 |
% Writing grant proposals is a collaborative effort that requires the integration of |
| 74 |
% contributions from many individuals. The use of an ASCII-based format like {\LaTeX} |
| 75 |
% allows to coordinate the process via a source code control system like |
| 76 |
% \subversion, allowing the proposal writing team to concentrate on the contents |
| 77 |
% rather than the mechanics of wrangling with text fragments and revisions. |
| 78 |
% |
| 79 |
% The |euproposal| class extends the |proposal| class~\cite{Kohlhase:pplp:svn} and |
| 80 |
% supports many of the specific elements of Part B of a Framework 7 Proposal. The |
| 81 |
% package documentation is still preliminary, fragmented and incomplete and only dwells |
| 82 |
% on the particulars of DFG proposals, so we treat~\cite{Kohlhase:pplp:svn} as a |
| 83 |
% prerequisite. Please consult the example proposal |propB.tex|, which comes with the |
| 84 |
% package and shows the usage of the class in action. It is intended as a template for |
| 85 |
% your proposal, but please bear in mind that the EU guidelines may change from call to |
| 86 |
% call, if in doubt, please consult the FP7 guide for proposers.\ednote{say something |
| 87 |
% about the proposers guide.} |
| 88 |
% |
| 89 |
% The |eureporting| class supports most of the specific elements of the project reports |
| 90 |
% to the EC. The example report |dfg/report.tex| is intended as a template for your |
| 91 |
% final report\ednote{say something about reporting}. |
| 92 |
% |
| 93 |
% The |euproposal| and |eureporting| classes and the |eupdata| package are distributed |
| 94 |
% under the terms of the LaTeX Project Public License from CTAN archives in directory |
| 95 |
% macros/latex/base/lppl.txt. Either version 1.0 or, at your option, any later |
| 96 |
% version. The CTAN archive always contains the latest stable version, the development |
| 97 |
% version can be found at \url{https://github.com/KWARC/LaTeX-proposal}. For bug reports |
| 98 |
% please use the sTeX TRAC at \url{https://github.com/KWARC/LaTeX-proposal/issues}. |
| 99 |
% |
| 100 |
% \section{The User Interface}\label{sec:user-interface} |
| 101 |
% |
| 102 |
% In this section we will describe the functionality offered by the |euproposal| class |
| 103 |
% along the lines of the macros and environments the class provides. Much of the |
| 104 |
% functionality can better be understood by studying the functional example |proposal.tex| |
| 105 |
% (and its dependents) that comes with the |euproposal| package in conjunction with the |
| 106 |
% proposer's EU proposer's guidelines (we have included it as |***| for convenience into |
| 107 |
% the package distribution).\ednote{MK@MK do that and talk about reporting as well.} |
| 108 |
% |
| 109 |
% \subsection{Package Options}\label{sec:user:options} |
| 110 |
% |
| 111 |
% As usual in {\LaTeX}, the package is loaded by |
| 112 |
% |\documentclass[|\meta{options}|]{euproposal}|, where |[|\meta{options}|]| is optional |
| 113 |
% and gives a comma separated list of options specified in~\cite{Kohlhase:pplp:svn}. Some |
| 114 |
% versions EU proposals want non-standard numbering schemes (e.g. starting with |
| 115 |
% \textbf{B...} since we are writing Part B.), this can be reached by giving the |propB| |
| 116 |
% option. |
| 117 |
% |
| 118 |
% \subsection{Proposal Metadata and Title page}\label{sec:user:metadata} |
| 119 |
% |
| 120 |
% The metadata of the proposal is specified in the \DescribeEnv{proposal}|proposal| |
| 121 |
% environment, which also generates the title page and the first section of the proposal |
| 122 |
% as well as the last pages of the proposal with the signatures, enclosures, and |
| 123 |
% references. The |proposal| environment should contain all the mandatory parts of the |
| 124 |
% proposal text. The |proposal| environment uses the following EU-specific keys to |
| 125 |
% specify metadata. |
| 126 |
% \begin{compactitem} |
| 127 |
% \item \DescribeMacro{callname}|callname| specifies the call the proposal addresses. It is |
| 128 |
% usually a string of the form |ICT Call 1|, \DescribeMacro{callid}|callid| is the |
| 129 |
% corresponding identifier, usually a string of the form |FP7-???-200?-?|. An overview |
| 130 |
% over open calls can be found at \url{http://cordis.europa.eu/fp7/dc/index.cfm} |
| 131 |
% \item The \DescribeMacro{challenge}|challenge|, \DescribeMacro{objective}|objective|, |
| 132 |
% and \DescribeMacro{outcome}|outcome| keys specifies the specific parts in the call |
| 133 |
% this proposal addresses. These are specified in the ``call fiche'' that can be |
| 134 |
% obtained from the URL above. All of these have an identifier, which can be specified |
| 135 |
% via the \DescribeMacro{challengeid}|challengeid|, |
| 136 |
% \DescribeMacro{objectiveid}|objectiveid|, and \DescribeMacro{outcomeid}|outcomeid| |
| 137 |
% keys.\ednote{MK@MK: the outcomeid should key should be a list key, I am not |
| 138 |
% implementing this right now, since it comes more natural when we change the class to |
| 139 |
% metakeys support.} |
| 140 |
% \item \DescribeMacro{topicsaddressed}|topicsaddressed| allows to enter free-form text |
| 141 |
% instead of specifying the |challenge*|, |objective*|, and |outcome*| keys. |
| 142 |
% \item The \DescribeMacro{coordinator}|coordinator| key gives the identifier of the |
| 143 |
% proposal coordinator. The |euproposal| package uses the |workaddress| package for |
| 144 |
% representation of personal metadata, see~\cite{Kohlhase:workaddress:ctan} for details. |
| 145 |
% \item The \DescribeMacro{coordinatorsite}|coordinatorsite| key gives the identifier of |
| 146 |
% the coordinating site (for the table). |
| 147 |
% \item If given, the \DescribeMacro{iconrowheight}|iconrowheight| key instructs the |
| 148 |
% |euproposal| class to make a line with the logos of the participants at the bottom of |
| 149 |
% the title page, and specify their heights; |1.5cm| is often a good value. |
| 150 |
% \end{compactitem} |
| 151 |
% |
| 152 |
% \subsection{Work Packages and Work Areas}\label{sec:user:wpwa} |
| 153 |
% |
| 154 |
% \DescribeMacro{type} The |type| key specifies the activity type of the work package: |
| 155 |
% |RTD| = Research and technological development (including any activities to prepare for |
| 156 |
% the dissemination and/or exploitation of project results, and coordination activities); |
| 157 |
% |DEM| = Demonstration; |MGT| = Management of the consortium; |OTHER| = Other specific |
| 158 |
% activities, if applicable in this call. |
| 159 |
% |
| 160 |
% \subsection{Milestones and Deliverables}\label{sec:user:deliverables} |
| 161 |
% |
| 162 |
% |euproposal.cls| adds the \DescribeMacro{verif}|verif| key to \DescribeMacro{\milestone} |
| 163 |
% for specifying a means of verification that the milestone has been successful. |
| 164 |
% |
| 165 |
% With this, we can generate the milestone table that is required in many EU |
| 166 |
% proposals. This can simply be done via the |
| 167 |
% \DescribeMacro{\milestonetable}|\milestonetable| macro. It takes a keyword argument with |
| 168 |
% the keys \DescribeMacro{caption}|caption| for specifying a different caption, and the |
| 169 |
% widths \DescribeMacro{wname}|wname|, \DescribeMacro{wdeliv}|wdeliv|, and |
| 170 |
% \DescribeMacro{wverif}|wverif| that can be used to specify different widths for the |
| 171 |
% name/deliverables/verification columns in the milestone table. |
| 172 |
% |
| 173 |
% \subsection{Risks}\label{sec:user:risks} |
| 174 |
% In some EU proposals (e.g. FET), we need to identify risks and contingency and specify |
| 175 |
% mitigation plans for them. In the |euproposal| we use two environments to mark them up. |
| 176 |
% |
| 177 |
% \DescribeMacro{risk}|\begin{risk}{|\meta{title}|}{|\meta{prob}|}{|\meta{grav}|}|\ldots|\end{risk}| |
| 178 |
% makes a paragraph no a risk \meta{title} with gravity \meta{grav} and probability |
| 179 |
% \meta{prob}, where the body of the environment contains a description of the risk. The |
| 180 |
% \DescribeMacro{riskcont}|riskcont| is a variant, where \meta{title} names a risk and the |
| 181 |
% body is a description of the contingency plan. |
| 182 |
% |
| 183 |
% \begin{newpart}{MK@MK: This is new, and only partially implemented} |
| 184 |
% \subsection{Reporting Infrastructure}\label{sec:user:report} |
| 185 |
% |
| 186 |
% The |eureporting| class gives an infrastructure for writing final reports of completed |
| 187 |
% projects (see the file |finalreport.tex| in the package distribution). The |
| 188 |
% \DescribeEnv{report}|report| environment has functionality analogous to the |proposal| |
| 189 |
% environment. It takes the same metadata keys --- making it easy to generate by |
| 190 |
% copy/paste from the proposal --- but adds the keys \DescribeMacro{key}|key| can be used |
| 191 |
% to specify the reference key (something like \texttt{KO 2428 47-11}) given to the |
| 192 |
% project by EU. Note that in the case of multiple proposers, you can use multiple |
| 193 |
% instances of |key| to specify more than one reference key. |
| 194 |
% \end{newpart} |
| 195 |
% |
| 196 |
% \section{Limitations and Enhancements}\label{sec:limitations} |
| 197 |
% |
| 198 |
% The |euproposal| is relatively early in its development, and many enhancements are |
| 199 |
% conceivable. We will list them here. |
| 200 |
% \begin{enumerate} |
| 201 |
% \item none reported yet. |
| 202 |
% \end{enumerate} |
| 203 |
% If you have other enhancements to propose or feel you can alleviate some limitation, |
| 204 |
% please feel free to contact the author. |
| 205 |
% |
| 206 |
% \StopEventually{\newpage\PrintIndex\newpage\PrintChanges\newpage\printbibliography}\newpage |
| 207 |
% |
| 208 |
% \section{The Implementation}\label{sec:implementation} |
| 209 |
% |
| 210 |
% In this section we describe the implementation of the functionality of the |euproposal| |
| 211 |
% and |eureporting| classes and the |eupdata| package. |
| 212 |
% |
| 213 |
% \subsection{Package Options and Format Initialization}\label{sec:impl:options} |
| 214 |
% |
| 215 |
% We first set up the options for the package. |
| 216 |
% |
| 217 |
% \begin{macrocode} |
| 218 |
%<*cls> |
| 219 |
\newif\ifpartB\partBfalse |
| 220 |
\DeclareOption{partB}{\partBtrue} |
| 221 |
\DeclareOption*{\PassOptionsToClass{\CurrentOption}{proposal}} |
| 222 |
%</cls> |
| 223 |
%<reporting>\DeclareOption*{\PassOptionsToClass{\CurrentOption}{reporting}} |
| 224 |
%<cls|reporting>\ProcessOptions |
| 225 |
% \end{macrocode} |
| 226 |
% |
| 227 |
% Then we load the packages we make use of |
| 228 |
% |
| 229 |
% \begin{macrocode} |
| 230 |
%<cls>\ifpartB\LoadClass[report,noRAM]{proposal}\else\LoadClass[noRAM]{proposal}\fi |
| 231 |
%<reporting>\LoadClass[report,noRAM]{reporting} |
| 232 |
%<*cls|reporting> |
| 233 |
\RequirePackage{longtable} |
| 234 |
\RequirePackage{eurosym} |
| 235 |
\RequirePackage{wrapfig} |
| 236 |
\RequirePackage{eupdata} |
| 237 |
% \end{macrocode} |
| 238 |
% we want to change the numbering of figures and tables |
| 239 |
% \begin{macrocode} |
| 240 |
\RequirePackage{chngcntr} |
| 241 |
\counterwithin{figure}{subsection} |
| 242 |
\counterwithin{table}{subsection} |
| 243 |
%</cls|reporting> |
| 244 |
% \end{macrocode} |
| 245 |
% |
| 246 |
% \subsection{Proposal Metadata and Title Page}\label{sec:impl:metadata} |
| 247 |
% |
| 248 |
% We extend the metadata keys from the |proposal| class. |
| 249 |
% \begin{macrocode} |
| 250 |
%<*pdata> |
| 251 |
\define@key{prop@gen}{coordinator}{\def\prop@gen@coordinator{#1}\pdata@def{prop}{gen}{coordinator}{#1}} |
| 252 |
\define@key{prop@gen}{coordinatorsite}{\def\prop@gen@coordinatorsite{#1}\pdata@def{prop}{gen}{coordinator}{#1}} |
| 253 |
\def\prop@gen@challenge{??}\def\prop@gen@challengeid{??} |
| 254 |
\define@key{prop@gen}{challenge}{\def\prop@gen@challenge{#1}\pdata@def{prop}{gen}{challenge}{#1}} |
| 255 |
\define@key{prop@gen}{challengeid}{\def\prop@gen@challengeid{#1}\pdata@def{prop}{gen}{challengeid}{#1}} |
| 256 |
\def\prop@gen@objective{??}\def\prop@gen@objectiveid{??} |
| 257 |
\define@key{prop@gen}{objective}{\def\prop@gen@objective{#1}\pdata@def{prop}{gen}{objective}{#1}} |
| 258 |
\define@key{prop@gen}{objectiveid}{\def\prop@gen@objectiveid{#1}\pdata@def{prop}{gen}{objectiveid}{#1}} |
| 259 |
\def\prop@gen@outcome{??}\def\prop@gen@outcomeid{??} |
| 260 |
\define@key{prop@gen}{outcome}{\def\prop@gen@outcome{#1}\pdata@def{prop}{gen}{outcome}{#1}} |
| 261 |
\define@key{prop@gen}{outcomeid}{\def\prop@gen@outcomeid{#1}\pdata@def{prop}{gen}{outcomeid}{#1}} |
| 262 |
\define@key{prop@gen}{callname}{\def\prop@gen@call{#1}\pdata@def{prop}{gen}{callname}{#1}} |
| 263 |
\define@key{prop@gen}{callid}{\def\prop@gen@call{#1}\pdata@def{prop}{gen}{callid}{#1}} |
| 264 |
\define@key{prop@gen}{iconrowheight}{\def\prop@gen@iconrowheight{#1}} |
| 265 |
\define@key{prop@gen}{topicsaddressed}{\def\prop@gen@topicsaddressed{#1}} |
| 266 |
%</pdata> |
| 267 |
% \end{macrocode} |
| 268 |
% |
| 269 |
% and now the ones for the final report |
| 270 |
% \begin{macrocode} |
| 271 |
%<*reporting> |
| 272 |
\define@key{prop@gen}{reportperiod}{\def\prop@gen@reportperiod{#1}} |
| 273 |
\define@key{prop@gen}{key}{\@dmp{key=#1}% |
| 274 |
\@ifundefined{prop@gen@keys}{\xdef\prop@gen@keys{#1}}{\xdef\prop@gen@keys{\prop@gen@keys,#1}}} |
| 275 |
\define@key{prop@gen}{projpapers}{\def\prop@gen@projpapers{#1}} |
| 276 |
%</reporting> |
| 277 |
% \end{macrocode} |
| 278 |
% |
| 279 |
% and the default values, these will be used, if the author does not specify something |
| 280 |
% better. |
| 281 |
% |
| 282 |
% If the |propB| option is given, we need to redefine some of the internal counters and |
| 283 |
% table of contents mechanisms to adapt to the fact that the proposal text is just Part B. |
| 284 |
% |
| 285 |
% \begin{macrocode} |
| 286 |
%<*cls> |
| 287 |
\ifpartB |
| 288 |
\def\thepart{\Alph{part}} |
| 289 |
\setcounter{part}{2} |
| 290 |
\def\thechapter{\thepart.\arabic{chapter}} |
| 291 |
\def\numberline#1{\hb@xt@\@tempdima{#1\hfil} } |
| 292 |
\fi |
| 293 |
% \end{macrocode} |
| 294 |
% |
| 295 |
% \begin{macro}{\prop@sites@table} |
| 296 |
% \begin{macrocode} |
| 297 |
\newcommand\prop@sites@table{\def\@@table{} |
| 298 |
{\let\tabularnewline\relax\let\hline\relax |
| 299 |
\@for\@I:=\prop@gen@sites\do{\xdef\@@table{\@@table\pdataref{site}\@I{number}} |
| 300 |
\xdef\@@table{\@@table&\@nameuse{wa@institution@\@I @name} |
| 301 |
\ifx\@I\prop@gen@coordinatorsite (coordinator)\fi} |
| 302 |
\xdef\@@table{\@@table&\@nameuse{wa@institution@\@I @acronym}} |
| 303 |
\xdef\@@table{\@@table&\@nameuse{wa@institution@\@I @countryshort}\tabularnewline\hline}}} |
| 304 |
\begin{tabular}{|l|p{8cm}|l|l|}\hline%| |
| 305 |
\# & Participant organisation name & Short name & Country\\\hline\hline |
| 306 |
\@@table |
| 307 |
\end{tabular}} |
| 308 |
% \end{macrocode} |
| 309 |
% \end{macro} |
| 310 |
% |
| 311 |
% \begin{environment}{prop@proposal} |
| 312 |
% \begin{macrocode} |
| 313 |
\renewenvironment{prop@proposal} |
| 314 |
{\ifgrantagreement\else |
| 315 |
\thispagestyle{empty}\begin{center} |
| 316 |
{\Large \prop@gen@instrument}\\[.2cm] |
| 317 |
{\Large\textbf\prop@gen@callname}\\[.4cm] |
| 318 |
{\LARGE \prop@gen@callid}\\[.8cm] |
| 319 |
{\huge\textbf\prop@gen@title}\\[.4cm] |
| 320 |
{\LARGE Acronym: {\prop@gen@acronym}}\\[2cm] |
| 321 |
\end{center} |
| 322 |
%{\large\prop@gen@instrument}\\ |
| 323 |
{\large\textbf{Date of Preparation: \today}} |
| 324 |
% \ifsubmit\else\if@svninfo\if@gitinfo\\ |
| 325 |
% {\large\textbf{Revision}: |
| 326 |
% \if@svninfo\svnInfoRevision\fi\if@gitinfo\gitAbbrevHash\fi |
| 327 |
% of |
| 328 |
% \if@svninfo\svnInfoDate\fi\if@gitinfo\gitAuthorDate\fi} |
| 329 |
% \fi\fi\fi |
| 330 |
\\[1em] |
| 331 |
\begin{large} |
| 332 |
\begin{description} |
| 333 |
% \item[Work program topics addressed by \pn:] |
| 334 |
% \@ifundefined{prop@gen@topicsaddressed} |
| 335 |
% {\textbf{Challenge \prop@gen@challengeid}: \prop@gen@challenge, |
| 336 |
% \textbf{Objective \prop@gen@objectiveid}: \prop@gen@objective, |
| 337 |
% \textbf{target outcome \prop@gen@outcomeid}) \prop@gen@outcome. |
| 338 |
% {\prop@gen@topicsaddressed}\\[1em] |
| 339 |
\item[Coordinator:] \wa@ref{person}\prop@gen@coordinator{name} |
| 340 |
\item[e-mail:] \wa@ref{person}\prop@gen@coordinator{email} |
| 341 |
\item[tel/fax:] \wa@ref{person}\prop@gen@coordinator{worktelfax} |
| 342 |
\@ifundefined{prop@gen@keywords}{}{\item[Keywords:] \prop@gen@keywords} |
| 343 |
\end{description} |
| 344 |
\end{large} |
| 345 |
\vspace*{1em} |
| 346 |
\begin{center} |
| 347 |
\prop@sites@table\vfill |
| 348 |
\@ifundefined{prop@gen@iconrowheight}{} |
| 349 |
{\@for\@site:=\prop@gen@sites\do{\wa@institution@logo[height=\prop@gen@iconrowheight]\@site\qquad}} |
| 350 |
\end{center} |
| 351 |
\newpage |
| 352 |
\fi% ifgrantagreement |
| 353 |
\setcounter{tocdepth}{2}\setcounter{part}{2}} |
| 354 |
{\newpage\printbibliography[heading=warnpubs,maxnames=999]} |
| 355 |
% \end{macrocode} |
| 356 |
% \end{environment} |
| 357 |
% |
| 358 |
% \begin{macrocode} |
| 359 |
\def\prop@gen@instrument{Proposal Instrument (e.g. IP)} |
| 360 |
% \end{macrocode} |
| 361 |
% |
| 362 |
% \subsection{Site Descriptions}\label{sec:sitedesc} |
| 363 |
% \ednote {this functionality should probably be refactored into proposal.dtx} |
| 364 |
% |
| 365 |
% \begin{environment}{sitedescription} |
| 366 |
% \ednote{document this above} |\begin{sitedescritpion}[|\meta{opt}|]{\meta{site}}| |
| 367 |
% marks up the description for the site \meta{site}. It looks up the relevant metadata |
| 368 |
% from the respective |\WAinstitution| declarations. The options argument \meta{opt} |
| 369 |
% is a key-value list for the keys \DescribeMacro{logo}|logo| (add the logo from |
| 370 |
% |\WAinstitution| to the site description), \DescribeMacro{width}|width|, |
| 371 |
% \DescribeMacro{height}|height| (intended dimensions of the logo), \ednote{more?}. |
| 372 |
% \begin{macrocode} |
| 373 |
\define@key{site@desc}{box}[true]{\def\site@desc@box{#1}% |
| 374 |
\pdata@def{sitedesc}{\@site}{box}{#1}} |
| 375 |
\define@key{site@desc}{logo}[true]{\def\site@desc@logo{#1}% |
| 376 |
\pdata@def{sitedesc}{\@site}{logo}{#1}} |
| 377 |
\define@key{site@desc}{width}{\def\site@desc@width{#1}% |
| 378 |
\pdata@def{sitedesc}{\@site}{width}{#1}\@dmp{wd=#1}} |
| 379 |
\define@key{site@desc}{height}{\def\site@desc@height{#1}% |
| 380 |
\pdata@def{sitedesc}{\@site}{height}{#1}\@dmp{ht=#1}} |
| 381 |
\newenvironment{sitedescription}[2][]% |
| 382 |
{\def\c@site{#2}% remember the site ID |
| 383 |
\newcounter{site@#2@PM} % for the site PM |
| 384 |
\def\site@desc@box{false}% not box unless requested |
| 385 |
\def\site@desc@logo{false}% not logo unless requested |
| 386 |
\def\site@desc@height{1.3cm}% default height |
| 387 |
\def\site@desc@width{5cm}% default width |
| 388 |
\setkeys{site@desc}{#1}% read the keys to overwrite the defaults |
| 389 |
\ifx\@site@desc@box\@true% if we want a logo |
| 390 |
\begin{wrapfigure}{r}{\site@desc@width}\vspace{-2.5ex}% |
| 391 |
\begin{tabular}{|p{\site@desc@width}|}\hline\vspace{1mm}% |
| 392 |
\ifx\@site@desc@logo\@true% if we want a logo |
| 393 |
\wa@institution@logo[height=\site@desc@width]{#2}\\[1ex]% |
| 394 |
\fi% end logo |
| 395 |
\textbf{\wa@ref{institution}{#2}{type}.\hfill \wa@ref{institution}{#2}{country}}\\% |
| 396 |
\small\wa@ref{institution}{#2}{streetaddress}, \wa@ref{institution}{#2}{townzip}\\\hline% |
| 397 |
\end{tabular}\vspace{-2.5ex}% |
| 398 |
\end{wrapfigure}% |
| 399 |
\fi% end box |
| 400 |
\pdata@target{site}{#2}% |
| 401 |
{\subsubsection{\wa@ref{institution}{#2}{acronym}: % space here |
| 402 |
{\textsc{\wa@ref{institution}{#2}{name}} (\wa@ref{institution}{#2}{countryshort})}}}% |
| 403 |
\small% |
| 404 |
\renewcommand\paragraph{\@startsection{paragraph}{4}{\z@}% |
| 405 |
{0.25ex \@plus1ex \@minus.2ex}% |
| 406 |
{-1em}% |
| 407 |
{\normalfont\normalsize\bfseries}}} |
| 408 |
{\pdata@def{site}{\c@site}{reqPM}{\csname thesite@\c@site @PM\endcsname}} |
| 409 |
% \end{macrocode} |
| 410 |
% \end{environment} |
| 411 |
% |
| 412 |
% \begin{environment}{participant} |
| 413 |
% \ednote{document this above} |\begin{picv}[|\meta{PM}|]{\meta{name}}| marks up the CV |
| 414 |
% and metadata about a principal investigator of a site (it can only be use inside a |
| 415 |
% |sitedescription| environment). The first argument \meta{PM} specifies the |
| 416 |
% involvement in person months: a fair estimation this PI will spend on this specific |
| 417 |
% project over its whole duration. |
| 418 |
% \begin{macrocode} |
| 419 |
\define@key{site@part}{type}{\def\site@part@type{#1}\@dmp{type=#1}} |
| 420 |
\define@key{site@part}{PM}{\def\site@part@PM{#1}\@dmp{PM=#1}} |
| 421 |
\define@key{site@part}{salary}{\def\site@part@salary{#1}}%\@dmp{\euro=#1}} |
| 422 |
\define@key{site@part}{gender}{\def\site@part@gender{#1}}%\@dmp{\euro=#1}} |
| 423 |
\newenvironment{participant}[2][]% |
| 424 |
{\def\site@part@type{}\def\site@part@PM{}\def\site@part@salary{}\def\site@part@gender{}% |
| 425 |
\setkeys{site@part}{#1}% |
| 426 |
\ifx\site@part@PM\@empty\else\addtocounter{site@\c@site @PM}{\site@part@PM}\fi% |
| 427 |
\paragraph*{#2\ % |
| 428 |
(\ifx\site@part@type\@empty\else\site@part@type\fi% |
| 429 |
\ifx\site@part@gender\@empty\else, \site@part@gender\fi% |
| 430 |
\ifx\site@part@PM\@empty\else, \site@part@PM~PM\fi% |
| 431 |
)}% |
| 432 |
\ignorespaces} |
| 433 |
{\par\medskip} |
| 434 |
% \end{macrocode} |
| 435 |
% \end{environment} |
| 436 |
% |
| 437 |
% \subsection{Work Packages, Work Areas, and Deliverables}\label{sec::impl:wpwa} |
| 438 |
% |
| 439 |
% \begin{environment}{wp*} |
| 440 |
% \begin{macrocode} |
| 441 |
\newmdenv[frametitle=Objectives]{wpobjectives} |
| 442 |
\newmdenv[frametitle=Description]{wpdescription} |
| 443 |
% \end{macrocode} |
| 444 |
% \end{environment} |
| 445 |
% |
| 446 |
% \begin{environment}{workpackage} |
| 447 |
% |
| 448 |
% \begin{macrocode} |
| 449 |
\renewenvironment{workpackage}[1][] |
| 450 |
{\begin{work@package}[#1]\medskip\wpheadertable% |
| 451 |
\addcontentsline{toc}{subsubsection}{\wp@label\wp@num: \pdataref{wp}\wp@id{title}}} |
| 452 |
{\end{work@package}} |
| 453 |
% \end{macrocode} |
| 454 |
% \end{environment} |
| 455 |
% |
| 456 |
% \begin{macro}{\wpheadertable} |
| 457 |
% We redefine the macro that computes the default work package header table, since there |
| 458 |
% are more sites in a EU proposal, we do this in a tabular form as asked for in the |
| 459 |
% template. We use the internal counter |@sites@po| (sites plus one) for convenience. |
| 460 |
% \begin{macrocode} |
| 461 |
\newcounter{@sitespo}\newcounter{@sitespt} |
| 462 |
\renewcommand\wpheadertable{% |
| 463 |
\wp@sites@efforts@lines% |
| 464 |
\setcounter{@sitespo}{\thewp@sites@num}\addtocounter{@sitespo}{1}% |
| 465 |
\par\noindent\begin{tabular}{|l|*{\thewp@sites@num}{c|}c|}\hline% |
| 466 |
\multicolumn{\the@sitespo}{|l|}{\textbf{\wp@mk@title{\wp@num}: }% |
| 467 |
\textsf{\pdata@target{wp}{\wp@id}{\pdataref{wp}\wp@id{title}}}} |
| 468 |
&\textbf{Start: }\pdataref{wp}\wp@id{start}\\\hline% |
| 469 |
\wp@sites@line\\\hline% |
| 470 |
\wp@efforts@line\\\hline% |
| 471 |
\end{tabular}\smallskip\par\noindent\ignorespaces} |
| 472 |
% \end{macrocode} |
| 473 |
% \end{macro} |
| 474 |
% |
| 475 |
% \subsection{Milestones and Deliverables}\label{sec:impl:deliverables} |
| 476 |
% |
| 477 |
% \begin{environment}{wpdelivs} |
| 478 |
% We make the deliverables boxed in EU proposals, this is simple with |mdframed.sty|. |
| 479 |
% \begin{macrocode} |
| 480 |
\surroundwithmdframed{wpdelivs} |
| 481 |
% \end{macrocode} |
| 482 |
% \end{environment} |
| 483 |
% |
| 484 |
% \begin{macro}{\milestone} |
| 485 |
% \begin{macrocode} |
| 486 |
\define@key{milestone}{verif}{\gdef\mile@verif{#1}\pdata@def{mile}\mile@id{verif}{#1}} |
| 487 |
% \end{macrocode} |
| 488 |
% \end{macro} |
| 489 |
% |
| 490 |
% \begin{macro}{milestonetable} |
| 491 |
% here we do the work. |
| 492 |
% \begin{macrocode} |
| 493 |
\define@key{mst}{caption}{\gdef\mst@caption{#1}} |
| 494 |
\define@key{mst}{wname}{\gdef\mst@wname{#1}} |
| 495 |
\define@key{mst}{wdeliv}{\gdef\mst@wdeliv{#1}} |
| 496 |
\define@key{mst}{wverif}{\gdef\mst@wverif{#1}} |
| 497 |
\newcommand\milestonetable[1][]{% |
| 498 |
\def\mst@caption{Milestones, Deliverables, and Verification}% |
| 499 |
\def\mst@wname{2.5cm}\def\mst@wdeliv{7cm}\def\mst@wverif{4cm} |
| 500 |
\setkeys{mst}{#1}% |
| 501 |
{\gdef\mst@lines{}%initialize |
| 502 |
\let\tabularnewline\relax\let\hline\relax% so they |
| 503 |
\let\textbf\relax\let\emph\relax% do not bother us |
| 504 |
\edef\@@miles{\pdataref{all}{mile}{ids}} |
| 505 |
\@for\@I:=\@@miles\do{ |
| 506 |
\edef\@delivs{\pdataref@safe{mile}{\@I}{delivs}}% |
| 507 |
\def\@@delivs{} |
| 508 |
\@for\@J:=\@delivs\do{\xdef\@@delivs{\@@delivs\ \pdataref{deliv}\@J{label}}} |
| 509 |
\def\@@line{ |
| 510 |
\textbf{\pdataref{mile}\@I{label}}& |
| 511 |
\emph{\pdataref{mile}{\@I}{title}} & |
| 512 |
\@@delivs& |
| 513 |
\pdataref{mile}\@I{month} & |
| 514 |
\pdataref{mile}\@I{verif}} |
| 515 |
\xdef\mst@lines{\mst@lines\@@line\tabularnewline\hline}}} |
| 516 |
\begin{table}[ht] |
| 517 |
\begin{tabular}{|l|p{\mst@wname}|p{\mst@wdeliv}|l|p{\mst@wverif}|}\hline |
| 518 |
\#&\textbf{\miles@legend@name} |
| 519 |
&\textbf{\miles@legend@involved} |
| 520 |
&\textbf{\miles@legend@mo} |
| 521 |
&\textbf{\miles@legend@verif}\\\hline\hline |
| 522 |
\mst@lines |
| 523 |
\end{tabular} |
| 524 |
\caption{\mst@caption}\label{tab:milestonetable} |
| 525 |
\end{table} |
| 526 |
\footnotetext\miles@legend@footnote} |
| 527 |
% \end{macrocode} |
| 528 |
% now the multilinguality support |
| 529 |
% \begin{macrocode} |
| 530 |
\newcommand\miles@legend@name{Name} |
| 531 |
\newcommand\miles@legend@mo{Mo} |
| 532 |
\newcommand\miles@legend@verif{Means of Verif.} |
| 533 |
\newcommand\miles@legend@involved{WPs\footnotemark/Deliverables involved} |
| 534 |
\newcommand\miles@legend@footnote{The work package number is the first number in the deliverable number.} |
| 535 |
% \end{macrocode} |
| 536 |
% \end{macro} |
| 537 |
% |
| 538 |
% \begin{macro}{\prop@milesfor} |
| 539 |
% the due date is the first argument to facilitate sorting |
| 540 |
% \begin{macrocode} |
| 541 |
\newcommand\prop@milesfor[1]{\edef\@delivs{\pdataref@safe{mile}{#1}{delivs}}% |
| 542 |
\let\m@sep=\relax\def\new@sep{,\ }% |
| 543 |
\@for\@I:=\@delivs\do{\m@sep\pdataRef{deliv}\@I{label}\let\m@sep=\new@sep}} |
| 544 |
% \end{macrocode} |
| 545 |
% \end{macro} |
| 546 |
% |
| 547 |
% \subsection{Risks}\label{sec:impl:risks} |
| 548 |
% |
| 549 |
% \begin{environment}{risk} |
| 550 |
% \begin{macrocode} |
| 551 |
\newenvironment{risk}[3] |
| 552 |
{\paragraph{Risk: #1}\hfill\emph{probability}: #2, \emph{gravity}: #3\par\noindent\ignorespaces} |
| 553 |
{} |
| 554 |
% \end{macrocode} |
| 555 |
% \end{environment} |
| 556 |
% |
| 557 |
% \begin{environment}{riskcont} |
| 558 |
% \begin{macrocode} |
| 559 |
\newenvironment{riskcont}[3] |
| 560 |
{\begin{risk}{#1}{#2}{#3}\textbf{Contingency:} } |
| 561 |
{\end{risk}} |
| 562 |
% \end{macrocode} |
| 563 |
% \end{environment} |
| 564 |
% |
| 565 |
% \subsection{Relevant Papers}\label{sec:impl:papers} |
| 566 |
% |
| 567 |
% \begin{macro}{\keypubs} |
| 568 |
% \ednote{MK: the baselinestretch manipulation does not work here, since |
| 569 |
% \texttt{prop@paperslist} makes its own provisions. We should provide a way of |
| 570 |
% manipulating sizes here.} |
| 571 |
% \begin{macrocode} |
| 572 |
\newcommand\keypubs[1]{% |
| 573 |
\paragraph{Key publications relevant to the project}% |
| 574 |
{\renewcommand{\baselinestretch}{.9}\prop@paperlist{#1}}} |
| 575 |
%</cls> |
| 576 |
% \end{macrocode} |
| 577 |
% \end{macro} |
| 578 |
% |
| 579 |
% \Finale |
| 580 |
\endinput |
| 581 |
% LocalWords: iffalse cls euproposal euproposal.dtx tt maketitle newpage wpwa eudata dfg |
| 582 |
% LocalWords: tableofcontents ednote euproposal DescribeEnv compactitem impl eureporting |
| 583 |
% LocalWords: longtable eurosym pdata thepart setcounter env vfill qquad NeedsTeXFormat |
| 584 |
% LocalWords: thechapter newcommand tabularnewline hline xdef pdataref nameuse SciML gen |
| 585 |
% LocalWords: countryshort rpoposal clange wrapfig wrapfigure vspace bfseries eupdata wd |
| 586 |
% LocalWords: startsection normalfont normalsize baselinestretch callname hb newpart wp |
| 587 |
% LocalWords: countryshort rpoposal clange wrapfig renewenvironment worktelfax prop@gen |
| 588 |
% LocalWords: tocdepth wpobjectives newenvironment noindent boxedminipage fbox warnpubs |
| 589 |
% LocalWords: textwidth textbf wpdescription sitedescription pgfdeclareimage projpapers |
| 590 |
% LocalWords: wrapfigure vspace pgfuseimage streetaddress townzip textsc xt wa maxnames |
| 591 |
% LocalWords: renewcommand startsection normalfont normalsize bfseries wptitle sitedesc |
| 592 |
% LocalWords: workpackage subsubsection wpheadertable newcounter sitespo hfil if@svninfo |
| 593 |
% LocalWords: newcounter sitespt addtocounter textsf smallskip ignorespaces pn setkeys |
| 594 |
% LocalWords: cellcolor lightgray keypubs paperlist callname callid callid ifx csname |
| 595 |
% LocalWords: challengeid challengeid objectiveid objectiveid outcomeid hfill if@gitinfo |
| 596 |
% LocalWords: outcomeid metakeys workaddress numberline tempdima ifsubmit iconrowheight |
| 597 |
% LocalWords: proposal.dtx texttt paperslist workaddress.dtx topicsaddressed thesite |
| 598 |
% LocalWords: topicsaddressed iconrowheight finalreport.tex printbibliography endcsname |
| 599 |
% LocalWords: reportperiod organisation thispagestyle gitAbbrevHash sitedescritpion |
| 600 |
% LocalWords: WAinstitution picv medskip newmdenv frametitle wpdelivs mdframed.sty emph |
| 601 |
% LocalWords: surroundwithmdframed emph riskcont prob grav ldots endinput |