1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
<refentry id="PangoMarkupFormat" revision="23 Oct 2000">
<refmeta>
<refentrytitle>Pango Text Attribute Markup</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>Pango Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Pango Text Attribute Markup</refname><refpurpose>Simple
markup language to encode text plus a <link linkend="PangoAttrList">PangoAttrList</link></refpurpose>
</refnamediv>
<refsect1>
<title>Pango Text Attribute Markup Language</title>
<para>
Frequently, you want to display some text to the user with attributes
applied to part of the text (for example, you might want bold or
italicized words). With the base Pango interfaces, you could create a
#PangoAttrList and apply it to the text; the problem is that you'd
need to apply attributes to some numeric range of characters, for
example "characters 12-17." This is broken from an
internationalization standpoint; once the text is translated, the word
you wanted to italicize could be in a different position.
</para>
<para>
The solution is to include the text attributes in the string to be
translated. Pango provides this feature with a small markup language.
You can parse a marked-up string into the string text plus a
<link linkend="PangoAttrList">PangoAttrList</link> using the function
pango_parse_markup().
</para>
<para>
A simple example of a marked-up string might be:
<literal>"<span foreground="blue" size="100">Blue text</span> is <i>cool</i>!"</literal>
</para>
<para>
The root tag of a marked-up document is <markup>, but
pango_parse_markup() allows you to omit this tag, so you will most
likely never need to use it. The most general markup tag is
<span>, then there are some convenience tags. <span> has
the following attributes:
<variablelist><title><span> attributes</title>
<varlistentry><term>font_desc</term>
<listitem><para>
A font description string, such as "Sans Italic 12"; note that any other
span attributes will override this description. So if you have "Sans
Italic" and also a style="normal" attribute, you will get Sans normal,
not italic.
</para></listitem>
</varlistentry>
<varlistentry><term>font_family</term>
<listitem><para>
A font family name
</para></listitem>
</varlistentry>
<varlistentry><term>face</term>
<listitem><para>
Synonym for font_family
</para></listitem>
</varlistentry>
<varlistentry><term>size</term>
<listitem><para>
Font size in 1000ths of a point, one of the absolute sizes
'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large',
'xx-large', or one of the relative sizes 'smaller' or 'larger'.
</para></listitem>
</varlistentry>
<varlistentry><term>style</term>
<listitem><para>
One of 'normal', 'oblique', 'italic'
</para></listitem>
</varlistentry>
<varlistentry><term>weight</term>
<listitem><para>
One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy',
or a numeric weight
</para></listitem>
</varlistentry>
<varlistentry><term>variant</term>
<listitem><para>
'normal' or 'smallcaps'
</para></listitem>
</varlistentry>
<varlistentry><term>stretch</term>
<listitem><para>
One of 'ultracondensed', 'extracondensed', 'condensed',
'semicondensed', 'normal', 'semiexpanded', 'expanded',
'extraexpanded', 'ultraexpanded'
</para></listitem>
</varlistentry>
<varlistentry><term>foreground</term>
<listitem><para>
An RGB color specification such as '#00FF00' or a color name such as
'red'
</para></listitem>
</varlistentry>
<varlistentry><term>background</term>
<listitem><para>
An RGB color specification such as '#00FF00' or a color name such as
'red'
</para></listitem>
</varlistentry>
<varlistentry><term>underline</term>
<listitem><para>
One of 'single', 'double', 'low', 'none'
</para></listitem>
</varlistentry>
<varlistentry><term>rise</term>
<listitem><para>
Vertical displacement, in 10000ths of an em. Can be negative for
subscript, positive for superscript.
</para></listitem>
</varlistentry>
<varlistentry><term>strikethrough</term>
<listitem><para>
'true' or 'false' whether to strike through the text
</para></listitem>
</varlistentry>
<varlistentry><term>lang</term>
<listitem><para>
A language code, indicating the text language
</para></listitem>
</varlistentry>
</variablelist>
</para>
<para>
The following convenience tags are provided:
<variablelist><title>Convenience tags</title>
<varlistentry><term>b</term>
<listitem><para>
Bold
</para></listitem>
</varlistentry>
<varlistentry><term>big</term>
<listitem><para>
Makes font relatively larger, equivalent to <span size="larger">
</para></listitem>
</varlistentry>
<varlistentry><term>i</term>
<listitem><para>
Italic
</para></listitem>
</varlistentry>
<varlistentry><term>s</term>
<listitem><para>
Strikethrough
</para></listitem>
</varlistentry>
<varlistentry><term>sub</term>
<listitem><para>
Subscript
</para></listitem>
</varlistentry>
<varlistentry><term>sup</term>
<listitem><para>
Superscript
</para></listitem>
</varlistentry>
<varlistentry><term>small</term>
<listitem><para>
Makes font relatively smaller, equivalent to <span size="smaller">
</para></listitem>
</varlistentry>
<varlistentry><term>tt</term>
<listitem><para>
Monospace font
</para></listitem>
</varlistentry>
<varlistentry><term>u</term>
<listitem><para>
Underline
</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
</refentry>
|
