Skip to content
Snippets Groups Projects
Commit 28d39462 authored by ml bonhomme's avatar ml bonhomme :bee: Committed by Erwan Rouchet
Browse files

Document transcription text orientations

parent b85a3ea6
No related branches found
No related tags found
1 merge request!88Document transcription text orientations
Pipeline #13886 passed
content/project/arabic_text.png

21 KiB

content/project/text_orientation.png

7.52 KiB

...@@ -21,7 +21,6 @@ Through Arkindex web interface, you will be able as a Project contributor to: ...@@ -21,7 +21,6 @@ Through Arkindex web interface, you will be able as a Project contributor to:
- Create new elements, of any existing type on the project (usually lines, words or paragraphs, ...). - Create new elements, of any existing type on the project (usually lines, words or paragraphs, ...).
- Then add a transcription to these elements. - Then add a transcription to these elements.
{{ figure(image="project/transcription-element.png", height=130, caption="Draw a polygon to create an element...") }} {{ figure(image="project/transcription-element.png", height=130, caption="Draw a polygon to create an element...") }}
{{ figure(image="project/transcription-editor.png", height=300, caption="... then write its transcription") }} {{ figure(image="project/transcription-editor.png", height=300, caption="... then write its transcription") }}
...@@ -29,6 +28,25 @@ You can read all existing transcriptions of an element by selecting an element o ...@@ -29,6 +28,25 @@ You can read all existing transcriptions of an element by selecting an element o
{{ figure(image="project/transcription-lines.png", height=500, caption="View transcriptions for a specific element in the Details panel") }} {{ figure(image="project/transcription-lines.png", height=500, caption="View transcriptions for a specific element in the Details panel") }}
### Text orientation
When creating a transcription on an element, you can choose its **text orientation**. This text orientation can be set either by a human manually creating a transcription, or by a Machine Learning worker, for example depending on the language of the recognized text.
The text orientation is used for the transcription's display, as well as by Machine Learning worker processes.
{{ figure(image="project/arabic_text.png", height=230, caption="Right to left Arabic text on Arkindex.") }}
Using the API (see [the API documentation](https://demo.arkindex.org/api-docs/#tag/transcriptions/operation/CreateTranscription)), a transcription's text orientation can be set to:
- horizontal left-to-right: for text where each line should be read from left to right, and text lines are organized from top to bottom. This is the orientation for most Western languages, and the default text orientation if none is specified when creating a transcription. In the frontend, the text is aligned to the left.
- horizontal right-to-left: for text where each line should be read from right to left, and text lines are organized from top to bottom. For example, this can be used for Arabic. In the frontend, the text is aligned to the right.
- vertical left-to-right: for text where each line should be read from top to bottom, and text lines are organized from left to right.
- vertical right-to-left: for text where each line should be read from top to bottom, and text lines are organized from right to left. For example, this can be used for Japanese.
From the frontend, the only available text orientations are horizontal right-to-left and horizontal left-to-right. Displaying vertically oriented text is not supported, so transcriptions that have a vertical text orientation are displayed horizontally.
{{ figure(image="project/text_orientation.png", height=200, caption="Select a text orientation when creating a transcription.") }}
## API Endpoints ## API Endpoints
These endpoints are the most useful to handle Element transcriptions: These endpoints are the most useful to handle Element transcriptions:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment