Courier Corpus curation and annotation

Description

Folder	Description
annotated_issues	Curated and annotated issue corpus. See #19. Basis for the Curated Courier corpus.
metadata	Article index files. Used to create the Curated Courier corpus.
curated_issues	Curated issue corpus. See #18.
rescanned_pages	Rescanned pages. See #11.
ocred_issues	OCRed and tagged issues. See #11.
workflow	Files used in the curation and annotation workflow.

Curation and annotation guidelines

Introduction

Each document contains the entire OCR:ed text, in markdown format, for a single Courier issue. The purpose of the curation is to manually check and correct the article segmentation for each issue in the corpus. The end goal is to mark up all text segments that belong to an article in such a way that it can be automatically extracted. To do this we need to insert a heading above each text segment, as well as an indicator where the segment ends.

Heading

A heading is a line that starts with a number signs (#). The number of number signs corresponds to the heading level.

Document

The first line in each document # [DOCUMENT_ID](link) TOTAL_MISMATCHES is a heading with a link to its original source PDF. TOTAL_MISMATCHES is the number of mismatching article titles in the issue.

Page

Each page begins with a heading ## Page [PAGE-NUMBER](link) MISMATCHES containing a link to the same page in the original PDF. MISMATCHES is the number of mismatching article titles on the page reported during the automatic text extraction.

Article

Articles within pages are indicated by an article heading ### ARTICLE_ID: article-title line. The article title is taken from the Courier Metadata Index. The article index lists the articles in the Metadata Index.

Unindexed articles, undindexed supplements and editorials are indicated by corresponding headings, see examples below.

Text segment

Sequences of text that are not headings in the formats described above are called text segments.

A text segment (article or non-article) ends when any of the following is encountered:

Description	Example
A new page heading	## [PAGE-NUMBER](link) MISMATCHES
A new article heading	### ARTICLE_ID: another title
A non-article heading	### IGNORE
An unindexed article heading	### UNINDEXED_ARTICLE
An unindexed supplement heading	### UNINDEXED_SUPPLEMENT
An editorial heading	### EDITORIAL

Example Document

# [123456](https://.../courier/123456eng.pdf) 12

## [Page 1](https://.../courier/123456eng.pdf#page=1) 0

### 78910: Title of article

article text

### IGNORE

non-article text

### UNINDEXED_ARTICLE

unindexed article text

### UNINDEXED_SUPPLEMENT

unindexed supplement text

### EDITORIAL

editorial text

Annotation workflow

1. Pull remote changes.
2. Process one issue at a time.
3. Correct title positions for each pages. Compare with PDF page and move title to the correct position within the page.
4. If article ends before new page or new article, mark ending by adding ### IGNORE
5. Add ### IGNORE for text segments which don't contain article text.
6. Add ### EDITORIAL heading. Mark end of editorial with ### IGNORE
7. If non-tagged article is found, mark with ### UNINDEXED_ARTICLE. This should be done on each page the article is on.
8. Report annotation progress in progress.csv.
9. Push changes after completing each issue.

Important

• If a new article heading is added or changed (apart from those that already exist in the document, the title must be the same as for existing headings for the same article.
• Each heading should be on new line. No other text is allowed on that line.

Guidelines

• Captions are a part of an article and should be included.
• Note problems with filename and line number.
• Text should not be changed or corrected.

Environment

VS Code

In browser (Preferred)

1. Navigate to https://github.com/inidun/tagged_courier in browser.
2. Push . to open VS Code in browser.

Alternative (Installation)

Prerequisites

1. Install Visual Studio Code
2. Install Git (Standalone)

Use default options when installing.

Setup

1. Open Git CMD
2. Navigate to desired folder
3. Clone repo git clone https://github.com/inidun/tagged_courier.git
4. Open Visual Studio Code code .

Keyboard Shortcut tips

Command	Keyboard Shortcut
Move line down	Alt + DownArrow
Move line up	Alt + UpArrow
Fold level 2	Ctrl + K, Ctrl + 2
Unfold	Ctrl + K, Ctrl + J
Open PDF	Ctrl + LeftMouseButton