重要

翻訳は あなたが参加できる コミュニティの取り組みです。このページは現在 64.81% 翻訳されています。

19. 付録：このマニュアルに貢献する

To add materials to this course, you must follow the guidelines in this Appendix. You are not allowed to alter the conditions in this Appendix except for clarification. This is to ensure that the quality and consistency of this manual can be maintained.

19.1. リソースのダウンロード

この文書のソースは GitHub で提供されています。Gitのバージョン管理システムを使用する方法については、 GitHub.com を参照してください。

19.2. マニュアルの形式

このマニュアルは、reStructuredText マーク付け言語を使ったPythonドキュメントジェネレータ、Sphinx を使って書かれました。これらのツールの使い方はそれぞれのサイトで入手できます。

19.3. モジュールを追加する

To add a new module:

  1. First create a new directory (directly under the top-level of the qgis-training-manual directory) with the name of the new module.

  2. Under this new directory, create a file called index.rst. Leave this file blank for now.

  3. Open the index.rst file under the top-level directory. Its first lines are:

    .. toctree::
   :maxdepth: 2

   foreword/index
   introduction/index

You will note that this is a list of directory names, followed by the name index. This directs the top-level index file to the index files in each directory. The order in which they are listed determines the order they will have in the document.

  1. Add the name of your new module (i.e., the name you gave the new directory), followed by /index, to this list, wherever you want your module to appear.

  2. 後のモジュールは前のモジュールで提示される知識の上に構築するように、モジュールの順序を論理的に維持することを忘れないでください。

  3. Open your new module's own index file (module_name/index.rst).

  4. Along the top of the page, create the module heading:

    1. write a first line of asterisks (*).

    2. Follow this with a line containing the markup phrase Module:, followed by the name of your module.

    3. End this off with another line of same number of asterisks.

    注釈

    The underline and the overline should not be shorter than the line containing the module title.

  5. この下に空白行を置きます。

  6. モジュールの目的と内容を説明する短い段落を書きます。

  7. 1行を空白のままに残し、次のテキストを追加します:

    .. toctree::
   :maxdepth: 2

   lesson1
   lesson2

    ... where lesson1, lesson2, etc., are the names of your planned lessons.

モジュールレベルのインデックスファイルは次のようになります。

*******************************************************************************
Module: Module Name
*******************************************************************************

Short paragraph describing the module.

.. toctree::
   :maxdepth: 2

   lesson1
   lesson2

19.4. レッスンを追加する

新規または既存のモジュールにレッスンを追加するには:

  1. モジュールディレクトリを開きます。

  2. Open the index.rst file (created above in the case of new modules).

  3. Ensure that the name of the planned lesson is listed underneath the toctree directive, as shown above.

  4. モジュールディレクトリの下に新しいファイルを作成します。

  5. Name this file exactly the same as the name you provided in the module's index.rst file, and add the extension .rst.

注釈

For editing purposes, a .rst file works exactly like a normal text file (.txt).

  1. To begin writing the lesson, write the markup phrase Lesson, followed by the lesson name.

  2. In the next line, write a line of equal signs (=), not shorter than the lesson title.

  3. この後に空行を置きます。

  4. レッスンの意図された目的について短い説明を書きます。

  5. 主題への一般的な紹介を含めます。例として、このマニュアル中の既存のレッスンを参照してください。

  6. この下には、この語句から始まる、新しい段落を開始します:

    **The goal for this lesson:**

  7. このレッスンを完了することによる意図した成果を簡単に説明します。

  8. 1つのまたは2つの文にレッスンの目標を記述できない場合は、主題を複数のレッスンに分けることを検討してください。

次に説明するように、各レッスンは複数のセクションに細分化されます。

19.5. セクションを追加する

セクションには、「理解しよう」と「自分でやってみよう」の2種類があります。

  • 「理解しよう」セクションは指示の詳細なセットで、QGISの所定の態様を使用する方法を読者に教示することを意図しています。これは通常、スクリーンショットを散りばめた状態で、クリックごとの指示をできる限り明確に示すことで行われます。

  • A "try yourself" section gives the reader a short assignment to try by themselves. It is usually associated with an entry in the answer box beneath, which will show or explain how to complete the assignment, and will show the expected outcome if possible.

すべてのセクションには難易度が付けられています。簡単なセクションは ★☆☆ 、中級は ★★☆ 、そして上級は ★★★ で表されます。

19.5.1. 「理解しよう」セクションを追加する

  1. （上記のように）このセクションを開始するには、意図した難易度のマークアップ語句を書き込みます。

  2. スペースを置き、次に「理解しよう:」を書きます。

  3. もうひとつスペースを置いて、セクションの名前を書きます（初回のみ大文字だけでなく、固有名詞のための大文字を使用）。

  4. In the next line, write a line of minuses/dashes (-), not shorter than the section title.

  5. その目的を説明し、セクションへの簡単な紹介を書きます。そして、例証される手続きについての詳細な（クリック毎の）指示を与えます。

  6. 必要に応じて各セクションには、内部リンク、外部リンク、およびスクリーンショットが含まれます。

  7. 可能ならば、それを終了し、次のセクションに自然につながる短い段落で、各セクションを終了してみてください。

19.5.2. 「自分でやってみよう」セクションを追加する

  1. （上記のように）このセクションを開始するには、意図した難易度のマークアップ語句を書き込みます。

  2. スペースを置き、次に「自分でやってみよう:」を書きます。

  3. In the next line, write a line of minuses/dashes (-), not shorter than the section title.

  4. 読者に完成させたい練習を説明します。必要に応じて、前のセクション、レッスンやモジュールを参照します。

  5. 単なる文章での説明でははっきりしない場合、要件を明確にするためにスクリーンショットを含めます。

In most cases, you will want to provide an answer regarding how to complete the assignment given in this section. To do so, you will need to create and feed an answer block beneath the instructions.

  1. First, create the custom collapsible widget that contains the answer:

    .. admonition:: Answer
   :class: dropdown

  2. Keeping an indentation with regard to the above block, write the instructions on how to complete the assignment, using links and images where needed.

19.6. 結論を追加

To end a lesson:

  1. Write the phrase In Conclusion, followed by a new line of minuses/dashes (-).

  2. Write a conclusion for the lesson, explaining which concepts have been covered in the lesson.

19.7. [さらに読む]セクションを追加

このセクションは任意です。

  • Write the phrase Further Reading, followed by a new line of minuses/dashes (-).

  • 適切な外部のウェブサイトへのリンクを含めます。

19.8. [次は]セクションを追加

  1. Write the phrase What's Next?, followed by a new line of minuses/dashes (-).

  2. このレッスンがどのように学生にとって次のレッスンまたはモジュールの準備になったかを説明します。

  3. 必要であれば前のレッスンの「次は」のセクションを、新しいレッスンを参照するように変更することを忘れないでください。これは既存のレッスンの間に、または既存のレッスンの後に新しいレッスンを挿入した場合に必要となります。

19.9. マークアップを使用する

このドキュメントの基準を遵守するため、テキストに標準的なマークアップを追加する必要があります。

19.9.1. 新しい概念

If you are explaining a new concept, you will need to write the new concept's name in italics by enclosing it in asterisks (*).

This sample text shows how to introduce a *new concept*.

19.9.2. 強調

  • To emphasize a crucial term which is not a new concept, write the term in bold by enclosing it in double asterisks (**).

  • これは控えめに使いましょう！多用すると、読者には怒鳴っていたり見下しているように見えることがあります。

This sample text shows how to use **emphasis** in a sentence. Include the
punctuation mark if it is followed by a **comma,** or at the **end of the
sentence.**

19.9.3. 画像

  • When adding an image, save it to an img folder next to the lesson file.

  • 文書にそれを入れるにはこのようにします:

    .. figure:: img/image_file.extension
   :align: center

  • 画像マークアップの上方および下方の空行を残すことを忘れないでください。

19.9.6. 等幅テキストを使う

  • When you are writing text that the user needs to enter, a path name, or the name of a database element such as a table or column name, you must write it in monospaced text. For example:

    Enter the following path in the text box: ``path/to/file``.

19.9.7. ラベルするGUI項目

  • GUIの項目、ボタンなど、を参照している場合は、 GUIラベルフォーマット の中にその名前を書く必要があります。例えば:

    To access this tool, click on the :guilabel:`Tool Name` button.

  • これは、ユーザーがボタンをクリックする必要なしに、ツールの名前を言及している場合にも適用されます。

19.9.9. 注を追加する

  • You might need to add a note in the text, which explains extra details that can't easily be made part of the flow of the lesson. This is the markup:

    [Normal paragraph.]

.. note:: Note text.
  New line within note.

  New paragraph within note.

[Unindented text resumes normal paragraph.]

19.9.10. 後援/原作者注を追加する

スポンサーに代わって新しいモジュール、レッスンまたはセクションを記述する場合は、スポンサーが希望する短いスポンサーメッセージを含める必要があります。これはスポンサーの名前を読者に通知しなければならず、そのスポンサーが主催するモジュール、レッスンやセクションの見出しの下に表示されなければなりません。しかし、それはスポンサーの会社の広告であってはいけません。

If you have volunteered to write a module, lesson or section in your own capacity, and not on behalf of a sponsor, you may include an authorship note below the heading of the module, lesson or section that you authored. This must take the form This [module/lesson/section] contributed by [author name]. Do not add further text, contact details, etc. Such details are to be added in the "Contributors" section of the Foreword, along with the name(s) of the part(s) you added. If you only made enhancements, corrections and/or additions, list yourself as an editor.

19.10. ありがとうございました！

このプロジェクトに貢献していただきありがとうございます！そうすることで、QGISはユーザーからより利用しやすくなり、全体としてQGISプロジェクトに価値を付加しています。