テクニカルティップスとその他のコンテンツの形式規則を使用する

概要

このドキュメントでは、シスコのテクニカルティップスとコンテンツで使用されるテキスト、イメージ、およびコマンド表記法の形式について説明します。

一般的な表記法

次の場合は、一般的な規則に従う必要があります。

• テキスト
• アラートとアイコン
• Cisco IOS®ソフトウェアのコマンド
• 設定例
• IPアドレス（ここでは注意してください）
• コードブロック内のコメント

テキスト

• 太字はユーザが入力または選択するテキストを表しています。メニュー項目、ボタン、コマンドなどです。

• 斜体は強調を意味します。

• 前方角カッコ(>)は、[ファイル] > [印刷]など、グラフィカルユーザインターフェイス(GUI)でユーザが選択する必要があるメニュー選択の進行状況を示します。

• シスコデバイスからの出力例は、Courierフォントで表示されます。例（コマンドは太字で表示され、黒以外の色は使用されません）。

3524xl# show running-config
Building configuration...

Current configuration:

!
version 12.0
no service pad
service timestamps debug uptime
service timestamps log uptime
no service password-encryption
!

• シスコデバイスからのシステムエラーメッセージは、Courierフォントで表示されます。次に例を示します。

• reload コマンドによって再起動されたルータは、「System returned to ROM by reload」というメッセージを表示します。

アラートメッセージとアイコン

注：読者が注意を払うことを意味します。役立つ情報や、このマニュアル以外の参照資料などを紹介しています。記事内の注を読むことをお勧めします。

ヒント：この情報は、問題の解決に役立ちます。ヒント情報は、情報やアクションのトラブルシューティングに推奨される方法ではありませんが、有用な情報になる可能性があります。ヒントはオプションです。

注意：注意が必要です。この状況では、操作によって機器の損傷やデータの損失が発生する可能性があります。注意に関する記述を読む必要があります。

警告：警告は危険を意味します。身体が負傷する可能性のある状況であることを意味しています。機器の作業を行う前に、電気回路に関連する危険に注意する必要があります。事故を防止するための標準的な方法に精通している必要があります。警告の翻訳版を確認するには、デバイスに付属の『Regulatory Compliance and Safety』を参照してください。 警告ステートメントを読む必要があります。

終了アイコン  は、Cisco Webサイトを終了しようとしていることを示しています。このイメージは、Cisco.com外部のWebサイトへのリンクの最後に表示され、別のブラウザウィンドウで開きます。 Cisco では、他の Web サイトのコンテンツに関する責任を負いません。 

Cisco IOS^®ソフトウェアのコマンド

Cisco IOSコマンドの次の表記法は、コマンドリファレンスガイドでも使用されています。Cisco IOSドキュメントの表記法の詳細は、『シスコテクニカルコンテンツスタイルガイド』を参照してください。 

• 縦線（ | )は、相互に排他的な代替引数を分離します。例： req-qos {best-effort | controlled-load | guaranteed-delay}

• 角カッコ（[ ]）は、オプションの要素を示します。例： [no] ip route-cache [cbus]

• 波カッコ（{ }）は、必須選択事項を示します。例：access-list number [{permit | deny}]

• 角カッコの内側の波カッコ（[{ }]）は、オプションの要素の中に必須選択事項があることを示します。

• かぎカッコ（< >）は、コンテキスト内でイタリック体を使用できない引数を示すほか、例においてユーザが入力する文字列で、画面には表示されないものを表します（パスワードなど）。

• 太字はコマンドとキーワードを意味します。

• 斜体はユーザの変数を意味します。

設定例

設定例では、一般的なルータ名、ホスト名、ユーザ名、パスワード、および IP アドレスが使用されます。これらは、会社に適した名前、パスワード、およびアドレスに置き換える必要があります。

注意：設定では、ユーザ名ciscoまたはパスワードciscoを使用しないでください。ciscoをパスワードまたはユーザ名として使用したり、簡単なパスワードを使用したりすると、セキュリティ上のリスクが生じます。また、記事のタイトルにCiscoを含めることはお勧めできません。

• ルータ名：RouterX、nasXなど。

• 電話番号： 555nnnn

[IP アドレス（IP Addresses）]

注意:IPアドレスは、プライベートネットワークアドレスのRFC 1918の定義に準拠しています。See Image Below.Cisco.comの記事にクライアントのIPアドレスが記載されていることから、最近のセキュリティ侵害が発生しています。記事のどこかにIPアドレスを含める場合は、慎重に判断してください。イメージをチェックして、これに違反する可能性のあるIPアドレスがないか確認します。

IP アドレスの 3 つのブロックは、プライベート インターネットとして Internet Assigned Numbers Authority（IANA）によって予約されています。

• 範囲：10.0.0.0 ～ 10.255.255.255（10/8プレフィクス）

• 範囲：172.16.0.0 ～ 172.31.255.255（172.16/12プレフィクス）

• 範囲：192.168.0.0 ～ 192.168.255.255（192.168/16プレフィクス）

IPアドレス参照

公開文書用に予約されたIPアドレス

コードブロック内のコメント

設定例にはコメントも頻繁に記述されます。コメントは斜体で表示されます。これらは黒いテキストとしてのみ表示する必要があります。色はスクリーンショットに表示される場合以外は使用できません。コメントによって、設定の出力や使用されるコマンドについて、より詳細な説明が加えられます。設定例のコメントは、次のように記述されます。

!--- Define IPSec traffic of interest. 
!--- This line covers traffic between the LAN segment behind two PIXes. 
!--- It also covers the SNMP/syslog traffic between the SNMP/syslog server 
!--- and the network devices located on the Ethernet segment behind PIX 515.

access-list 101 permit ip 172.18.124.0 255.255.255.0 10.99.99.0 255.255.255.0 

注：コードブロックの例を短くして、例の最後にスライダが表示されないようにすることをお勧めします。

関連情報

• RFC 1918
• シスコテクニカルコンテンツスタイルガイド
• シスコテクニカルサポートおよびダウンロード