Skip to content

Commit

Permalink
Use babelquarto for trans
Browse files Browse the repository at this point in the history
  • Loading branch information
joelnitta committed Nov 26, 2024
1 parent d6034ed commit 8ab21d3
Show file tree
Hide file tree
Showing 6 changed files with 222 additions and 8 deletions.
10 changes: 10 additions & 0 deletions _quarto-en.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
website:
navbar:
background: primary
left:
- href: index.qmd
text: Home
- href: quickguide.qmd
text: "Translation Guide"
- href: links.qmd
text: Links
10 changes: 10 additions & 0 deletions _quarto-ja.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
website:
navbar:
background: primary
left:
- href: index.qmd
text: ホーム
- href: quickguide.qmd
text: "翻訳ガイド"
- href: links.qmd
text: リンク
22 changes: 14 additions & 8 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,23 @@ project:
website:
title: "SWC-JA"
navbar:
background: primary
left:
- href: index.qmd
text: ホーム
- quickguide.qmd
- links.qmd
- href: "https://swcarpentry-ja.github.io/en/"
text: English
left: []

format:
html:
theme: materia
css: styles.css
toc: false

babelquarto:
languagecodes:
- name: en
text: "English"
- name: ja
text: "日本語"
mainlanguage: 'ja'
languages: ['en']
title-en: SWC-JA
description-en: Software Carpentry Japan
author-en: Joel Nitta
lang: ja
28 changes: 28 additions & 0 deletions index.en.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Software Carpentry Japan"
title-block-banner: images/chiba_swc_2024-05-30_cropped.png
include-in-header:
- text: |
<style>
.quarto-title-block .quarto-title-banner {
background-position-y: center;
height: 250px;
}
</style>
---

[Software Carpentry](https://software-carpentry.org/) is an international community that teaches research computing lessons through workshops. The Software Carpentry JA team translates English lessons into Japanese and provides information about Software Carpentry in Japan.

Our specific goals are to translate all the [Software Carpentry lessons](https://software-carpentry.org/lessons/) into Japanese, and to [hold workshops](https://software-carpentry.org/workshops/) **in Japanese** on a regular basis.

## The Translation Project

We use [Crowdin]((https://carpentries.crowdin.com/u)) for translation.

If you would like to contribute to translation, please first [create a Crowdin account](https://accounts.crowdin.com/carpentries/login), then read the [translation guide]().

### Lessons Currently in Translation

- [The Unix Shell ](https://swcarpentry-ja.github.io/shell-novice/)
- [Version Control with Git](https://swcarpentry-ja.github.io/git-novice/)
- [R for Reproducible Scientific Analysis](https://swcarpentry-ja.github.io/r-novice-gapminder/)
72 changes: 72 additions & 0 deletions links.en.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Links
---

## Posts on the Carpentries blog

- 2019-11-5 [The Carpentries in Tōkyō: Adventures bringing Software Carpentry to Japan](https://carpentries.org/blog/2019/11/local-team-japan/)

- 2019-11-21 [Internationalisation of Software Carpentry: System for Translation into Japanese](https://carpentries.org/blog/2019/11/translations-in-japanese/)

- 2021-06-29 [First Software Carpentry Workshop in Japanese](https://carpentries.org/blog/2021/06/first-japanese-r-workshop-en/)

## Slack Workspace

- Join the Carpentries Slack Workspace from <https://slack-invite.carpentries.org/>, then join the `#local-japan` channel.

## X

- [@swcarpentry-ja](https://twitter.com/swcarpentry_ja)

## Presentations

- 2018-10-20 TokyoR Introducing Software Carpentry [@TomKellyGenetics](https://github.com/TomKellyGenetics)

- [Slides](https://www.slideshare.net/Fridayitis/presentation-oct2018tokyo-r)

- 2019-12-16 [Workflow Meetup](https://workflow-meetup-jp.github.io/) Introducing Software Carpentry [@joelnitta](https://github.com/joelnitta)

- [Slides](https://joelnitta.github.io/swc-trans-2019-12-16/#1)

- [Source code](https://github.com/joelnitta/swc-trans-2019-12-16)

- 2020-11-7 [Kansai Open Forum KOF2020](https://www.k-of.jp/2020/) [@kozo2](https://github.com/kozo2)

- [Summary](https://k-of.jp/backend/session/1380)

- [Slides](https://docs.google.com/presentation/d/1Or3HULEmJZT1P8AFSOl4C9JMfts-4T5FaMb0T9pVNZ8/edit#slide=id.p)


- YouTube Video (Japanese)
[![](http://img.youtube.com/vi/8nRD6DkgkDw/0.jpg)](http://www.youtube.com/watch?v=8nRD6DkgkDw "KOF2020 ソフトウェア・カーペントリーで研究計算用のスキルを広めよう")

- 2020-11-17 [Iwasaki lab](http://iwasakilab.k.u-tokyo.ac.jp/eindex.html) Introducing Software Carpentry [@joelnitta](https://github.com/joelnitta)

- [Slides](https://joelnitta.github.io/swc-trans-2020-11-17/#1) (Japanese)

- [Source code](https://github.com/joelnitta/swc-trans-2020-11-17/)

- [Notes](https://hackmd.io/TyLqI5dQTmqnnrH94mKn2A?view)

- 2021-03-27: [fukuoka.R #17](https://fukuoka-r.connpass.com/event/206105/)(Online) Introducing the Carpentries [@masamiy](https://github.com/masamiy)

- [Slides](https://www.slideshare.net/MasamiYamaguchi/what-is-the-carpentries) (Japanese)

## Meeting notes

- [2018-11-10](https://docs.google.com/document/d/1a25dAWiWfNo5-ffe_VGFBdpx-n_O5D2HMYogpaGs1xE/edit)

- [2018-12-1](https://docs.google.com/document/d/1iAmVtqdprjIgo8YercQg9wYwkNdkK4lyp24sL-pt5sA/edit)

- [2019-1-19](https://docs.google.com/document/d/1CfjKSGpuZngPcSkZwV31XPhxtyruerX2pn_lUAP_GV0/edit)

- [2019-7-21](https://docs.google.com/document/d/1WAnWp2s4tIXqo6a8EOABfWizoiPiRe6FI2PTTfNqtZs/edit)

- [2019-12-7](https://docs.google.com/document/d/16IA3ChdGcs-VaPMr30FlSRXq88AVWSjsnqEcMHc9fqQ/edit)

- [2019-12-24](https://hackmd.io/yX10jYXzSb-XVlgdApnOkQ?view)

- [2020-5-10](https://docs.google.com/document/d/1dZR0DHtQ5udNU3gdEvnHv_18j5XuCoVpnDEpdjRDkt0/edit#heading=h.oq2lm1b7nze7)

- [2020-7-29 and onwards](https://docs.google.com/document/d/1guIoZ4a-Nrr-oaBTsbPcZsx6bN_n8jrHGVqGya9OVYA/edit#heading=h.lx3pjqndsni4)

88 changes: 88 additions & 0 deletions quickguide.en.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: Translation Guide
---

This document explains how to participate as a community member contributing to translation (l10n). You may also want to consult the [general Crowdin documentation for volunteer translators](https://support.crowdin.com/enterprise/getting-started-for-volunteers/).

For information about the overall translation system used by The Carpentries, see the [Carpentries Translation Guide](https://hackmd.io/@joelnitta/SkCSC6ZNT).

### Create an account

We use [Crowdin](https://ja.crowdin.com/) for translation. Create an account in the [Carpentries Crowdin account](https://carpentries.crowdin.com/) through [this link](https://accounts.crowdin.com/carpentries/login).

You can either create an account in Crowdin by filling the requested details or through sign up using your GitHub, Facebook, Twitter, GitLab or Google account.

**Warning**: The Carpentries is using Crowdin Enterprise, which is **not** connected to crowdin.com and needs a separate account. If you have an account in crowdin.com, you will still need to sign up again in Crowdin Enterprise.

### Choose a file to translate

Once you create your account and log in to the Carpentries workspace, you should see a dashboard including various on-going translation projects.
In the Carpentries workspace, each project corresponds to a lesson.

![image](https://hackmd.io/_uploads/r1PE3cfhp.png)

Choose one of the lessons that you wish to translate, then choose a language to translate. If you don't see the language that you are interested in, contact one of the managers to request it be added.

After selecting a language, you will see a list of files that need to be translated.

![image](https://hackmd.io/_uploads/H1ej99lNa.png)

The **priority** for each file is indicated by the colored up arrows next the file name; red indicates high priority, so if possible, please translate those first.

The blue and green bars indicate how many words have been translated and approved, respectively. Machine translation is used as a first-pass, but requires human approval for use.

Choosing a file will take you to the translation editor window.

### Using the editor

The [Crowdin](https://crowdin.com/) editor is your friend.
You can use it to change translation language, proofread, add comments for contributors, contact the managers, vote on translations, view suggestions for translation from Translation Memory or find Machine Translation from Google, Crowdin, DeepL, and others.

Once you click on any file, you will be directed to the comfortable mode in the Crowdin crowdsourcing editor.
There are different modes and editors inside Crowdin but we will only go through comfortable mode and proofreader mode in the Crowdin crowdsourcing editor.
You can find more information about the Crowdin Editor from the [documentation here](https://support.crowdin.com/enterprise/getting-started-for-translators/).

The comfortable mode is divided into four sections:
1. **Left Sidebar (1):** It contains all strings in the file that you will translate.
2. **Middle-top area (2):** The main working area where you edit/upvote the translations.
3. **Middle-bottom area (3):** This section contains suggestions from Translation Memory, Machine Translation (MT) suggestions, and translations by other project participants
4. **Right sidebar (4):** You can use it to add comments, report issues, and see the existing Glossary available for the strings.

![image](https://hackmd.io/_uploads/SyUroAe4a.png)

As shown in the image above, the **Middle-top area (2)** is the main working area with the source string on the top, and the section where you can type in translations.
Crowdin will show you suggestions for translation carried out using two different engines (DeepL and Crowdin Translate), which will show you several possible translations that you can further edit.

Strings may have the following statuses:

- ![icons](images/untranslated.png){height="20"} Untranslated
- ![icons](https://hackmd.io/_uploads/HkdL4s-Na.png =60x60){height="25"} Translated
- ![icons](https://the-turing-way.netlify.app/_images/approved_icon.png){height="25"} Approved translation
- ![icons](https://the-turing-way.netlify.app/_images/hidden_icon.png){height="25"} Hidden (visible only for project managers and proofreaders)

An active string is highlighted with the yellow color but you can turn on/off color highlight of strings by clicking on ![icons](https://the-turing-way.netlify.app/_images/preview_filter.png) and show translation preview using ![icons](https://the-turing-way.netlify.app/_images/eye.png).

Crowdin editor won't only show you suggestions of a translation made by the translation engine but also suggestions from translation for strings that are stored in Translation Memory \(TM\) if the string is has a similarity above 70%.
This avoids duplication of effort.

### Proofreading

By default, when you [join the project as a translator](#Create-an-account), you only have permission to translate strings, but not to approve or reject translations. Strings that have not been approved will not appear the in actual translated file.

To approve strings for translation, you need to first obtain permission as a Proofreader. Contact a Language Coordinator via email or slack, providing your Crowdin username. The Language Coordinator may then grant you permission to do proofreading.

Once you have obtained permissions, switch to Proofreading mode by clicking the Workflow button on the top menu, which should say `CROWDSOURCING` by default:

![image](https://hackmd.io/_uploads/ry1KHs-ET.png)

This brings up the Workflow menu, where you can select `PROOFREADING`:

![image](https://hackmd.io/_uploads/HJKyIo-NT.png)

The editor window looks basically the same, but now for each string there is a check button. Press the check to approval the string if the translation appears correct.

![image](https://hackmd.io/_uploads/rkr7PibNT.png)

### Viewing the translated lesson

After your translations have been approved, if the lesson website is set up correctly, you should be able to see the newly translated website by syncing the fork as described in the [Guide for Language Coordinators](#https://hackmd.io/oj4EsGXOQOScgB67E7f_bQ?view#Guide-for-Language-Coordinators).

0 comments on commit 8ab21d3

Please sign in to comment.