Group bidi stuff together. Add a section in the docs for them.

2008-04-21  Behdad Esfahbod  <behdad@gnome.org>

        * docs/pango-docs.sgml:
        * docs/pango-sections.txt:
        * docs/tmpl/bidi.sgml:
        * docs/tmpl/main.sgml:
        * docs/tmpl/vertical.sgml:
        * pango/pango-bidi-type.c (pango_log2vis_get_embedding_levels),
        (pango_unichar_direction), (pango_get_mirror_char):
        * pango/pango-bidi-type.h:
        * pango/pango-types.h:
        * pango/pango-utils.c:
        Group bidi stuff together.  Add a section in the docs for them.


svn path=/trunk/; revision=2608

5 files changed, 126 insertions, 101 deletions

diff --git a/docs/pango-docs.sgml b/docs/pango-docs.sgml
index cf57855c..0517ba6e 100644
--- a/docs/pango-docs.sgml
+++ b/docs/pango-docs.sgml
@@ -29,6 +29,7 @@
 <!ENTITY pango-querymodules SYSTEM "pango-querymodules.xml">
 <!ENTITY pango-Version SYSTEM "xml/pango-version.xml">
 <!ENTITY pango-Vertical-Text SYSTEM "xml/vertical.xml">
+<!ENTITY pango-Bidi-Text SYSTEM "xml/bidi.xml">
 <!ENTITY version SYSTEM "version.xml">
 <!ENTITY pango-tree-index SYSTEM "xml/tree_index.sgml">
 ]>
@@ -48,6 +49,7 @@
     &markup-format;
     &pango-Layout-Objects;
     &pango-Scripts;
+    &pango-Bidi-Text;
     &pango-Vertical-Text;
   </chapter>
 
diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt
index 72666c12..458917d8 100644
--- a/docs/pango-sections.txt
+++ b/docs/pango-sections.txt
@@ -6,7 +6,6 @@ PangoContext
 PangoItem
 PangoAnalysis
 PANGO_ANALYSIS_FLAG_CENTERED_BASELINE
-PangoDirection
 PANGO_TYPE_DIRECTION
 <SUBSECTION>
 pango_itemize
@@ -37,14 +36,7 @@ pango_context_load_font
 pango_context_load_fontset
 pango_context_get_metrics
 pango_context_list_families
-<SUBSECTION>
-pango_get_mirror_char
-pango_unichar_direction
-pango_find_base_dir
-PangoBidiType
-pango_bidi_type_for_unichar
 <SUBSECTION Standard>
-PANGO_TYPE_BIDI_TYPE
 PANGO_TYPE_CONTEXT
 PangoContextClass
 PANGO_CONTEXT
@@ -63,8 +55,6 @@ PangoLogAttr
 pango_shape
 
 <SUBSECTION Private>
-pango_bidi_type_get_type
-pango_direction_get_type
 pango_context_get_type
 pango_item_get_type
 </SECTION>
@@ -1080,14 +1070,31 @@ pango_version_check
 <TITLE>Vertical Text</TITLE>
 <FILE>vertical</FILE>
 PangoGravity
-PANGO_TYPE_GRAVITY
 PangoGravityHint
-PANGO_TYPE_GRAVITY_HINT
 PANGO_GRAVITY_IS_VERTICAL
 pango_gravity_get_for_matrix
 pango_gravity_get_for_script
 pango_gravity_to_rotation
+<SUBSECTION Standard>
+PANGO_TYPE_GRAVITY
+PANGO_TYPE_GRAVITY_HINT
 <SUBSECTION Private>
 pango_gravity_get_type
 pango_gravity_hint_get_type
 </SECTION>
+
+<SECTION>
+<TITLE>Bidirectional Text</TITLE>
+<FILE>bidi</FILE>
+PangoDirection
+pango_unichar_direction
+pango_find_base_dir
+pango_get_mirror_char
+PangoBidiType
+pango_bidi_type_for_unichar
+<SUBSECTION Standard>
+PANGO_TYPE_BIDI_TYPE
+<SUBSECTION Private>
+pango_bidi_type_get_type
+pango_direction_get_type
+</SECTION>
diff --git a/docs/tmpl/bidi.sgml b/docs/tmpl/bidi.sgml
new file mode 100644
index 00000000..7e5171e9
--- /dev/null
+++ b/docs/tmpl/bidi.sgml
@@ -0,0 +1,105 @@
+<!-- ##### SECTION Title ##### -->
+Bidirectional Text
+
+<!-- ##### SECTION Short_Description ##### -->
+Types and functions to help with handling bidirectional text
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+Pango supports bidirectional text (like Arabic and Hebrew) automatically.
+Some applications however, need some help to correctly handle bidirectional
+text.
+</para>
+<para>
+The #PangoDirection type can be used with pango_context_set_base_dir() to
+instruct Pango about direction of text, though in most cases Pango detects
+that correctly and automatically.  The rest of the facilities in this section
+are used internally by Pango already, and are provided to help applications
+that need more direct control over bidirectional setting of text.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+pango_context_get_base_dir(),
+pango_context_set_base_dir(),
+pango_itemize_with_base_dir()
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### ENUM PangoDirection ##### -->
+<para>
+</para>
+
+@PANGO_DIRECTION_LTR: 
+@PANGO_DIRECTION_RTL: 
+@PANGO_DIRECTION_TTB_LTR: 
+@PANGO_DIRECTION_TTB_RTL: 
+@PANGO_DIRECTION_WEAK_LTR: 
+@PANGO_DIRECTION_WEAK_RTL: 
+@PANGO_DIRECTION_NEUTRAL: 
+
+<!-- ##### FUNCTION pango_unichar_direction ##### -->
+<para>
+
+</para>
+
+@ch: 
+@Returns: 
+
+
+<!-- ##### FUNCTION pango_find_base_dir ##### -->
+<para>
+
+</para>
+
+@text: 
+@length: 
+@Returns: 
+
+
+<!-- ##### FUNCTION pango_get_mirror_char ##### -->
+<para>
+
+</para>
+
+@ch: 
+@mirrored_ch: 
+@Returns: 
+
+
+<!-- ##### ENUM PangoBidiType ##### -->
+<para>
+
+</para>
+
+@PANGO_BIDI_TYPE_L: 
+@PANGO_BIDI_TYPE_LRE: 
+@PANGO_BIDI_TYPE_LRO: 
+@PANGO_BIDI_TYPE_R: 
+@PANGO_BIDI_TYPE_AL: 
+@PANGO_BIDI_TYPE_RLE: 
+@PANGO_BIDI_TYPE_RLO: 
+@PANGO_BIDI_TYPE_PDF: 
+@PANGO_BIDI_TYPE_EN: 
+@PANGO_BIDI_TYPE_ES: 
+@PANGO_BIDI_TYPE_ET: 
+@PANGO_BIDI_TYPE_AN: 
+@PANGO_BIDI_TYPE_CS: 
+@PANGO_BIDI_TYPE_NSM: 
+@PANGO_BIDI_TYPE_BN: 
+@PANGO_BIDI_TYPE_B: 
+@PANGO_BIDI_TYPE_S: 
+@PANGO_BIDI_TYPE_WS: 
+@PANGO_BIDI_TYPE_ON: 
+
+<!-- ##### FUNCTION pango_bidi_type_for_unichar ##### -->
+<para>
+
+</para>
+
+@ch: 
+@Returns: 
+
+
diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml
index 221bef43..fe37ff91 100644
--- a/docs/tmpl/main.sgml
+++ b/docs/tmpl/main.sgml
@@ -66,18 +66,6 @@ Since: 1.16
 
 
 
-<!-- ##### ENUM PangoDirection ##### -->
-<para>
-</para>
-
-@PANGO_DIRECTION_LTR: 
-@PANGO_DIRECTION_RTL: 
-@PANGO_DIRECTION_TTB_LTR: 
-@PANGO_DIRECTION_TTB_RTL: 
-@PANGO_DIRECTION_WEAK_LTR: 
-@PANGO_DIRECTION_WEAK_RTL: 
-@PANGO_DIRECTION_NEUTRAL: 
-
 <!-- ##### MACRO PANGO_TYPE_DIRECTION ##### -->
 <para>
 The #GObject type for #PangoDirection.
@@ -344,69 +332,6 @@ The #GObject type for #PangoDirection.
 @n_families: 
 
 
-<!-- ##### FUNCTION pango_get_mirror_char ##### -->
-<para>
-
-</para>
-
-@ch: 
-@mirrored_ch: 
-@Returns: 
-
-
-<!-- ##### FUNCTION pango_unichar_direction ##### -->
-<para>
-
-</para>
-
-@ch: 
-@Returns: 
-
-
-<!-- ##### FUNCTION pango_find_base_dir ##### -->
-<para>
-
-</para>
-
-@text: 
-@length: 
-@Returns: 
-
-
-<!-- ##### ENUM PangoBidiType ##### -->
-<para>
-
-</para>
-
-@PANGO_BIDI_TYPE_L: 
-@PANGO_BIDI_TYPE_LRE: 
-@PANGO_BIDI_TYPE_LRO: 
-@PANGO_BIDI_TYPE_R: 
-@PANGO_BIDI_TYPE_AL: 
-@PANGO_BIDI_TYPE_RLE: 
-@PANGO_BIDI_TYPE_RLO: 
-@PANGO_BIDI_TYPE_PDF: 
-@PANGO_BIDI_TYPE_EN: 
-@PANGO_BIDI_TYPE_ES: 
-@PANGO_BIDI_TYPE_ET: 
-@PANGO_BIDI_TYPE_AN: 
-@PANGO_BIDI_TYPE_CS: 
-@PANGO_BIDI_TYPE_NSM: 
-@PANGO_BIDI_TYPE_BN: 
-@PANGO_BIDI_TYPE_B: 
-@PANGO_BIDI_TYPE_S: 
-@PANGO_BIDI_TYPE_WS: 
-@PANGO_BIDI_TYPE_ON: 
-
-<!-- ##### FUNCTION pango_bidi_type_for_unichar ##### -->
-<para>
-
-</para>
-
-@ch: 
-@Returns: 
-
-
 <!-- ##### FUNCTION pango_break ##### -->
 <para>
 
diff --git a/docs/tmpl/vertical.sgml b/docs/tmpl/vertical.sgml
index 917641da..5a75d991 100644
--- a/docs/tmpl/vertical.sgml
+++ b/docs/tmpl/vertical.sgml
@@ -84,13 +84,6 @@ pango_attr_gravity_hint_new()
 @PANGO_GRAVITY_WEST: 
 @PANGO_GRAVITY_AUTO: 
 
-<!-- ##### MACRO PANGO_TYPE_GRAVITY ##### -->
-<para>
-The #GObject type for #PangoGravity.
-</para>
-
-
-
 <!-- ##### ENUM PangoGravityHint ##### -->
 <para>
 
@@ -100,13 +93,6 @@ The #GObject type for #PangoGravity.
 @PANGO_GRAVITY_HINT_STRONG: 
 @PANGO_GRAVITY_HINT_LINE: 
 
-<!-- ##### MACRO PANGO_TYPE_GRAVITY_HINT ##### -->
-<para>
-The #GObject type for #PangoGravity.
-</para>
-
-
-
 <!-- ##### MACRO PANGO_GRAVITY_IS_VERTICAL ##### -->
 <para>