|
|
1.
|
|
|
Information for Mahara documentation writers
|
|
|
|
|
Maharaドキュメンテーション執筆者のための情報
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:6
|
|
|
2.
|
|
|
This is a list in progress as I work on the documentation. There are a number of things for which I create conventions. I want to keep them in a central space so that others have access to them and that I can refer to them as well. ;-)
|
|
|
|
|
これは、私がドキュメントを作成している最中のリストです。私が作成した規約にはいくつかのものがあります。他の人がアクセスできるように、また私も参照できるように、一元的に保管しておきたいと思っています。)
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:8
|
|
|
3.
|
|
|
The list is not in any particular order.
|
|
|
|
|
リストは特定の順序には並べられていません。
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:10
|
|
|
4.
|
|
|
Screenshots
|
|
|
|
|
スクリーンショット
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:58
|
|
|
5.
|
|
|
are placed using the "figure" directive.
|
|
|
|
|
「figure」ディレクティブを使用して配置されます。
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:62
|
|
|
6.
|
|
|
always include alt text and a figure description. The latter will be numbered in the PDF export. That sets them apart from the text.
|
|
|
|
|
には常にaltテキストおよび図の説明が含まれます。後者はPDFエクスポートで番号が付けられます。これによりテキストと区別されます。
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:18
|
|
|
7.
|
|
|
are generally placed above a list if they are part of step-by-step instructions.
|
|
|
|
|
それらがステップバイステップの指示の一部である場合、一般にリストの上に置かれます。
|
|
Translated by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:62
|
|
|
8.
|
|
|
should have as few instructions as possible about the steps that are to be taken in them. Preferably, only the step numbers so that they can be exchanged more easily and the text of the steps is translatable because it is text and not part of the image. That could also mean that translators can translate the steps but don't immediately have to change the screenshots.
|
|
|
|
|
それらに取り入れられるべきステップについてできるだけ少ないインストラクションを持つべきです。できればステップ番号だけを交換することができ、ステップのテキストはテキストでありイメージの一部ではないため、翻訳可能です。それは翻訳者がステップを翻訳できるけれども、直ちにスクリーンショットを変更する必要がないことも意味しています。
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:65
|
|
|
9.
|
|
|
are created with Shutter in Ubuntu. It is easy to add the callouts which indicate the steps to take. However, any other screenshot software can be used. Preferably, the callouts look similarly for consistency. The color is #4C711D.
|
|
|
|
|
はUbuntuのShutterで作成しています。手順を示す吹き出しを追加するのは簡単です。しかし、他のスクリーンショットソフトウェアを使用することができます。好ましくは、一貫性を保つために、吹き出しの見た目が似ていることが望ましい。色は#4C711Dです。
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:18
|
|
|
10.
|
|
|
that have callouts refer to the steps that need to be taken and that are explained below the figure.
|
|
|
|
|
実行する必要があり図の下で説明されるステップが参照される呼び出し (callout) を持っています。
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:66
|
