Begin to document the GIR format
authorJohan Dahlin <jdahlin@litl.com>
Thu, 12 Feb 2009 22:35:35 +0000 (20:35 -0200)
committerJohan Dahlin <johan@gnome.org>
Thu, 12 Feb 2009 22:35:35 +0000 (20:35 -0200)
docs/reference/Makefile.am
docs/reference/gi-docs.sgml
docs/reference/gi-gir.sgml [new file with mode: 0644]

index efc70c9..60430aa 100644 (file)
@@ -32,7 +32,7 @@ FIXXREF_OPTIONS=
 include $(top_srcdir)/gtk-doc.make
 
 # Other files to distribute
-EXTRA_DIST +=version.xml.in
+EXTRA_DIST += version.xml.in
 
 ########################################################################
 
index 1a40904..dc28eba 100644 (file)
@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
 <!ENTITY gi-ginfo SYSTEM "xml/ginfo.xml">
 <!ENTITY gi-girepository SYSTEM "xml/girepository.xml">
 <!ENTITY gi-girffi SYSTEM "xml/girffi.xml">
@@ -27,15 +28,16 @@ Bla bla bla bla bla
     &gi-building;
 -->
   </chapter>
-<!--
-  <chapter id="gi-gir">
+
+  <part id="gi-gir">
     <title>GIR markup format</title>
-    &gi-gir-overview;
+      <xi:include href="gi-gir-reference.xml" />
+<!--
     &gi-gir-creating;
     &gi-gir-parsing;
     &gi-gir-verifying;
-  </chapter>
 -->
+  </part>
 
   <chapter id="gi-typelib">
     <title>typelib</title>
diff --git a/docs/reference/gi-gir.sgml b/docs/reference/gi-gir.sgml
new file mode 100644 (file)
index 0000000..8556b1d
--- /dev/null
@@ -0,0 +1,29 @@
+<chapter id="gi-gir-reference">
+
+  <title>The GIR XML format</title>
+
+  <para>
+    This chapter describes the GIR XML markup format.
+    are interested in the procedure which GTK+ follows to draw its
+    widgets and windows, you should read this chapter; this will be
+    useful to know if you decide to implement your own widgets.  This
+    chapter will also clarify the reasons behind the ways certain
+    things are done in GTK+; for example, why you cannot change the
+    background color of all widgets with the same method.
+  </para>
+
+   <section id="gi-gir-api">
+      <title>API node</title>
+      
+      The root node of all GIR documents is the api node.
+
+      Attributes:
+      <itemizedlist>
+       <listitem><para>version</para></listitem>
+        The version of the GIR, currently the only known version is 1.0.
+      </itemizedlist>
+
+   </section>
+
+</chapter>
+