規約

ユーザーの皆様にさらにご理解いただけるように、本文書全体で特定のフォーマッティング規約を使用しています。使用される書式規則を以下に示します。

ユーザー ガイドの表記規則

要素

表記

説明

出力

一般的な強調

プログラム ワークスペース内。

特定のテキスト要素を目立たせる、またはハイライト表示します。

太字のテキスト

グラフィカル ユーザー インターフェイス (GUI) 項目

機能ボタンを選択します。

GUI の画面上にある項目に関する記載 (コマンド ボタン、アイコン名、フィールド名など)。

太字のテキスト

グラフィカル ユーザー インターフェイス (GUI) パス >

一般に、GUI の上部にあります。

GUI 内の場所を追跡するナビゲーション補助。

例:コントローラ > プログラム > 編集

ユーザー入力

プログラムの説明を入力します。

ユーザーが入力する任意のテキスト。

太字のテキスト

ファイル名

エクスポートするファイル名を入力します。

システムからエクスポートまたはインポートされたファイル。

太字斜体のテキスト

変数およびパラメーターの名前

エクスポートの名前を入力します。

変数名とパラメーター名 (値ではありません)。

斜体のテキスト

変数およびパラメーターの値

エクスポートのを入力します。

変数とパラメーターの値。

太字大文字のテキスト

システム出力

Client.Domain.Models.ExportImportConfiguration

システムによって出力される任意のテキスト。

等幅のテキスト

外部リンク

文書または対象のコンテンツに関連する情報がある外部サイトへのリンク。これには、次のようなものがあります:

  • 技術製品データ

  • 寸法図面

  • アクセサリ

  • 製品特定情報

外部サイトへの選択可能なテキスト

内部ドキュメントへのリンク

  • 関連情報 - 現在のトピックに直接関連し、行われた特定の構成について考慮する必要がある情報へのリンク。

  • 本セクション内 - セクション内のすべてのトピックへのリンクです。機能や構成を理解する際に役立ちます。

ある場合、これらのリンクはテキストの下に表示されます。

内部コンテンツへの選択可能なテキスト