記述ルール

このセクションではこのマニュアル全般にわたる統一した記述ルールについて列挙します。このマニュアルで利用する記述ルールは以下のとおりです:

GUI 記述ルール

GUIの記述スタイルはGUIの外観をまねるように意図されています。一般的に これの目的は non-hover の外観を利用することです,ですからユーザーはGUIの外観を見てマニュアルの操作手引きと同じようなものを見出せます 。

• メニューオプション: レイヤ ラスタレイヤの追加

  または

  設定 ツールバー   ▸ ✓ デジタイジング

• ツール: ラスタレイヤの追加r
• ボタン : デフォルトとして保存
• ダイアログボックスタイトル: レイヤプロパティ
• タブ: 一般情報
• ツールボックス :   nviz - Open 3D-View in NVIZ
• チェックボックス: Render
• ラジオボタン: Postgis SRID EPSG ID
• 数値の選択: Hue 60
• 文字列の選択: Outline style  —Solid Line
• ファイルブラウズ: …
• 色の選択: Outline color 
• スライダ: Transparency 10% 020mm
• テキストの入力: Display Name  lakes.shp

影はクリック可能なGUIコンポーネントを表します。

テキストまたはキーボードについての記述ルール

このマニュアルではテキストに関するスタイル、キーボードコマンド、クラスやメソッドのコーディングを別のエンティティにするスタイルを含みます。これらは実際の見かけには依存しません。

• ハイパーリンク: http://qgis.org
• キーボード押下の組み合わせ: press Ctrl+B , これはCtrlキーを押しながらBキーを押すことを表します。
• ファイルの名前: lakes.shp
• クラスの名前: NewLayer
• メソッド: classFactory
• サーバー: myhost.de
• ユーザーテキスト: qgis –-help

コードは固定長フォントで表記されます:

プラットフォーム依存の操作

プラットフォームごとの操作が単語レベルで異なる場合には、次のようにインライン形式で記述します: QGISを終了するには、{ File QGIS} メニュー下にあるQuitをクリックしてください。

これはLinux, Unix と Windows プラットフォームではファイルメニューオプションを最初にクリックしてからドロップダウンメニューから終了することを示します。また, Macintosh OSX プラットフォームでは,QGISメニューオプションを最初にクリックしてドロップダウンメニューから終了することを示しています。 より文字数の多い箇所では次のようにリスト形式で表示します:

• この画像で示される部分は、Linux, Unixプラットフォーム向けの解説です。
• この画像で示される部分は、Windowsプラットフォーム向けの解説です。
• この画像で示される部分は、Macintosh OSXプラットフォーム向けの解説です。

次のように、パラグラフの先頭に付けて区別することもあります。

Linux、Unix、Macintosh OSXプラットフォーム向けの解説です。文章中の解説手順に基づいて作業してください。

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

ユーザーガイド中のスクリーンショットはいろいろなプラットフォームで作成されています。その時のプラットフォームはプラットフォームの種別を示すアイコンが図のキャプションの最後に表示されます。