diff options
Diffstat (limited to 'docs/pango_markup.sgml')
| -rw-r--r-- | docs/pango_markup.sgml | 301 |
1 files changed, 0 insertions, 301 deletions
diff --git a/docs/pango_markup.sgml b/docs/pango_markup.sgml deleted file mode 100644 index c2ba377c..00000000 --- a/docs/pango_markup.sgml +++ /dev/null @@ -1,301 +0,0 @@ -<refentry id="PangoMarkupFormat" revision="11 Dec 2002"> -<refmeta> -<refentrytitle>Text Attribute Markup</refentrytitle> -<manvolnum>3</manvolnum> -<refmiscinfo>Pango Library</refmiscinfo> -</refmeta> - -<refnamediv> -<refname>Text Attribute Markup</refname><refpurpose>Simple -markup language to encode text with attributes</refpurpose> -</refnamediv> - -<refsect1 id="PangoMarkupFormatLanguage"> -<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 -<link linkend="PangoAttrList">PangoAttrList</link> 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 either of -<link linkend="pango-parse-markup">pango_parse_markup()</link> or -<link linkend="pango-markup-parser-new">pango_markup_parser_new()</link>. -</para> - -<para> -A simple example of a marked-up string might be: -<literal>"<span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>!"</literal> -</para> - -<para> -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. -</para> - -<para> -The root tag of a marked-up document is <markup>, but <link -linkend="pango-parse-markup">pango_parse_markup()</link> 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<footnote id='since_1_21'><para>Since 1.21</para></footnote></term> -<term>font_desc</term> -<listitem><para> -A font description string, such as "Sans Italic 12". See -<link linkend="pango-font-description-from-string">pango_font_description_from_string()</link> -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.</para></listitem> -</varlistentry> - -<varlistentry> -<term>font_family</term> -<term>face</term> -<listitem><para> -A font family name -</para></listitem> -</varlistentry> - -<varlistentry> -<term>font_size<footnoteref linkend='since_1_21'/></term> -<term>size</term> -<listitem><para> -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 -<literal>font='12.5'</literal> rather than -<literal>size='12800'</literal>. -</para></listitem> -</varlistentry> - -<varlistentry> -<term>font_style<footnoteref linkend='since_1_21'/></term> -<term>style</term> -<listitem><para> -One of 'normal', 'oblique', 'italic' -</para></listitem> -</varlistentry> - -<varlistentry> -<term>font_weight<footnoteref linkend='since_1_21'/></term> -<term>weight</term> -<listitem><para> -One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', -or a numeric weight -</para></listitem> -</varlistentry> - -<varlistentry> -<term>font_variant<footnoteref linkend='since_1_21'/></term> -<term>variant</term> -<listitem><para> -One of 'normal' or 'smallcaps' -</para></listitem> -</varlistentry> - -<varlistentry> -<term>font_stretch<footnoteref linkend='since_1_21'/></term> -<term>stretch</term> -<listitem><para> -One of 'ultracondensed', 'extracondensed', 'condensed', -'semicondensed', 'normal', 'semiexpanded', 'expanded', -'extraexpanded', 'ultraexpanded' -</para></listitem> -</varlistentry> - -<varlistentry> -<term>font_features<footnote id='since_1_38'><para>Since 1.38</para></footnote></term> -<listitem><para> -A comma separated list of OpenType font feature settings, in the same -syntax as accepted by CSS. E.g: <literal>font_features='dlig=1, -kern, afrc on'</literal> -</para></listitem> -</varlistentry> - -<varlistentry> -<term>foreground</term> -<term>fgcolor<footnoteref linkend='since_1_21'/></term> -<term>color</term> -<listitem><para> -An RGB color specification such as '#00FF00' or a color name such as -'red'. -Since 1.38, an RGBA color specification such as '#00FF007F' will -be interpreted as specifying both a foreground color and foreground alpha. -</para></listitem> -</varlistentry> - -<varlistentry> -<term>background</term> -<term>bgcolor<footnoteref linkend='since_1_21'/></term> -<listitem><para> -An RGB color specification such as '#00FF00' or a color name such as -'red'. -Since 1.38, an RGBA color specification such as '#00FF007F' will -be interpreted as specifying both a background color and background alpha. -</para></listitem> -</varlistentry> - -<varlistentry> -<term>alpha</term> -<term>fgalpha<footnoteref linkend='since_1_38'/></term> -<listitem><para> -An alpha value for the foreground color, either a plain integer between 1 and 65536 -or a percentage value like '50%'. -</para></listitem> -</varlistentry> - -<varlistentry> -<term>background_alpha</term> -<term>bgalpha<footnoteref linkend='since_1_38'/></term> -<listitem><para> -An alpha value for the background color, either a plain integer between 1 and 65536 -or a percentage value like '50%'. -</para></listitem> -</varlistentry> - -<varlistentry><term>underline</term> -<listitem><para> -One of 'none', 'single', 'double', 'low', 'error' -</para></listitem> -</varlistentry> - -<varlistentry><term>underline_color</term> -<listitem><para> -The color of underlines; an RGB color specification such as '#00FF00' -or a color name such as 'red' -</para></listitem> -</varlistentry> - -<varlistentry><term>rise</term> -<listitem><para> -Vertical displacement, in Pango units. 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>strikethrough_color</term> -<listitem><para> -The color of strikethrough lines; an RGB color specification such as -'#00FF00' or a color name such as 'red' -</para></listitem> -</varlistentry> - -<varlistentry><term>fallback</term> -<listitem><para> -'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. -</para></listitem> -</varlistentry> - -<varlistentry><term>lang</term> -<listitem><para> -A language code, indicating the text language -</para></listitem> -</varlistentry> - -<varlistentry><term>letter_spacing</term> -<listitem><para> -Inter-letter spacing in 1024ths of a point. -</para></listitem> -</varlistentry> - -<varlistentry><term>gravity</term> -<listitem><para> -One of 'south', 'east', 'north', 'west', 'auto'. -</para></listitem> -</varlistentry> - -<varlistentry><term>gravity_hint</term> -<listitem><para> -One of 'natural', 'strong', 'line'. -</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> |