ヘルプドキュメントのスタイル

Sumo Logic のヘルプでは、以下のドキュメントテキストの表記規則が使用されています。

検索構文、クエリ、パラメーター、およびファイル名は、Regular Code Font で表示されます。

必須の引数は、山括弧 < > で囲まれます。
省略可能な引数は、角括弧 [ ] で囲まれます。

例

| parse [field=<field_name>] "<start_anchor>*<stop_anchor>" as <field> [nodrop]

必須の引数は、<start_anchor>、<stop_anchor>、および <field> です。
省略可能な引数は、[field=<field_name>]、および [nodrop] 省略可能です。

複数の指定が可能な引数には、省略記号 ... が表示され、別の引数を追加できることが示されます。

例

concat(<field1>, <field2>[, <field3>, ...]) as <field>

太字テキストは、操作するユーザインターフェイスの要素を表します。例:

(メニューを続けて選択する場合は、> の記号を使用します)。

また、次の項目にも太字テキストを使用します。

重要なポイントに注目を引くために、何種類かの注意書きを使用しています。