Include embargo in default report template

[k-griffiths]

I suggest we include the embargo (and instructions for removing it) in the default template. I also suggest we add: \MONTH, % add_to_dictionary, and remove \subtitle (given it is not used for either reports or working papers).

For example:

\documentclass[embargoed]{grattan}
% Comments are deployed by the % sign; everything after % is ignored by the compiler.
% Please do not put comments before \documentclass as these are reserved for TeX directives.
% For final publication of a report replace [embargoed] with [FrontPage] and remove \EmbargoText: \documentclass[FrontPage]{grattan}
% For final publication of a working paper remove [embargoed] and \EmbargoText: \documentclass{grattan}

% add_to_dictionary: Grattan OECD GDP GFC

\addbibresource{bib/put-new-refs-here.bib}

\title{Example title: subtitle}
\author{John Daley}
\EmbargoText{Embargoed until 9pm 1 July 2019}
\GrattanReportNumber{2019-00}
\MONTH{July}

[wfmackey]

@k-griffiths how about this. It defaults to embargoed, and provides clear instructions on how to change to alternative document types. The top-end of the document is also clearer (I think).

Suggestions encouraged @carmelachivers1 @OwainEmslie @jamesha95

\documentclass[embargoed]{grattan}
% Note: please do not put comments before \documentclass as these are reserved for TeX directives.

% Summary of alternative options for \documentclass[]------------------

%   Final publication: 
%       -   \documentclass[FrontPage]{grattan}
%       -   Remove \EmbargoText{}

%   Working paper: 
%       -   \documentclass{grattan}
%       -   Remove \EmbargoText{} line
%       -   Change \ReportOrWorkingPaper{Working Paper}
%       -   Change \acknowledgements to read 'This working paper was written by...'

%   Submission:  
%       -   \documentclass[submission]{grattan}
%       -   Remove \EmbargoText{} line
%       -   Remove \acknowledgements{} section
%       -   Remove \GrattanReportNumber{} line
%       -   Add the MONTH and YEAR to \subtitle{}, eg \subtitle{July 2019}

% Document details ----------------------------------------------------
% Set Report or Working Paper; report number; and month of release:
\ReportOrWorkingPaper{Report}
\GrattanReportNumber{2019-00}
\MONTH{July}

% Set embargo text when \documentclass[embargoed]{grattan}
\EmbargoText{Embargoed until 9pm DAY MONTH YEAR}

% Add words to spellcheck dictionary ----------------------------------
    % To add words to the spellcheck dictionary, list them after %add_to_dictionary (including the comment symbol %)

% add_to_dictionary: SSBs? roman Grattan OECD GDP GFC

% Point to bib file(s) ------------------------------------------------
\addbibresource{bib/put-new-refs-here.bib}

% Start report --------------------------------------------------------

% Title and author (you can add a \subtitle{} if required)
\title{1 Orange Balloon}
\author{John Daley}

[k-griffiths]

Looks good, a couple of tweaks.

% Summary of document types ------------------

% Embargoed report (default): % - \documentclass[embargoed]{grattan} % - \EmbargoText{Embargoed until 9pm DAY MONTH YEAR}

% Final report with cover: % - \documentclass[FrontPage]{grattan} % - Remove \EmbargoText{}

etc.

% Title and author \title{Example title: subtitle} \author{John Daley}

[\subtitle is confusing because it's not the style we use for report or working paper subtitles - it seems to be only relevant to submissions as you've already noted]

[wfmackey]

Yep good idea. I'll run these through the regular checks and submit a pull request tonight.

If anyone else has ideas on what would be useful in preamble of the standard Report.tex file, comment here, submit an issue, send a carrier pigeon, craft your message in my bowl of soup next time you're on, or email me.

[wfmackey]

This originally passed Travis tests, but has errored when merged. Not sure why -- I'll look into it. For now, I'm reverting the main branch.

[wfmackey]

HMMM the reversion doesn't pass Travis either. Will leave as-is for now and work out why.

[carmelachivers1]

Eek. Has anyone been playing in grattanReporter?

From: Will Mackey notifications@github.com Sent: 1 August, 2019 1:38 PM To: grattan/grattex grattex@noreply.github.com Cc: carmelachivers1 carmela.chivers@grattan.edu.au; Mention mention@noreply.github.com Subject: Re: [grattan/grattex] Include embargo in default report template (#156)

HMMM the reversion doesn't pass Travis either. Will leave as-is for now and work out why.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/grattan/grattex/issues/156?email_source=notifications&email_token=AGBJCP57NNFE7SFEIX4NTZTQCJLA7A5CNFSM4IIDPQWKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD3JGPBQ#issuecomment-517105542, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AGBJCPZ6OMSU2FR4A43FKSLQCJLA7ANCNFSM4IIDPQWA.

[wfmackey]

Nah grattanReporter has been unchanged for a while! grattex was passing last night; and failed today without change (I think).

[carmelachivers1]

Strange...

[wfmackey]

I know! And Travis isn't even throwing up an error. It just kind of stops, then fails.

But it's okay -- the template still works, it's just failing Travis (before checkGrattanReport, so it's not an issue there either).