Utiliser les conventions de format pour les conseils techniques et autres contenus

Introduction

Ce document décrit les formats des conventions de texte, d'image et de commande utilisés dans les conseils techniques et le contenu de Cisco.

Conventions générales

Les conventions générales doivent être respectées pour :

• Texte
• Alertes et icônes
• Commandes du logiciel Cisco IOS®
• Exemples de configuration
• Adresses IP (veuillez être prudent ici.)
• Commentaires dans les blocs de code

Texte

• Le gras indique du texte que l'utilisateur doit entrer ou sélectionner, tel que des éléments de menu, des boutons et des commandes.

• Les italiques permettent d'insister sur du texte.

• Le crochet d'angle avant ( >) indique la progression des choix de menu que l'utilisateur doit sélectionner dans une interface graphique utilisateur (GUI), telle que Fichier > Imprimer.

• Les exemples de sortie des périphériques Cisco sont affichés en police Courier ; par exemple (les commandes sont en gras, n'utilisent pas d'autre couleur que le noir) :

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
!

• Les messages d'erreur système des périphériques Cisco sont affichés en police Courier ; par exemple :

• Un routeur redémarré avec la commande reload affiche le message System return to ROM by reload.

Messages d'alerte et icônes

Note : Signifie que le lecteur prend note. Les notes contiennent des suggestions utiles ou des références à des éléments non traités dans le document. Il est recommandé de lire les notes de l'article.

Conseil : ces informations peuvent vous aider à résoudre un problème. Les informations de conseils ne peuvent pas être une suggestion de dépannage d'informations ou même une action, mais peuvent être des informations utiles. Les conseils sont facultatifs.

Attention : signifie que le lecteur doit être prudent. Dans ce cas, votre action peut entraîner des dommages matériels ou la perte de données. Vous devez lire les instructions Attention.

Avertissement : Avertissement signifie danger. Vous êtes dans une situation qui pourrait entraîner une blessure corporelle. Avant de travailler sur un équipement, vous devez être conscient des dangers liés aux circuits électriques. Vous devez être familier avec les pratiques standard de prévention des accidents. Pour consulter les versions traduites de l'avertissement, reportez-vous au document Conformité aux réglementations et sécurité qui accompagnait votre périphérique. Vous devez lire les instructions d'avertissement.

Icône de sortie  indique que vous êtes sur le point de quitter le site Web de Cisco. Cette image apparaît à la fin d'un lien vers des sites Web externes à Cisco.com et s'ouvre dans une fenêtre de navigateur distincte. Cisco n'est pas responsable du contenu d'autres sites Web. 

Commandes du logiciel Cisco IOS^®

Les conventions suivantes relatives aux commandes Cisco IOS sont également utilisées dans les guides de référence des commandes. Pour plus d'informations sur les conventions dans la documentation Cisco IOS, référez-vous au Guide de style de contenu technique Cisco . 

• Les barres verticales ( | ) des arguments alternatifs distincts, mutuellement exclusifs. Exemple : req-qos {best-effort | controllé-load | garanti-delay}

• Les crochets ([]) indiquent les éléments facultatifs. Exemple : [no] ip route-cache [cbus]

• Les accolades ({}) indiquent un choix obligatoire. Exemple : numéro de liste d'accès [{permit | deny}]

• Les accolades dans les crochets ([{}]) indiquent des choix obligatoires dans des éléments facultatifs.

• Les chevrons (< >) indiquent des arguments dans des contextes qui n'autorisent pas les italiques, et dans les exemples indiquent des chaînes de caractères entrées par un utilisateur qui n'apparaissent pas à l'écran (par exemple, un mot de passe).

• Le gras indique des commandes et des mots clés.

• Les italiques indiquent des variables utilisateur.

Exemples de configuration

Les noms du routeur, les noms d'hôte, les noms d'utilisateur, les mots de passe et les adresses IP sont utilisés dans les exemples de configuration. Vous devez les remplacer par les noms, mots de passe et adresses appropriés pour votre entreprise.

Attention : n'utilisez pas le nom d'utilisateur cisco ou le mot de passe cisco dans vos configurations. L'utilisation de cisco comme mot de passe ou nom d'utilisateur, ou d'un mot de passe trivial, est un risque de sécurité. Notez également qu'il n'est pas recommandé d'inclure Cisco dans le titre de l'article.

• Noms des routeurs : RouterX, nasX, etc.

• Numéros de téléphone : 555nnnn

Adresses IP 

Attention : les adresses IP sont conformes aux définitions RFC 1918 des adresses réseau privées. Voir image ci-dessous. Il y a eu une violation récente en raison d'une adresse IP client exposée dans un article Cisco.com. Soyez prudent lorsque vous incluez une adresse IP n'importe où dans votre article. Recherchez dans vos images les adresses IP qui pourraient être en violation de cette règle.

Trois blocs d'adresse IP sont réservés par l'Internet Assigned Numbers Authority (IANA) pour les internet privés :

• Plage : 10.0.0.0 - 10.255.255.255 (préfixe 10/8)

• Plage : 172.16.0.0 - 172.31.255.255 (préfixe 172.16/12)

• Plage : 192.168.0.0 - 192.168.255.255 (préfixe 192.168/16)

Référence des adresses IP

Adresses IP réservées à la documentation publique

Commentaires dans les blocs de code

Souvent des commentaires sont inclus dans les exemples de configuration. Les commentaires sont en italique. Elles doivent être affichées en noir uniquement ; les couleurs sont inacceptables sauf lorsqu'elles apparaissent dans une capture d'écran. Ils fournissent des compléments d'information au sujet de la sortie de configuration et des commandes utilisées. Les commentaires de configuration ressemblent à :

!--- 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 

Remarque : il est recommandé de raccourcir les exemples de blocs de code afin qu'aucun curseur ne s'affiche à la fin de l'exemple.

Informations connexes

• RFC 1918
• Guide de style du contenu technique Cisco
• Assistance technique et téléchargements Cisco