home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / share / gnome / help / gnome-doc-xslt / C / theme.xml < prev    next >
Encoding:
Extensible Markup Language  |  2009-03-17  |  15.6 KB  |  75 lines

  1. <?xml version="1.0"?>
  2. <section id="S__theme"><title>Themes</title>
  3.   <para>This module provides a common interface to specify custom colors and icons
  4.   for transformations to presentation-oreinted formats.  This allows similar
  5.   output for different types of input documents.  Theme information may either
  6.   be passed in as XSLT parameters or specified in a theme file.</para>
  7.   <remark>Describe the format of theme files.</remark>
  8.   <variablelist><title>Parameters</title><varlistentry><term><link linkend="P__theme_color_background"><parameter>theme.color.background</parameter></link></term><listitem><para>The background color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_link"><parameter>theme.color.link</parameter></link></term><listitem><para>The color of links</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_link_visited"><parameter>theme.color.link_visited</parameter></link></term><listitem><para>The color of visited links</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_text"><parameter>theme.color.text</parameter></link></term><listitem><para>The normal text color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_text_light"><parameter>theme.color.text_light</parameter></link></term><listitem><para>The light text color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_blue_background"><parameter>theme.color.blue_background</parameter></link></term><listitem><para>The blue background color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_blue_border"><parameter>theme.color.blue_border</parameter></link></term><listitem><para>The blue border color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_gray_background"><parameter>theme.color.gray_background</parameter></link></term><listitem><para>The gray background color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_gray_border"><parameter>theme.color.gray_border</parameter></link></term><listitem><para>The gray border color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_red_background"><parameter>theme.color.red_background</parameter></link></term><listitem><para>The red background color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_red_border"><parameter>theme.color.red_border</parameter></link></term><listitem><para>The red border color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_yellow_background"><parameter>theme.color.yellow_background</parameter></link></term><listitem><para>The yellow background color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_color_yellow_border"><parameter>theme.color.yellow_border</parameter></link></term><listitem><para>The yellow border color</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_icon_admon_path"><parameter>theme.icon.admon.path</parameter></link></term><listitem><para>The default path to the admonition icons</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_icon_admon_size"><parameter>theme.icon.admon.size</parameter></link></term><listitem><para>The size of the admonition icons</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_icon_admon_bug"><parameter>theme.icon.admon.bug</parameter></link></term><listitem><para>The path for the bug admonition icon</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_icon_admon_caution"><parameter>theme.icon.admon.caution</parameter></link></term><listitem><para>The path for the caution admonition icon</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_icon_admon_important"><parameter>theme.icon.admon.important</parameter></link></term><listitem><para>The path for the important admonition icon</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_icon_admon_note"><parameter>theme.icon.admon.note</parameter></link></term><listitem><para>The path for the note admonition icon</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_icon_admon_tip"><parameter>theme.icon.admon.tip</parameter></link></term><listitem><para>The path for the tip admonition icon</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_icon_admon_warning"><parameter>theme.icon.admon.warning</parameter></link></term><listitem><para>The path for the warning admonition icon</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_watermark_path"><parameter>theme.watermark.path</parameter></link></term><listitem><para>The default path to the watermark graphics</para></listitem></varlistentry><varlistentry><term><link linkend="P__theme_watermark_blockquote"><parameter>theme.watermark.blockquote</parameter></link></term><listitem><para>The path for the blockquote watermark graphic</para></listitem></varlistentry></variablelist><refentry id="P__theme_color_background"><indexterm><primary>theme.color.background</primary></indexterm><refnamediv><refname><parameter>theme.color.background</parameter></refname><refpurpose>The background color</refpurpose></refnamediv><refsection><title>Description</title>
  9.   <para>This parameter specifies the default background color.</para>
  10.   </refsection></refentry><refentry id="P__theme_color_link"><indexterm><primary>theme.color.link</primary></indexterm><refnamediv><refname><parameter>theme.color.link</parameter></refname><refpurpose>The color of links</refpurpose></refnamediv><refsection><title>Description</title>
  11.   <para>If set, this parameter specifies the color for unvisited links.</para>
  12.   </refsection></refentry><refentry id="P__theme_color_link_visited"><indexterm><primary>theme.color.link_visited</primary></indexterm><refnamediv><refname><parameter>theme.color.link_visited</parameter></refname><refpurpose>The color of visited links</refpurpose></refnamediv><refsection><title>Description</title>
  13.   <para>This parameter specifies the color for visited links.</para>
  14.   </refsection></refentry><refentry id="P__theme_color_text"><indexterm><primary>theme.color.text</primary></indexterm><refnamediv><refname><parameter>theme.color.text</parameter></refname><refpurpose>The normal text color</refpurpose></refnamediv><refsection><title>Description</title>
  15.   <para>This parameter specifies the default color for normal text.</para>
  16.   </refsection></refentry><refentry id="P__theme_color_text_light"><indexterm><primary>theme.color.text_light</primary></indexterm><refnamediv><refname><parameter>theme.color.text_light</parameter></refname><refpurpose>The light text color</refpurpose></refnamediv><refsection><title>Description</title>
  17.   <para>This parameter specifies the color for light text.  The light text
  18.   color is used to make bold headings and certain parenthetical text less intense.</para>
  19.   </refsection></refentry><refentry id="P__theme_color_blue_background"><indexterm><primary>theme.color.blue_background</primary></indexterm><refnamediv><refname><parameter>theme.color.blue_background</parameter></refname><refpurpose>The blue background color</refpurpose></refnamediv><refsection><title>Description</title>
  20.   <para>This parameter specifies the blue background color.  The blue
  21.   background color may be used by certain types of block elements.</para>
  22.   </refsection></refentry><refentry id="P__theme_color_blue_border"><indexterm><primary>theme.color.blue_border</primary></indexterm><refnamediv><refname><parameter>theme.color.blue_border</parameter></refname><refpurpose>The blue border color</refpurpose></refnamediv><refsection><title>Description</title>
  23.   <para>This parameter specifies the blue border color.  The blue
  24.   border color may be used by certain types of block elements.</para>
  25.   </refsection></refentry><refentry id="P__theme_color_gray_background"><indexterm><primary>theme.color.gray_background</primary></indexterm><refnamediv><refname><parameter>theme.color.gray_background</parameter></refname><refpurpose>The gray background color</refpurpose></refnamediv><refsection><title>Description</title>
  26.   <para>This parameter specifies the gray background color.  The gray
  27.   background color may be used by certain types of block elements.</para>
  28.   </refsection></refentry><refentry id="P__theme_color_gray_border"><indexterm><primary>theme.color.gray_border</primary></indexterm><refnamediv><refname><parameter>theme.color.gray_border</parameter></refname><refpurpose>The gray border color</refpurpose></refnamediv><refsection><title>Description</title>
  29.   <para>This parameter specifies the gray border color.  The gray
  30.   border color may be used by certain types of block elements.</para>
  31.   </refsection></refentry><refentry id="P__theme_color_red_background"><indexterm><primary>theme.color.red_background</primary></indexterm><refnamediv><refname><parameter>theme.color.red_background</parameter></refname><refpurpose>The red background color</refpurpose></refnamediv><refsection><title>Description</title>
  32.   <para>This parameter specifies the red background color.  The red
  33.   background color may be used by certain types of block elements.</para>
  34.   </refsection></refentry><refentry id="P__theme_color_red_border"><indexterm><primary>theme.color.red_border</primary></indexterm><refnamediv><refname><parameter>theme.color.red_border</parameter></refname><refpurpose>The red border color</refpurpose></refnamediv><refsection><title>Description</title>
  35.   <para>This parameter specifies the red border color.  The red
  36.   border color may be used by certain types of block elements.</para>
  37.   </refsection></refentry><refentry id="P__theme_color_yellow_background"><indexterm><primary>theme.color.yellow_background</primary></indexterm><refnamediv><refname><parameter>theme.color.yellow_background</parameter></refname><refpurpose>The yellow background color</refpurpose></refnamediv><refsection><title>Description</title>
  38.   <para>This parameter specifies the yellow background color.  The yellow
  39.   background color may be used by certain types of block elements.</para>
  40.   </refsection></refentry><refentry id="P__theme_color_yellow_border"><indexterm><primary>theme.color.yellow_border</primary></indexterm><refnamediv><refname><parameter>theme.color.yellow_border</parameter></refname><refpurpose>The yellow border color</refpurpose></refnamediv><refsection><title>Description</title>
  41.   <para>This parameter specifies the yellow border color.  The yellow
  42.   border color may be used by certain types of block elements.</para>
  43.   </refsection></refentry><refentry id="P__theme_icon_admon_path"><indexterm><primary>theme.icon.admon.path</primary></indexterm><refnamediv><refname><parameter>theme.icon.admon.path</parameter></refname><refpurpose>The default path to the admonition icons</refpurpose></refnamediv><refsection><title>Description</title>
  44.   <para>This parameter specifies a default path where admonition icons can be found.
  45.   This is only a default path.  It has no effect on admonition icons for which
  46.   the corresponding parameter has been specified explicitly.</para>
  47.   </refsection></refentry><refentry id="P__theme_icon_admon_size"><indexterm><primary>theme.icon.admon.size</primary></indexterm><refnamediv><refname><parameter>theme.icon.admon.size</parameter></refname><refpurpose>The size of the admonition icons</refpurpose></refnamediv><refsection><title>Description</title>
  48.   <para>This parameter specifies the size of the icons given in <parameter><link linkend="P__theme_icon_admon_bug">theme.icon.admon.bug</link></parameter>,
  49.   <parameter><link linkend="P__theme_icon_admon_caution">theme.icon.admon.caution</link></parameter>, <parameter><link linkend="P__theme_icon_admon_important">theme.icon.admon.important</link></parameter>, <parameter><link linkend="P__theme_icon_admon_note">theme.icon.admon.note</link></parameter>,
  50.   <parameter><link linkend="P__theme_icon_admon_tip">theme.icon.admon.tip</link></parameter>, and <parameter><link linkend="P__theme_icon_admon_warning">theme.icon.admon.warning</link></parameter>.  The value of this parameter
  51.   should be a single integer specifying both the width and the height in pixels.  Icon
  52.   sizes are assumed to be square.</para>
  53.   </refsection></refentry><refentry id="P__theme_icon_admon_bug"><indexterm><primary>theme.icon.admon.bug</primary></indexterm><refnamediv><refname><parameter>theme.icon.admon.bug</parameter></refname><refpurpose>The path for the bug admonition icon</refpurpose></refnamediv><refsection><title>Description</title>
  54.   <para>This parameter specifies the icon used for bug admonitions.</para>
  55.   </refsection></refentry><refentry id="P__theme_icon_admon_caution"><indexterm><primary>theme.icon.admon.caution</primary></indexterm><refnamediv><refname><parameter>theme.icon.admon.caution</parameter></refname><refpurpose>The path for the caution admonition icon</refpurpose></refnamediv><refsection><title>Description</title>
  56.   <para>This parameter specifies the icon used for caution admonitions.</para>
  57.   </refsection></refentry><refentry id="P__theme_icon_admon_important"><indexterm><primary>theme.icon.admon.important</primary></indexterm><refnamediv><refname><parameter>theme.icon.admon.important</parameter></refname><refpurpose>The path for the important admonition icon</refpurpose></refnamediv><refsection><title>Description</title>
  58.   <para>This parameter specifies the icon used for important admonitions.</para>
  59.   </refsection></refentry><refentry id="P__theme_icon_admon_note"><indexterm><primary>theme.icon.admon.note</primary></indexterm><refnamediv><refname><parameter>theme.icon.admon.note</parameter></refname><refpurpose>The path for the note admonition icon</refpurpose></refnamediv><refsection><title>Description</title>
  60.   <para>This parameter specifies the icon used for note admonitions.</para>
  61.   </refsection></refentry><refentry id="P__theme_icon_admon_tip"><indexterm><primary>theme.icon.admon.tip</primary></indexterm><refnamediv><refname><parameter>theme.icon.admon.tip</parameter></refname><refpurpose>The path for the tip admonition icon</refpurpose></refnamediv><refsection><title>Description</title>
  62.   <para>This parameter specifies the icon used for tip admonitions.</para>
  63.   </refsection></refentry><refentry id="P__theme_icon_admon_warning"><indexterm><primary>theme.icon.admon.warning</primary></indexterm><refnamediv><refname><parameter>theme.icon.admon.warning</parameter></refname><refpurpose>The path for the warning admonition icon</refpurpose></refnamediv><refsection><title>Description</title>
  64.   <para>This parameter specifies the icon used for warning admonitions.</para>
  65.   </refsection></refentry><refentry id="P__theme_watermark_path"><indexterm><primary>theme.watermark.path</primary></indexterm><refnamediv><refname><parameter>theme.watermark.path</parameter></refname><refpurpose>The default path to the watermark graphics</refpurpose></refnamediv><refsection><title>Description</title>
  66.   <para>This parameter specifies a default path where watermark graphics can be found.
  67.   This is only a default path.  It has no effect on watermark graphics for which
  68.   the corresponding parameter has been specified explicitly.</para>
  69.   </refsection></refentry><refentry id="P__theme_watermark_blockquote"><indexterm><primary>theme.watermark.blockquote</primary></indexterm><refnamediv><refname><parameter>theme.watermark.blockquote</parameter></refname><refpurpose>The path for the blockquote watermark graphic</refpurpose></refnamediv><refsection><title>Description</title>
  70.   <para>This parameter specifies the graphic file used for blockquote watermarks.  Note
  71.   that the default graphic is translatable.  If you set this parameter, you should
  72.   ensure that your graphic uses a suitable quote character for the language your
  73.   document is written in.</para>
  74.   </refsection></refentry></section>
  75.