You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Merge pull request #189 from grattan/miajessurun_acknowledgements
Moved the acknowledgements to a single half page after the bibliography and appendices (final page of the report), and replaced the affiliates with a slot for a full page PDF, rather than having the logos/ names in the code directly. This reflects a CEO decision in late 2025.
Copy file name to clipboardExpand all lines: README.md
+23-18Lines changed: 23 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,12 @@ Staff starting a new report need to "clone the `grattex` repository on Github" (
10
10
If **you do not have a Github account** that is connected to the Grattan organisation:
11
11
12
12
* 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]*
13
-
* Ask Will to add you to the Grattan Github organisation.
13
+
* Ask Mia or Alan to add you to the Grattan Github organisation.
14
14
15
15
If **you do not have an Overleaf account**:
16
16
17
17
* Create an Overleaf account at [overleaf.com](https://overleaf.com) using your `@grattaninstitute` email address.
18
-
* Ask Will to add you to the Grattan Institute premium account.
18
+
* Ask Mia or Alan to add you to the Grattan Institute premium account.
19
19
* Under 'Account Settings', ensure your account is linked to both Dropbox and Github.
20
20
21
21
@@ -33,7 +33,7 @@ If **you do not have an Overleaf account**:
33
33
10. Locate the repository you just created, and click `Import to Overleaf`.
34
34
11. Once imported the document will open and attempt to compile.
35
35
12. At the top right, click `Share` and:
36
-
+ add collaborators via their email address. *Please add all the LaTeXnicians (Nick)*, as well as the members of your team, plus Paul and Kat.
36
+
+ add collaborators via their email address. Please add Mia, as well as the members of your team, plus Paul and Kat.
37
37
+ copy the `Anyone with this link can edit the project` link and paste it just under `\documentclass{grattan}` as a comment, *i.e.:*
38
38
39
39
```latex
@@ -55,22 +55,22 @@ Now you can write almost as easily as you would in more user-friendly text edito
55
55
For anything more advanced (footnotes, referencing, tables, figures and other miscellaneous troubleshooting), there are three resources that might help.
56
56
57
57
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.
58
-
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.
59
-
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.
58
+
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.
59
+
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.
60
60
61
61
***
62
-
## Publishing a Grattan report: what to do in the final week
63
-
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:
62
+
<!--## Publishing a Grattan report: what to do in the final week-->
63
+
<!--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:
64
64
65
65
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.
66
66
+ 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.
67
67
+ The bibliography will also be scoured, identifying duplicate entries and some other errors.
68
68
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.
69
69
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...
70
70
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.
71
-
5. To release a report, there are a few additional steps (also outlined below).
71
+
5. To release a report, there are a few additional steps (also outlined below).-->
72
72
73
-
### One week out
73
+
<!--### One week out
74
74
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:
75
75
76
76
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.
@@ -98,14 +98,16 @@ For associates, _once you've told your team that you're going to check the repor
98
98
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).
99
99
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.
100
100
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.
101
-
101
+
-->
102
102
### To release a report
103
-
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.
104
-
105
-
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}`.
106
-
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.
107
-
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.
108
-
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.
103
+
Releasing a report involves adding the front cover, updating the logos/affiliates on page 2, and adding the ISBN and report number
104
+
<!-- , and running the report through `checkGrattanReport` again -- but this time with some extra checks. -->
105
+
106
+
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}`.
107
+
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`.
108
+
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.)
109
+
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.
110
+
<!-- 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.
109
111
```R
110
112
# To update affiliates/logos, you need to update the 'classfile'. Here's how:
111
113
checkGrattanReport(update_grattan.cls = TRUE)
@@ -119,12 +121,15 @@ Releasing a report involves adding the front cover, updating the logos/affiliate
119
121
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.
120
122
6. Copy the offline files back into the Overleaf folder on Dropbox to update them.
121
123
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.
122
-
123
-
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.
124
+
<!--
125
+
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.--> -->
124
126
125
127
***
126
128
## Changelog
127
129
130
+
## 2026-01-09
131
+
* Updated documentation to reflect current processes, including new affiliates page process
0 commit comments