Outdated version of the documentation. Find the latest one here.

20. 付録:このマニュアルに貢献する

このコースに材料を追加するには、この付録のガイドラインに従う必要があります。明確化のためを除き、この付録の条件を変更してはいけません。これは、このマニュアルの品質と一貫性を維持できるようにするためです。

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

この文書のソースは GitHubの<https://github.com/qgis/QGIS-Documentation> _で提供されています。Gitのバージョン管理システムを使用する方法については、_ `` GitHub.com <https://github.com/>参照してください。

20.2. マニュアルの形式

このマニュアルは、 `スフィンクス<http://sphinx.pocoo.org/>`_`reStructuredTextの使用Pythonのドキュメントジェネレータ<http://docutils.sourceforge.net/rst.html>`_ マークアップ言語を使用して書かれています。これらのツールを使用する方法については、それぞれのサイトからご利用可能です。

20.3. モジュールの追加

  • 新しいモジュールを追加するには、最初に新しいモジュール名を持つ新しいディレクトリ( QGIS-トレーニングマニュアル ディレクトリのトップレベルのすぐ下)を作成します。

  • この新しいディレクトリの下に、 index.rst というファイルを作成します。今のところ、このファイルは空白のままにします。

  • 最上位ディレクトリの下の index.rst ファイル開きます。その最初の数行は:

    .. toctree::
       :maxdepth: 2
    
    
       foreword/index
       introduction/index

これは、名前 index が続く、ディレクトリ名のリストであることに注意します。これは、各ディレクトリ内のインデックスファイルにトップレベルのインデックスファイルを指示します。それらがリストされている順序は、文書中での順序を決定します。

  • モジュールを表示したい場所に、このリストに、 /index を続けて、新しいモジュール(すなわち、新しいディレクトリを付けた名前)の名前を追加します。

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

  • 新しいモジュールの独自のインデックスファイルを開きます( [module name]/index.rst )。

  • ページの上部に沿って、80個のアスタリスクの行を書く(*)。これは、モジュールの見出しを表します。

  • これに続けて |MOD| (「モジュール」の略) 、モジュールの名前が続くマークアップフレーズを含む行でください。

  • 80個のアスタリスクの別の行でこれをオフに終了します。

  • この下に空白行を残します。

  • モジュールの目的と内容を説明する短いパラグラフを書きます。

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

    .. toctree::
       :maxdepth: 2
    
    
       lesson1
       lesson2

    ...ここで、lesson1lesson2 などは、計画された授業の名前です。

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

*******************************************************************************
|MOD| Module Name
*******************************************************************************

Short paragraph describing the module.

.. toctree::
   :maxdepth: 2


   lesson1
   lesson2

20.4. レッスンの追加

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

  • モジュールディレクトリを開く

  • index.rst ファイル(新しいモジュールの場合に上で作成)を開きます。

  • 計画された授業の名前が、上で示されるように、 toctree ディレクティブ下に表示されていることを確認してください。

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

  • このファイルにモジュールの index.rst ファイルで与えられた名前とまったく同じ名前を付け、拡張子 .rst を追加します。

ノート

編集する目的では、 .rst ファイルは通常のテキストファイル( .txt )とまったく同じように動作します。

  • レッスンの書き込みを開始するには、マークアップのフレーズ |LS| を書き、その後ろにレッスン名を書きます。

  • 次の行では、80の等号( = )の行を書き込む。

  • この後に空行を残します。

  • 授業の意図された目的の短い説明を書きます。

  • 主題への一般的な導入を含みます。例については、このマニュアルでは、既存のレッスンを参照してください。

  • この下には、このフレーズから始まる、新しい段落を開始:

    **The goal for this lesson:**
  • 簡単に言えば、このレッスンを完了することを意図し成果を説明します。

  • 1つのまたは2つの文にレッスンの目標を記述することができない場合は、複数のレッスンにかかわらアップ対象を壊すことを検討してください。

各レッスンには、次の対処されることになります複数のセクションに細分化されます。

20.5. セクションの追加

セクションは2種類あります。「この通りに従ってください」と「自分でやってみよう」。

  • 「この通りに従ってください」セクションには、QGISの所定の態様を使用する方法を読者に教示することを意図方向の詳細なセットです。これは通常、クリックごとのクリックスクリーンショットが散在し、できるだけ明瞭として指示を与えることによって行われます。

  • 「自分でやってみよう」セクションでは、読者自身で試して短い割り当てを与えます。これは通常表示または割り当てを完了するために、可能な場合に予想される結果を表示する方法を説明しますドキュメントの最後に解答用紙のエントリに関連付けられています。

すべてのセクションでは、難易度が付属しています。簡単なセクションは |basic| 、適度は |moderate| 、および上級は |hard| で表されます。

20.5.1. 「一緒に従う」セクションを追加

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

  •  |FA| を書き込み、その後にスペースを入れてください( “一緒に従う” のため)。

  • (初回のみ大文字だけでなく、固有名詞のための大文字を使用)、別のスペースを残して、セクションの名前を書きます。

  • 次の行では、80マイナス/ダッシュの線を書き込む(-)。テキストエディタが長いダッシュまたは他の文字でデフォルトマイナス/ダッシュ文字に置き換えられないことを確認してください。

  • その目的を説明し、セクションへの簡単な紹介を書きます。そして、立証されるように手続き上の詳細(クリックでクリック)指示を与えます。

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

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

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

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

  • スペースを残し、その後 |TY| と書き込みます( “自分でやってみよう” のために)。

  • 次の行では、80マイナス/ダッシュの線を書き込む(-)。テキストエディタが長いダッシュまたは他の文字でデフォルトマイナス/ダッシュ文字に置き換えられないことを確認してください。

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

  • プレーンテキスト記述が明確でない場合は要件を明確にするためにスクリーンショットを含めます。

ほとんどの場合、このセクションで与えられた割り当てを完了する方法についての答えを提供したいと思うでしょう。そのためには、解答用紙にエントリを追加する必要があるでしょう。

  • まず、回答に一意の名前を決定します。理想的には、この名前は、レッスンの名前とインクリメント番号が含まれます。

  • この回答へのリンクを作成:

    :ref:`Check your results <answer-name>`
  • 解答用紙を開きます (answers/answers.rst)。

  • この行を書き込むことによって、「自分を試してみてください」セクションへのリンクを作成します。

    .. _answer-name:
  • 必要な場合、リンクや画像を使用して、割り当てを完了する方法の手順を書きます。

  • それを終了するには、この行を書き込むことによって、バック「自分自身を試してみてください」セクションへのリンクが含まれています。

    :ref:`Back to text <backlink-answer-name>`
  • このリンクを動作させるために、「自分を試してみてください」セクションに、見出しの上に次の行を追加します。

    .. _backlink-answer-name:

文書を作成しながら、それ以外の場合はエラーが発生する可能性があり、上に示したこれらの線のそれぞれは、その上下の空白行を持たなければならないことに注意してください。

20.6. 結論を追加

  • フレーズを書き、レッスンを終了するには |IC| 80マイナス/ハイフンの新しい行に続いて、 “結論に” のために (-)。レッスンでカバーされている概念を説明、レッスンの結論を書きます。

20.7. また、読取部を追加します。

  • このセクションは追加分です.

  • 80マイナス/ハイフンの新しい行に続いて “さらに読書” のための フレーズ FR を書く (-)。

  • 適切な外部のウェブサイトへのリンクが含まれています。

20.8. 何の次のセクションを追加します。

  • フレーズ |WN| を書く 80マイナス/ハイフンの新しい行に続いて、 “次に”(-)。

  • このレッスンは、次のレッスンまたはモジュールのための学生を準備している方法について説明します。

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

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

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

20.9.1. 新しい概念

  • 新しい概念を説明している場合は、アスタリスク( * )で囲むことでイタリック体で新しい概念の名前を記述する必要があります。

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

20.9.2. 強調

  • 新しい概念ではない重要な用語を強調するために、二重のアスタリスク( ** )で囲むことで太字の用語を記述します。

  • これは控えめに使用!あまり使用しすぎると、読者には叫んでたり恩着せつつあるように見えるかも。

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.**

20.9.3. 画像

  • 画像を追加する場合は、フォルダ _static/lesson_name/ に保存します。

  • このような文書でそれを含める:

    .. image:: /static/training_manual/lesson_name/image_file.extension
       :align: center
  • 画像マークアップの上方および下方の空行を残すことを忘れないでください。

20.9.6. 等幅のテキストを使用して

  • ユーザーが入力する必要のあるテキスト、パス名、またはテーブルやカラム名などのデータベース要素の名前を書いているときは、それを 等幅text で記述する必要があります。例えば::

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

20.9.7. ラベリングGUIアイテム

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

    To access this tool, click on the :guilabel:`Tool Name` button.
  • ボタンをクリックし、ユーザを必要とせずに、ツールの名前を言及している場合にも適用されます。

20.9.9. ノートを追加する

  • 簡単に授業の流れの一部を行うことができない余分な詳細を説明するテキストに注釈が必要になる場合があります。これは、マークアップです:

    [Normal paragraph.]
    
    .. note:: Note text.
       New line within note.
    
       New paragraph within note.
    
    [Unindented text resumes normal paragraph.]

20.9.10. 後援/原作者ノートを追加します

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

自身の容量のモジュール、レッスンまたはセクションを記述するために志願し、ないスポンサーを代表している場合は、あなたが執筆モジュール、レッスンやセクションの見出しの下、原作者のノートを含むことができます。これは形を取る必要がありますのkbd: `この[モジュール/レッスン/セクション] [著者名] .`このような詳細は、の「協力者」セクションに追加されるさらに、テキスト、連絡先などを追加しないでくださいで貢献しましたはじめは、一部(複数可)の名前(複数可)と一緒にあなたが追加しました。あなただけの機能強化、修正および/または追加を行った場合は、編集者として自分自身をリストします。

20.10. ありがとうございました!

このプロジェクトに貢献してくれてありがとう!そうすることで、ユーザーにQGISは、よりアクセスしやすく、全体としてQGISプロジェクトに値を追加しています。