||5 years ago|
|checking||5 years ago|
|intro||5 years ago|
|process||5 years ago|
|translate||5 years ago|
|.gitignore||6 years ago|
|LICENSE.md||6 years ago|
|README.md||6 years ago|
|REVIEWME.md||5 years ago|
|manifest.yaml||6 years ago|
translationAcademy is intended to enable anyone, anywhere to equip themselves so that they will be able to make high-quality translations of biblical content into their own language. translationAcademy is designed to be highly flexible. It can be used in a systematic, in-advance approach or it can be used for just-in-time learning (or both, as needed). It is modular in structure.
translationAcademy was developed by the Door43 World Missions Community in conjunction with Wycliffe Associates. The entire project is made available under a Creative Commons Attribution-ShareAlike 4.0 International License, see the LICENSE file for more information.
Please use the issue queue to provide feedback or suggestions for improvement.
Contributing or Translating
Explanation of the content file layout
Each manual has it's own directory in this repository (for example, the Checking Manual is in the checking directory). The content of the files are in a hybrid YAML/markdown format, beginning with a YAML header followed by the body of the article in markdown.
YAML is a markup language that is compact and easy to read. The YAML header bounded on the top and bottom by
---. Each line within the header is a key-value pair, with the key and the value separated by a colon. Because the key is used by the publishing process, it should never be translated or changed. Some of the values can be translated, and those are enumerated below in the instructions for translating.
Following the YAML header is the body of the article, which uses a format called "markdown." If you aren't familiar with markdown, you may find this markdown tutorial helpful. Also, this README file, the one you are reading now, is written in markdown.
Before you get started translating
DO NOT RENAME ANY FILES. The name of the file is the same as the slug and is used to link the file to other files.
If you do any translation work, be sure to put your name in the
LICENSE.mdfile does not need to be translated or modified.
Images that are included in tA should be no more than 600px wide.
Instructions for translating translationAcademy
The instructions for translating
meta.yaml (metadata) and
toc.yaml (table of contents) are included in the header of those files.
The first step is to fork this repository. When you do this, change the name of the repository to start with your language code rather than
When translating the files for each manual:
In the YAML header, you are free to translate the values following the
creditskeys. DO NOT TRANSLATE THE KEYS. None of the other values should be translated. They contain slugs that are used to identify this article and to link it to other articles.
Translating hyperlinks: Hyperlinks (links to other articles or to other pages on the internet) follow this pattern,
[text to display](http://www.example.com)
You can translate the "text to display" inside the square brackets but not the web address that follows inside the parentheses.
You are free to add additional pages. In order for the new page to be included when tA is published, all of the following conditions need to be satisfied:
You must create a directory in one of the manual directories (like the translate directory) that has the short name of the module you want to write. For example, to create a new module on "testing" in the Translation Manual, you will want to put the file in "translate/testing/01.md".
The file must be included in the table of contents,
toc.yamlfor the appropriate manual.
The value of the slug in the YAML header and the file name (without the extension) must be the same as the directory name.
The slug must be unique, and not used in any of the other tA repositories. This is a requirement so that it is possible to create unambiguous links to articles in other tA manuals.