Bump up version

CHANGELOG.md

@@ -1,4 +1,11 @@
 
+<a name="5.6.0"></a>
+## 5.6.0 (2025-01-02)
+
+Enhancements:
+
+* Add an optional presentation
+
 <a name="5.5.2"></a>
 ## 5.5.2 (2024-09-09)
 

README.md

@@ -6,8 +6,8 @@ The template itself is in the `{{cookiecutter.paper_id}}-paper`.
 In order to generate a project from the template:
 
 * install cookiecutter
-* find a paper-cutter tag applicable (usually the latest tag listed at <https://git.wmi.amu.edu.pl/filipg/paper-cutter/releases>), say 5.5.2
-* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.5.2`
+* find a paper-cutter tag applicable (usually the latest tag listed at <https://git.wmi.amu.edu.pl/filipg/paper-cutter/releases>), say 5.6.0
+* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.6.0`
 
 You will be asked to choose a LaTeX template, at the moment the
 following templates are handled:
@@ -59,7 +59,7 @@ git remote set-url origin YOUR-GIT-REPO
    password: `git config credential.helper "cache --timeout=10000000"`
 8. Unfortunately, Overleaf will discard hidden files (`.*`) when a zip
    is uploaded, also file permissions will be somewhat broken
-9.  … so you need to copy `.cookiecutter.yml` file and re-apply the template (`cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.5.2 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`)
+9.  … so you need to copy `.cookiecutter.yml` file and re-apply the template (`cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.6.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`)
 10. Re-commit the files (including recovered `.*` files).
 11. Push the repo to Overleaf (fortunately, the `.*` will be treated
    correctly when this is done by git): `git push overleaf master`
@@ -73,10 +73,10 @@ Updating package with updated template
 To keep your codebase in sync with template you need to occasionally reapply the template.
 Here's how:
 
-* find a paper-cutter tag applicable, say 5.5.2
+* find a paper-cutter tag applicable, say 5.6.0
 * (do *not* refer to master in your projects!)
 * go to project root
-* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.5.2 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`
+* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.6.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`
 * check changes with git
 
 Editing the files
@@ -99,7 +99,7 @@ Switching to another conference or journal template is easy.
    If not, get in touch with Filip Graliński.
 2. Commit or stash any uncommitted changes.
 3. Change the `latex_template` value accordingly in the `.cookiecutter.yml` file. Commit the changes.
-4. Re-run the template (as if updating, see above: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.5.2 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`).
+4. Re-run the template (as if updating, see above: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.6.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`).
 5. Compare `metadata.tex` against the right metadata template file
    (`*/*-template-meta.tex` in `_latex-templates/`) and make any fixes
    needed. This is the only thing that needs to be done manually

cookiecutter.json

@@ -17,5 +17,6 @@
     "supervisor": "none",
     "album_no": "none",
     "beeminder_support": "no",
-    "contribution_declaration": "{{ 'yes' if cookiecutter.latex_template != 'pw-thesis' and cookiecutter.latex_template != 'amu' else 'no' }}"
+    "contribution_declaration": "{{ 'yes' if cookiecutter.latex_template != 'pw-thesis' and cookiecutter.latex_template != 'amu' else 'no' }}",
+    "with_presentation": "no"
 }

hooks/post_gen_project.sh

@@ -155,6 +155,10 @@ if [ "{{ cookiecutter.contribution_declaration }}" = "yes" ]; then
     cp -r _optional_files/_contribution_declaration/* .
 fi
 
+if [ "{{ cookiecutter.with_presentation }}" = "yes" ]; then
+    cp -r _optional_files/_presentation/presentation.tex {{cookiecutter.paper_id}}-presentation.tex
+fi
+
 rm -rf _latex-templates _optional_files
 
 if [ -e .git ]; then

{{cookiecutter.paper_repo_name}}/.cookiecutter.yml

@@ -18,3 +18,4 @@ default_context:
   album_no: '{{ cookiecutter.album_no }}'
   beeminder_support: '{{ cookiecutter.beeminder_support }}'
   contribution_declaration: '{{ cookiecutter.contribution_declaration }}'
+  contribution_declaration: '{{ cookiecutter.with_presentation }}'

{{cookiecutter.paper_repo_name}}/.gitignore

@@ -153,6 +153,7 @@ vcs.xml
 *.run.xml
 /auto
 {{cookiecutter.paper_id}}.pdf
+{{cookiecutter.paper_id}}-presentation.pdf
 {{cookiecutter.paper_id}}.zip
 autozoil-log.txt
 stats.txt

{{cookiecutter.paper_repo_name}}/.gitlab-ci.yml

@@ -6,5 +6,5 @@ variables:
 # THIS IS AN UGLY WORK-AROUND
 include:
   - project: 'research/paper-cutter'
-    ref: '5.5.2'
+    ref: '5.6.0'
     file: 'main.yml'

{{cookiecutter.paper_repo_name}}/Makefile

@@ -7,7 +7,7 @@ HAS_APPENDIX={{cookiecutter.with_appendix}}
 LATEX_TEMPLATE={{cookiecutter.latex_template}}
 WITH_ARXIV_PACKAGE={{cookiecutter.with_arxiv_package}}
 
-CONTENT_TEX_SOURCES=$(filter-out $(PAPER_ID).tex config.tex extras.tex metadata.tex preamble.tex the-appendix.tex, $(shell find . -name '*.tex'))
+CONTENT_TEX_SOURCES=$(filter-out $(PAPER_ID).tex $(PAPER_ID)-presentation.tex config.tex extras.tex metadata.tex preamble.tex the-appendix.tex, $(shell find . -name '*.tex'))
 
 CURRENT_DIR=$(shell pwd)
 AUTOZOIL_DIR?=/opt/autozoil
@@ -70,6 +70,13 @@ $(PAPER_ID).pdf: $(PAPER_ID).tex preamble.tex metadata.tex $(CONTENT_TEX_SOURCES
 	pdflatex $<
 	pdflatex $<
 
+{% if cookiecutter.with_presentation == 'yes' %}
+$(PAPER_ID)-presentation.pdf: $(PAPER_ID)-presentation.tex
+	pdflatex $<
+	pdflatex $<
+	pdflatex $<
+{% endif %}
+
 # to be copied and pasted as plain text (without LaTeX stuff)
 abstract.txt: abstract.tex
 	cat $< | perl -pne 's/noqa\{[^}]+\}//g' | detex > $@

{{cookiecutter.paper_repo_name}}/_latex-templates/acl-template-meta.tex

@@ -1,6 +1,6 @@
-\title{Insert your title}
+\title{ {{ cookiecutter.paper_title }} }
 
-\author{First Author \\
+\author{ {{cookiecutter.main_contributor_name}} \\
   Affiliation / Address line 1 \\
   Affiliation / Address line 2 \\
   Affiliation / Address line 3 \\

{{cookiecutter.paper_repo_name}}/_latex-templates/acl-template.tex

@@ -46,11 +46,16 @@
 \newcommand\BibTeX{B\textsc{ib}\TeX}
 \newcommand\bycite[1]{by~\citet{#1}}
 
+\usepackage{graphicx}
+
 \input{config}
 \input{extras}
 \input{preamble}
 \input{metadata}
 
+\usepackage{times}
+\usepackage{inconsolata}
+
 \begin{document}
 \maketitle
 \begin{abstract}

{{cookiecutter.paper_repo_name}}/_optional_files/_presentation/presentation.tex

@@ -0,0 +1,15 @@
+\documentclass{beamer}
+
+\title{ {{cookiecutter.paper_title}} }
+%\subtitle{Using Beamer}
+\author{ {{cookiecutter.main_contributor_name}} }
+\institute{INSERT INSTITUTE}
+\date{INSERT DATE}
+
+\begin{document}
+
+\begin{frame}
+\titlepage
+\end{frame}
+
+\end{document}

{{cookiecutter.paper_repo_name}}/helpers/set-up-overleaf.sh

@@ -27,7 +27,7 @@ echo "then upload $source_pack from here ($(pwd)/$source_pack)"
 
 echo ""
 echo "When it is uploaded, click Menu / Git, copy the URL"
-echo "(something like https://git.overleaf.com/123456789ec0830001af836f),"
+echo "(something like https://git@git.overleaf.com/123456789ec0830001af836f),"
 echo "paste here and press ENTER"
 
 read
@@ -56,7 +56,7 @@ cp ../$backup_dir/.cookiecutter.yml .
 git add .cookiecutter.yml
 git commit -m 'Back cookiecutter config'
 
-cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.5.2 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists
+cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.6.0 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists
 
 git add --all
 git commit -m 'Bring back all the files'