forked from processing/p5.js-website-legacy
-
Notifications
You must be signed in to change notification settings - Fork 2
StyleGuide
SHIBAHARA Hiroki edited this page May 24, 2023
·
10 revisions
ここでは、翻訳する際の表記ルール等についてご説明します。まずは、次の点をご理解ください。
- 翻訳初版からすべてのルールを満たす必要はない
- チームでレビューして補完しあっていける
- 臨機応変に対応している
最初からルールにこだわる必要はありません。ルール違反があったとしても、レビューの際に気付いた人が指摘してくれますので、後でいくらでも修正することができます。まずは気軽に翻訳してみましょう。
上記文献の内容を基本方針とした上で、さらに以下のルールに従ってください。
正誤例:
| 正 | 誤 |
|---|---|
| サーバー | サーバ |
| ユーザー | ユーザ |
| ブラウザー | ブラウザ |
| パラメーター | パラメータ |
| コンピューター | コンピュータ |
データの読み書きは「ロード・セーブ」が適切に感じられますが、メディア(画像や音声)など、そのままで意味を成して利用されるものは「読み込み・書き込み」の方が適切でしょう。しかしプログラム内でメディアなどを利用する場合はロードの方が適切かもしれません。
このように使い分けに迷うところではありますが、「読み込み・書き込み」で統一します。ゲームのセーブデータなど、よっぽど「ロード・セーブ」の方が適切だと感じられる場合はその限りではありません。
draw()など関数の丸カッコにはシングルバイトの丸カッコ()を使用し、それ以外にはマルチバイトの丸カッコ（）を使用します。
サンプルページ内で「example」が登場した場合は「例」ではなく「サンプル」と訳します。
例:
| 原文 | 訳文 |
|---|---|
| This example is a port of Dan Shiffman's example for Processing. | このサンプルは、ProcessingウェブサイトのDan ShiffmanによるConvolutionのサンプルを移植したものです。 |
- コメント文は、ですます調で終わらせます。
- 文章の最後には「。」をつけてください。
正誤例:
| 正 | 誤 |
|---|---|
| 指定された幅、高さ、奥行きで箱を描画します。 | 指定された幅、高さ、奥行きで箱を描画する |
- 引数の説明などの単語説明的なものは、基本的に体言止めにします。続けて説明が必要ならば、ですます調にします。
正誤例:
| 正 | 誤 |
|---|---|
| 描画距離 | 描画距離です。 |
- 一般化している専門用語訳を使う。
- ただし、初出時は（）囲みでシンプルな日本語（ひとこと単語か説明文）をつける。
例:
| 原文 | 訳文 |
|---|---|
| Geometry | ジオメトリ（幾何学） |
- カタカナが複数語になる場合、間にスペースは不要。
例:
| 原文 | 訳文 |
|---|---|
| ray tracing | レイトレーシング (レイとトレーシングをくっつける) |
- アルファベットのワードの前後に半角スペースを入れる（行頭、行末は不要）。
- 関数名＋() や 数値＋単位 の場合は、間に半角スペースは入れない。
- 名称として「英語＋日本語」が望ましいものは、2023/05/17時点では半角スペースを入れるが、最終的に精査する。（例: Webサイト、3D空間）
- タグの前後には半角スペースを入れる（行頭、行末は不要）。
- 複数のタグが連続している場合は、最も外側のタグの前後にのみ半角スペースを入れる。
例:
このサンプルをローカルで実行するには2つの画像ファイルと実行中の <a href="https://github.com/processing/p5.js/wiki/Local-server">ローカルサーバー</a> が必要です。このサンプルをローカルで実行するには2つの画像ファイルと実行中の <em><span class="strong">ローカルサーバー</span></em> が必要です。