Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added FrontPages/AffiliatesPage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ Staff starting a new report need to "clone the `grattex` repository on Github" (
If **you do not have a Github account** that is connected to the Grattan organisation:

* Create a Github account at [github.com](https://github.com) using your @grattaninstitute email address and a username that makes it easy to identify yourself (and remember). *[Skip if you already have a Github account]*
* Ask Will to add you to the Grattan Github organisation.
* Ask Mia or Alan to add you to the Grattan Github organisation.

If **you do not have an Overleaf account**:

* Create an Overleaf account at [overleaf.com](https://overleaf.com) using your `@grattaninstitute` email address.
* Ask Will to add you to the Grattan Institute premium account.
* Ask Mia or Alan to add you to the Grattan Institute premium account.
* Under 'Account Settings', ensure your account is linked to both Dropbox and Github.


Expand All @@ -33,7 +33,7 @@ If **you do not have an Overleaf account**:
10. Locate the repository you just created, and click `Import to Overleaf`.
11. Once imported the document will open and attempt to compile.
12. At the top right, click `Share` and:
+ add collaborators via their email address. *Please add all the LaTeXnicians (Nick)*, as well as the members of your team, plus Paul and Kat.
+ add collaborators via their email address. Please add Mia, as well as the members of your team, plus Paul and Kat.
+ copy the `Anyone with this link can edit the project` link and paste it just under `\documentclass{grattan}` as a comment, *i.e.:*

```latex
Expand All @@ -55,22 +55,22 @@ Now you can write almost as easily as you would in more user-friendly text edito
For anything more advanced (footnotes, referencing, tables, figures and other miscellaneous troubleshooting), there are three resources that might help.

1. __*Using LaTeX in reports at Grattan*__ is a more-than-one-hundred page document that should contain the answer. It lives in the Grattan Dropbox under `Grattan Team > Templates > LaTeX > grattexDocumentation.pdf`. While super helpful and comprehensive, the document is very long -- the best strategy is to `ctrl+F` for whatever you need assistance with.
2. The __latexShowcase__ project in Overleaf contains many examples of code that you might find useful, including how to use boxes and complex tables. Ask Will Mackey to invite you to this project if you didn't already receive the invite during your induction.
3. Your colleagues have probably encountered any issues you might have. Breaking a Latex document can be unnerving and frustrating, but the fix usually takes only a few seconds. Ask around! __Nick__ is the designated 'Latexnician' as of September 2023, and is more than happy to help.
2. The __latexShowcase__ project in Overleaf contains many examples of code that you might find useful, including how to use boxes and complex tables. Ask Mia to invite you to this project if you didn't already receive the invite during your induction.
3. Your colleagues have probably encountered any issues you might have. Breaking a Latex document can be unnerving and frustrating, but the fix usually takes only a few seconds. Ask around! __Mia__ is the designated 'Latexnician' as of January 2026, and is more than happy to help.

***
## Publishing a Grattan report: what to do in the final week
The purpose of using LaTeX is to improve the quality of our final publications. One of the main ways this happens is by running the document through a series of checks. Here's how it works:
<!-- ## Publishing a Grattan report: what to do in the final week -->
<!-- The purpose of using LaTeX is to improve the quality of our final publications. One of the main ways this happens is by running the document through a series of checks. Here's how it works:

1. A week before publication, an associate will need to download the Overleaf project and run some R code (details below) that checks the project.
+ These checks will make sure we have all the punctuation, capital letters, cross-references and many, many other features that make a document clean and precise.
+ The bibliography will also be scoured, identifying duplicate entries and some other errors.
2. The process is very stop-start. Each time R finds an error, it must be manually corrected for the process to continue. R will __not__ give you a list of errors to fix. The associate will fix the error in the offline version of the project that they downloaded, then run the check again.
3. The rest of the team __must not__ be working on the Overleaf project when this process is carried out. That's because the final step is...
4. ... the associate will copy their offline version of the project into the Dropbox folder where the online Overleaf project lives, replacing all duplicate files. That means any changes made to the Overleaf project will be overwritten.
5. To release a report, there are a few additional steps (also outlined below).
5. To release a report, there are a few additional steps (also outlined below). -->

### One week out
<!-- ### One week out
For associates, _once you've told your team that you're going to check the report_ (so that they stop editing it), the process of checking the document is as follows:

1. Ensure that your computer has both R and RStudio installed. Details on how to do this [can be found here](https://grattan.github.io/R_at_Grattan/introduction-to-r.html). This guide will also explain how to run code in R.
Expand Down Expand Up @@ -98,14 +98,16 @@ For associates, _once you've told your team that you're going to check the repor
8. Repeat until there's no further issues. Then run `checkGrattanReport(compile = TRUE)` until there are no further issues (this performs some additional checks, like making sure your references aren't broken/missing).
9. Copy the contents of the downloaded folder into the Overleaf project folder in Dropbox (assuming you've linked Overleaf and Dropbox; if not, see a Latexnician). Replace all of the duplicated files.
10. Wait a minute, open Overleaf, compile the document and check that everything looks as it should. If not, now is the perfect time to seek out a Latexnician.

-->
### To release a report
Releasing a report involves adding the front cover, updating the logos/affiliates on page 2, adding the ISBN and report number, and running the report through `checkGrattanReport` again -- but this time with some extra checks.

1. To add the front cover, ensure that there is a folder in the Overleaf project called `FrontPage`, which must contain the front cover as a PDF with the name `FrontPage.pdf`. In `Report.tex`, change the first line of code from `\documentclass[embargoed]{grattan}` to `\documentclass[FrontPage]{grattan}`.
2. Check with Central Services what ISBN and report number your report should have. Replace whatever ISBN/report number is currently in `Report.tex` with the correct one.
3. Now download your Overleaf project again -- just as you did one week ago, it's time to run `checkGrattanReport()`, ensuring that your team is not trying to make any final changes to the document.
4. This time, however, we're going to add some extra arguments to `checkGrattanReport()`. These extra arguments will check that `\CenturyFootnote` is used correctly (see `grattexDocumentation.pdf`), and will build the final PDF for us.
Releasing a report involves adding the front cover, updating the logos/affiliates on page 2, and adding the ISBN and report number
<!-- , and running the report through `checkGrattanReport` again -- but this time with some extra checks. -->

1. To add the front cover, ensure that there is a folder in the Overleaf project called `FrontPages`, which must contain the front cover as a PDF with the name `FrontPage.pdf`. In `Report.tex`, change the first line of code from `\documentclass[embargoed]{grattan}` to `\documentclass[FrontPage]{grattan}`.
2. Check with Central Services what ISBN and report number your report should have, and ask for a png of the current Affiliates page. Replace whatever ISBN/report number is currently in `Report.tex` with the correct one. Save the affiliates page in the folder `Frontpages` with the file name `AffiliatesPage.png`.
3. Check that `\CenturyFootnote` is between the 99th and 100th footnote (this will fix the spacing on subsequent footnotes, making sure three-digit footnotes still have a space between the full stop and the footnote content.)
Now download your Overleaf project again -- just as you did one week ago, it's time to run `checkGrattanReport()`, ensuring that your team is not trying to make any final changes to the document.
<!-- 4. This time, however, we're going to add some extra arguments to `checkGrattanReport()`. These extra arguments will check that `\CenturyFootnote` is used correctly (see `grattexDocumentation.pdf`), and will build the final PDF for us.
```R
# To update affiliates/logos, you need to update the 'classfile'. Here's how:
checkGrattanReport(update_grattan.cls = TRUE)
Expand All @@ -119,12 +121,15 @@ Releasing a report involves adding the front cover, updating the logos/affiliate
5. A new folder will be created called `RELEASE`, and inside will be a PDF of your report. This is what you will send to Central Services so that they can upload it to the Grattan website in time for its 9pm publication.
6. Copy the offline files back into the Overleaf folder on Dropbox to update them.
7. Breathe a small sigh of relief. It's almost over! But inevitably, on a final read-through, you or a team member will pick up on something you need changed (hopefully just typographical at this stage). If so, you'll need to make the change and repeat this process, sending a new, updated PDF to Central Services in time for release.

And if something goes badly wrong -- you can't get `checkGrattanReport()` to make you a PDF, and no Latexnician is available -- rest assured that you can always use the PDF that Overleaf compiles as a workaround. However, it may not have the updated affiliates, and there's a greater risk of bugs in the document if it hasn't passed `checkGrattanReport()`. But at least you'll have a usable document, and you can talk to a Latexnician on Monday to fix anything outstanding.
<!--
And if something goes badly wrong -- you can't get `checkGrattanReport()` to make you a PDF, and no Latexnician is available -- rest assured that you can always use the PDF that Overleaf compiles as a workaround. However, it may not have the updated affiliates, and there's a greater risk of bugs in the document if it hasn't passed `checkGrattanReport()`. But at least you'll have a usable document, and you can talk to a Latexnician on Monday to fix anything outstanding. --> -->

***
## Changelog

## 2026-01-09
* Updated documentation to reflect current processes, including new affiliates page process

## 2024-09-13
* Changed affiliates page.

Expand Down
3 changes: 3 additions & 0 deletions Report.tex
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
% Final report publication:
% - \documentclass[FrontPage]{grattan}
% - Remove \EmbargoText{}
% - Save report cover in a folder 'FrontPage' with the file name 'FrontPage.pdf'
% - Check that 'AffiliatesPage.png' is up-to-date

% Working paper:
% - \documentclass{grattan}
Expand Down Expand Up @@ -398,5 +400,6 @@ \chapter{Appendices and back matter}\label{chap:appendices}

\printbibliography

\acknowledgementspage

\end{document}
133 changes: 31 additions & 102 deletions grattan.cls
Original file line number Diff line number Diff line change
Expand Up @@ -651,14 +651,14 @@ numbers=noenddot,

% Alternatively, if FrontPage is declared, the file there is used as the frontpage picture
\DeclareOption{FrontPage}{
\IfFileExists{./FrontPage/FrontPage.pdf}{%
%\includegraphics[width=\paperwidth,keepaspectratio]{./FrontPage/FrontPage}%
\IfFileExists{./FrontPages/FrontPage.pdf}{%
%\includegraphics[width=\paperwidth,keepaspectratio]{./FrontPages/FrontPage}%
}{
\ClassError{grattan}{%
'./FrontPage/FrontPage.pdf' does not exist
'./FrontPages/FrontPage.pdf' does not exist
}{%
You have asked for a fullpicture option, but we can't find
a file at './FrontPage/FrontPage.pdf'. Try placing the image
a file at './FrontPages/FrontPage.pdf'. Try placing the image
there or not using the fullpicture option.
}
}
Expand All @@ -668,14 +668,14 @@ numbers=noenddot,
\vfill
\centering
% Amend
\IfFileExists{./FrontPage/FrontPage.pdf}{%
\includegraphics[width=\paperwidth,keepaspectratio]{./FrontPage/FrontPage.pdf}%
\IfFileExists{./FrontPages/FrontPage.pdf}{%
\includegraphics[width=\paperwidth,keepaspectratio]{./FrontPages/FrontPage.pdf}%
}{
\ClassError{grattan}{%
'./FrontPage/FrontPage' does not exist
'./FrontPages/FrontPage' does not exist
}{%
You have asked for a fullpicture option, but we can't find
a file at './FrontPage/FrontPage'. Try placing the image
a file at './FrontPages/FrontPage'. Try placing the image
there or not using the fullpicture option.
}
}
Expand All @@ -693,101 +693,16 @@ numbers=noenddot,
\counterwithout{table}{chapter}
}

\newcommand{\Vshiftacknowledgements}{-5mm}
\newcommand{\Hshiftacknowledgements}{-10mm}

\newcommand*{\@pagetwo}{%
\onecolumn
\begin{minipage}[t][0.85\textheight][t]{0.55\textwidth + \Hshiftacknowledgements}
\vspace{\Vshiftacknowledgements}
\subsection*{Grattan Institute Support}
\setlength{\columnsep}{0.75cm}
\begin{multicols}{2}
\setlength{\parskip}{3.5pt plus 6pt minus 4pt}
\textbf{\textcolor{theGrey}{\normalsize Founding members (2009)}}\hfill\par
{\centering

\IfFileExists{aus-gov-logo-stacked-black.pdf}%
{\includegraphics[width=3.75cm]{aus-gov-logo-stacked-black}}%
{\includegraphics[width=3.75cm]{./logos/aus-gov-logo-stacked-black}}

\IfFileExists{Vic_Gov_Logo-2016.pdf}%
{\includegraphics[width=3.25cm]{Vic_Gov_Logo-2016}}%
{\includegraphics[width=3.25cm]{./logos/Vic_Gov_Logo-2016}}

\IfFileExists{UOM-Pos_S_PMS.pdf}%
% Too much whitespace on top:
% l t r b
{\includegraphics[trim = {0 2cm 0 2cm}, clip, width=3.5cm]{UOM-Pos_S_PMS}}%
{\includegraphics[trim = {0 2cm 0 2cm}, clip, width=3.5cm]{./logos/UOM-Pos_S_PMS}}%


\IfFileExists{Bhp.pdf}%
{\includegraphics[width=3.25cm]{Bhp}}%
{\includegraphics[width=3.25cm]{./logos/Bhp}}%
% par is necessary to centre the last logo
\par}
\vspace{2cm}
\columnbreak\par
\footnotesize
\textbf{\textcolor{theGrey}{\normalsize Endowment Supporters}}
\vspace{4pt}

McKinnon

The Myer Foundation

National Australia Bank

Scanlon Foundation

Summer Foundation

\vspace{10pt}

\textbf{\textcolor{theGrey}{\normalsize Affiliate Partners}}
\vspace{4pt}

Third Link Growth Fund

Origin Energy Foundation

UTS

\vspace{10pt}

\textbf{\textcolor{theGrey}{\normalsize Senior Affiliates}}
\vspace{4pt}

Cuffe Family Foundation

Medibank Private

Wesfarmers

\vspace{10pt}

\textbf{\textcolor{theGrey}{\normalsize Affiliates}}
\vspace{4pt}

Allens

Ashurst

Maddocks

Urbis

Westpac\rule[-1.5ex]{0pt}{0pt} % for BHp
\end{multicols}
\end{minipage}
\normalsize
\begin{minipage}[t][0.85\textheight][t]{0.45\textwidth - \Hshiftacknowledgements}
\vspace{\Vshiftacknowledgements}
\subsection*{Grattan Institute \@Report\ No. \@GrattanReportNumber, \@MONTH\ \@YEAR}
\setlength{\parskip}{5.5pt plus 2pt}
\raggedright\@acknowledgements
\end{minipage}
\clearpage
\begingroup
\onecolumn
\thispagestyle{scrheadings}%
\begin{center}
\vspace*{-2em}
\includegraphics[width=0.825\paperwidth,height=0.825\paperheight,keepaspectratio]{FrontPages/AffiliatesPage.png}%
\end{center}
\endgroup
\twocolumn
}

Expand Down Expand Up @@ -1188,6 +1103,20 @@ numbers=noenddot,
% Helpful for determining which labels are causing infinite reruns.
% https://tex.stackexchange.com/questions/154594/how-to-diagnose-a-permanent-labels-may-have-changed-warning?noredirect=1&lq=1

\newcommand{\acknowledgementspage}{%
\onecolumn
\begin{minipage}[t][0.85\textheight][t] {0.45\textwidth - {-10mm}}
\vspace{\Vshiftacknowledgements}
\subsection*{Grattan Institute \@Report\ No. \@GrattanReportNumber, \@MONTH\ \@YEAR}
\setlength{\parskip}{5.5pt plus 2pt}
\raggedright\@acknowledgements
\end{minipage}%
\twocolumn
}

\newcommand{\Vshiftacknowledgements}{-5mm}
\newcommand{\Hshiftacknowledgements}{-10mm}

\def\@testdef #1#2#3{%
\def\reserved@a{#3}\expandafter \ifx \csname #1@#2\endcsname
\reserved@a \else
Expand Down
Binary file removed logos/Better-targeting-super-breaks.pdf
Binary file not shown.
Binary file removed logos/Bhp.pdf
Binary file not shown.
Binary file removed logos/TMF_logo_green-eps-converted-to.pdf
Binary file not shown.
Binary file removed logos/TMF_logo_green.pdf
Binary file not shown.
Binary file removed logos/UOM-Pos_S_PMS.pdf
Binary file not shown.
Binary file removed logos/Vic_Gov_Logo-2016.pdf
Binary file not shown.
Binary file removed logos/aus-gov-logo-stacked-black.pdf
Binary file not shown.
2 changes: 0 additions & 2 deletions logos/grattex-2018-09-07.tex

This file was deleted.