Research/LaTeX-proposal
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

graying out canceled deliverables, adding documentation

Browse Source
This commit is contained in:
Michael Kohlhase 2017-09-21 16:52:06 +02:00
parent 4a9bf44ed1
commit 66a65eea29
1 changed files with 58 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
base/proposal.dtx
View File

@ -218,6 +218,9 @@
% should not be used for single-institution proposals. We will describe the setup for a % should not be used for single-institution proposals. We will describe the setup for a
% single-site proposal below and point out the differences. The example |proposal.tex| % single-site proposal below and point out the differences. The example |proposal.tex|
% is a two-site proposal. % is a two-site proposal.
% \item Sometimes it makes sense to document the proposal number in the metadata, e.g. to
% use the generated metadata file \meta{main}|.pdata| for project reports. The
% |proposalnumber| can be used for that.
% \end{compactitem} % \end{compactitem}
% If the |acronym| and |acrolong| are given, then they automatically define the macros % If the |acronym| and |acrolong| are given, then they automatically define the macros
% \DescribeMacro{\pn}|\pn| and \DescribeMacro{\pnlong}|\pnlong| which allow to use the % \DescribeMacro{\pn}|\pn| and \DescribeMacro{\pnlong}|\pnlong| which allow to use the
@ -402,7 +405,11 @@
% status (usually as short strings prescribed by the proposal template), and |miles| for % status (usually as short strings prescribed by the proposal template), and |miles| for
% the milestone this deliverable is targeted for (specified by the milestone % the milestone this deliverable is targeted for (specified by the milestone
% identifier). For repeating deliverables (e.g. project reports), both |due| and |miles| % identifier). For repeating deliverables (e.g. project reports), both |due| and |miles|
% can contain comma-separated lists. Deliverables are numbered by labels whose shape can % can contain comma-separated lists. The |status| key gives the status of the
% deliverable. If it has the value |canceled|, then the deliverable is grayed out and it
% is not mentioned in the deliverables table given by |\inputdelivs| below.
%
% Deliverables are numbered by labels whose shape can
% be customized by number, where the shape of the label can be specified by redefining % be customized by number, where the shape of the label can be specified by redefining
% \DescribeMacro{\deliv@label}|\deliv@label| and referenced by % \DescribeMacro{\deliv@label}|\deliv@label| and referenced by
% \DescribeMacro{\delivref}|\delivref{|\meta{wp}|}{|\meta{id}|}| where \meta{wp} is the % \DescribeMacro{\delivref}|\delivref{|\meta{wp}|}{|\meta{id}|}| where \meta{wp} is the
@ -419,7 +426,8 @@
% generation in {\LaTeX}. The |wpdeliv| environment writes the deliverable data to a file % generation in {\LaTeX}. The |wpdeliv| environment writes the deliverable data to a file
% \meta{main}|.delivs|, which can be processed externally (usually just sorting with % \meta{main}|.delivs|, which can be processed externally (usually just sorting with
% |sort| in Unix is sufficient) into \meta{main}|.deliverables|, which is then input via % |sort| in Unix is sufficient) into \meta{main}|.deliverables|, which is then input via
% the |\inputdelivs| macro. % the |\inputdelivs| macro. Finally, the |issue| key can be used to bind the deliverable
% to an issue identifier in a project management system.
% %
% In some proposals, also work areas can have deliverables, then the above hold % In some proposals, also work areas can have deliverables, then the above hold
% analogously for \DescribeMacro{wadelivs}|wpdelivs| and \DescribeMacro{wadeliv}|wadeliv| % analogously for \DescribeMacro{wadelivs}|wpdelivs| and \DescribeMacro{wadeliv}|wadeliv|
@ -548,6 +556,16 @@
% provides an option |german| for german-language proposals and project reports that % provides an option |german| for german-language proposals and project reports that
% triggers a redefinition of all of these macros at read time. % triggers a redefinition of all of these macros at read time.
% %
% \subsection{Project Management}\label{sec:use:project}
%
% Much of the metadata that is explicitly represented in proposals written with the
% |proposal| class is very useful for project management. For instance, it is possible to
% use the metadata in the \meta{main}|.pdata| file to generate issues for all the tasks,
% work packages, and deliverables automatically. The |LaTeX-proposal|
% repository~\cite{LaTeX-proposal:git} contains an experimental script that automates
% that. After that, we can cross-reference them using the \DescribeMacro{issue}|issue| key
% to get extra mileage\ednote{MK: how to use this?}
%
% \section{Limitations and Enhancements}\label{sec:limitations} % \section{Limitations and Enhancements}\label{sec:limitations}
% %
% The |proposal| is relatively early in its development, and many enhancements are % The |proposal| is relatively early in its development, and many enhancements are
@ -625,6 +643,8 @@
\RequirePackage{proposal} \RequirePackage{proposal}
%</cls|reporting> %</cls|reporting>
% \end{macrocode} % \end{macrocode}
% \ednote{We should probably try to move all the grantagreement stuff into the euproposal
% class.}
% %
% For |proposal.sty| we load the packages we make use of % For |proposal.sty| we load the packages we make use of
% %
@ -1580,8 +1600,11 @@
\@ifundefined{deliv@status}{}{\pdata@def{deliv}{\taskin\deliv@id\wpg@id}{status}{\deliv@status}} \@ifundefined{deliv@status}{}{\pdata@def{deliv}{\taskin\deliv@id\wpg@id}{status}{\deliv@status}}
\@ifundefined{deliv@blog}{}{\pdata@def{deliv}{\taskin\deliv@id\wpg@id}{blog}{\deliv@blog}} \@ifundefined{deliv@blog}{}{\pdata@def{deliv}{\taskin\deliv@id\wpg@id}{blog}{\deliv@blog}}
% \end{macrocode} % \end{macrocode}
% Then we iterate over the due dates and generate an entry for teach of them. % Then we iterate over the due dates and generate an entry for teach of them in the
% |*.deliverables| file; but only if the status is not |canceled|.
% \begin{macrocode} % \begin{macrocode}
\def\@@status@canceled{canceled}
\ifx\deliv@status\@@status@canceled\else
\@ifundefined{deliv@due}{}{% \@ifundefined{deliv@due}{}{%
\@for\@I:=\deliv@due\do{\protected@write\wpg@delivs{}{\string\deliverable% \@for\@I:=\deliv@due\do{\protected@write\wpg@delivs{}{\string\deliverable%
{\ifnum\@I<10 0\@I\else\@I\fi}% sort key {\ifnum\@I<10 0\@I\else\@I\fi}% sort key
@ -1592,10 +1615,13 @@
{\@ifundefined{deliv@nature}{??}{\deliv@nature}}% nature {\@ifundefined{deliv@nature}{??}{\deliv@nature}}% nature
{#2} {#2}
{\ifx\@type\@wp{WP\ifwork@areas\thewa.\fi\thewp}\else{WA\thewa}\fi}%WP {\ifx\@type\@wp{WP\ifwork@areas\thewa.\fi\thewp}\else{WA\thewa}\fi}%WP
{\@ifundefined{deliv@lead}{??}{\string\site{\deliv@lead}}}}}}% lead {\@ifundefined{deliv@lead}{??}{\string\site{\deliv@lead}}}}}% lead
}%deliv@due defined
\fi% status != canceled
% \end{macrocode} % \end{macrocode}
% And finally, we generate the entry into the deliverables table. % And finally, we generate the entry into the deliverables table.
% \begin{macrocode} % \begin{macrocode}
{\ifx\deliv@status\@@status@canceled\color{lightgray}\fi
\item[\current@label\ (% \item[\current@label\ (%
\delivs@legend@due: \@ifundefined{deliv@due}{??}{\deliv@due}, \delivs@legend@due: \@ifundefined{deliv@due}{??}{\deliv@due},
\delivs@legend@nature: \@ifundefined{deliv@nature}{??}{\deliv@nature}, \delivs@legend@nature: \@ifundefined{deliv@nature}{??}{\deliv@nature},
@ -1612,7 +1638,9 @@
\expandafter\ifx\csname\@I delivs\endcsname\relax% Check that the miles@delivs is empty \expandafter\ifx\csname\@I delivs\endcsname\relax% Check that the miles@delivs is empty
{\expandafter\xdef\csname\@I delivs\endcsname{\wpg@id @\deliv@id}}% if so, skip the separator {\expandafter\xdef\csname\@I delivs\endcsname{\wpg@id @\deliv@id}}% if so, skip the separator
\else\expandafter\xdef\csname\@I delivs\endcsname%if not add it \else\expandafter\xdef\csname\@I delivs\endcsname%if not add it
{\csname\@I delivs\endcsname\d@sep\wpg@id @\deliv@id}\fi}}} {\csname\@I delivs\endcsname\d@sep\wpg@id @\deliv@id}\fi}}%
}% end gray color
}
% \end{macrocode} % \end{macrocode}
% \end{macro} % \end{macro}
% %
@ -2636,7 +2664,22 @@ joint&\multicolumn{\the@site}{l|}{\jpub $\hat=$ publication, \jpro $\hat=$ proje
% \end{macrocode} % \end{macrocode}
% \end{macro} % \end{macro}
% \Finale % \Finale
\endinput % \endinput
% Local Variables:
% mode: doctex
% TeX-master: t
% End:
% LocalWords: localization sec:user-interface standardizes initialization referencable
% LocalWords: pages,start,length,caption sec:implwptable draft,yscale organization
% LocalWords: tab:collaboration sec:limitations sec:implementation ifgrantagreement
% LocalWords: grantagreementfalse grantagreement grantagreementtrue a4paper,twoside
% LocalWords: a4paper,margin alphabetic,defernumbers true,backend bibtex,firstinits
% LocalWords: true,maxbibnames true,linkcolor eso-foot,today proposalnumber grayed
% LocalWords: specializing sortkey,due,label,id,title,type,level,lead gantt@step,very
% LocalWords: gantt@xscale,yscale gantt@ymiles gantt@ymiles subbibliography,type 5,step
% LocalWords: subbibliography,title featured,heading renewbibmacro iffieldundef showit
% LocalWords: proposal dtx xkohlhase areastrue svninfo noworkareas twoside emph gitinfo % LocalWords: proposal dtx xkohlhase areastrue svninfo noworkareas twoside emph gitinfo
% LocalWords: areasfalse wa textcomp amssymb url graphicx colortbl xcolor RO OJBref sl % LocalWords: areasfalse wa textcomp amssymb url graphicx colortbl xcolor RO OJBref sl
% LocalWords: fancyhdr keyval eurosym tikz calc USenglish ngerman linkcolor ne WPref gen % LocalWords: fancyhdr keyval eurosym tikz calc USenglish ngerman linkcolor ne WPref gen
@ -2702,26 +2745,14 @@ joint&\multicolumn{\the@site}{l|}{\jpub $\hat=$ publication, \jpro $\hat=$ proje
% LocalWords: wpsubsection wpsubsection wpsubsectionfalse wpsubsectiontrue ppl 2pt,color % LocalWords: wpsubsection wpsubsection wpsubsectionfalse wpsubsectiontrue ppl 2pt,color
% LocalWords: definecolor medskip fundsuntil fundsuntil defernumbers shortname 2,title % LocalWords: definecolor medskip fundsuntil fundsuntil defernumbers shortname 2,title
% LocalWords: totalduration circ orga notype allpapers allpaperstrue prl sym bbx:eprint % LocalWords: totalduration circ orga notype allpapers allpaperstrue prl sym bbx:eprint
% LocalWords: allpapersfalse subbibliography unclass inbook confpapers wphases % LocalWords: allpapersfalse subbibliography unclass inbook confpapers wphases 2pt,color
% LocalWords: inproceedings wspapers notkeyword techreports techreport emphbox % LocalWords: inproceedings wspapers notkeyword techreports techreport emphbox newskip
% LocalWords: textbackslash wpsectionheadings compactht compactht emphbox sym % LocalWords: textbackslash wpsectionheadings compactht compactht emphbox sym euproposal
% LocalWords: dfgproposal Tsanko Tsankov mdframed newmdenv wphase thealltasks % LocalWords: dfgproposal Tsanko Tsankov mdframed newmdenv wphase thealltasks bigcenter
% LocalWords: alltasks taskreflong definecolorset leadgray wagray thewpfig fancyhfoffset % LocalWords: alltasks taskreflong definecolorset leadgray wagray thewpfig fancyhfoffset
% LocalWords: wpfigstyle colspan keyvals gantttaskchart baselinestretch NeedsTeXFormat % LocalWords: wpfigstyle colspan keyvals gantttaskchart baselinestretch NeedsTeXFormat
% LocalWords: mileref mileref miletref backref firstinits wissenschaftlicher usebibmacro % LocalWords: mileref mileref miletref backref firstinits wissenschaftlicher usebibmacro
% LocalWords: wissenschaftliche startend@wphases addtocategory localdelivref % LocalWords: wissenschaftliche startend@wphases addtocategory localdelivref trivlist
% LocalWords: numericcites LaTeX-proposal:git numeric,hyperref auto,defernumbers
% \endinput % LocalWords: 9,maxcitenames alphabetic,hyperref bigcentering rightskip parindent
% Local Variables: % LocalWords: parfillskip endbigcenter endtrivlist 2,title
% mode: doctex
% TeX-master: t
% End:
% LocalWords: localization sec:user-interface standardizes initialization referencable
% LocalWords: pages,start,length,caption sec:implwptable draft,yscale organization
% LocalWords: tab:collaboration sec:limitations sec:implementation ifgrantagreement
% LocalWords: grantagreementfalse grantagreement grantagreementtrue a4paper,twoside
% LocalWords: a4paper,margin alphabetic,defernumbers true,backend bibtex,firstinits
% LocalWords: true,maxbibnames true,linkcolor eso-foot,today proposalnumber
% LocalWords: specializing sortkey,due,label,id,title,type,level,lead gantt@step,very
% LocalWords: gantt@xscale,yscale gantt@ymiles gantt@ymiles subbibliography,type
% LocalWords: subbibliography,title featured,heading renewbibmacro iffieldundef