3. 記述ルール

このセクションでは、このマニュアルを通して使われている、一貫した記述ルールについて説明します。

3.1. GUI 記述ルール

グラフィカルユーザインタフェース (GUI) の記述スタイルは、GUIの見た目に似せるように意図されています。このスタイルは一般的にツールチップが表示されていない状態を反映しています。このためユーザはGUIの外観をざっと眺めるだけで、マニュアルの指示と同じものを見つけることができます。

  • メニューのオプション: レイヤ►ラスタレイヤの追加設定►ツールバー ►デジタル化

  • ツール: addRasterLayer ラスタレイヤの追加

  • ボタン: デフォルトとして保存

  • ダイアログボックスの見出し: レイヤプロパティ

  • タブ: 一般情報

  • チェックボックス checkbox 描画

  • ラジオボタン: radioButtonOn Postgis SRID radioButtonOff EPSG ID

  • 数値を選択: selectNumber

  • 文字を選択: selectString

  • ファイルの一覧から選択: ...

  • 色の選択: selectColor

  • スライダー: slider

  • テキストの入力: inputText

影がついているものは、クリック可能なGUIコンポーネントであることを表しています。

3.2. テキストやキーボードの記述ルール

このマニュアルでは、クラスやメソッドなど異なるエンティティを識別するために、テキストやキーボードショートカット、コーディングに関連するスタイルも使われています。これらのスタイルはQGISでの実際のテキストやコードの外観には一切対応していません。

  • ハイパーリンク: https://qgis.org

  • キーの組み合わせ: Ctrl+B を押す : これはCtrl キーを押したまま、Bキーを押すことを意味します。

  • ファイル名: lakes.shp

  • クラス名: NewLayer

  • メソッド: classFactory

  • サーバー: myhost.de

  • ユーザー入力テキスト: qgis --help

プログラムのコードは固定幅フォントで表示されます。

PROJCS["NAD_1927_Albers",
  GEOGCS["GCS_North_American_1927",

3.3. プラットフォーム固有の指示

GUIでのひとつづきの操作で、文字も少ない場合は、インラインで(行内で)フォーマットされます。たとえば: nix win ファイル osx QGIS ► 終了してQGISを閉じる をクリック —— これは「Linux、UnixおよびWindowsプラットフォーム上では最初に [ファイル] メニューをクリックしてそれから [終了] する」こと、一方「macOSプラットフォーム上では最初に [QGIS] メニューをクリックしてそれから [終了] する」ことを示しています。

文字が多くなる場合はリストとしてフォーマットされることもあります。

  • nix Linux・Unixではこうします

  • win Windowsではこうします

  • osx macOSではこうします

または、段落としてフォーマットされることもあります。

nix osx これはLinux・Unix・macOSプラットフォーム向けの解説です。文章中の解説手順に基づいて作業してください。

win これはWindowsプラットフォーム向けの解説です。文章中の解説手順に基づいて作業してください。

ユーザーガイド中のスクリーンショットはいろいろなプラットフォームで作成されています。