ドキュメントの表記規則

このセクションでは、AWS の技術的刊行物に共通する表記と記号の規則について説明します。

文字の表記

以下の表は、文字の表記規則をまとめたものです。

表記説明/例

コールアウト

コールアウトは、本文のテキスト内に挿入したイラストによる数字です。コールアウトの付いたテキストは、ドキュメント内の別の場所でさらに詳しく説明されています。

このリソースは定期的に使用できます。1

テキスト内のコード

インラインコードサンプル(XMLを含む)やコマンドは特殊なフォントで表記します。

コマンド java -versionを使用できます。

コードブロック

サンプルコードのブロックは、本文との区別のため、全体を別のスタイルで表記します。

# ls -l /var/www/html/index.html
-rw-rw-r--  1 root root 1872 Jun 21 09:33 /var/www/html/index.html
# date
Wed Jun 21 09:33:42 EDT 2006

強調

特別な意味を持つ語句や重要な語句は、特殊なフォントで表記します。

このサービスを利用するには、アカウントにサインアップする必要があります

内部の相互参照

同じドキュメント内の参照箇所を示します。

論理値、定数、正規表現、アブストラクタ

コード以外でも、前後と区別して表記すべき値などは特殊なフォントで表記します。

値が nullの場合、返されるレスポンスは falseになります。

製品名および機能名

AWS の製品名および機能名は、初出時のみ斜体で表記します。

Amazon Machine Image (AMI) を作成してください。

オペレーション

テキスト内のオペレーションの表記です。

商品リストで返される出品情報をコンディションタイプでフィルタリングするには、 GetHITResponse オペレーションで返されます。

パラメータ

パラメータに対する本文中の参照。

このオペレーションでは、パラメータAccountIDを使用できます。

レスポンス要素

レスポンスに対する本文中の参照。

1つの CollectionParent および1つまたは複数の CollectionItemsに対するコンテナ。

技術ドキュメントの参照

他の AWS ドキュメントの参照。ドキュメントの参照先がハイパーリンクされている場合には、下線付きで表記します。

コンセプトの詳細については、『Amazon Mechanical Turk Developer Guide』を参照してください。

ユーザー入力値

ユーザーがタイプ入力するテキストは、特殊なフォントで表記します。

パスワードの入力を求めるプロンプトが現れたら、MyPasswordとタイプします。

ユーザーインターフェースのコントロールとラベル

UI 上に名前付きの項目を表示して識別しやすくします。

「File」メニューでPropertiesをクリックします。

変数

サンプルのテキストをコマンドラインにコピーする際は、この書式で表記されている値を変更する必要があります。

% ec2-register <your-s3-bucket>/image.manifest

次の「記号の表記」もご参照ください。

記号の表記

以下の表は、記号の表記規則をまとめたものです。

表記記号説明/例

相互排他的なパラメータ

括弧および縦棒 ( | )

コード記述の中で、複数のオプションからひとつを選択しなければならない場合、各オプションを縦棒で区切って表記します。

% data = hdfread (start | stride | edge)

任意指定のパラメータ

XML変数テキスト

角括弧 [ ]

コード記述の中で、任意で指定するコマンドまたはパラメータは角括弧で囲みます。

% sed [-n, -quiet]

XMLの例では、前後のタグと区別するため、変数テキストを角括弧で囲みます。

<CustomerId>[ID]</CustomerId>

変数

山括弧 <>

コードサンプルでは、有効な値に置き換える変数を山括弧で囲みます。

% ec2-register <your-s3-bucket>/image.manifest