マニュアルの編集(英語の原文の編集)

ローカルのテキストファイルを編集することによってマニュアルを編集できます。ファイルはリポジトリ内のファイルと同期しています。編集されたファイルをリポジトリに送る(コミットする)ことによってマニュアルの文章が変えられます。

The manual is written in the reStructuredText (RST) markup language and can be edited using a plain text editor. For a local preview, you convert (build) the manual source files from RST into HTML web pages.

アップデート

Firstly, make sure that your local copy of the manual is up to date with the online repository using:

svn update

書く

アップデートが終わったら manual フォルダー内の .rst ファイルを好きなテキストエディタで編集できます。

書き方の決まりは Writing Style Guide で確認してください。reStructuredText(マークアップ言語)の書き方は Markup Style Guide で覚えられます。

頑張ってください!

大編集

セクションを追加したいか書き直したい場合、まず既に存在していないことをよく確認してください。一部の場所では、ドキュメントが非常に整理されていないため、セクションが重複したり奇妙な場所に置かれていたりします。そういったものを見つけた場合は 、問題を説明する タスクを作成 し、オプションでリビジョン (実際の修正内容) を含めてください。

単純でなく確実に明瞭だと言えない編集 (たとえばフォルダの移動など) を行う前には、コミュニティが持つマニュアルへのビジョンに沿うものであるかを、マニュアルの管理者に相談する必要があります。それがあなたの時間と善意を最も活かす方法です。そうでない場合、何らかの理由で競合が発生してあなたの編集が却下されたり、レビューに時間がかかる可能性があります。例えば、あなたが変更したいセクションを既に別の人が作業していたり、セクション自体が削除される予定であったり、Blender への計画的な変更による更新があるかもしれません。

コミュニケーション を取ることによって生産的環境を保ちましょう。話し合って努力の無駄を防ぎましょう。それがBlender マニュアルを良くします。

助け・答えが必要な場合

書きたい機能の仕様に疑問がある場合は、その分野の Blender 開発の責任者に問い合わせるか、非公式の Blender チャット 内の、ユーザーサポートチャンネル #docs または #blender-coders で質問してください。

Blender では、モジュールオーナーのシステムを採用しており、各分野ごとにモジュールのメンバーとしてデザインとメンテナンスを任されている開発者やアーティストがいます。より詳しい情報は module owners page を参照してください。

Preview

To view your changes, build the manual as instructed. Keep in mind that you can also build only the chapter you just edited to view it quickly. Open the generated .html files inside the build/html folder using your web browser, or refresh the page if you have it open already.

アップロード(コミット)

変更に満足したら、それをアップロードして、オンラインマニュアルに反映されるようにします。最初は、誰かがレビューしてフィードバックを返せるように、パッチを提出します。その後、変更を直接コミットできるようになります。この過程の詳細は、次のセクションで紹介します。