Cours DocBook accelere

10.2. Éléments d'interface GUI

Accel - Touche utilisée avec une touche meta pour activer une Interface Utilisateur Graphique (GUI)
KeyCap - Texte imprimé par une touche physique de clavier d'ordinateur, pas nécessairement la même chose que KeyCode
KeyCode - Désignation numérique d'une touche sur un clavier d'ordinateur
KeyCombo - Combinaison d'actions de saisie
KeySym - Nom de symbole de touche, pas nécessairement la même chose que KeyCap
MenuChoice - Sélection de menu ou de séries
MouseButton - Nom conventionnel d'un bouton de souris
Interface - Élément de GUI
InterfaceDefinition - Nom complet ou court d'une spécification formelle d'un GUI
GUIButton - Texte sur un bouton dans un GUI
GUIIcon - Graphique et/ou texte apparaissant comme icône dans un GUI
GUILabel - Texte dans un GUI
GUIMenu - Nom de menu dans un GUI
GUIMenuItem - Nom d'un menu de terminal dans un GUI
GUISubmenu - Nom d'un sous-menu dans un GUI
Action - Fonction invoquée en réponse à une action utilisateur

On peut parfois dire qu'il y a de trop nombreuses balises dans DocBook pour décrire les éléments de GUI. La plupart des balises ci-dessus peuvent être utilisées dans une varitété de contextes, mais quelques unes, comme <keycap>, doivent utilisées dans d'autres balises. L'exemple ci-dessous ne présentera pas toutes les balises décrites au-dessus. Cette liste est faite pour votre commodité car la Référence DocBook ne groupe pas les balises par leur fonction.

Toutes les balises GUI peuvent être utilisées dans un contexte de paragraphe normal. Si vous voulez parler d'une icône de corbeille ou d'un bouton de corbeille vide, vous utiliserez simplement les balises <guiicon> et <guibutton> comme ceci : <guiicon>Trash</guiicon> icon, <guibutton>Empty Trash</guibutton> button. Notez que toutes les balises GUI peuvent aussi contenir des graphiques dans le corps du texte.

Ci-dessous, un exemple un peu plus compliqué d'une utilisation de balise GUI.

Exemple 10-5. guimenu et shortcut


<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>n</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>New</guimenuitem>
</menuchoice></term>
<listitem><para><action>Creates a new document</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>s</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save</guimenuitem>
</menuchoice></term>
<listitem><para><action>Saves the document</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quits</action> application>Kapp</application></para></listitem>
</varlistentry>
</variablelist>
 

J'espère que vos yeux ne clignotent pas à la vue de toutes ces balises ! La partie la plus compliquée de cet exemple est la balise <Shortcut> qui désigne les raccourcis clavier des éléments de menus. Les raccourcis contiennent soit une KeyCombo ou une simple KeyCap contenant la touche ou le groupe de touches à presser pour invoquer le menu depuis le clavier. Il est important d'utiliser les balises KeyCombo et KeyCap dans les balises Shortcut car il est incorrect d'utiliser les caractères de données (le texte Ctrl-q par exemple) dans un raccourci. .

D'autres balises de l'exemple qui doivent être mentionnées sont menuchoice, action et application. Menuchoice désigne un choix de menu et contient en raccourci (si besoin est) le nom du menu dans le GUI et le nom du menuitem dans guimenuitem. Action désigne une phrase qui décrit ce que fait menuitem (ou un autre élément d'interface). Application est une balise utilisée pour désigner les noms d'applications.

L'exemple, une fois converti :

File->New (Ctrl-n)

Creates a new document

File->Save (Ctrl-s)

Saves the document

File->Quit (Ctrl-q)

Quits Kapp