Stub of a migration chapter Stub of an overview Overview diagram taken

2007-12-17  Matthias Clasen <mclasen@redhat.com>

        * gio/migration.xml: Stub of a migration chapter
        * gio/overview.xml: Stub of an overview
        * gio/gvfs-overview.{odg,png}: Overview diagram taken
        from Alex Guadec slides.

        * gio/Makefile.am:
        * gio/gio-docs.xml: Include these

svn path=/trunk/; revision=6145

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 974892e..b237d45 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,15 @@
 2007-12-17  Matthias Clasen <mclasen@redhat.com>
 
+       * gio/migration.xml: Stub of a migration chapter
+       * gio/overview.xml: Stub of an overview
+       * gio/gvfs-overview.{odg,png}: Overview diagram taken
+       from Alex Guadec slides.
+
+       * gio/Makefile.am:
+       * gio/gio-docs.xml: Include these
+
+2007-12-17  Matthias Clasen <mclasen@redhat.com>
+
        * gio/gio-sections.txt: Updates
 
 2007-12-14  Matthias Clasen <mclasen@redhat.com>

diff --git a/docs/reference/gio/Makefile.am b/docs/reference/gio/Makefile.am
index 2cc965f..88afc47 100644 (file)
--- a/docs/reference/gio/Makefile.am
+++ b/docs/reference/gio/Makefile.am
@@ -87,12 +87,16 @@ GTKDOC_LIBS = \
 MKDB_OPTIONS = --output-format=xml --sgml-mode
 
 # Images to copy into HTML directory
-HTML_IMAGES =
+HTML_IMAGES =                  \
+       gvfs-overview.png
 
 content_files =                \
-       version.xml
+       version.xml             \
+       migrating.xml
 
-extra_files = version.xml.in
+extra_files =                  \
+       version.xml.in          \
+       gvfs-overview.odg
 
 include $(top_srcdir)/gtk-doc.make
 

diff --git a/docs/reference/gio/gio-docs.xml b/docs/reference/gio/gio-docs.xml
index 22d089e..8e7d980 100644 (file)
--- a/docs/reference/gio/gio-docs.xml
+++ b/docs/reference/gio/gio-docs.xml
@@ -8,10 +8,10 @@
   <bookinfo>
     <title>GIO Reference Manual</title>
     <releaseinfo>for GIO &version;</releaseinfo>
-  </bookinfo>
-  <part>
-  <title>GIO Overview</title>
-  </part>
+  < /bookinfo>
+
+  <xi:include href="overview.xml"/>
+
   <part>
   <title>API Reference</title>
     <chapter id="file_ops">
@@ -96,6 +96,8 @@
     </chapter>
   </part>
 
+  <xi:include href="migrating.xml"/>
+
   <chapter id="gio-hierarchy">
     <title>Object Hierarchy</title>
       <xi:include href="xml/tree_index.sgml"/>

diff --git a/docs/reference/gio/gvfs-overview.odg b/docs/reference/gio/gvfs-overview.odg
new file mode 100644 (file)
index 0000000..c279348
Binary files /dev/null and b/docs/reference/gio/gvfs-overview.odg differ

diff --git a/docs/reference/gio/gvfs-overview.png b/docs/reference/gio/gvfs-overview.png
new file mode 100644 (file)
index 0000000..c93099f
Binary files /dev/null and b/docs/reference/gio/gvfs-overview.png differ

diff --git a/docs/reference/gio/migrating.xml b/docs/reference/gio/migrating.xml
new file mode 100644 (file)
index 0000000..3091661
--- /dev/null
+++ b/docs/reference/gio/migrating.xml
@@ -0,0 +1,11 @@
+<chapter id="migrating">
+  <title>Migrating to GIO</title>
+
+  <para>
+    This chapter explains how to port applications from POSIX I/O or
+    gnome-vfs to GIO.
+  </para>
+
+  <!-- FIXME now explain ! -->
+
+</chapter>

diff --git a/docs/reference/gio/overview.xml b/docs/reference/gio/overview.xml
new file mode 100644 (file)
index 0000000..8d11d72
--- /dev/null
+++ b/docs/reference/gio/overview.xml
@@ -0,0 +1,14 @@
+<part>
+  <title>GIO Overview</title>
+
+  <para>
+    <figure id="mainloop-states">
+      <title>GIO in the GTK+ library stack</title>
+      <graphic fileref="gvfs-overview.png" format="PNG"></graphic>
+    </figure>
+  </para>
+
+  <!-- FIXME a picture is worth a 1000 words, 
+             but we still need some text here 
+  -->
+</part>