summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2002-12-11 19:26:16 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2002-12-11 19:26:16 +0000
commit5800b8090ac0ce46f851cd1312441de4e4a4c0e4 (patch)
tree4f232c93bd0e617b2ae4a22f522ae4540ec899a7 /docs
parent7c5519bf1e9a090d8da67f915dde5e4ff19a9bf5 (diff)
downloadpango-5800b8090ac0ce46f851cd1312441de4e4a4c0e4.tar.gz
Cosmetic changes to short descriptions.
* docs/tmpl/text-attributes.sgml: * docs/tmpl/glyphs.sgml: * docs/tmpl/engines.sgml: * docs/tmpl/main.sgml: * docs/tmpl/pango-indic.sgml: * docs/tmpl/coverage-maps.sgml: * docs/tmpl/fonts.sgml: * docs/pango_markup.sgml: Cosmetic changes to short descriptions. * docs/tmpl/tab-stops.sgml: * docs/tmpl/modules.sgml: * docs/tmpl/opentype.sgml: * docs/tmpl/xft-fonts.sgml: * docs/tmpl/freetype-fonts.sgml: * docs/tmpl/win32-fonts.sgml: Add short descriptions. * docs/pango-docs.sgml: Move "OpenType Font Handling" to "Low Level Functionality". * docs/pango-sections.txt: Combine the "X Fonts" and "X Rendering" sections.
Diffstat (limited to 'docs')
-rw-r--r--docs/pango-docs.sgml8
-rw-r--r--docs/pango-sections.txt9
-rw-r--r--docs/pango_markup.sgml4
-rw-r--r--docs/tmpl/coverage-maps.sgml2
-rw-r--r--docs/tmpl/engines.sgml2
-rw-r--r--docs/tmpl/fonts.sgml4
-rw-r--r--docs/tmpl/freetype-fonts.sgml1
-rw-r--r--docs/tmpl/glyphs.sgml2
-rw-r--r--docs/tmpl/main.sgml2
-rw-r--r--docs/tmpl/modules.sgml4
-rw-r--r--docs/tmpl/opentype.sgml2
-rw-r--r--docs/tmpl/pango-indic.sgml2
-rw-r--r--docs/tmpl/tab-stops.sgml2
-rw-r--r--docs/tmpl/text-attributes.sgml2
-rw-r--r--docs/tmpl/win32-fonts.sgml1
-rw-r--r--docs/tmpl/x-fonts.sgml93
-rw-r--r--docs/tmpl/x-rendering.sgml105
-rw-r--r--docs/tmpl/xft-fonts.sgml1
18 files changed, 114 insertions, 132 deletions
diff --git a/docs/pango-docs.sgml b/docs/pango-docs.sgml
index 2f296af0..065c6908 100644
--- a/docs/pango-docs.sgml
+++ b/docs/pango-docs.sgml
@@ -11,8 +11,7 @@
<!ENTITY pango-Engines SYSTEM "xml/engines.xml">
<!ENTITY pango-Indic-Engine-Support SYSTEM "xml/pango-indic.xml">
<!ENTITY pango-Modules SYSTEM "xml/modules.xml">
-<!ENTITY pango-X-Rendering SYSTEM "xml/x-rendering.xml">
-<!ENTITY pango-X-Fonts SYSTEM "xml/x-fonts.xml">
+<!ENTITY pango-X-Fonts-and-Rendering SYSTEM "xml/x-fonts.xml">
<!ENTITY pango-Win32-Fonts-and-Rendering SYSTEM "xml/win32-fonts.xml">
<!ENTITY pango-FreeType-Fonts-and-Rendering SYSTEM "xml/freetype-fonts.xml">
<!ENTITY pango-Xft-Fonts-and-Rendering SYSTEM "xml/xft-fonts.xml">
@@ -39,16 +38,15 @@
<chapter id="rendering">
<title>Rendering with Pango</title>
- &pango-X-Fonts;
- &pango-X-Rendering;
+ &pango-X-Fonts-and-Rendering;
&pango-Win32-Fonts-and-Rendering;
&pango-FreeType-Fonts-and-Rendering;
&pango-Xft-Fonts-and-Rendering;
- &pango-OpenType-Font-Handling;
</chapter>
<chapter id="lowlevel">
<title>Low Level Functionality</title>
+ &pango-OpenType-Font-Handling;
&pango-Coverage-Maps;
&pango-Engines;
&pango-Indic-Engine-Support;
diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt
index 3ba5dbd7..ec11c070 100644
--- a/docs/pango-sections.txt
+++ b/docs/pango-sections.txt
@@ -490,8 +490,8 @@ pango_indic_split_out_characters
</SECTION>
<SECTION>
-<TITLE>X Rendering</TITLE>
-<FILE>x-rendering</FILE>
+<TITLE>X Fonts and Rendering</TITLE>
+<FILE>x-fonts</FILE>
PANGO_RENDER_TYPE_X
pango_x_get_context
pango_x_context_set_funcs
@@ -500,11 +500,6 @@ PangoFreeGCFunc
pango_x_render
pango_x_render_layout_line
pango_x_render_layout
-</SECTION>
-
-<SECTION>
-<TITLE>X Fonts</TITLE>
-<FILE>x-fonts</FILE>
PangoXSubfont
PANGO_X_MAKE_GLYPH
PANGO_X_GLYPH_SUBFONT
diff --git a/docs/pango_markup.sgml b/docs/pango_markup.sgml
index fc8c225b..e988e1d2 100644
--- a/docs/pango_markup.sgml
+++ b/docs/pango_markup.sgml
@@ -1,4 +1,4 @@
-<refentry id="PangoMarkupFormat" revision="23 Oct 2000">
+<refentry id="PangoMarkupFormat" revision="11 Dec 2002">
<refmeta>
<refentrytitle>Pango Text Attribute Markup</refentrytitle>
<manvolnum>3</manvolnum>
@@ -7,7 +7,7 @@
<refnamediv>
<refname>Pango Text Attribute Markup</refname><refpurpose>Simple
-markup language to encode text plus a <link linkend="PangoAttrList">PangoAttrList</link></refpurpose>
+markup language to encode text with attributes</refpurpose>
</refnamediv>
<refsect1>
diff --git a/docs/tmpl/coverage-maps.sgml b/docs/tmpl/coverage-maps.sgml
index 710960a3..d673d65e 100644
--- a/docs/tmpl/coverage-maps.sgml
+++ b/docs/tmpl/coverage-maps.sgml
@@ -2,7 +2,7 @@
Coverage Maps
<!-- ##### SECTION Short_Description ##### -->
-Unicode character range coverage storage.
+Unicode character range coverage storage
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/tmpl/engines.sgml b/docs/tmpl/engines.sgml
index ce7c6fb2..1f27d225 100644
--- a/docs/tmpl/engines.sgml
+++ b/docs/tmpl/engines.sgml
@@ -2,7 +2,7 @@
Engines
<!-- ##### SECTION Short_Description ##### -->
-language-specific and rendering-system-specific processing.
+Language-specific and rendering-system-specific processing
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml
index 1aacbf32..e5385006 100644
--- a/docs/tmpl/fonts.sgml
+++ b/docs/tmpl/fonts.sgml
@@ -2,7 +2,7 @@
Fonts
<!-- ##### SECTION Short_Description ##### -->
-Structures representing abstract fonts.
+Structures representing abstract fonts
<!-- ##### SECTION Long_Description ##### -->
<para>
@@ -691,6 +691,7 @@ The #PangoFontMapClass structure holds the virtual functions for
a particular #PangoFontMap implementation.
</para>
+@parent_class:
@load_font: a function to load a font with a given description. See
pango_font_map_load_font()
@list_families: A function to list available font families. See
@@ -778,6 +779,7 @@ The #PangoFontsetClass structure holds the virtual functions for
a particular #PangoFontset implementation.
</para>
+@parent_class:
@get_font: a function to get the font in the fontset that contains the
best glyph for the given unicode character; see pango_fontset_get_font().
@get_metrics: a function to get overall metric information for the fonts
diff --git a/docs/tmpl/freetype-fonts.sgml b/docs/tmpl/freetype-fonts.sgml
index c68fc2f5..e402f02c 100644
--- a/docs/tmpl/freetype-fonts.sgml
+++ b/docs/tmpl/freetype-fonts.sgml
@@ -2,6 +2,7 @@
FreeType Fonts and Rendering
<!-- ##### SECTION Short_Description ##### -->
+Functions for shape engines to manipulate FreeType fonts
<!-- ##### SECTION Long_Description ##### -->
diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml
index e4ec644e..4700e713 100644
--- a/docs/tmpl/glyphs.sgml
+++ b/docs/tmpl/glyphs.sgml
@@ -2,7 +2,7 @@
Glyph Storage
<!-- ##### SECTION Short_Description ##### -->
-Structures for storing information about glyphs.
+Structures for storing information about glyphs
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml
index b921e455..f9804cbc 100644
--- a/docs/tmpl/main.sgml
+++ b/docs/tmpl/main.sgml
@@ -2,7 +2,7 @@
Rendering
<!-- ##### SECTION Short_Description ##### -->
-Functions to run the rendering pipeline.
+Functions to run the rendering pipeline
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/tmpl/modules.sgml b/docs/tmpl/modules.sgml
index 9233e333..032248a3 100644
--- a/docs/tmpl/modules.sgml
+++ b/docs/tmpl/modules.sgml
@@ -1,8 +1,8 @@
<!-- ##### SECTION Title ##### -->
-modules
+Modules
<!-- ##### SECTION Short_Description ##### -->
-
+Support for loadable modules
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/tmpl/opentype.sgml b/docs/tmpl/opentype.sgml
index 306440ba..19c554fe 100644
--- a/docs/tmpl/opentype.sgml
+++ b/docs/tmpl/opentype.sgml
@@ -2,7 +2,7 @@
OpenType Font Handling
<!-- ##### SECTION Short_Description ##### -->
-
+Obtaining information from OpenType tables
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/tmpl/pango-indic.sgml b/docs/tmpl/pango-indic.sgml
index 2959576a..8409296f 100644
--- a/docs/tmpl/pango-indic.sgml
+++ b/docs/tmpl/pango-indic.sgml
@@ -2,7 +2,7 @@
Indic Engine Support
<!-- ##### SECTION Short_Description ##### -->
-Indic support for legacy shaper engines.
+Indic support for legacy shaper engines
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/tmpl/tab-stops.sgml b/docs/tmpl/tab-stops.sgml
index fb7c29b8..85672a5f 100644
--- a/docs/tmpl/tab-stops.sgml
+++ b/docs/tmpl/tab-stops.sgml
@@ -2,7 +2,7 @@
Tab Stops
<!-- ##### SECTION Short_Description ##### -->
-
+Structures for storing Tab Stops
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml
index 56e1a796..5371ebf6 100644
--- a/docs/tmpl/text-attributes.sgml
+++ b/docs/tmpl/text-attributes.sgml
@@ -2,7 +2,7 @@
Text Attributes
<!-- ##### SECTION Short_Description ##### -->
-Font and other attributes for annotating text.
+Font and other attributes for annotating text
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/tmpl/win32-fonts.sgml b/docs/tmpl/win32-fonts.sgml
index 92966883..90588157 100644
--- a/docs/tmpl/win32-fonts.sgml
+++ b/docs/tmpl/win32-fonts.sgml
@@ -2,6 +2,7 @@
Win32 Fonts and Rendering
<!-- ##### SECTION Short_Description ##### -->
+Functions for shape engines to manipulate Win32 fonts
<!-- ##### SECTION Long_Description ##### -->
diff --git a/docs/tmpl/x-fonts.sgml b/docs/tmpl/x-fonts.sgml
index 048a30d4..161040f6 100644
--- a/docs/tmpl/x-fonts.sgml
+++ b/docs/tmpl/x-fonts.sgml
@@ -1,8 +1,8 @@
<!-- ##### SECTION Title ##### -->
-X Fonts
+X Fonts and Rendering
<!-- ##### SECTION Short_Description ##### -->
-Functions for shape engines to manipulate X fonts.
+Functions for shape engines to manipulate X fonts
<!-- ##### SECTION Long_Description ##### -->
<para>
@@ -16,6 +16,95 @@ sets within an #PangoFont for the X rendering system.
</para>
+<!-- ##### MACRO PANGO_RENDER_TYPE_X ##### -->
+<para>
+A string constant identifying the X renderer. The associated quark (see
+g_quark_from_string()) is used to identify the renderer in pango_find_map().
+</para>
+
+
+
+<!-- ##### FUNCTION pango_x_get_context ##### -->
+<para>
+
+</para>
+
+@display:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_x_context_set_funcs ##### -->
+<para>
+
+</para>
+
+@context:
+@get_gc_func:
+@free_gc_func:
+
+
+<!-- ##### USER_FUNCTION PangoGetGCFunc ##### -->
+<para>
+Specifies the type of the function used to create a new GC for a given
+color.
+</para>
+
+@context: a #PangoContext.
+@color: the color to create a new GC for.
+@base_gc: the GC to base the new GC on.
+@Returns: the new GC.
+
+
+<!-- ##### USER_FUNCTION PangoFreeGCFunc ##### -->
+<para>
+Specifies the type of the function used to free a GC created with
+the corresponding #PangoGetGCFunc function.
+</para>
+
+@context: a #PangoContext.
+@gc: the GC to free.
+
+
+<!-- ##### FUNCTION pango_x_render ##### -->
+<para>
+
+</para>
+
+@display:
+@d:
+@gc:
+@font:
+@glyphs:
+@x:
+@y:
+
+
+<!-- ##### FUNCTION pango_x_render_layout_line ##### -->
+<para>
+
+</para>
+
+@display:
+@drawable:
+@gc:
+@line:
+@x:
+@y:
+
+
+<!-- ##### FUNCTION pango_x_render_layout ##### -->
+<para>
+
+</para>
+
+@display:
+@drawable:
+@gc:
+@layout:
+@x:
+@y:
+
+
<!-- ##### TYPEDEF PangoXSubfont ##### -->
<para>
The #PangoXSubFont type is an integer ID that identifies one
diff --git a/docs/tmpl/x-rendering.sgml b/docs/tmpl/x-rendering.sgml
deleted file mode 100644
index 03d8a395..00000000
--- a/docs/tmpl/x-rendering.sgml
+++ /dev/null
@@ -1,105 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-X Rendering
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### MACRO PANGO_RENDER_TYPE_X ##### -->
-<para>
-A string constant identifying the X renderer. The associated quark (see
-g_quark_from_string()) is used to identify the renderer in pango_find_map().
-</para>
-
-
-
-<!-- ##### FUNCTION pango_x_get_context ##### -->
-<para>
-
-</para>
-
-@display:
-@Returns:
-
-
-<!-- ##### FUNCTION pango_x_context_set_funcs ##### -->
-<para>
-
-</para>
-
-@context:
-@get_gc_func:
-@free_gc_func:
-
-
-<!-- ##### USER_FUNCTION PangoGetGCFunc ##### -->
-<para>
-Specifies the type of the function used to create a new GC for a given
-color.
-</para>
-
-@context: a #PangoContext.
-@color: the color to create a new GC for.
-@base_gc: the GC to base the new GC on.
-@Returns: the new GC.
-
-
-<!-- ##### USER_FUNCTION PangoFreeGCFunc ##### -->
-<para>
-Specifies the type of the function used to free a GC created with
-the corresponding #PangoGetGCFunc function.
-</para>
-
-@context: a #PangoContext.
-@gc: the GC to free.
-
-
-<!-- ##### FUNCTION pango_x_render ##### -->
-<para>
-
-</para>
-
-@display:
-@d:
-@gc:
-@font:
-@glyphs:
-@x:
-@y:
-
-
-<!-- ##### FUNCTION pango_x_render_layout_line ##### -->
-<para>
-
-</para>
-
-@display:
-@drawable:
-@gc:
-@line:
-@x:
-@y:
-
-
-<!-- ##### FUNCTION pango_x_render_layout ##### -->
-<para>
-
-</para>
-
-@display:
-@drawable:
-@gc:
-@layout:
-@x:
-@y:
-
-
diff --git a/docs/tmpl/xft-fonts.sgml b/docs/tmpl/xft-fonts.sgml
index 552301a4..74411d21 100644
--- a/docs/tmpl/xft-fonts.sgml
+++ b/docs/tmpl/xft-fonts.sgml
@@ -2,6 +2,7 @@
Xft Fonts and Rendering
<!-- ##### SECTION Short_Description ##### -->
+Functions for shape engines to manipulate Xft fonts
<!-- ##### SECTION Long_Description ##### -->