Skip to content

Latest commit

 

History

History
146 lines (101 loc) · 6.04 KB

README_en.md

File metadata and controls

146 lines (101 loc) · 6.04 KB
Raw

Internationalisation of carpentry lessons

日本語

Please take a look at the quickstart guide if you wish to make small contribution(s).

Before translating any material, please make sure you comply with the Guidelin es for Translators and read the Rules of Conduct.

We encourage translators to [join our slack workspace](https://carpentries-jp-e n.herokuapp.com/). We also have a #swcarpentry slack channel in the Tokyo.R workspace. This is a great place to ask any questions you may have about the workflow.

You can follow our swcarpentry-ja twitter account for updates.

Purpose

The repository is intended to host the files and tools need to facilitate trans lations of the Software Carpentry lessons from English into other languages (currently we are working on Japanese). This repository is intended to merge with the Multi-lingual versions of the lessons in English and Spanish. We plan for these to be compatible to be hosted along w ith other languages on the main Software Carpentry website and to maintain updated copies of the Japanese lesso ns with new releases of the English lessons.

We are translating (and keeping up-to-date) the Software Carpentry lessons, not revising original lesson material. If you notice an issue with the lesson materials themselves, please send an iss ue for pull request to the English lesson materials.

About git

This assumes that you are familiar with using Git and GitHub.

If you need help installing git, please see the [guide on installing git](git.m d).

About PO files

We use [PO files](https://www.gnu.org/software/gettext/manual/html_node/PO-File s.html) for translation, rather than translating the text of each lesson directly. A PO file is a plain text file consisting of multiple entries, where each entry contains a short portion of the original text and its translation. There is one PO file for each original lesson. For example, the Software Carpentry 'git novice' lesson, which consists of multiple markdown documents, has a single PO file called git-novice.ja.po for translating into Japanese.

This way, we can keep track of the original text and know exactly what needs to be changed when the original lessons are updated, instead of manually tracking changes.

There are a number of free PO editors: PoEdit, GTranslator, [Lokalize](https://user base.kde.org/Lokalize), to name a few. We recommend using one of these to edit the PO files.

Importing a lesson for the first time

Lessons are imported as submodules. This only needs to happen once per lesson, so most translators will not need to do this. If you want to import a new lesson, please see the guide on importing.

Contributing to a translation of an existing lesson

This is the task that we need the most help with from translators!

This assumes that the lesson has already been added to the swcarpentry-ja/i18n as a submodule as described in the guide on importing, and you would like to contribute translations for that lesson.

  1. Create a "Fork" for this repository on your personal GitHub account. (Click "Fork" in the top right corner of the https://github.com/swcarpentry-ja/i18n webpage)

  2. Clone this repository from your personal account (e.g., GitHubUser). This is your local copy to manage your version of the translation files.

cd directory
git clone [email protected]:GitHubUser/i18n.git
cd i18n
  1. Populate submodules.
git submodule init
git submodule update

This repository should already contain a translation file for the lesson that y ou wish to contribute to in the po directory <lesson-name>.<lang>.po such as git-novice.ja.po

cd po
ls git-novice.ja.po

  1. Edit the PO files. As per the guidelines, please commit you r changes frequently and submit a pull request when you are satisfied with your work.

  2. Your PR will be reviewed for accuracy. You may need to make edits so it can pass review. When doing so, always be sure to pull changes from the organisation repository first:

git checkout ja
git remote add swc-ja [email protected]:swcarpentry-ja/i18n.git
git pull swc-ja ja

Repeat steps 4 and 5 until the PR passes review.

A few notes:

Editing the PO file will not generate the translated website. That is left to t he maintainers, as described in the guide for maintainers and administrators.

If you want to see a translated MD file after editing the PO file, run bash po 4gitbook/compile.sh. This generates a translated version of the lesson with your changes, which you can find at locale/<lang>/<lesson>, e.g., locale/ja/git-novice.

Contributing to translation of an updated lesson with a new release of the m

ain English lessons

If there is an existing (complete) translation of the lesson but there has a new release of the main English lessons, the updated version of the English lessons needs to be merged with the current translated one.

Please see the guide on updating lessons.

Resources for translations

Please follow guidelines for translators when e diting the lessons.

There is a [list of technical terms](https://github.com/swcarpentry-ja/i18n/wik i/Glossary-for-technical-terms) to refer to for ensuring that terms are consistently used between lessons. Please update and refer to this as needed.

Please see the culture notes for a standardized treatme nt of concepts that don't translate literally into Japanese to ensure consistency.

We have a change log to track progress and goals.

Guide for maintainers and administrators

Please see the guide for maintainers and administrators

Thank you for all your help. Even seemingly minor contributions will be appreci ated!