文書作成のガイドライン¶

見出し¶

文書の各ウェブページに .rst ファイルが対応しています。

テキストを構造化するために使用されるセクションはそれらのタイトルを通じて識別されます。タイトルには下線（及び第1レベルに対して上線）が引かれます。同じレベルのタイトルは下線装飾のために同じ文字を使用する必要があります。QGIS文書では、章、セクション、サブセクションとminisecに対して以下のスタイルを使用する必要があります。

********
Chapter
********

Section
=======

Subsection
----------

Minisec
.......

Subminisec
^^^^^^^^^^

Inline tags¶

テキスト内では項目を強調するためにタグを使用できます。

• Menu gui: to mark a complete sequence of menu selections, including selecting submenus and choosing a specific operation, or any subsequence of such a sequence.

  :menuselection:`menu --> submenu`
  

• Dialog and Tab title: Labels presented as part of an interactive user interface including window title, tab title and option labels.

  :guilabel:`title`
  

• Button labels

  **[Apply]**
  

• ファイル名またはディレクトリ

  :file:`README.rst`
  

• アイコンに属するポップアップテキストを持つアイコン

  |icon| :sup:`popup_text`
  

  （ 以下の 画像 を参照してください）。

• Shorcut keyboard

  :kbd:`ctrl B`
  

  will show Ctrl B

• ユーザーテキスト

  ``label``
  

ラベル/参照¶

参照はテキスト内にアンカーを配置するために使用されます。セクションやページ間のハイパーリンクを作成して呼び出すのに役立ちます。

以下の例は、セクション（例えば、ラベル/参照タイトル）のアンカーを作成します

.. _my_anchor:

Label/reference
---------------

同じページ 中の参照を呼び出すために使用するのは

see my_anchor_ for more information.

これが返すのは：

詳細については my_anchor を参照してください。

Notice how it will jump to the following line/thing following the ‘anchor’. Normally to declare this label you do not need to use apastroph’s but you do need to use empty lines before and after the anchor.

文書内のどこからでも 同じ場所にジャンプする別の方法は、 :ref: 役割を使用することです。

see :ref:`my_anchor` for more information.

その代わりに、キャプションが表示されます（この場合は、このセクションのタイトルを！）：

詳細については ラベル/参照 を参照。

だから参照1（ my_anchor ）と参照2（ ラベル/参照 ）。参照は多くの場合キャプションを完全に表示しているので、語 セクション を使用する必要は本当はありません。参照を記述するためにカスタムのキャプションも使用できます

see :ref:`Label and reference <my_anchor>` for more information.

返します：

詳細については ラベルや参照 を参照。

Figure and image¶

ピクチャ¶

画像を挿入するには、使用します

.. image:: /static/common/qgislogo.png
   :width: 10 em

これを返します

.. |nice_logo| image:: /static/common/qgislogo.png
               :width: 2 em

my paragraph begins here with a nice logo |nice_logo|.

図¶

.. _figure_logo:

.. figure:: /static/common/qgislogo.png
   :width: 20 em
   :align: center

   A caption: A logo I like

結果は以下のようになります。

キャプション：私の好きなロゴ

To avoid possible conflict with another references, always begin figures anchor with _figure_ and prefer using terms that can easily refer to the figure caption. While only the centered alignment is mandatory for the image, feel free to use any other options for figure (such as width, height, scale...) if needed.

The scripts will insert an automatical generated number before the caption of the figure in pdf.

キャプションを使用するには（ My caption を参照）、図ブロックに空白行の後ろに字下げテキストを挿入します。

図への参照は、このような参照ラベルを使用して実現できます

(see Figure_logo_).

それはアンカー Figure_logo を表示します。大文字を使用することもできます。これは同じ .rst 文書では使用できますが、他の文書では使用できません。他のファイルからの参照のために :ref: の役割を引き続き使用できますが、これは画像の完全なキャプションを返すことに注意してください。

see :ref:`figure_logo`

返します：

キャプション：私の好きなロゴ 参照

テーブル¶

簡単な表を作成するには

=======  =======  =======
x        y        z
=======  =======  =======
1        2        3
2        4
=======  =======  =======

空きスペースを残すためには、空きスペースの前に \ を使用してください。

より複雑な表も、参照およびすべてを使用すると作成できます。

.. _my_drawn_table:

+---------------+--------------------+
| Windows       | macOS              |
+---------------+--------------------+
| |win|         | |osx|              |
+---------------+--------------------+
| and of course not to forget |nix|  |
+------------------------------------+

My drawn table, mind you this is unfortunately not regarded a caption

You can reference to it like this my_drawn_table_.

結果：

ウィンドウズ	macOS
そしてもちろん を忘れないように

My drawn table, mind you this is unfortunately not regarded a caption

my_drawn_table のように参照できます。

索引¶

索引は、読者が文書内の情報を簡単に見つけるのを助ける便利な方法です。 QGISの文書作成では、いくつかの重要な索引があります。本当に有用な（一貫性があり、整合性があり、本当に互いに関連付けされている）索引のセットを保持するための規則はほとんどありません。

• Index should be human readable, understandable and translatable; an index can be made from many words but you should avoid any unneeded _, -... characters to link them i.e., Loading layers instead of loading_layers or loadingLayers.
• Always capitalize only the first letter of the index unless the word has a particular spelling, in which case keep using its spelling e.g., Loading layers, Atlas generation, WMS, pgsql2shp
• Keep an eye on the existing Index list in order to reuse the most convenient expression with the right spelling and avoid wrong duplicates.

いくつかの索引タグがRSTにはあります。通常テキスト内で行内 :index: タグも使用できますし

QGIS allows to load several :index:`Vector formats` supported by GDAL/OGR ...

あるいは、次の段落の先頭にリンクする index:: ブロックレベルのマークアップを使うこともできます。上記のルールのため、後者のタグを使用する方が簡単なので、このタグを使用することをお勧めします。

.. index:: WMS, WFS, Loading layers

It’s also recommanded to use index parameters such as single, pair, see... in order to build a more structured and interconnected table of index. See http://www.sphinx-doc.org/en/stable/markup/misc.html#index-generating-markup for more information on index creation.

特別のコメント¶

Sometimes, you may want to emphasize some points of the description, either to warn, remind or give some hints to the user. In QGIS Documentation, we use reST special directives such as .. warning::, .. note:: and .. tip:: generating particular frames that highlight your comments. See http://www.sphinx-doc.org/en/stable/markup/para.html#paragraph-level-markup for more information. A clear and appropriate title is required for both warnings and tips.

.. tip:: **Always use a meaningful title for tips**

 Begin tips with a title that summarizes what it is about. This helps
 users to quickly overview the message you want to give them, and
 decide on its relevance.

Code snippets¶

You may also want to give examples and insert a code snippet. In this case, write the comment below a line with the :: directive inserted. However, for a better rendering, especially to apply color highlighting to code according to its language, use the code-block directive, e.g. .. code-block:: xml. By default, Python code snippets do not need this reST directive. More details at http://www.sphinx-doc.org/en/stable/markup/code.html.

脚注¶

ご注意：脚注は翻訳ソフトでは認識されず、またPDF形式に適切に変換されません。だから、可能であればドキュメント内では脚注は使用しないでください。

This is for creating a footnote

blabla [1]_

これが指しているのは：

[1]	コアプラグインの更新

新しいスクリーンショットを追加¶

Here are some hints to create new, nice looking screenshots. For the user guide they go into ./resources/en/user_manual/

• same environment for all the screen caps (same OS, same decoration, same font size). We have used Ubuntu with Unity and the default “ambience” theme. For screenshots of QGIS main window and composer we have set it to show menus on the window (not the default in unity).
• reduce the window to the minimal space needed to show the feature (taking the all screen for a small modal window > overkill)
• the less clutter, the better (no need to activate all the toolbars)
• don’t resize them in an image editor, the size will be set into the rst files if necessary (downscaling the dimensions without properly upping the resolution > ugly)
• cut the background
• make the top corners transparent if the background is not white
• Set print size resolution to 135 dpi (e.g. in Gimp set the print resolution image ‣ print size and save). This way, images will be at original size in html and at a good print resolution in the PDF. You can also use ImageMagick convert command to do a batch of images

convert -units PixelsPerInch input.png -density 135 output.png

• save them in png (no jpeg artifacts)
• the screenshot should show the content according to what is described in the text
• you can find some prepared QGIS-projects that were used before to create screenshots in ./qgis-projects. This makes it easier to reproduce screenshots for the next version of QGIS. These projects use the QGIS Sample Data (aka Alaska Dataset), which should be placed in the same folder as the QGIS-Documentation Repository.

• メニューの持つ小さなアプリケーション画面を作成するために、Ubuntuの中でグローバルメニューの機能を削除するには、次のコマンドを使用します。

sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt

スクリーンショットを翻訳¶

Here are some hints to create screenshots for your translated user guide. They will go into ./resources/<your language>/user_manual/

• same environment for all the screen caps (same OS, same decoration, same font size)
• use the QGIS -projects included in QGIS-Documentation repository (in ./qgis_projects ). These were used to produce the ‘original’ screenshots in the manual. The QGIS Sample Data (aka Alaska Dataset) should be placed in the same folder as the QGIS-Documentation Repository.
• same size as the english ‘original’ screenshots, otherwise they will be stretched and look ugly. If you need to have a different size due to longer ui strings, don’t forget to change the dimension in the rst code of your language.
• reduce the window to the minimal space needed to show the feature (taking all the screen for a small modal window > overkill)
• the less clutter, the better (no need to activate all the toolbars)
• don’t resize them in an image editor, the size will be set into the rst files (downscaling the dimensions without properly upping the resolution > ugly)
• cut the background
• save them in png (no jpeg artifacts)
• the screenshot should show the content according to what is described in the text