Conventions typographiques

Les noms des boutons, champs, fenêtres, zones de texte, icônes, éléments de contrôle, colonnes, indicateurs, masques de connexion, etc. apparaissent en gras dans le texte descriptif.

L'italique est utilisé pour :

• Les noms de produits et de programmes
• Les noms d'autres documents, chapitres, titres de livres
• La sélection d'énumérations (telles que menus déroulants, radio boutons, listes à cocher, cases à cocher). Notez que le nom de ces zones de menus déroulants, boutons radio etc. sont écrits en gras.

IMAGE:TOOLS\BS2_TAR

Dans le texte descriptif, les dossiers du CDROM AE sont écrits en majuscules sous la forme IMAGE:DOSSIER. IMAGE: représente la lettre du lecteur de CDROM suivie du nom de dossier qui correspond à la version d'AE.

Exemple : IMAGE:TOOLS\BS2_TAR correspond à R:\11.0.0\TOOLS\BS2_TAR

<system>AE</system>

Ce formatage représente des extraits de fichiers (par exemple des rapports ou des fichiers de configuration).

L'instruction de script et les noms de fonctions sont écrits en caractères gras. Les instructions de script commencent par deux-points.

Certaines instructions de script et certaines fonctions peuvent être sous forme longue ou abrégée. Si c'est le cas, l'instruction de script ou la fonction est indiquée avec le texte facultatif de sa forme longue entre crochets [ ]. Par exemple, l'instruction de script :PRINT est indiquée par :P[RINT]. Selon vos besoins, elle peut être écrite :PRINT ou :P.

Les paramètres obligatoires sont écrits en caractères rouge foncé gras et italiques. Par exemple, Object name.

Dans certains cas, un ou plusieurs sous-ensembles de paramètres sont obligatoires. Dans ce cas, les paramètres sont écrits en caractères rouge foncé, gras et italiques et se trouvent entre crochets. Par exemple, vous devez définir un nom de tâche ou un numéro d'exécution pour la fonction de script MODIFY_TASK.

MODIFY_TASK (RunID, [task name], [running number], REPLACE_TASK , object name [, EXTERNAL , Nom du Workflow])

Les caractères spéciaux obligatoires, comme les parenthèses ouvertes et fermées ou le signe égal, sont écrits en caractères rouge foncé, gras et italiques. Dans l'exemple ci-dessous, = est un qualificateur obligatoire entre les paramètres obligatoires Propriété et Valeur.

:MODIFY_STATEProperty=Value

Les paramètres facultatifs sont écrits entre crochets [ ] et en italique; par exemple, [Date].

Si des paramètres facultatifs multiples doivent être utilisés en même temps, ils sont rassemblés dans les mêmes crochets; par exemple [Calendrier, Règle de calendrier].

Les paramètres mot-clés sont écrits en gras; par exemple, VERSION. Lorsqu'ils sont facultatifs, les paramètres mot-clés sont aussi entre crochets; par exemple [TERMINATE]. Le texte d'un paramètre mot-clé doit être saisi exactement comme il est présenté.

Certains paramètres mot-clés peuvent être sous forme longue ou abrégée. Dans ce cas, le paramètre mot-clé est indiqué avec le texte facultatif de sa forme longue entre crochets [ ]. Par exemple, le paramètre mot-clé STR_SUBSTITUTE_VAR est indiqué STR_SUBSUB[STITUTE]_VAR. Selon vos besoins, il peut être écrit STR_SUBSTITUTE_VAR ou STR_SUB_VAR.

Les virgules séparent les paramètres d'éléments de script. Les éléments de script sont évalués dans l'ordre dans lequel ils sont inscrits. Dans l'exemple ci-dessous présentant la syntaxe, les virgules séparent chaque paramètre de la fonction de script CREATE_OBJECT.

CREATE_OBJECT(Object Type, Object Name, [Folder], [Title])

Si vous ne voulez pas indiquer une valeur pour un paramètre facultatif, il ne faut rien saisir ou mettre un espace entre les virgules. Par exemple, pour ne pas spécifier de dossier, il ne faut rien saisir entre la troisième et la quatrième virgule :

:SET&RET# = CREATE_OBJECT("CALE","FIRM.CALENDAR2015",,"Firm calendar for 2015")

Si vous avez spécifié des valeurs pour tous les paramètres obligatoires, et que vous ne voulez pas inclure des valeurs pour les paramètres facultatifs restants, vous n'aurez pas besoin de saisir des virgules pour ces derniers. Par exemple, comme ci-dessous, si vous voulez créer un objet sans spécifier de dossier ou de titre, vous devrez placer des parenthèses fermantes après le paramètre du nom d'objet :

:SET &RET# = CREATE_OBJECT("CALE","FIRM.CALENDAR2015")

Avertissement, indique d'éventuels problèmes.

Informations complémentaires, remarques.

Étapes ne pouvant être réalisées que par des administrateurs.

Signale une étape. Une étape d'installation, par exemple.

Signale des particularités qui proviennent des spécifications du système d'autorisations (telles que les privilèges ou les droits).