Compare commits

...

13 Commits

15 changed files with 114 additions and 114 deletions

View File

@ -1,4 +1,30 @@
<a name="5.5.0"></a>
## 5.5.0 (2023-10-03)
Updates:
* Update Coling template
Fixes:
* Remove some broken tests
<a name="5.4.6"></a>
## 5.4.6 (2022-12-20)
Bug fixes:
* Fix setting up Overleaf
<a name="5.4.5"></a>
## 5.4.5 (2022-12-20)
Improvements:
* fill in some fields in LLNCS
* add test for amu-en
<a name="5.4.4"></a> <a name="5.4.4"></a>
## 5.4.4 (2022-12-19) ## 5.4.4 (2022-12-19)

View File

@ -6,8 +6,8 @@ The template itself is in the `{{cookiecutter.paper_id}}-paper`.
In order to generate a project from the template: In order to generate a project from the template:
* install cookiecutter * 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.4.4 * 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.1
* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.4.4` * run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.5.1`
You will be asked to choose a LaTeX template, at the moment the You will be asked to choose a LaTeX template, at the moment the
following templates are handled: following templates are handled:
@ -18,7 +18,7 @@ following templates are handled:
* Natural Language Engineering journal (`nle`), * Natural Language Engineering journal (`nle`),
* ACM SIGCONF template (`sigconf`), e.g. for the SIGIR conference, * ACM SIGCONF template (`sigconf`), e.g. for the SIGIR conference,
* MSc thesis at Warsaw University of Technology (`pw-thesis`) * MSc thesis at Warsaw University of Technology (`pw-thesis`)
* COLING (`coling`) * COLING (& LREC, `coling`)
* LLNCS (`llncs`) * LLNCS (`llncs`)
* EMNLP (`emnlp`) * EMNLP (`emnlp`)
* NeurIPS (`neurips`) * NeurIPS (`neurips`)
@ -59,7 +59,7 @@ git remote set-url origin YOUR-GIT-REPO
password: `git config credential.helper "cache --timeout=10000000"` password: `git config credential.helper "cache --timeout=10000000"`
8. Unfortunately, Overleaf will discard hidden files (`.*`) when a zip 8. Unfortunately, Overleaf will discard hidden files (`.*`) when a zip
is uploaded, also file permissions will be somewhat broken 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.4.4 --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.5.1 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`)
10. Re-commit the files (including recovered `.*` files). 10. Re-commit the files (including recovered `.*` files).
11. Push the repo to Overleaf (fortunately, the `.*` will be treated 11. Push the repo to Overleaf (fortunately, the `.*` will be treated
correctly when this is done by git): `git push overleaf master` 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. To keep your codebase in sync with template you need to occasionally reapply the template.
Here's how: Here's how:
* find a paper-cutter tag applicable, say 5.4.4 * find a paper-cutter tag applicable, say 5.5.1
* (do *not* refer to master in your projects!) * (do *not* refer to master in your projects!)
* go to project root * go to project root
* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.4.4 --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.5.1 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`
* check changes with git * check changes with git
Editing the files 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. If not, get in touch with Filip Graliński.
2. Commit or stash any uncommitted changes. 2. Commit or stash any uncommitted changes.
3. Change the `latex_template` value accordingly in the `.cookiecutter.yml` file. Commit the 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.4.4 --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.5.1 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`).
5. Compare `metadata.tex` against the right metadata template file 5. Compare `metadata.tex` against the right metadata template file
(`*/*-template-meta.tex` in `_latex-templates/`) and make any fixes (`*/*-template-meta.tex` in `_latex-templates/`) and make any fixes
needed. This is the only thing that needs to be done manually needed. This is the only thing that needs to be done manually
@ -172,7 +172,7 @@ Variables to be set in GitLab UI
## Authors ## Authors
Prepared by Filip Graliński (Applica.ai). Prepared by Filip Graliński (while at Adam Mickiewicz University / Applica.ai).
### Contributors ### Contributors

View File

@ -66,11 +66,12 @@ elif [ "{{ cookiecutter.latex_template }}" = "pw-thesis" ]; then
cp -r _optional_files/_pw-thesis/* . cp -r _optional_files/_pw-thesis/* .
elif [ "{{ cookiecutter.latex_template }}" = "coling" ]; then elif [ "{{ cookiecutter.latex_template }}" = "coling" ]; then
get_files "https://coling2020.org/coling2020.zip" \ get_files "https://lrec-coling-2024.org/wp-content/uploads/2023/10/lrec-latex.zip" \
coling.bst \ lrec-coling2024-natbib.bst \
coling2020.sty lrec-coling2024.sty \
cp -r _latex-templates/coling2020-template.tex {{cookiecutter.paper_id}}.tex languageresource.bib
cp -r _latex-templates/coling2020-template-meta.tex metadata.tex cp -r _latex-templates/coling-template.tex {{cookiecutter.paper_id}}.tex
cp -r _latex-templates/coling-template-meta.tex metadata.tex
elif [ "{{ cookiecutter.latex_template }}" = "llncs" ]; then elif [ "{{ cookiecutter.latex_template }}" = "llncs" ]; then
get_files "https://resource-cms.springernature.com/springer-cms/rest/v1/content/19238648/data/v6" \ get_files "https://resource-cms.springernature.com/springer-cms/rest/v1/content/19238648/data/v6" \
llncs.cls \ llncs.cls \

12
test/configs/amu-en.yml Normal file
View File

@ -0,0 +1,12 @@
default_context:
latex_template: 'amu'
locale: 'pl_PL'
with_appendix: 'no'
extra_locale: 'en_US'
with_arxiv_package: 'no'
discipline: 'informatyka'
specialization: 'sztuczna inteligencja'
supervisor: 'prof. dr hab. Jan Nowak'
album_no: '123456'
contribution_declaration: 'no'

View File

@ -1,5 +0,0 @@
default_context:
latex_template: 'ieee-access'
with_arxiv_package: 'no'

View File

@ -1,2 +0,0 @@
default_context:
latex_template: 'scitepress'

View File

@ -16,7 +16,7 @@ check()
cd "$PAPER_DIR" cd "$PAPER_DIR"
make clean make clean
make make
if [[ "$config_file" != "configs/pw-thesis.yml" && "$config_file" != "configs/amu.yml" && "$config_file" != "configs/ieee-access.yml" ]] if [[ "$config_file" != "configs/pw-thesis.yml" && "$config_file" != "configs/amu.yml" && "$config_file" != "configs/ieee-access.yml" && "$config_file" != "configs/amu-en.yml" ]]
then then
make arxiv-$PAPER_ID.tar.gz make arxiv-$PAPER_ID.tar.gz
fi fi

View File

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

View File

@ -0,0 +1,9 @@
\title{ {{ cookiecutter.paper_title }} }
\name{ {{cookiecutter.main_contributor_name}} }
{% raw %}
\address{Affiliation1, Affiliation2, Affiliation3 \\
Address1, Address2, Address3 \\
author1@xxx.yy, author2@zzz.edu, author3@hhh.com\\
\{author1, author5, author9\}@abc.org\\}
{% endraw %}

View File

@ -0,0 +1,42 @@
{% raw %}
% LREC-COLING 2024 Example;
% LREC Is now using templates similar to the ACL ones.
\documentclass[10pt, a4paper]{article}
\usepackage[review]{lrec-coling2024} % this is the new style
\input{config}
\input{extras}
\input{preamble}
\input{metadata}
\newcommand\bycite[1]{in~\citet{#1}}
\abstract{
\input{abstract}
\\ \newline \Keywords{keyword1, keyword2, keyword3} }
\begin{document}
\maketitleabstract
\input{main}
\nocite{*}
\section{Bibliographical References}\label{sec:reference}
\bibliographystyle{lrec-coling2024-natbib}
\bibliography{bibliography}
\section{Language Resource References}
\label{lr:ref}
\bibliographystylelanguageresource{lrec-coling2024-natbib}
\bibliographylanguageresource{languageresource}
\end{document}
%%% Local Variables:
%%% mode: latex
%%% TeX-master: t
%%% End:
{% endraw %}

View File

@ -1,14 +0,0 @@
{% raw %}
\title{Insert your title}
\author{First Author \\
Affiliation / Address line 1 \\
Affiliation / Address line 2 \\
Affiliation / Address line 3 \\
\texttt{email@domain} \\\And
Second Author \\
Affiliation / Address line 1 \\
Affiliation / Address line 2 \\
Affiliation / Address line 3 \\
\texttt{email@domain} \\}
{% endraw %}

View File

@ -1,73 +0,0 @@
{% raw %}
\pdfoutput=1
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% [paper-cutter clarifications]
%
% DO NOT EDIT THIS FILE (unless you know what you are doing).
% THIS IS A FILE SUPPLIED BY THE TEMPLATE.
% PLEASE EDIT main.tex INSTEAD.
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% File coling2020.tex
%
% Contact: feiliu@cs.ucf.edu & liang.huang.sh@gmail.com
%% Based on the style files for COLING-2018, which were, in turn,
%% Based on the style files for COLING-2016, which were, in turn,
%% Based on the style files for COLING-2014, which were, in turn,
%% Based on the style files for ACL-2014, which were, in turn,
%% Based on the style files for ACL-2013, which were, in turn,
%% Based on the style files for ACL-2012, which were, in turn,
%% based on the style files for ACL-2011, which were, in turn,
%% based on the style files for ACL-2010, which were, in turn,
%% based on the style files for ACL-IJCNLP-2009, which were, in turn,
%% based on the style files for EACL-2009 and IJCNLP-2008...
%% Based on the style files for EACL 2006 by
%%e.agirre@ehu.es or Sergi.Balari@uab.es
%% and that of ACL 08 by Joakim Nivre and Noah Smith
\newcommand\citep[1]{\cite{#1}}
\newcommand\citet[1]{\newcite{#1}}
\newcommand\bycite[1]{by~\citet{#1}}
\documentclass[11pt]{article}
\usepackage{coling2020}
\usepackage{times}
\usepackage{url}
\usepackage{latexsym}
%\setlength\titlebox{5cm}
% You can expand the titlebox if you need extra space
% to show all the authors. Please do not make the titlebox
% smaller than 5cm (the original size); we will check this
% in the camera-ready version and ask you to change it back.
\input{config}
\input{extras}
\input{preamble}
\input{metadata}
\begin{document}
\maketitle
\begin{abstract}
\input{abstract}
\end{abstract}
\input{main}
\bibliography{bibliography}
\bibliographystyle{coling}
\ifwithappendix
\typeout{!!! APPENDIX WILL BE SKIPPED FOR THIS TEMPLATE. !!!}
\fi
\end{document}
%%% Local Variables:
%%% mode: latex
%%% TeX-master: t
%%% End:
{% endraw %}

View File

@ -1,13 +1,15 @@
\title{ {{ cookiecutter.paper_title }}\thanks{Supported byorganization x.} }
{% raw %} {% raw %}
\title{Contribution Title\thanks{Supported by organization x.}}
% %
%\titlerunning{Abbreviated paper title} %\titlerunning{Abbreviated paper title}
% If the paper title is too long for the running head, you can set % If the paper title is too long for the running head, you can set
% an abbreviated paper title here % an abbreviated paper title here
% %
\author{First Author\inst{1}\orcidID{0000-1111-2222-3333} \and {% endraw %}
\author{ {{cookiecutter.main_contributor_name}}\inst{1}\orcidID{0000-1111-2222-3333} \and
Second Author\inst{2,3}\orcidID{1111-2222-3333-4444} \and Second Author\inst{2,3}\orcidID{1111-2222-3333-4444} \and
Third Author\inst{3}\orcidID{2222--3333-4444-5555}} Third Author\inst{3}\orcidID{2222--3333-4444-5555} }
{% raw %}
% %
\authorrunning{F. Author et al.} \authorrunning{F. Author et al.}
% First names are abbreviated in the running head. % First names are abbreviated in the running head.

View File

@ -100,7 +100,9 @@ then
: :
elif [[ "$latex_template" == "coling" ]] elif [[ "$latex_template" == "coling" ]]
then then
copy_to_project coling2020.sty coling.bst copy_to_project lrec-coling2024-natbib.bst \
lrec-coling2024.sty \
languageresource.bib
elif [[ "$latex_template" == "llncs" ]] elif [[ "$latex_template" == "llncs" ]]
then then
copy_to_project llncs.cls splncs04.bst copy_to_project llncs.cls splncs04.bst

View File

@ -56,7 +56,7 @@ cp ../$backup_dir/.cookiecutter.yml .
git add .cookiecutter.yml git add .cookiecutter.yml
git commit -m 'Back cookiecutter config' git commit -m 'Back cookiecutter config'
cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.4.3 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.5.1 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists
git add --all git add --all
git commit -m 'Bring back all the files' git commit -m 'Bring back all the files'