Compare commits
No commits in common. "master" and "5.4.2" have entirely different histories.
50
CHANGELOG.md
50
CHANGELOG.md
@ -1,54 +1,4 @@
|
||||
|
||||
<a name="5.5.2"></a>
|
||||
## 5.5.2 (2024-09-09)
|
||||
|
||||
Updates:
|
||||
|
||||
* Update Coling template
|
||||
|
||||
Misc:
|
||||
|
||||
* Switch off gonito scores in the example
|
||||
|
||||
<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>
|
||||
## 5.4.4 (2022-12-19)
|
||||
|
||||
Bug fixes:
|
||||
|
||||
* update LLNCS URL
|
||||
|
||||
<a name="5.4.3"></a>
|
||||
## 5.4.3 (2022-11-09)
|
||||
|
||||
Bug fixes:
|
||||
|
||||
* Fix updating on MacOS
|
||||
|
||||
<a name="5.4.2"></a>
|
||||
## 5.4.2 (2022-11-09)
|
||||
|
17
README.md
17
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.4.2
|
||||
* run: `cookiecutter https://git.wmi.amu.edu.pl/filipg/paper-cutter.git --checkout 5.4.2`
|
||||
|
||||
You will be asked to choose a LaTeX template, at the moment the
|
||||
following templates are handled:
|
||||
@ -18,7 +18,7 @@ following templates are handled:
|
||||
* Natural Language Engineering journal (`nle`),
|
||||
* ACM SIGCONF template (`sigconf`), e.g. for the SIGIR conference,
|
||||
* MSc thesis at Warsaw University of Technology (`pw-thesis`)
|
||||
* COLING (& LREC, `coling`)
|
||||
* COLING (`coling`)
|
||||
* LLNCS (`llncs`)
|
||||
* EMNLP (`emnlp`)
|
||||
* NeurIPS (`neurips`)
|
||||
@ -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.4.2 --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.4.2
|
||||
* (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.4.2 --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.4.2 --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
|
||||
@ -128,7 +128,6 @@ MacOS Requirements
|
||||
------------
|
||||
|
||||
```
|
||||
brew install cookiecutter
|
||||
brew install texlive
|
||||
brew install biber
|
||||
brew install pyyaml
|
||||
@ -172,7 +171,7 @@ Variables to be set in GitLab UI
|
||||
|
||||
## Authors
|
||||
|
||||
Prepared by Filip Graliński (while at Adam Mickiewicz University / Applica.ai).
|
||||
Prepared by Filip Graliński (Applica.ai).
|
||||
|
||||
### Contributors
|
||||
|
||||
|
@ -25,7 +25,7 @@ fix_noexpand_issue()
|
||||
{
|
||||
# see https://tex.stackexchange.com/questions/487428/patch-failed-in-emnlp-style-template
|
||||
file_to_be_patched="$1"
|
||||
sed -i~ 's|{\\errmessage{\\noexpand patch failed}}|{}|g' "$1"
|
||||
sed -i 's|{\\errmessage{\\noexpand patch failed}}|{}|g' "$1"
|
||||
}
|
||||
|
||||
if [ "{{ cookiecutter.latex_template }}" = "vanilla" ]; then
|
||||
@ -66,13 +66,13 @@ elif [ "{{ cookiecutter.latex_template }}" = "pw-thesis" ]; then
|
||||
|
||||
cp -r _optional_files/_pw-thesis/* .
|
||||
elif [ "{{ cookiecutter.latex_template }}" = "coling" ]; then
|
||||
get_files "https://coling2025.org/downloads/coling-2025.zip" \
|
||||
coling_natbib.bst \
|
||||
coling.sty
|
||||
cp -r _latex-templates/coling-template.tex {{cookiecutter.paper_id}}.tex
|
||||
cp -r _latex-templates/coling-template-meta.tex metadata.tex
|
||||
get_files "https://coling2020.org/coling2020.zip" \
|
||||
coling.bst \
|
||||
coling2020.sty
|
||||
cp -r _latex-templates/coling2020-template.tex {{cookiecutter.paper_id}}.tex
|
||||
cp -r _latex-templates/coling2020-template-meta.tex metadata.tex
|
||||
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/v4" \
|
||||
llncs.cls \
|
||||
splncs04.bst
|
||||
cp -r _latex-templates/llncs-template.tex {{cookiecutter.paper_id}}.tex
|
||||
@ -114,7 +114,7 @@ elif [ "{{ cookiecutter.latex_template }}" == "ieee-access" ]; then
|
||||
mkdir -p images
|
||||
cp -r _latex-templates/ieee-access-template-photo.png images/sample-photo.png
|
||||
# not compatible with tikz (and todonotes which is based on tikz)
|
||||
sed -i~ 's/\\usepackage\[textsize=tiny\]{todonotes}/\\usepackage{todo}/' extras.tex
|
||||
sed -i 's/\\usepackage\[textsize=tiny\]{todonotes}/\\usepackage{todo}/' extras.tex
|
||||
elif [ "{{ cookiecutter.latex_template }}" == "ieee-conf" ]; then
|
||||
cp -r _latex-templates/ieee-conf-template.tex {{cookiecutter.paper_id}}.tex
|
||||
cp -r _latex-templates/ieee-conf-template-meta.tex metadata.tex
|
||||
|
@ -1,12 +0,0 @@
|
||||
|
||||
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'
|
5
test/configs/ieee-access.yml
Normal file
5
test/configs/ieee-access.yml
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
|
||||
default_context:
|
||||
latex_template: 'ieee-access'
|
||||
with_arxiv_package: 'no'
|
5
test/configs/ieee-conf.yml
Normal file
5
test/configs/ieee-conf.yml
Normal file
@ -0,0 +1,5 @@
|
||||
|
||||
|
||||
default_context:
|
||||
latex_template: 'ieee-conf'
|
||||
with_arxiv_package: 'yes'
|
3
test/configs/llncs.yml
Normal file
3
test/configs/llncs.yml
Normal file
@ -0,0 +1,3 @@
|
||||
|
||||
default_context:
|
||||
latex_template: 'llncs'
|
3
test/configs/pw-thesis.yml
Normal file
3
test/configs/pw-thesis.yml
Normal file
@ -0,0 +1,3 @@
|
||||
|
||||
default_context:
|
||||
latex_template: 'pw-thesis'
|
2
test/configs/scitepress.yml
Normal file
2
test/configs/scitepress.yml
Normal file
@ -0,0 +1,2 @@
|
||||
default_context:
|
||||
latex_template: 'scitepress'
|
3
test/configs/sigconf.yml
Normal file
3
test/configs/sigconf.yml
Normal file
@ -0,0 +1,3 @@
|
||||
|
||||
default_context:
|
||||
latex_template: 'sigconf'
|
@ -16,7 +16,7 @@ check()
|
||||
cd "$PAPER_DIR"
|
||||
make clean
|
||||
make
|
||||
if [[ "$config_file" != "configs/pw-thesis.yml" && "$config_file" != "configs/amu.yml" && "$config_file" != "configs/ieee-access.yml" && "$config_file" != "configs/amu-en.yml" ]]
|
||||
if [[ "$config_file" != "configs/pw-thesis.yml" && "$config_file" != "configs/amu.yml" && "$config_file" != "configs/ieee-access.yml" ]]
|
||||
then
|
||||
make arxiv-$PAPER_ID.tar.gz
|
||||
fi
|
||||
|
@ -6,5 +6,5 @@ variables:
|
||||
# THIS IS AN UGLY WORK-AROUND
|
||||
include:
|
||||
- project: 'research/paper-cutter'
|
||||
ref: '5.5.2'
|
||||
ref: '5.4.2'
|
||||
file: 'main.yml'
|
||||
|
@ -1,6 +1,6 @@
|
||||
\title{ {{ cookiecutter.paper_title }} }
|
||||
\title{Insert your title}
|
||||
|
||||
\author{ {{cookiecutter.main_contributor_name}} \\
|
||||
\author{First Author \\
|
||||
Affiliation / Address line 1 \\
|
||||
Affiliation / Address line 2 \\
|
||||
Affiliation / Address line 3 \\
|
||||
|
@ -46,16 +46,11 @@
|
||||
\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}
|
||||
|
@ -1,36 +0,0 @@
|
||||
{% raw %}
|
||||
% COLING 2025 Example;
|
||||
|
||||
\documentclass[11pt]{article}
|
||||
|
||||
\usepackage[review]{coling}
|
||||
|
||||
\input{config}
|
||||
\input{extras}
|
||||
\input{preamble}
|
||||
\input{metadata}
|
||||
|
||||
\usepackage{times}
|
||||
\usepackage{inconsolata}
|
||||
|
||||
\newcommand\bycite[1]{by~\citet{#1}}
|
||||
|
||||
\begin{document}
|
||||
|
||||
\maketitle
|
||||
\begin{abstract}
|
||||
\input{abstract}
|
||||
\end{abstract}
|
||||
|
||||
\input{main}
|
||||
|
||||
\section*{References}\label{sec:reference}
|
||||
|
||||
\bibliography{bibliography}
|
||||
|
||||
\end{document}
|
||||
%%% Local Variables:
|
||||
%%% mode: latex
|
||||
%%% TeX-master: t
|
||||
%%% End:
|
||||
{% endraw %}
|
@ -1,6 +1,7 @@
|
||||
\title{ {{ cookiecutter.paper_title }} }
|
||||
{% raw %}
|
||||
\title{Insert your title}
|
||||
|
||||
\author{ {{cookiecutter.main_contributor_name}} \\
|
||||
\author{First Author \\
|
||||
Affiliation / Address line 1 \\
|
||||
Affiliation / Address line 2 \\
|
||||
Affiliation / Address line 3 \\
|
||||
@ -10,3 +11,4 @@
|
||||
Affiliation / Address line 2 \\
|
||||
Affiliation / Address line 3 \\
|
||||
\texttt{email@domain} \\}
|
||||
{% endraw %}
|
@ -0,0 +1,73 @@
|
||||
{% 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 %}
|
@ -1,15 +1,13 @@
|
||||
\title{ {{ cookiecutter.paper_title }}\thanks{Supported byorganization x.} }
|
||||
{% raw %}
|
||||
\title{Contribution Title\thanks{Supported by organization x.}}
|
||||
%
|
||||
%\titlerunning{Abbreviated paper title}
|
||||
% If the paper title is too long for the running head, you can set
|
||||
% an abbreviated paper title here
|
||||
%
|
||||
{% endraw %}
|
||||
\author{ {{cookiecutter.main_contributor_name}}\inst{1}\orcidID{0000-1111-2222-3333} \and
|
||||
\author{First Author\inst{1}\orcidID{0000-1111-2222-3333} \and
|
||||
Second Author\inst{2,3}\orcidID{1111-2222-3333-4444} \and
|
||||
Third Author\inst{3}\orcidID{2222--3333-4444-5555}}
|
||||
{% raw %}
|
||||
%
|
||||
\authorrunning{F. Author et al.}
|
||||
% First names are abbreviated in the running head.
|
||||
|
@ -10,11 +10,7 @@ for my $filepath (@ARGV) {
|
||||
|
||||
while (my $line=<$ih>) {
|
||||
while ($line =~ m<\\gonito(?:barescore|score|entry)\{([^\}]+)\}>g) {
|
||||
my $k = $1;
|
||||
|
||||
if ($k ne '#1') {
|
||||
$found{$k} = 1;
|
||||
}
|
||||
$found{$1} = 1;
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -12,7 +12,6 @@
|
||||
\usepackage{graphicx}
|
||||
\usepackage{booktabs}
|
||||
\usepackage{latexsym}
|
||||
\usepackage{microtype}
|
||||
|
||||
% so that footnotes in tables would work
|
||||
% https://tex.stackexchange.com/questions/109467/footnote-in-tabular-environment
|
||||
|
@ -100,8 +100,7 @@ then
|
||||
:
|
||||
elif [[ "$latex_template" == "coling" ]]
|
||||
then
|
||||
copy_to_project coling_natbib.bst \
|
||||
coling.sty
|
||||
copy_to_project coling2020.sty coling.bst
|
||||
elif [[ "$latex_template" == "llncs" ]]
|
||||
then
|
||||
copy_to_project llncs.cls splncs04.bst
|
||||
|
@ -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@git.overleaf.com/123456789ec0830001af836f),"
|
||||
echo "(something like https://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.4.2 --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists
|
||||
|
||||
git add --all
|
||||
git commit -m 'Bring back all the files'
|
||||
|
@ -11,6 +11,17 @@ See the experiments described \bycite{gonito2016}.
|
||||
Please put your content here.
|
||||
|
||||
|
||||
{% if cookiecutter.latex_template != 'pw-thesis' and cookiecutter.latex_template != 'amu' %}
|
||||
\subsection{Gonito}
|
||||
{% else %}
|
||||
\section{Gonito}
|
||||
{% endif %}
|
||||
|
||||
Gonito submission should be referenced like this
|
||||
\gonitoscore{6ab4979e4629c5559feba452b7ca74c0cac89ebb}%
|
||||
\footnote{Reference codes to repositories stored at
|
||||
Gonito.net~\cite{gonito2016} are given in curly brackets. Such a~repository may be also accessed by going
|
||||
to \url{http://gonito.net/q} and entering the code there.}
|
||||
|
||||
{% if cookiecutter.latex_template != 'pw-thesis' and cookiecutter.latex_template != 'amu' %}
|
||||
\section{Yet another section}
|
||||
|
Loading…
Reference in New Issue
Block a user