2. Maharaユーザマニュアル執筆者および翻訳者のための情報

by Kristina D.C. Hoeppner

This is a list in progress as I work on the user manual. There are a number of things for which I created 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. ;-)

このリストは特定の順番に並べられていません。

2.1. スクリーンショット

  • are placed using the 「figure」 directive.
  • always include alt text and a figure description. The latter will be numbered in the PDF export. That sets them apart from the text.
  • are generally placed above a list if they are part of step-by-step instructions.
  • 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.
  • new in Mahara 1.6 get callouts that are created in Gimp with the script that Iñaki adapted.
  • that have callouts refer to the steps that need to be taken and that are explained below the figure.
  • should only show the necessary area and not the entire screen or URL address bars etc. where not necessary.

ほとんどのスクリーンショットには*figure*ディレクティブが追加されます:

Example of including a screenshot

スクリーンショットを含む例

  1. The first line provides the path to the file. The * replaces the file extension and Sphinx chooses the file that is most appropriate. Thus, files could have different image extensions or you could have the same screenshots in different file formats that are then chosen by the programme to best suit the end format of the manual.
  2. 2行目はイメージの上にマウスを乗せた場合、イメージが表示されない場合またはスクリーンリーダでページを閲覧する場合の代替テキストを意味します。
  3. 3行目は空白行に続く必要があります。これは画像の説明としてスクリーンショットの下に表示されるテキストです。PDF出力の場合、説明は連続して番号付けされます。

注釈

If you want to include an image inline with the text and don’t want to or can’t use the regular figure, you should create a substitution and place it into the shortcuts.rstext file.

2.2. 使用されている警告

  • ノート: さらに少しだけ注意が必要なすべてのことです。
  • 警告: 注意しながら実施する必要のあるすべてのことです。
  • seealso: for references to other documents if they need special attention. References to other documents can also be included in the text inline.
  • todo: 実行中のToDoリストを保持するため

2.3. 規約

  • ナビゲーションメニューアイテムに関連するそれぞれのセクションにはパスの記述が必要です。例) コンテンツ → ファイル。正しい矢印を取得するには矢印 ( → ) をコピーしてください。

  • 保存*または*ページをコピーする*およびポートフォリオセクションの*コンテンツ、ポートフォリオ*等のボタンはテキストを強調するため「」マークを使ってハイライトされています。

  • Little buttons can be included in the text like edit, manage. They are added through a substitution. All replacements are kept in the file shortcuts.rstext which is included in each file in which a substitution is used by placing 「.. include:: /shortcuts.rstext」 in the first line of the file. Substitutions are referenced in the text as 「*Edit* button |edit|」 for example pointing out what the action is that you do with them. Translators should not edit the substitution 「|edit|」 itself, but only change 「*Edit* button」 taking care to include the * again without placing any spaces between the * and the text.

  • それぞれのセクションにインデックスエントリを作成してください。

  • New features receive an index entry as well in the form 「single: New in Mahara 1.6; [the functionality that is new]」.

  • 編集時に操作しやすいよう長いセクションは複数ページに分割されます。

  • reStructuredText does not have a set hierarchy of heading levels. They depend on the individual files. However, to be consistent, the following convention exists:

    • 見出し1 例) 1.: ===============
    • 見出し2 例) 1.1.: —————
    • 見出し3 例) 1.1.1.: ~~~~~~~~~~~~~~~
    • 見出し4 例) 1.1.1.1.: ^^^^^^^^^^^^^^^

  • h4以下の見出しは控えてください。

2.4. インテキストフォーマット

  • 箇条書きリストにはそれぞれの箇条書きの前に「*」記号が付けられます。
  • 番号付きリストにはそれぞれの番号付きアイテムの先頭に「#.」が付けられます。
  • If you require an indented bulleted or numbered list, place a free line before the indented list and then indent each line with 3 spaces. There also needs to be an empty line when the indented list ends.
  • 強調テキストは1つの「*」開始および終了します。 例) *this* は次のようになります this
  • 太字テキストは次で開始および終了します: 2 ** 例) **this** は次のようになります this