1
<page xmlns="http://projectmallard.org/1.0/"
3
id="mal_inline_guiseq">
6
<link type="guide" xref="mal_inline#elements"/>
7
<link type="seealso" xref="mal_inline_gui"/>
9
<revision version="0.1" date="2008-12-16" status="review"/>
11
<credit type="author">
12
<name>Shaun McCance</name>
13
<email>shaunm@gnome.org</email>
16
<year>2008-2009</year>
17
<name>Shaun McCance</name>
20
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" />
22
<desc>Mark up a sequence of interface controls to navigate.</desc>
25
<title>GUI Sequences</title>
27
<synopsis><code mime="application/relax-ng-compact-syntax">
28
mal_inline_guiseq = element guiseq {
29
attribute style { xsd:NMTOKENS } ?,
30
attribute * - (mal:* | local:*) { text } *,
32
mixed { <link xref="mal_inline_gui">mal_inline_gui</link> + }
36
<p>Use the <code>guiseq</code> element to mark up a sequence of graphical
37
interface elements. This is typically used to present a sequence of menu
45
<item><p>The <code>guiseq</code> element can contain a mixture of text and
46
<code xref="mal_inline_gui">gui</code> elements.</p></item>
48
<item><p>The <code>guiseq</code> element can occur in any
49
general inline context, including inside most
50
<link xref="mal_inline">inline elements</link>, some
51
<link xref="mal_block#basic">basic block elements</link>, and certain
52
<link xref="mal_info">informational elements</link>.</p></item>
54
<item><p>The <code>style</code> attribute takes a space-separated list of
55
style hints. Processing tools should adjust their behavior according to
56
those style hints they understand.</p></item>
58
<item><p>The <code>guiseq</code> element can have attributes from external
59
namespaces. See <link xref="mal_external"/> for more information
60
on external-namespace attributes.</p></item>
66
<!-- BEGIN examples -->
67
<section id="examples">
68
<title>Examples</title>
70
<p>Use <code>guiseq</code> to mark up a sequence of menu items:</p>
74
Select <guiseq><gui>File</gui><gui>New</gui></guiseq> to open
77
<p>Select <guiseq><gui>File</gui><gui>New</gui></guiseq> to open
84
<!-- BEGIN processing -->
85
<section id="processing">
86
<title>Processing Expectations</title>
88
<p>Each of the child <code>key</code> elements and text nodes, except
89
whitespace-only text nodes, is displayed as described below, adding a
90
separator between them. The exact separator may vary according to the
91
language and style preferences, but it will typically be some sort of
92
right-pointing arrow or triangle, or left-pointing for right-to-left
95
<p>Child <code>gui</code> elements are shown as normal. Text nodes
96
have their whitespace normalized to strip leading and trailing spaces.
97
Text nodes may be rendered using a font variation.</p>
99
<!-- END processing -->
102
<!-- BEGIN comparison -->
103
<section id="comparison">
104
<title>Comparison to Other Formats</title>
105
<p>The <code>guiseq</code> element is similar to the
106
<code href="http://www.docbook.org/tdg/en/html/menuchoice.html">menuchoice</code>
107
element in DocBook. Since Mallard does not provide different elements for
108
different types of interface elements, the contents of <code>guiseq</code>
109
are all <code>gui</code> elements or text. Currently, Mallard does not
110
provide a way to encode shortcut keys like the
111
<code href="http://www.docbook.org/tdg/en/html/shortcut.html">shortcut</code>
112
element in DocBook. It is recommended that shortcuts, when necessary, be
113
written into prose separately.</p>
115
<!-- END comparison -->
added
removed
doc/mallard/C/mal_inline_guiseq.page
