|
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 are placed as figures and always include alt text and a figure description. The latter will receive numbering in the PDF export.
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:10
|
|
5.
|
|
|
Admonitions in use are:
|
|
|
|
使用されている警告は次のとおりです:
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:21
|
|
6.
|
|
|
note: for anything that should receive a bit more attention
|
|
|
|
注意: やや注意が必要なものです。
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:23
|
|
7.
|
|
|
warning: for anything that needs to be done with caution
|
|
|
|
警告: 注意が必要なものです。
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:24
|
|
8.
|
|
|
seealso: for references to other documents if they need special attention. References to other documents can also be included in the text inline.
|
|
|
|
他の文書が特別な注意を必要とする場合は、他の文書への参照についても参照してください。他の文書への参照は、インラインのテキストに含めることもできます。
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:25
|
|
9.
|
|
|
todo: for keeping a running ToDo list
|
|
|
|
todo: 実行中のToDoリストを維持するために
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:26
|
|
10.
|
|
|
Buttons such as *Save* or *Copy page* and also portfolio sections such as *Content*, *Porfolio* etc. are highlighted as emphasized text (with a single \*).
|
|
|
|
*保存*または*ページをコピーする*およびポートフォリオセクションの*コンテンツ*、*ポートフォリオ*等のボタンはテキストを強調するため「*」マークを使ってハイライトされています。
|
|
Translated and reviewed by
Mitsuhiro Yoshida
|
|
|
|
Located in
../source/documentation_info.rst:73
|
|
11.
|
|
|
Little buttons can be included in the text.
|
|
|
|
(no translation yet)
|
|
|
|
Located in
../source/documentation_info.rst:19
|