Sync with Overleaf

[davidweichiang]

Who maintains the Overleaf version and can keep it in sync with this version? @neubig @bethard @mjpost

The recent changes are not critical, but it would be good to know who to contact when there is a critical change.

[mjpost]

Good question, I'm not sure. I'm not sure if tagging here will work, you might want to email.

[neubig]

I also don't know, it's not me.

[davidweichiang]

It looks like @mjpost is the owner. Also, it appears that I can edit it -- I hope it's not world-editable -- is it?

[davidweichiang]

Also, it looks to me like this is an ordinary project and not a template?

[mjpost]

That is the draft template I created when we were fiddling around with the new environment. I did not realize this got converted into the official template!

[davidweichiang]

I think it would be nice to create an Overleaf template that is linked to this GitHub repository. Then any updates here can be synced to Overleaf with one click.

Like this (demo, don't actually use): https://www.overleaf.com/read/yrqgpvyrscxj

• I don't have permissions to import from the real repo, so this is linked to my fork of it
• I don't know how to make this into a real template, and whether templates can be linked to GitHub repos
• Maybe archive should be renamed to something later in the alphabet so it appears at the bottom of the file tree

[davidweichiang]

@mjpost Do you know who we would contact in order to get permissions to import from this repo to Overleaf?

[davidweichiang]

Someone made this on Dec 9: https://www.overleaf.com/latex/templates/acl-rolling-review-template/jxbhdzhmcpdm

[davidweichiang]

Publishing a template requires moderation by Overleaf and I'm not sure what the process is for updating an existing template. Maybe it should remain an ordinary project after all. The only downside I see is that users have to take the extra step of cloning the project (which they currently have to do, and should be documented).

[davidweichiang]

@ajstent @neubig Do you have any thoughts about this?

[ajstent]

not only does publishing a template require Overleaf moderation, but then it's really really hard to get them to unpublish it. So I'd suggest not, thanks though!

[davidweichiang]

OK, so I can think of two options:

(1) Continue using @mjpost's project and manually re-upload the style files whenever they change.

Pros: Status quo, simple

Cons: Re-uploading is more work

(2) Create a new Overleaf project (not template) that is set up to sync with this repository.

Pros: Syncing is a one-button process

Cons:

• We'll need the owner of this Github organization to do the linking to Overleaf, or give someone permission to do it.
• The actual LaTeX template will be in a subdirectory, which will be inconvenient for authors.

[leondz]

(2) Create a new Overleaf project (not template) that is set up to sync with this repository.

Pros: Syncing is a one-button process

Can this be done via cron job, daily, using Overleaf's git offering? Maybe wrapped in a condition that the commit hash is out of sync? Then it would need to be hosted and documented and owned, but at least it could push itself. If that git access is available to Overleaf template instances, I'd support (2).

---

There's another underlying issue caused by ARR decoupling template versioning from events. Previously, specific versions of the ACL template were attached to individual calls, and that template would be valid for that call. Now that ARR decouples authoring and submission from publication, there's no definition of which template versions are valid at a given time.

For a stretched but not impossible example, one might start authoring a paper in 2021, submit it in 2022, revise it, but then the grad student leaves, and so it's eventually resubmitted in 2023, and perhaps published in 2024. This means that quite old template could potentially crop up in submissions, and also that the set of articles published in any given proceedings are likely to use a mixture of different ACL template versions.

This only presents an issue if significant changes are made to the ACL template (for some definition of significant). If we want to lock ourselves into pretty much the same format for the forseeable future, there's of course no impact. On the downside, we've regularly seen cool new additions to our templates (like line numbering for review) and I think it's beneficial for chairs + community to continue to be able to do this sort of thing.

Other options could be:

• to give a sliding time window for templates, e.g. "EMNLP 2024 uses templates versions 8a7e6c1f3d49816+" or "EMNLP 2024 uses templates from March 2023 onwards"
• to stipulate a fixed template release schedule, e.g. annually on 1 Jan, and declare that the current (or current + one previous) templates are eligible
• to specify a "minimum constraints list" that all ACL templates will always adhere to, and let people use whatever fits that, and hope that reviewers and ACs don't get spooked about minor template changes. (this tactic probably has some chance of occasional false-positive desk rejects, so ACs need to be on-board)

[davidweichiang]

Can this be done via cron job, daily, using Overleaf's git offering?

I don't think that's necessary; I believe an Overleaf project can be set up to use the official git repository as its underlying repository, so it would all be automatic.

The fact that the LaTeX files would be in a subdirectory seems to me an annoying problem, though, enough to make me favor (1).

[leondz]

Can this be done via cron job, daily, using Overleaf's git offering?

I don't think that's necessary; I believe an Overleaf project can be set up to use the official git repository as its underlying repository, so it would all be automatic.

The fact that the LaTeX files would be in a subdirectory seems to me an annoying problem, though, enough to make me favor (1).

Yeah, I agree, this would be annoying and unintuitive. There are already enough clicks between a conference homepage and the templates.

The ability to script unwrapping of this is trivial in (2). Would that tempt you?

[davidweichiang]

The other question you brought up about ARR is a good one but should be made by the ARR editors. As far as maintaining the style files is concerned, I suggest we use some kind of semantic versioning (major version = can affect accept/reject decisions; minor version = improvements that don't affect accept/reject) and ARR, or any meetings not using ARR, can decide to require a minimum version number.

[davidweichiang]

Maybe better than a cron job would be a GitHub action that, whenever there is a push on this repository, pushes the latex/ subdirectory into the Overleaf repository. I don't know how to do that, but maybe you or @mjpost can do it (especially since @mjpost owns the current Overleaf project).

[ajstent]

From an ARR perspective, we point authors to the current official version; venues (conferences, workshops) would be the ones to potentially see papers using older templates. (Wouldn't it be nice if we could just have authors upload the LaTex like arXiv does? long-term future work). I think for now ARR just continues to point authors at the official repository.

[jkkummerfeld]

Reviving this discussion - the repository and the Overleaf version are not in sync yet. Skimming the discussion above, it sounds like that is something only @mjpost can fix?

[mjpost]

I just shared with a number of you an Overleaf project that I think has been used for some conferences. I think this has been used at least once, but I don't know for what conference. It's hard to know who's using what.

It shouldn't be too hard to set this up to automatically update; the harder item is to adopt and enforce a policy where people across conferences stick to using it.

[mjpost]

Also, I just checked, and this might be easier than we had hoped—Overleaf has an explicit option to sync with a named Github repo. It looks like I don't have the right permissions to acl-org, though.

@jkkummerfeld do you what is the current correct version? Is it this repo, or the current template?

[jkkummerfeld]

ARR simply points to this repository. I just checked for ACL 2023, and it had a zip file. Comparing the contents of that zip file with this repository and overleaf I see:

• acl_natbib.bst - same everywhere
• acl.sty - the ACL 2023 version is closer to the overleaf version. There is one extra line \newcommand{\citeposs}[1]{\citeauthor{#1}'s (\citeyear{#1})} on line 210
  • acl_latex.tex - The ACL 2023 version has a range of edits, including adding content about the Limitations section and Ethics Statement

Maybe the best thing is to update this repository and overleaf to match ACL 2023? (without the year specific bits) I'm happy to prepare the files and make a PR here if that's the right next step.

[mjpost]

Reviewing this thread I see David made the exact point about Github-backed Overleaf.

I don't know about updating the repo with your suggested edits (I suppose you have jurisdiction here?) It seems reasonable. So a PR would be great.

Then we should definitely connect this repo to the overleaf. This might be a job for @desilinguist.

[davidweichiang]

+1 for \citeposs.

[jkkummerfeld]

PR created - https://github.com/acl-org/acl-style-files/pull/18

[jkkummerfeld]

Re: jurisdiction... it's unclear to me who has definitive say here, since this is intended to be for general use within ACL. These edits don't seem substantive to me (just bringing in minor edits from ACL 2023 and updating the files to be consistent with standard practise re: limitations and ethics). Given that, I would assume anyone with PR-merging privileges in this repository can merge it.

[jkkummerfeld]

Following up on this. @danielgildea and @davidweichiang, based on our discussion in the PR, this repository is correct and the overleaf is out of date.

I have updated the overleaf content to match this repository (solution (1) above). That means all is well for the immediate next cycles of ARR (ie, for EACL, NAACL, and ACL). There is still the question of a longer term solution to keeping these in sync.

[danielgildea]

Since the github README points to the overleaf project, they should really be in sync. Can you please update the overleaf project manually for now?

[mjpost]

Someone who's a member of @acl-org-github could easily link this directly from Overleaf. I don't seem to have the right permissions.

[danielgildea]

I don't understand exactly what you're trying to do... the pasted graphic says "create a github repository", but we don't want to do that, we want to sync with this existing github repository, right? What does acl-org-github own exactly? Do you have any idea who they are?

In any case, I think we should remove the link to overleaf from the README in github if we can't update the overleaf project.

[mjpost]

Yeah, I was assuming there would be a way to try to sync it with an existing Github repo, and included the screenshot just to demonstrate what it looks like for me. Digging a bit further, the documentation tells how to do what we want (see "Creating an Overleaf project from an existing Git repository").

Since I own the Overleaf, I'll give this a shot.

[mjpost]

Okay, I updated the style files in the Overleaf template.

I didn't setup direct sync, because it would require the LaTeX style files to be moved to the root folder. If we want to do that, it should be trivial to setup the syncing. I would also suggest that we remove the archive/ directory, since it will just clutter up people's directories. It's in the git history, anyway. If people care about quick access, we could add a "History" section to the README with direct links to the git commits.

[davidweichiang]

I agree about removing archive.

I think it might be okay either to change the example paper to \usepackage{latex/acl} or to leave the style files where they are and put a latexmkrc in the root directory (https://www.overleaf.com/learn/latex/Questions/I_have_a_lot_of_.cls%2C_.sty%2C_.bst_files%2C_and_I_want_to_put_them_in_a_folder_to_keep_my_project_uncluttered._But_my_project_is_not_finding_them_to_compile_correctly).

[mjpost]

@davidweichiang it's not quite what you asked for, but I created a PR at #19.

[danielgildea]

I merged the pull request.

Matt, can you please sync to overleaf again?

It looks like there is no way to make updates to overleaf totally automatic - we will need to push to overleaf for each change. Could you add me as an owner of the overleaf project?

[mjpost]

Dan, I just added you to the Overleaf. I think we can make it automatic (see my post above on Sep. 12), but it just requires us to restructure the repo a bit so it makes sense in both settings. It'd be nice to keep both this repo and the current Overleaf since they are both pointed to from multiple places. I've not had time/motivation for this and am only accidentally involved so I'd be happy to have someone take it over.

[danielgildea]

Thanks, I have synched the overleaf and github repositories, and I can keep them in sync from now on.

(I haven't found a way to make this fully automatic. I am doing "git push origin master" and "git push overleaf master" from the command line. Others with access to both repositories can do this too. It looks like even with overleaf's sync with github feature, you would have to click a button to make the updates copy over.)

Matt, you can transfer ownership of the overleaf project to me if you want to be totally done with it.

[mjpost]

@danielgildea do you know who owns the ARR Overleaf (#37)? That one is not being updated (and contains outdated instructions about anthology.bib.gz).