GNOME.org
 

[seed] [docs] Include module references in big Seed Reference

commit 4b1663647e75c94c9c202a86489108f81105cbfe
Author: Tim Horton <hortont svn gnome org>
Date:   Fri Jul 10 17:23:03 2009 -0400

    [docs] Include module references in big Seed Reference
    
    It's becoming clear that we should put *everything* in the one
    big book, so we can have interlinking and so that everything is
    in the same devhelp book.

 doc/Makefile.am                       |    2 +-
 doc/modules/book.xml                  |    2 +-
 doc/modules/gtkbuilder/gtkbuilder.xml |   10 +++++-----
 doc/modules/readline/readline.xml     |   10 +++++-----
 doc/modules/sandbox/sandbox.xml       |   11 +++++------
 doc/modules/sqlite/sqlite.xml         |   16 ++++++++--------
 doc/reference/Makefile.am             |    2 +-
 doc/reference/contact.sgml            |    2 +-
 doc/reference/seed-docs.sgml          |   17 +++++++++++++----
 9 files changed, 40 insertions(+), 32 deletions(-)
---
diff --git a/doc/Makefile.am b/doc/Makefile.am
index de015be..6b83f0a 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = tutorial-standalone reference modules mapping
+SUBDIRS = tutorial-standalone modules mapping reference
 
 EXTRA_DIST = \
 	index.html \
diff --git a/doc/modules/book.xml b/doc/modules/book.xml
index 8a17389..b82c965 100644
--- a/doc/modules/book.xml
+++ b/doc/modules/book.xml
@@ -3,7 +3,7 @@
  <bookinfo>
     <title>Seed Modules Reference Manual</title>
     <releaseinfo>
-      Documentation for Seed 0.7 modules.
+      Documentation for Seed 0.8.5 modules.
       The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://www.gnome.org/~racarr/seed/gtk-\
 doc/index.html">http://www.gnome.org/~racarr/seed/modules/</ulink>.
diff --git a/doc/modules/gtkbuilder/gtkbuilder.xml b/doc/modules/gtkbuilder/gtkbuilder.xml
index 827853e..899b2aa 100644
--- a/doc/modules/gtkbuilder/gtkbuilder.xml
+++ b/doc/modules/gtkbuilder/gtkbuilder.xml
@@ -11,9 +11,9 @@
       </affiliation>
     </author>
   </chapterinfo>
-  <title>GtkBuilder module.</title>
+  <title>GtkBuilder</title>
 
-  <section>
+  <refsect1>
     <title>API Reference</title>
     <para>
       The GtkBuilder extends Gtk.GtkBuilder.prototype to implement a custom automatic signal connection function, which is useful in Seed. It does not provide any methods or types, so there is no need to save it's namespace, as of such it can be imported as follows.
@@ -23,14 +23,14 @@
     </para>
     
     <xi:include href="gtkbuilder-funcs.xml"/>
-  </section>
-  <section>
+  </refsect1>
+  <refsect1>
     <title>Examples</title>
     <para>Below are several examples of using the Seed GtkBuilder module. For additional resources, consult the examples/ folder of the Seed source</para>
     <example id="GtkBuilder-xml-example">
       <xi:include href="example.ui"/>
       <xi:include href="example.js"/>
     </example>
-  </section>
+  </refsect1>
 </chapter>
 
diff --git a/doc/modules/readline/readline.xml b/doc/modules/readline/readline.xml
index fd9f647..914b1d5 100644
--- a/doc/modules/readline/readline.xml
+++ b/doc/modules/readline/readline.xml
@@ -11,9 +11,9 @@
       </affiliation>
     </author>
   </chapterinfo>
-  <title>readline module.</title>
+  <title>readline</title>
 
-  <section>
+  <refsect1>
     <title>API Reference</title>
     <para>
       The readline module allows for basic usage of the GNU readline library, in Seed. More advanced features may be added a a later time. In order to use the readline module it must be first imported.
@@ -23,8 +23,8 @@
     </para>
     
     <xi:include href="readline-funcs.xml"/>
-  </section>
-  <section>
+  </refsect1>
+  <refsect1>
     <title>Examples</title>
     <para>Below are several examples of using the Seed readline module. For additional resources, consult the examples/ folder of the Seed source</para>
     <example id="readline-repl-example">
@@ -41,6 +41,6 @@ while (1){
 }
       </programlisting>
     </example>
-  </section>
+  </refsect1>
 </chapter>
 
diff --git a/doc/modules/sandbox/sandbox.xml b/doc/modules/sandbox/sandbox.xml
index 5ab1e2d..73d7fc0 100644
--- a/doc/modules/sandbox/sandbox.xml
+++ b/doc/modules/sandbox/sandbox.xml
@@ -11,9 +11,9 @@
       </affiliation>
     </author>
   </chapterinfo>
-  <title>Sandbox module.</title>
+  <title>Sandbox</title>
 
-  <section>
+  <refsect1>
     <title>API Reference</title>
     <para>
       The sandbox module allows the creation of isolated JSCore contexts with individual global objects. It is useful as a literal "sandbox" or in a variety of other contexts. 
@@ -23,8 +23,8 @@
     </para>
     
     <xi:include href="sandbox-funcs.xml"/>
-  </section>
-  <section>
+  </refsect1>
+  <refsect1>
     <title>Examples</title>
     <para>Below are several examples of using the Seed Sandbox module. For additional resources, consult the examples/ folder of the Seed source</para>
     <example id="sandbox-example">
@@ -36,9 +36,8 @@ ctx.eval("b = 2+2");
 print(ctx.global.b); //4
 ctx.global.b = new Gtk.Window(); // Possible to expose objects to the context.
 ctx.eval("b.show()");
-
       </programlisting>
     </example>
-  </section>
+  </refsect1>
 </chapter>
 
diff --git a/doc/modules/sqlite/sqlite.xml b/doc/modules/sqlite/sqlite.xml
index d908ea6..820c635 100644
--- a/doc/modules/sqlite/sqlite.xml
+++ b/doc/modules/sqlite/sqlite.xml
@@ -11,14 +11,14 @@
       </affiliation>
     </author>
   </chapterinfo>
-  <title>SQLite module.</title>
+  <title>SQLite</title>
   
-  <section>
+  <refsect1>
     <title>API Reference</title>
     <para>
       The sqlite module allows for manipulation and querying of sqlite databases.
       <programlisting>
-	sqlite = imports.sqlite;
+sqlite = imports.sqlite;
       </programlisting>
     </para>
     
@@ -31,8 +31,8 @@ sqlite.[OK, ERROR, INTERNAL, PERM ABORT, BUSY,
         NOLFS, AUTH, FORMAT, RANGE, NOTADB, ROW, DONE]
     </programlisting>
     <xi:include href="sqlite-funcs.xml"/>
-  </section>
-  <section>
+  </refsect1>
+  <refsect1>
     <title>Examples</title>
     <para>Below are several examples of using the Seed sqlite module. For additional resources, consult the examples/ folder of the Seed source</para>
     <example id="readline-repl-example">
@@ -43,9 +43,9 @@ var db = new sqlite.Database("people.db");
 db.exec("create table people (key INTEGER PRIMARY KEY, name TEXT," +
                              "age INTEGER, phone TEXT);");
 db.exec("insert into people(name, age, phone) " + 
-                    "values('John Smith', 24, '555-123-4567');");
+        "values('John Smith', 24, '555-123-4567');");
 
-function cb_print_phone(results){
+function cb_print_phone(results) {
     print(results.phone);
 }
 
@@ -53,6 +53,6 @@ db.exec("select from people where name='John Smith';", cb_print_phone);
 db.close();
       </programlisting>
     </example>
-  </section>
+  </refsect1>
 </chapter>
 
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index cb5581c..46b9772 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -47,7 +47,7 @@ CFILE_GLOB=$(top_srcdir)/libseed/*.c
 
 # Header files to ignore when scanning.
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=seed-builtins.h seed-closure.h seed-engine.h seed-exceptions.h seed-gtype.h seed-private.h seed-signals.h seed-structs.h seed-types.h
+IGNORE_HFILES=seed-builtins.h seed-closure.h seed-engine.h seed-exceptions.h seed-gtype.h seed-private.h seed-signals.h seed-structs.h seed-types.h seed-importer.h
 
 # Images to copy into HTML directory.
 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
diff --git a/doc/reference/contact.sgml b/doc/reference/contact.sgml
index a4f4f52..c3d6271 100644
--- a/doc/reference/contact.sgml
+++ b/doc/reference/contact.sgml
@@ -10,7 +10,7 @@
 <refpurpose>
 Where to find help, ask questions, or bring patches
 </refpurpose>
-  </refnamediv>
+</refnamediv>
   
     <refsect1 id="build">
       <title>Authors</title>
diff --git a/doc/reference/seed-docs.sgml b/doc/reference/seed-docs.sgml
index 30c52e5..acecb8d 100644
--- a/doc/reference/seed-docs.sgml
+++ b/doc/reference/seed-docs.sgml
@@ -5,7 +5,7 @@
   <bookinfo>
     <title>Seed Reference Manual</title>
     <releaseinfo>
-      Documentation for Seed 0.8.
+      Documentation for Seed 0.8.5.
       The latest version of this documentation can be found on-line at
       <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>
@@ -19,9 +19,9 @@
     <xi:include href="contact.sgml"/>
   </part>
   
-  <part id="js">
+  <!--<part id="js">
     <title>Seed JavaScript Reference</title>
-  </part>
+  </part>-->
   
   <part id="api">
     <title>Seed API Reference</title>
@@ -32,7 +32,7 @@
     <xi:include href="xml/seed-exception.xml"/>
     <xi:include href="xml/seed-signals.xml"/>
     <chapter id="types">
-		<title>Values and Type Conversion</title>
+        <title>Values and Type Conversion</title>
         <xi:include href="xml/seed-typeconversion.xml"/>
         <xi:include href="xml/seed-nativetypes.xml"/>
         <xi:include href="xml/seed-object.xml"/>
@@ -43,6 +43,15 @@
     <xi:include href="xml/seed-modules.xml"/>
   </part>
   
+  <part id="modules">
+    <title>Seed Module Reference</title>
+    <para>This is the documentation for the various modules included with Seed.</para>
+    <xi:include href="../modules/readline/readline.xml"/>
+    <xi:include href="../modules/sqlite/sqlite.xml"/>
+    <xi:include href="../modules/gtkbuilder/gtkbuilder.xml"/>
+    <xi:include href="../modules/sandbox/sandbox.xml"/>
+  </part>
+  
   <index>
     <title>Index</title>
   </index>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]