GNOME.org
 

[seed] Make the documentation a bit more...hierarchal

commit 97f9fa23d020eab42a0a9eecab2decba106caeae
Author: Robert Carr <racarr svn gnome org>
Date:   Sun May 17 22:36:01 2009 -0400

    Make the documentation a bit more...hierarchal
---
 doc/reference/html/index.html |   10 ++++++++-
 doc/reference/seed-docs.sgml  |   42 +++++++++++++++++++++++++++-------------
 2 files changed, 37 insertions(+), 15 deletions(-)

diff --git a/doc/reference/html/index.html b/doc/reference/html/index.html
index afed95d..cd8ea99 100644
--- a/doc/reference/html/index.html
+++ b/doc/reference/html/index.html
@@ -5,11 +5,14 @@
 <title>Seed Reference Manual</title>
 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
 <link rel="start" href="index.html" title="Seed Reference Manual">
-<link rel="next" href="ch01.html" title="General Seed Functions">
+<link rel="next" href="pr01.html" title="Introduction">
 <meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
+<link rel="preface" href="pr01.html" title="Introduction">
+<link rel="part" href="pt01.html" title="Part I. API Reference">
 <link rel="chapter" href="ch01.html" title="General Seed Functions">
 <link rel="chapter" href="ch02.html" title="Value and Object manipulation">
+<link rel="index" href="ix01.html" title="Index">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <div class="book" lang="en">
@@ -25,6 +28,9 @@
 <hr>
 </div>
 <div class="toc"><dl>
+<dt><span class="preface"><a href="pr01.html">Introduction</a></span></dt>
+<dt><span class="part"><a href="pt01.html">I. API Reference</a></span></dt>
+<dd><dl>
 <dt><span class="chapter"><a href="ch01.html">General Seed Functions</a></span></dt>
 <dd><dl>
 <dt>
@@ -49,6 +55,8 @@
 <span class="refentrytitle"><a href="seed-SeedValue.html">SeedValue</a></span><span class="refpurpose"> â?? Conversion between, and manipulation of, Seed and C types.</span>
 </dt>
 </dl></dd>
+</dl></dd>
+<dt><span class="index"><a href="ix01.html">Index</a></span></dt>
 </dl></div>
 </div>
 <div class="footer">
diff --git a/doc/reference/seed-docs.sgml b/doc/reference/seed-docs.sgml
index cc0ce3e..7206bcf 100644
--- a/doc/reference/seed-docs.sgml
+++ b/doc/reference/seed-docs.sgml
@@ -10,18 +10,32 @@
       <ulink role="online-location" url="http://www.gnome.org/~racarr/seed/gtk-doc/index.html";>http://www.gnome.org/~racarr/seed/gtk-doc/</ulink>.
     </releaseinfo>
   </bookinfo>
-
-  <chapter>
-    <title>General Seed Functions</title>
-    <xi:include href="xml/seed.xml"/>
-    <xi:include href="xml/seed-context.xml"/>
-    <xi:include href="xml/seed-closure.xml"/>
-    <xi:include href="xml/seed-string.xml"/>
-    <xi:include href="xml/seed-exception.xml"/>
-  </chapter>
-  <chapter>
-    <title>Value and Object manipulation</title>
-    <xi:include href="xml/seed-object.xml"/>
-    <xi:include href="xml/seed-value.xml"/>
-  </chapter>
+  
+  <preface>
+    <title>Introduction</title>
+    <para>
+      This is the documentation for the C API of Seed, used for embedding, and modules. For documentation on the JavaScript interface of Seed, see <ulink role="online-location" url="http://www.gnome.org/~racarr/seed";>http://www.gnome.org/~racarr/seed/</ulink>
+    </para>
+  </preface>
+  
+  <part>
+    <title>API Reference</title>
+    <chapter>
+      <title>General Seed Functions</title>
+      <xi:include href="xml/seed.xml"/>
+      <xi:include href="xml/seed-context.xml"/>
+      <xi:include href="xml/seed-closure.xml"/>
+      <xi:include href="xml/seed-string.xml"/>
+      <xi:include href="xml/seed-exception.xml"/>
+    </chapter>
+    <chapter>
+      <title>Value and Object manipulation</title>
+      <xi:include href="xml/seed-object.xml"/>
+      <xi:include href="xml/seed-value.xml"/>
+    </chapter>
+    </part>
+  
+  <index>
+    <title>Index</title>
+  </index>
 </book>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]