Skip to content

dohliam/gasp-translator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Global-ASP Translator - Translation system for the Global African Storybook Project

The goal of this project is to build an easy-to-use and accessible translation system to automate the process of translating African Storybook Project stories into other languages for Global-ASP.

It has deliberately been kept as minimal as possible to allow translators to focus on the translation with as little distraction as possible.

You can visit the live Translator tool here.

Usage

To begin translating stories, just click on the "Translate!" button at the bottom of the page. This will open up a story from the African Storybook Project collection, with empty space on the right for you to enter your translation.

Make sure to enter your name and the language you are translating into at the top of the page. Your work will be released under the same Creative Commons license as the original story, and you will be credited for attribution using the name you select here. You can edit either field at any time, e.g. if you want to change the way you are attributed or translate into a different language.

Within the main translation area of the page, images from each page of the story will appear on the left side accompanied by the original text of that page. On the far right side is a box where you can input your translation. You can hover over the thumbnails to see larger versions of the images.

If you have completed part of a translation but want to move on to another story or close the window, the text you have entered in each box will be saved automatically on your local machine so you can return to it later. Note that it will NOT be submitted until you click on the "Review Submission" button and then finally click on "Submit Translation" to send it to Global-ASP for inclusion in the project.

When you click on the "Review Submission" button, a new text box will appear at the bottom of the screen containing the entire text of your translation. If there is anything you would like to add or change you can edit the text in the window before submitting. However, please try to avoid changing the layout or markup (e.g., pagebreaks marked by ##).

Once you are satisfied with your translation, click on the "Submit Translation" button to send it for inclusion in the Global-ASP project. You can optionally include your email address in the box above the submit button if you would like to be contacted about your translation.

Navigation

The "Next" and "Previous" buttons can be used to navigate through the available stories in the collection. All work is saved in local storage, so you can feel free to browse the collection for stories you would like to translate, even if you have partly begun another translation.

Click on the "Random Story" button to visit a random story from the collection. There are over 300 stories in the collection, all of different lengths, styles, and subject matter, so browse around until you see something you would be comfortable translating.

API

The Translator features a simple API that allows you to link directly to individual stories for translation. Just add ? and the index number of the story at the end of the url, for example:

  • https://global-asp.github.io/translator/?0030: links to translation template for story #0030

Data format

The file stories.js contains an array of JSON objects, each of which represents a story from the ASP collection. The format is described below. By replacing the data in stories.js with your own data, it is possible to use gasp-translator as a general-purpose translation tool. This has already been done as a way of providing translation from languages other than English, by generating JSON objects from e.g. French, Yoruba, or Norwegian markdown source files.

Here is a simple example from the stories.js file of a storybook represented as a JSON object:

{"i":"0253","t":"My Picture Book","a":"b|Oku Modesto|Rob Owen,Marleen Visser,Katrien Coetzer,Wiehan de Jager,Karen Lilje,Catherine Groenewald,Alice Toich","s":[{"02":"A girl"},{"03":"A bird"},{"04":"A lion"},{"05":"A cat"}]}

This has been compressed (spaces and linebreaks removed) to save space. A more human-readable representation of the same data would look like this:

{
    "i": "0253",
    "t": "My Picture Book",
    "a": "b|Oku Modesto|Rob Owen,Marleen Visser,Katrien Coetzer,Wiehan de Jager,Karen Lilje,Catherine Groenewald,Alice Toich",
    "s": [
        {
            "02": "A girl"
        },
        {
            "03": "A bird"
        },
        {
            "04": "A lion"
        },
        {
            "05": "A cat"
        }
    ]
}

Keys:

  • "i": The index number of the story
  • "t": The title of the story
  • "a": Attribution information for the story, separated by vertical bars (|)
    • A b in the initial position means that the story is licensed "CC-BY", and an n means it is licensed "CC-BY-NC"
    • The author of the story
    • The illustrator(s) of the story images
  • "s": An array of JSON objects representing the full text content of the story, with each object representing a page

License

The code portion of this project is released under the MIT license (see LICENSE file for details).

The full text of the original ASP stories is derived from the asp-source repo. All stories are Creative Commons licensed, either CC-BY or CC-BY-NC. License information is included with each file, and also displayed in gasp-translator during the translation process.

"Next", "previous", and "random" buttons are courtesy of Material Design Icons (CC-BY).

Tacit CSS by Yegor Bugayenko is licensed under MIT.

Submissions are handled by Formspree.

Pure CSS modals within the app are made possible by drublic's css-modal project.

Pure JavaScript lightbox image galleries are thanks to baguetteBox.js.