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

Proposal for adding 'timed-text' in the Text Granularity Extension #2221

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion source/extension/text-granularity/context.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"paragraph":"iiif_text_granularity:paragraph",
"line":"iiif_text_granularity:line",
"word":"iiif_text_granularity:word",
"glyph":"iiif_text_granularity:glyph"
"glyph":"iiif_text_granularity:glyph",
"timed-text":"iiif_text_granularity:timedText"
}
}
}
Expand Down
15 changes: 9 additions & 6 deletions source/extension/text-granularity/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ A number of common workflows can result in annotation sets with discrete levels
- Manual transcription user interfaces may constrain user input to the level of the line,
block, or page.
- Transcriptions may be produced without coordinate data and thus have a very coarse level of granularity, such as page- or block-level.
- In A/V content, the text granularity of subtitles follows standard subtitling guidelines in terms of reading speed, number of lines in each subtitle, line length (number of characters).

Identification of the level of text granularity in published annotations can facilitate the use of their textual content and target regions in other applications. A primary use case is search: clients can use word-level transcription annotations to provide a search function capable of accurate hit highlighting. Other common use cases derive from crowdsourced text input, such as the correction of OCR transcription, which may require the user to work with a text at a specific level of granularity.

Expand All @@ -37,12 +38,13 @@ The `textGranularity` property identifies the Text Granularity Level of a resour

| Text Granularity Level | Description |
|------------------------------|-----------------
| `page` | A page in a paginated document |
| `block` | An arbitrary region of text |
| `paragraph` | A paragraph |
| `line` | A topographic line |
| `word` | A single word |
| `glyph` | A single glyph or symbol |
| `page` | A page in a paginated document |
| `block` | An arbitrary region of text |
| `paragraph` | A paragraph |
| `line` | A topographic line |
| `word` | A single word |
| `glyph` | A single glyph or symbol |
| `timed-text` | A synchronized fragment of text |
{: .api-table #table-granularity-level-dfn}

{% include api/code_header.html %}
Expand Down Expand Up @@ -152,6 +154,7 @@ Many thanks to the members of the [IIIF community][iiif-community] for their con
| ---------- | --------------------- |
| 2018-09-20 | Initial commit |
| 2019-11-03 | Minor pre-publication revisions |
| 2023-03-07 | Addition of the 'timed-text' granularity |
{: .api-table #table-changelog}

{% include acronyms.md %}
Expand Down