Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes required for indexing of Workshop Papers (ACL Anthology) #2706

Closed
asdogruoz opened this issue Jul 31, 2023 · 36 comments · Fixed by #2798
Closed

Changes required for indexing of Workshop Papers (ACL Anthology) #2706

asdogruoz opened this issue Jul 31, 2023 · 36 comments · Fixed by #2798
Assignees

Comments

@asdogruoz
Copy link

Currently, each ACL workshop (listed in ACL Anthology) stands as a volume of its own. The workshop organizers act as editors of this volume in the front matter. However, the organizers are not listed as editors of the workshop papers in the Bibtex (ACL). This is a request to include the editors of the workshops in the Bibtex referencing of the ACL Workshop papers which will improve scientific indexing of these papers and recognize the workshop editors' efforts who organize the whole event and prepare the papers for publication.

@mbollmann
Copy link
Member

I can totally see the reasoning behind this. Two purely technical notes:

  1. The ACL natbib style will not currently render the "editor" field for @inproceedings entries, and it looks like this was a conscious decision at some point, though I don't know why:
    https://github.com/acl-org/acl-style-files/blob/3a7a4d1d1c4e153dd8edb9411aa6dc0a45444bce/latex/acl_natbib.bst#L121-L124C14
  2. If we implemented this, we should probably make sure that the individual workshop papers do not appear on the author pages of the workshop editors.

@nschneid
Copy link
Contributor

  1. The ACL natbib style will not currently render the "editor" field for @inproceedings entries, and it looks like this was a conscious decision at some point, though I don't know why:

Proceedings entries in the bibliography using Anthology BibTeX are fairly long even without showing program chairs/workshop chairs as editors. Personally I'd be happy if it stayed that way in the stylesheet. But I have no objection to including the editors in the BibTeX.

LREC-produced BibTeX used to do this BTW (example), but starting with LREC 2020 it seems they stopped including the editor field on papers.

2. If we implemented this, we should probably make sure that the individual workshop papers do not appear on the author pages of the workshop editors.

To state this is more general terms: Anthology author pages would need to recognize the editor role as something that applies to an entire volume but not the individual papers in that volume (for purposes of listing all the publications from that individual).

@knmnyn
Copy link
Collaborator

knmnyn commented Aug 1, 2023

I think Seza's idea makes sense and it seems it would be pretty easy to check how well propagating author information from volume frontmatters would correctly populate editorships. I recall that in the earlier part of the Anthology's materials there are volume where frontmatter was not attributed to any author. I guess we would only propagate in one direction (frontmatter to volume) and not the other way around.

@asdogruoz
Copy link
Author

Thank you for the comments and suggestions. I have encountered yet another indexing issue this week about the workshop papers since they lack an editor. It will be great if we are able to solve this issue soon before things get more complicated.

  1. APA style could serve as a guide for referencing: https://apastyle.apa.org/style-grammar-guidelines/references/examples/edited-book-chapter-references
  2. ACL'2023 workshops are also lacking DOI numbers now.

What would be the timeline to resolve these issues? Who could help to try a few things to find the best solution?

@mbollmann
Copy link
Member

I'm all for fixing this if it is a problem and no one has any objections, but how come there is an urgency now when this has been the status quo for all past workshops for many years?

  1. When we introduced pre-formatted references, we decided against having APA, but use the official ACL style instead. This could be changed of course, but then again I don't think which citation style is used in the Anthology has any bearings on the indexing.
  2. DOIs are added in ACL 2023 DOIs #2723.

For reference, this one line of code prevents the propagation of volume editors to the individual paper entries:

for key, value in volume.attrib.items():
# Only inherit 'editor' for frontmatter
if (key == "editor" and not self.is_volume) or key in (

Removing this condition might already do what we want, but might also break things since papers are allowed to have their own <editor> tag as per the schema. We'd have to carefully test this change.

@mbollmann
Copy link
Member

@asdogruoz #2798 adds editors to the BibTeX; some examples from the preview:

I wonder if and how we should show the editor field in the pre-formatted citation string (where it says "Cite (ACL)"), because it looks quite verbose now. Maybe it would be sufficient to have the full editor list in the BibTeX, but render the pre-formatted citation with "{Editor1} et al."?

@nschneid
Copy link
Contributor

Thanks @mbollmann! A couple things that popped out to me:

  • Cite (Informal) should have the author name, not the editor name
  • Agree re: verbosity
  • Right now the vertical alignment of "Bibkey:" and "Cite (ACL):" is not quite right. I assume this is just because the .bib file is not generated in the preview, so the bibkey is missing?

@mbollmann
Copy link
Member

  • Cite (Informal) should have the author name, not the editor name

Huh, how did that happen ... good catch!

  • Right now the vertical alignment of "Bibkey:" and "Cite (ACL):" is not quite right. I assume this is just because the .bib file is not generated in the preview, so the bibkey is missing?

Yes, that currently happens with all previews.

@mjpost
Copy link
Member

mjpost commented Sep 18, 2023

Thanks for this preview, Marcel! This adds quite a bit of verbosity to the citation preview, particularly for workshops with long lists of organizers. I wonder if we need to add some documentation for this, for people alarmed by the change? One suggestion is a little info hover-over icon with (i) or (?) that would explain the change; we could note that the citation includes the volume editor field, but that the BST file need not use this field (and that ACL's doesn't).

Maybe not necessary but I am trying to anticipate community reaction.

@mbollmann
Copy link
Member

Technically the "Cite (ACL)" field is supposed to mimic the ACL BST, so if it doesn't here, that's a bug in the CSL file (which we use to generate this).

(On an only slightly related note, the build check in #2798 has now failed three times in a row presumably due to memory/resource issues ... I fear this is starting to become a more serious issue as the Anthology grows)

@asdogruoz
Copy link
Author

Thank you, all. Is there an update on this?

@mbollmann
Copy link
Member

Yes, I've rebuilt the PR #2798 now that we have fixed the build issues, so technically this can be merged.

I don't see a consensus here on what we should do about the verbosity of the citations on the paper pages. I assume the important change is the BibTeX, not the example citation on the website (which, either way, is a very recent addition), so I would suggest shortening the editor field in the example citation with "et al.".

We could optionally also introduce an "Editor" row in the tabular metadata, so the full list of editors is shown on the paper pages, but I'm not sure if that would achieve anything?

@asdogruoz
Copy link
Author

Yes, we need an Editor row in the tabular metadata. The full list of editors are important for scientific indexing. Thank you in advance,

@nschneid
Copy link
Contributor

Agreed, I think it would make sense for the tabular metadata fields to match the BibTeX fields.

@asdogruoz
Copy link
Author

What is the latest update/timeline on this issue? It will be great if we can resolve it soon due to some deadlines about indexing in the process. Thank you in advance,

@mbollmann
Copy link
Member

I can add the Editor row pretty quickly.

I don't see a consensus here on what we should do about the verbosity of the citations on the paper pages. I assume the important change is the BibTeX, not the example citation on the website (which, either way, is a very recent addition), so I would suggest shortening the editor field in the example citation with "et al.".

@mjpost Any thoughts on this?

@nschneid
Copy link
Contributor

@mjpost Any updates?

@akoehn
Copy link
Member

akoehn commented Oct 18, 2023

As acl style does not render the editors, so in that case, the html string should not render them as well. Otherwise, it should not be called "cite (ACL)".

@mjpost
Copy link
Member

mjpost commented Oct 18, 2023

We have an editor field now in the page metadata block, and the bibtex contains the editor information. I agree with Arne we should remove it from the citation preview since it does not mirror the real ACL citation. Seza is this sufficient?

@shashwatup9k
Copy link
Contributor

shashwatup9k commented Oct 24, 2023

Hi all,
Thanks for this initiative and your efforts.
It is a very important topic, so, I would like to share my thoughts on this matter.

  • I think it is a good idea to render the editors in both the cite (ACL) and citation preview
  • I have found that @inproceedings{ doesn't include editors in the references(screenshot attached), even when added in the BibTeX at least with acl_natbib.bst and/or natbib bibliography styles. Hence, we need to replace _@inproceedings{ with @incollection{. Otherwise, this effort will not be helpful in achieving the indexing goal.
    indexing-issue

P.S.: I believe ACL or non-ACL conference/workshop proceedings are collections of papers. It would be good if we make the needful changes. 
Many thanks!

@mbollmann
Copy link
Member

@shashwatup9k Do you know of any citation style, for a major conference or journal, that displays the full list of proceedings editors for conference papers? I'm genuinely curious, because I feel this would be a very unpopular change, as it blows up the size of the references enormously.

Either way, a discussion about changing the BibTeX style doesn't really belong here (but probably in https://github.com/acl-org/acl-style-files?), as it is unrelated to the Anthology.

I definitely disagree that we should change the bibtype from @inproceedings. It is intended precisely for conference papers, so is the most appropriate entry type.

@akoehn
Copy link
Member

akoehn commented Oct 24, 2023

Agree with @mbollmann. The anthology provides correct metadata in the bibtex file, the consumer (in this case the latex style) decides how to use it.

The "collection" of papers for a conference are the proceedings (hence e.g. "proceedings of ACL 2025"), so, as Marcel wrote, inproceedings is the correct bibtex type.

It seems to me that whatever process is indexing the metadata should not use the bibliography in papers but the original source to get all relevant data if this is important.

@shashwatup9k
Copy link
Contributor

shashwatup9k commented Oct 24, 2023

Yes, here are some references (sorry if I didn't get your points correctly):

Since 2020 ELRA/LREC also removed the editors' information from the BibTeX when they moved to the ACL anthology or the START account changed the BibTeX stylesheet (my understanding is only speculative. Nicoletta Calzolari or Khalid Choukri or LREC editors can provide better inputs on this matter).

Many thanks!

@nschneid
Copy link
Contributor

@shashwatup9k Thanks for your comment—I think the point is that the Anthology is responsible for the BibTeX and how the metadata is listed on the Anthology website. Both of those will be updated with this change. What goes into the PDF (including the bibliography rendering) is not in the Anthology's purview.

@akoehn
Copy link
Member

akoehn commented Oct 24, 2023

Both of those will be updated with this change.

Just to be clear, the "cite (ACL)" should still mirror the acl style, which does not show the editor.

@nschneid
Copy link
Contributor

nschneid commented Oct 26, 2023

May I suggest merging these changes (#2798), and then we can reevaluate what is needed to support indexing?

@mbollmann
Copy link
Member

#2798 depends on a decision on "Cite (ACL)". It seems we're in agreement that it should mirror ACL style, which (with the editor change) it currently does not, so that fix should be implemented first IMHO.

@nschneid
Copy link
Contributor

OK sure

@mbollmann
Copy link
Member

Pushed this to #2798 now.

@asdogruoz
Copy link
Author

I agree with Atul's comments and suggestions. The current format is not in accordance with the scientific indexing practices. The editors should be acknowledged and (@incollection) bib format seems to be right format for this purpose. Thank you in advance,

@mbollmann
Copy link
Member

@asdogruoz What do you mean by "format" now, the bibliographic information as provided in BibTeX, or the citation style as it appears in papers? @incollection is just the semantically wrong type for conference papers, and if you are talking about how the citation is rendered, this is outside the purview of the Anthology, as previously mentioned.

@shashwatup9k
Copy link
Contributor

shashwatup9k commented Oct 29, 2023

Hi all, thank you for sharing your thoughts and updating my information!
My intention was to propose a potential solution in order to avoid creating new issues in multiple places, including "acl-style files," "ACLPUB," and "ACLPUB2." I completely understand @nschneid, @mbollmann, and other points.

In this revised scenario, I believe that ACL-ORG could potentially address this matter exclusively within the "acl-style files" and "ACLPUB" templates. At least this will work for ACL and non-ACL events' papers/proceedings (either organisers/publication chairs use START or ACLPUB2 for compiling the proceedings). Maybe @mjpost and/or another team member can fix this matter using the same PR (if it is possible). However, this solution/format may not be applicable on a broader scale, such as at ICML, NeurIPS conferences, or in the LaTeX-style files of other journals. Additionally, it's worth mentioning that editors will not be cross-referenced in papers' citations from other conferences or journals.

Thank you!

@nschneid
Copy link
Contributor

I assume indexing services (SCOPUS, Web of Science etc.) rely on metadata such as BibTeX, so improving the Anthology pages & BibTeX will have an effect, right? ICML, NeurIPS, etc. are not published in the ACL Anthology, so any proposed changes for BibTeX from those venues would have to be taken up with the respective organizations.

@nschneid
Copy link
Contributor

TBC, the changes in #2798 as I understand it are:

Any paper within a proceedings (conference or workshop) in the ACL Anthology will include the editors of the proceedings on its Anthology page, and in the BibTeX (with the @inproceedings entry type as usual). Therefore, metadata used by indexing services will have the editors listed for all papers of the proceedings.

As is always the case with BibTeX, how it translates to a human-readable bibliography entry in a PDF depends on the style (.bst file) of the citing venue. Style files are not under the control of the Anthology.

@mbollmann
Copy link
Member

TBC, the changes in #2798 as I understand it are:

Any paper within a proceedings (conference or workshop) in the ACL Anthology will include the editors of the proceedings on its Anthology page, and in the BibTeX (with the @inproceedings entry type as usual). Therefore, metadata used by indexing services will have the editors listed for all papers of the proceedings.

As is always the case with BibTeX, how it translates to a human-readable bibliography entry in a PDF depends on the style (.bst file) of the citing venue. Style files are not under the control of the Anthology.

That's exactly my understanding too.

@nschneid
Copy link
Contributor

Editors are now incorporated! See e.g. https://aclanthology.org/2023.semeval-1.8/

Thanks to @asdogruoz and @shashwatup9k for suggesting the change and @mbollmann for leading the implementation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants