Update author docs (#4602)

* Update corrections page
* Update blog post
* Remove rich from bin/requirements.txt (often leads to conflicts with the version-pegged requirement in python/)

Author: mjpost

bin/requirements.txt

@@ -21,7 +21,6 @@ python-slugify>=2.0
 pytz
 PyYAML>=3.0
 requests
-rich
 ruff~=0.3.4
 setuptools==75.6.0
 stop-words==2018.7.23

hugo/content/faq/corrections.md

@@ -3,8 +3,14 @@ Title: How can I submit corrections to papers?
 weight: 1
 ---
 
-Metadata (title, author list, and abstract) can be corrected by clicking on the yellow "Fix data" button on any paper page in the Anthology (e.g., [K17-1003](https://aclanthology.org/K17-1003/)). This will present you with a modal dialog that upon submission will instantiate an issue template in the Anthology Github repository.
+There are a number of types of corrections. For an overview, you can see our [our corrections page]({{< relref "/info/corrections.md" >}}).
 
-The Anthology treats PDFs as the authoritative source of information, so metadata corrections should conform to the information in the PDF.
+In summary, there are three main types of corrections we handle:
 
-For corrections to PDFs, please read the information on [our corrections page]({{< relref "/info/corrections.md" >}}).
+* _Metadata only_. This includes corrections to the title, author list, or abstract. These can be initiated by clicking on the yellow "Fix data" button on any paper page in the Anthology.
+* _Author disambiguation_. These corrections involve author pages (e.g., anything under https://aclanthology/people/), and can also be initiated by clicking on the yellow "Fix data" button on any author page. There are two main types of author disambiguation:
+   1. _One author, 2+ names_. e.g., [Aravind Joshi](https://aclanthology.org/people/aravind-joshi) Aravind K. Joshi, etc. Note that often, an author will have multiple pages because the metadata for one or more PDFs is incorrect. The pages can be automatically merged if the underlying PDFs have the verbatim string and are simply correct in the metadata. If different names were used, we have to create an entry in our name variants file.
+   2. _2+ authors, one name_. e.g., [Yang Liu](https://aclanthology.org/people/yang-liu). In this situation, we have to manually assign IDs to the papers to create a separate author page, typically using their Ph.D. granting institution (e.g., [Yang Liu of Edinburgh](https://aclanthology.org/people/y/yang-liu-edinburgh/).
+* _PDF corrections_. This includes changes such as revisions or retractions. For more information, please see see [details on the corrections page]({{< relref "/info/corrections.md" >}}).
+
+Important: The Anthology treats the data on the PDF itself as the authoritative source of information, so all metadata corrections should conform to the information found there. If that information is wrong, a PDF correction is needed.

hugo/content/info/corrections.md

@@ -2,18 +2,73 @@
 Title: Requesting Corrections
 linktitle: Corrections
 subtitle: How to submit corrections to the Anthology
-date: 2024-12-26
+date: 2025-02-10
 ---
 
-### Types of corrections
+### What type of correction do I need?
 
-The staff of the ACL Anthology can process requests for many types of corrections.
-We generally distinguish five types, loosely following the [ACM Publications Policy](https://www.acm.org/publications/policies/):
+Our central guiding corrections principle is that **we view the content of PDFs as authoritative**. If you see errors or inconsistencies in the metadata (author list, title, abstract), you need to first check to see if it matches the PDF.
+
+This view drives three main types of corrections:
+
+* [_PDF corrections_](#pdf-corrections). The PDF itself can be in error.
+* [_Metadata only_](#metadata-corrections). Information presented in the Anthology may be different from the PDF. Examples include errors in the title, abstract, or author list.
+* [_Author disambiguation_](#author-disambiguation). An author's papers might be spread across multiple author pages (one person, multiple pages), or a single author page might contain papers from different people (multiple people, one page).
+
+Below we describe the process for addressing these types of corrections, in order of the frequency we encounter them.
+
+### Metadata corrections
+
+Corrections to **metadata** do not require changing the PDF.
+These kinds of corrections bring the information presented in the Anthology in line with the authoritative PDF.
+
+A request to change paper metadata can be submitted in two ways.
+
+1. Navigate to the paper's page in the ACL Anthology (e.g., [K17-1003](https://aclanthology.org/K17-1003/)). From there, click the yellow "Fix data" button. This will display a dialog that you can use to correct the title and abstract and fix issues with the author list.
+
+   Submitting this form will create a Github issue with a JSON data block. This will then be validated by Anthology staff, and processed by a semi-automatic bulk corrections script on a weekly basis.
+
+2. If you would like to expedite the process and are familiar with [git](https://git-scm.com), you can make the correction yourself and file a [pull request (PR)](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
+
+    * First, locate your file amongst our [authoritative XML files](https://github.com/acl-org/acl-anthology/tree/master/data/xml). The name of your file is the portion of the Anthology ID that comes before the hyphen. As an example, if the Anthology ID of your paper is `P19-10171`, then the file you will need to edit is [data/xml/P19.xml](https://github.com/acl-org/acl-anthology/blob/master/data/xml/P19.xml); if the Anthology ID of your paper is `2021.iwslt-1.28`, then the file you will need to edit is [data/xml/2021.iwslt.xml](https://github.com/acl-org/acl-anthology/blob/master/data/xml/2021.iwslt.xml).
+    * Find your entry in the XML file, and use Github's edit button to fix it and then to issue a PR against our `master` branch.
+    * For larger XML files, you may have to fork the repository first. [More information can be found here](https://help.github.com/en/github/managing-files-in-a-repository/editing-files-in-another-users-repository).
+
+The Anthology team will attend to the correction as we find time.
+Metadata changes are generally accepted if they are consistent with the PDF, which we take as authoritative.
+However, please see the following note.
+
+**Note on changes to author metadata**
+
+Because it is beyond our ability to keep track of the many differing policies governing conferences and journals whose proceedings we host, it is therefore up to those groups to ensure that PDF authorship is correct when proceedings are delivered to the Anthology for ingestion.
+
+We reserve the right to seek permission or corroboration from the associated conference or workshop program chairs in unusual situations, such as removing or adding an author to a PDF revision.
+In such cases, we will ask authors to arrange for this permission to be conveyed to us, either (ideally) on the corresponding Github issue or via email.
+
+### Author disambiguation
+
+The Anthology builds author pages based on the string form of names found in paper metadata.
+These pages are housed under https://aclanthology.org/people/, e.g., [Aravand Joshi](https://aclanthology.org/people/aravind-joshi).
+
+There are two types of author disambiguation:
+
+**One person, multiple author pages**.
+This situation occurs when a person has multiple papers written under different names.
+Often, these names are minor variations of each other (e.g., including or excluding a middle initial).
+Sometimes, this is a simple mistake in the metadata that can be handled using the procedure described above.
+However, if the metadata for the papers is correct, then we need to manually link the author pages.
+
+**Multiple people, single author page**.
+In this situation, many different people have published under the same name.
+An example is [Yang Liu](https://aclanthology.org/people/yang-liu).
+In this case, we have to manually assign IDs to the papers to create a separate author page, typically using their Ph.D. granting institution (e.g., [Yang Liu of Edinburgh](https://aclanthology.org/people/y/yang-liu-edinburgh/).
+
+Both situations can be addressed by [filing an Author Page request](https://github.com/acl-org/acl-anthology/issues/new?template=02-name-correction.yml).
+
+### PDF corrections
+
+Our PDF corrections process loosely follows the [ACM Publications Policy](https://www.acm.org/publications/policies/):
 
-* Corrections to **metadata** do not require changing the PDF.
-  Examples include correcting the spelling of a name or the title.
-  These kinds of corrections are typically made to bring the metadata in line with what is on the PDF, which is taken to be authoritative.
-  If changes to the metadata also require a change to the PDF (e.g., changing an author's name), a revision must also be supplied.
 * An **erratum** clarifies errors made in the original scholarly work.
   Usually these are just short notes, corrective statements, or changes to equations or other problems in the original, which need to be read alongside the original work.
 * A **revision** is a versioned replacement of the original scholarly work.
@@ -29,28 +84,8 @@ Please take note of the following points regarding revisions and retractions.
 * We cannot currently regenerate the full volumes, which will continue to contain only the original papers.
 * We have no control over how downstream consumers of the Anthology, such as search engine, process the changes.
 
-### Correcting Metadata
-
-Please note that **the Anthology treats PDFs as authoritative**. This means that all metadata corrections must be consistent with the PDF.
-
-A request to change paper metadata can be submitted in two ways.
-
-- Navigate to the paper's page in the ACL Anthology (e.g., [K17-1003](https://aclanthology.org/K17-1003/)). From there, click the yellow "Fix data" button. This will display a dialog that you can use to correct the title and abstract and fix issues with the author list.
-
-  Submitting this form will create a Github issue with a JSON data block. This will then be validated by Anthology staff, and processed by a semi-automatic bulk corrections script on a weekly basis.
 
--  If you would like to expedite the process and are familiar with [git](https://git-scm.com), you can make the correction yourself and file a [pull request (PR)](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
-    1. First, locate your file amongst our [authoritative XML files](https://github.com/acl-org/acl-anthology/tree/master/data/xml). The name of your file is the portion of the Anthology ID that comes before the hyphen.
-
-    As an example, if the Anthology ID of your paper is `P19-10171`, then the file you will need to edit is [data/xml/P19.xml](https://github.com/acl-org/acl-anthology/blob/master/data/xml/P19.xml); if the Anthology ID of your paper is `2021.iwslt-1.28`, then the file you will need to edit is [data/xml/2021.iwslt.xml](https://github.com/acl-org/acl-anthology/blob/master/data/xml/2021.iwslt.xml).
-    2. Find your entry in the XML file, and use Github's edit button to fix it and then to issue a PR against our `master` branch.
-    3. For larger XML files, you may have to fork the repository first. [More information can be found here](https://help.github.com/en/github/managing-files-in-a-repository/editing-files-in-another-users-repository).
-
-The Anthology team will attend to the correction as we find time.
-Metadata changes are generally accepted if they are consistent with the PDF, which we take as authoritative.
-However, please see the [note below about changes to the author list](#note-on-author-changes).
-
-### Revisions and errata
+#### Revisions and errata
 
 For requests to change paper *content* (either a revision or an erratum), again, please [file a Github issue](https://github.com/acl-org/acl-anthology/issues/new?assignees=anthology-assist&labels=correction%2Crevision&template=03-revision-or-errata.yml&title=Paper+Revision%7Breplace+with+Anthology+ID%7D).
 **Please note the following**:
@@ -76,7 +111,7 @@ Submissions not meeting these standards will be rejected, potentially without no
 
 A revision that changes the author list needs permission (see below).
 
-### Retractions
+#### Retractions
 
 To initiate a retraction, please communicate directly with the Anthology director.
 Retractions often involve the organizing editors or chairs of the respective journal or conference.
@@ -91,7 +126,7 @@ Retractions result in the following changes in the Anthology:
   No bibliographic files are generated, and the paper is not listed in the consolidated Anthology BibTeX file.
 * The paper is removed entirely from the listing on the author page.
 
-### Removal
+#### Removal
 
 Removals are rare events that are undertaken only in the most serious of situations, such as plagiarism or fraud.
 A paper can be removed at the request of the scientific organization with jurisdiction over the paper.
@@ -108,12 +143,3 @@ A removal will result in the following changes to the Anthology:
   Its title and author list will be presented in ~~strikeout text~~.
   The abstract, if present, will be removed.
   No bibliographic files will be generated.
-
-### Note on changes to author metadata
-
-The Anthology generally accepts corrections to the author metadata that bring it into line with the PDF, which we treat as authoritative.
-Example corrections include name spellings and details (such as initialization or the inclusion of a middle name), changes to author ordering, and even the addition of authors mistakenly left out of the metadata.
-Because it is beyond our ability to keep track of the many differing policies governing conferences and journals whose proceedings we host, it is therefore up to those groups to ensure that PDF authorship is correct when proceedings are delivered to the Anthology for ingestion.
-
-We reserve the right to seek permission or corroboration from the associated conference or workshop program chairs in unusual situations, such as removing or adding an author to a PDF revision.
-In such cases, we will ask authors to arrange for this permission to be conveyed to us, either via email or on a Github issue.

hugo/content/posts/2024-12-27-new-metadata-workflow.md

@@ -4,16 +4,26 @@ date: "2024-12-27"
 description: >
     A simplified workflow for processing metadata corrections should make it easier for authors to submit corrections and for Anthology staff and volunteers to process them expeditiously.
 ---
+### A long-standing problem
+
 After proceedings are published, authors often discover errors in the paper metadata, including misspelled author names, missing or misordered authors, and mistakes in titles or abstracts. Until today, corrections to this data involved a lot of manual effort on both the part of authors (who had to locate the form and fill it out) and Anthology staff (who had to manually process and interpret these forms and make the corrections). The result was hundreds of issues accumulating on the [Anthology Github repository](https://github.com/acl-org/acl-anthology/issues?q=is%3Aissue+is%3Aopen+label%3Acorrection+label%3Ametadata), and a delay of weeks or sometimes even months to process them.
 
 <img src="/images/2024-12-27/many-requests.png" alt="Accumulating issues" style="width:50%;" />
 
+### Our simplified solution
+
 We are therefore happy to announce a new simplified workflow that we hope will reduce effort and processing time. This workflow introduces a yellow "Fix data" button on each paper page in the Anthology. Clicking on this button will display a dialog allowing for easy manipulation of the title, author list, and abstract. Upon submission, this dialog will lead the submitter to the creation of a structured Github issue for the correction. The user needs only to submit the issue, and leave the rest to Anthology staff.
 
 <img src="/images/2024-12-27/dialog.png" alt="Metadata correction dialog" style="width:50%;" />
 
 For the curious, from that point, we make use of further Github automations to make the process as easy as possible. A Github workflow annotates the issue with an image of the paper and a link to its paper page, allowing for easy visual verification of the corrections. We then run a script that can automatically create a consolidated pull request from all approved correction requests.
 
+### Our workflow
+
+Anthology volunteers continually process these corrections. If further information is required, we will ask you for it on the Github issue. Once everything looks correct, we will add an "approved" label. We then process approved corrections in bulk, aiming for a weekly cadence.
+
+### In closing
+
 We hope that this simplified process will make the submission process easier and more intuitive for authors who submit corrections, and also that it will enable us to process them much more frequently than the monthly process we've been using up till this point.
 
 We are excited to see how this new process will work in practice, and we welcome feedback from the community on how we can further improve it.