[gtksourceview/wip/improve-doc: 1/4] Improve API reference structure by grouping classes



commit 3359b075d5d83bcbba95ff5f364295e68f05a19a
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Sat Nov 22 18:11:06 2014 +0100

    Improve API reference structure by grouping classes
    
    The classes were just sorted alphabetically. The GtkSourceView class at
    the end was not great, since it's the main class.
    
    The features with only one class are grouped into "Others".

 docs/reference/gtksourceview-docs.xml |   95 +++++++++++++++++++++------------
 1 files changed, 61 insertions(+), 34 deletions(-)
---
diff --git a/docs/reference/gtksourceview-docs.xml b/docs/reference/gtksourceview-docs.xml
index 9803b5f..e6a5610 100644
--- a/docs/reference/gtksourceview-docs.xml
+++ b/docs/reference/gtksourceview-docs.xml
@@ -14,46 +14,73 @@
     <releaseinfo>for GtkSourceView &version;</releaseinfo>
   </bookinfo>
 
-  <chapter>
+  <part>
     <title>API reference</title>
-    <xi:include href="xml/buffer.xml"/>
-    <xi:include href="xml/completion.xml"/>
-    <xi:include href="xml/completioncontext.xml"/>
-    <xi:include href="xml/completioninfo.xml"/>
-    <xi:include href="xml/completionitem.xml"/>
-    <xi:include href="xml/completionproposal.xml"/>
-    <xi:include href="xml/completionprovider.xml"/>
-    <xi:include href="xml/completionwords.xml"/>
-    <xi:include href="xml/encoding.xml"/>
-    <xi:include href="xml/file.xml"/>
-    <xi:include href="xml/fileloader.xml"/>
-    <xi:include href="xml/filesaver.xml"/>
-    <xi:include href="xml/gutter.xml"/>
-    <xi:include href="xml/gutterrenderer.xml"/>
-    <xi:include href="xml/gutterrendererpixbuf.xml"/>
-    <xi:include href="xml/gutterrenderertext.xml"/>
-    <xi:include href="xml/language.xml"/>
-    <xi:include href="xml/languagemanager.xml"/>
-    <xi:include href="xml/mark.xml"/>
-    <xi:include href="xml/markattributes.xml"/>
-    <xi:include href="xml/printcompositor.xml"/>    
-    <xi:include href="xml/searchcontext.xml"/>
-    <xi:include href="xml/searchsettings.xml"/>
-    <xi:include href="xml/style.xml"/>
-    <xi:include href="xml/stylescheme.xml"/>
-    <xi:include href="xml/styleschememanager.xml"/>
-    <xi:include href="xml/undomanager.xml"/>
-    <xi:include href="xml/utils.xml"/>
-    <xi:include href="xml/view.xml"/>
-  </chapter>
 
-  <chapter>
-    <title>Syntax highlighting reference</title>
+    <chapter>
+      <title>Main Classes</title>
+      <xi:include href="xml/buffer.xml"/>
+      <xi:include href="xml/view.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>Syntax Highlighting</title>
+      <xi:include href="xml/language.xml"/>
+      <xi:include href="xml/languagemanager.xml"/>
+      <xi:include href="xml/style.xml"/>
+      <xi:include href="xml/stylescheme.xml"/>
+      <xi:include href="xml/styleschememanager.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>Completion</title>
+      <xi:include href="xml/completion.xml"/>
+      <xi:include href="xml/completioncontext.xml"/>
+      <xi:include href="xml/completioninfo.xml"/>
+      <xi:include href="xml/completionitem.xml"/>
+      <xi:include href="xml/completionproposal.xml"/>
+      <xi:include href="xml/completionprovider.xml"/>
+      <xi:include href="xml/completionwords.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>File Loading and Saving</title>
+      <xi:include href="xml/encoding.xml"/>
+      <xi:include href="xml/file.xml"/>
+      <xi:include href="xml/fileloader.xml"/>
+      <xi:include href="xml/filesaver.xml"/>
+    </chapter>
 
+    <chapter>
+      <title>Gutter and Marks</title>
+      <xi:include href="xml/gutter.xml"/>
+      <xi:include href="xml/gutterrenderer.xml"/>
+      <xi:include href="xml/gutterrendererpixbuf.xml"/>
+      <xi:include href="xml/gutterrenderertext.xml"/>
+      <xi:include href="xml/mark.xml"/>
+      <xi:include href="xml/markattributes.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>Search and Replace</title>
+      <xi:include href="xml/searchcontext.xml"/>
+      <xi:include href="xml/searchsettings.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>Others</title>
+      <xi:include href="xml/printcompositor.xml"/>    
+      <xi:include href="xml/undomanager.xml"/>
+      <xi:include href="xml/utils.xml"/>
+    </chapter>
+  </part>
+
+  <part>
+    <title>Syntax highlighting reference</title>
     &tutorial;
     &reference;
     &stylereference;
-  </chapter>
+  </part>
 
   <chapter id="object-tree">
     <title>Object Hierarchy</title>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]