/usr/share/doc/libpango1.0-doc/pango/PangoMarkupFormat.html is in libpango1.0-doc 1.36.8-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Pango Reference Manual: Text Attribute Markup</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Pango Reference Manual">
<link rel="up" href="pango.html" title="Basic Pango Interfaces">
<link rel="prev" href="pango-Tab-Stops.html" title="Tab Stops">
<link rel="next" href="pango-Layout-Objects.html" title="Layout Objects">
<meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="pango.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="pango-Tab-Stops.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="pango-Layout-Objects.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="PangoMarkupFormat"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">Text Attribute Markup</span></h2>
<p>Text Attribute Markup — Simple
markup language to encode text with attributes</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="PangoMarkupFormatLanguage"></a><h2>Pango Text Attribute Markup Language</h2>
<p>
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
<a class="link" href="pango-Text-Attributes.html#PangoAttrList">PangoAttrList</a> 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.
</p>
<p>
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
<a class="link" href="pango-Text-Attributes.html#PangoAttrList">PangoAttrList</a> using either of
<a class="link" href="pango-Text-Attributes.html#pango-parse-markup" title="pango_parse_markup ()">pango_parse_markup()</a> or
<a class="link" href="pango-Text-Attributes.html#pango-markup-parser-new" title="pango_markup_parser_new ()">pango_markup_parser_new()</a>.
</p>
<p>
A simple example of a marked-up string might be:
<code class="literal">"<span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!"</code>
</p>
<p>
Pango uses #GMarkup to parse this language, which means that XML features
such as numeric character entities such as &#169; for © can
be used too.
</p>
<p>
The root tag of a marked-up document is <markup>, but <a class="link" href="pango-Text-Attributes.html#pango-parse-markup" title="pango_parse_markup ()">pango_parse_markup()</a> 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:
</p>
<div class="variablelist">
<p class="title"><b><span> attributes</b></p>
<table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">font<a href="#ftn.since_1_21" class="footnote" name="since_1_21"><sup class="footnote">[1]</sup></a>, </span><span class="term">font_desc</span></p></td>
<td><p>
A font description string, such as "Sans Italic 12". See
<a class="link" href="pango-Fonts.html#pango-font-description-from-string" title="pango_font_description_from_string ()">pango_font_description_from_string()</a>
for a description of the format of the string representation . 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.</p></td>
</tr>
<tr>
<td><p><span class="term">font_family, </span><span class="term">face</span></p></td>
<td><p>
A font family name
</p></td>
</tr>
<tr>
<td><p><span class="term">font_size<a href="PangoMarkupFormat.html#ftn.since_1_21" class="footnoteref"><sup class="footnoteref">[1]</sup></a>, </span><span class="term">size</span></p></td>
<td><p>
Font size in 1024ths of a point, or 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'.
If you want to specify a absolute size, it's usually easier
to take advantage of the ability to specify a partial
font description using 'font'; you can use
<code class="literal">font='12.5'</code> rather than
<code class="literal">size='12800'</code>.
</p></td>
</tr>
<tr>
<td><p><span class="term">font_style<a href="PangoMarkupFormat.html#ftn.since_1_21" class="footnoteref"><sup class="footnoteref">[1]</sup></a>, </span><span class="term">style</span></p></td>
<td><p>
One of 'normal', 'oblique', 'italic'
</p></td>
</tr>
<tr>
<td><p><span class="term">font_weight<a href="PangoMarkupFormat.html#ftn.since_1_21" class="footnoteref"><sup class="footnoteref">[1]</sup></a>, </span><span class="term">weight</span></p></td>
<td><p>
One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy',
or a numeric weight
</p></td>
</tr>
<tr>
<td><p><span class="term">font_variant<a href="PangoMarkupFormat.html#ftn.since_1_21" class="footnoteref"><sup class="footnoteref">[1]</sup></a>, </span><span class="term">variant</span></p></td>
<td><p>
One of 'normal' or 'smallcaps'
</p></td>
</tr>
<tr>
<td><p><span class="term">font_stretch<a href="PangoMarkupFormat.html#ftn.since_1_21" class="footnoteref"><sup class="footnoteref">[1]</sup></a>, </span><span class="term">stretch</span></p></td>
<td><p>
One of 'ultracondensed', 'extracondensed', 'condensed',
'semicondensed', 'normal', 'semiexpanded', 'expanded',
'extraexpanded', 'ultraexpanded'
</p></td>
</tr>
<tr>
<td><p><span class="term">foreground, </span><span class="term">fgcolor<a href="PangoMarkupFormat.html#ftn.since_1_21" class="footnoteref"><sup class="footnoteref">[1]</sup></a>, </span><span class="term">color</span></p></td>
<td><p>
An RGB color specification such as '#00FF00' or a color name such as
'red'
</p></td>
</tr>
<tr>
<td><p><span class="term">background, </span><span class="term">bgcolor<a href="PangoMarkupFormat.html#ftn.since_1_21" class="footnoteref"><sup class="footnoteref">[1]</sup></a></span></p></td>
<td><p>
An RGB color specification such as '#00FF00' or a color name such as
'red'
</p></td>
</tr>
<tr>
<td><p><span class="term">underline</span></p></td>
<td><p>
One of 'none', 'single', 'double', 'low', 'error'
</p></td>
</tr>
<tr>
<td><p><span class="term">underline_color</span></p></td>
<td><p>
The color of underlines; an RGB color specification such as '#00FF00'
or a color name such as 'red'
</p></td>
</tr>
<tr>
<td><p><span class="term">rise</span></p></td>
<td><p>
Vertical displacement, in Pango units. Can be negative for
subscript, positive for superscript.
</p></td>
</tr>
<tr>
<td><p><span class="term">strikethrough</span></p></td>
<td><p>
'true' or 'false' whether to strike through the text
</p></td>
</tr>
<tr>
<td><p><span class="term">strikethrough_color</span></p></td>
<td><p>
The color of strikethrough lines; an RGB color specification such as
'#00FF00' or a color name such as 'red'
</p></td>
</tr>
<tr>
<td><p><span class="term">fallback</span></p></td>
<td><p>
'true' or 'false' whether to enable fallback. If disabled, then characters
will only be used from the closest matching font on the system. No fallback
will be done to other fonts on the system that might contain the characters
in the text. Fallback is enabled by default. Most applications should not
disable fallback.
</p></td>
</tr>
<tr>
<td><p><span class="term">lang</span></p></td>
<td><p>
A language code, indicating the text language
</p></td>
</tr>
<tr>
<td><p><span class="term">letter_spacing</span></p></td>
<td><p>
Inter-letter spacing in 1024ths of a point.
</p></td>
</tr>
<tr>
<td><p><span class="term">gravity</span></p></td>
<td><p>
One of 'south', 'east', 'north', 'west', 'auto'.
</p></td>
</tr>
<tr>
<td><p><span class="term">gravity_hint</span></p></td>
<td><p>
One of 'natural', 'strong', 'line'.
</p></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
The following convenience tags are provided:
</p>
<div class="variablelist">
<p class="title"><b>Convenience tags</b></p>
<table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">b</span></p></td>
<td><p>
Bold
</p></td>
</tr>
<tr>
<td><p><span class="term">big</span></p></td>
<td><p>
Makes font relatively larger, equivalent to <span size="larger">
</p></td>
</tr>
<tr>
<td><p><span class="term">i</span></p></td>
<td><p>
Italic
</p></td>
</tr>
<tr>
<td><p><span class="term">s</span></p></td>
<td><p>
Strikethrough
</p></td>
</tr>
<tr>
<td><p><span class="term">sub</span></p></td>
<td><p>
Subscript
</p></td>
</tr>
<tr>
<td><p><span class="term">sup</span></p></td>
<td><p>
Superscript
</p></td>
</tr>
<tr>
<td><p><span class="term">small</span></p></td>
<td><p>
Makes font relatively smaller, equivalent to <span size="smaller">
</p></td>
</tr>
<tr>
<td><p><span class="term">tt</span></p></td>
<td><p>
Monospace font
</p></td>
</tr>
<tr>
<td><p><span class="term">u</span></p></td>
<td><p>
Underline
</p></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
<div class="footnotes">
<br><hr style="width:100; text-align:left;margin-left: 0">
<div id="ftn.since_1_21" class="footnote"><p><a href="#since_1_21" class="para"><sup class="para">[1] </sup></a>Since 1.21</p></div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21.1</div>
</body>
</html>
|