summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorÁlvaro Peña <alvaropg@gmail.com>2013-12-17 22:49:26 +0100
committerÁlvaro Peña <alvaropg@gmail.com>2013-12-17 22:49:26 +0100
commit5d66f02ca8abf5efd2dc0be99bc73644114c1d19 (patch)
tree3b7512ddafdb3631a405d51c0f05448077fe9536
parent75ef38c978f11adfeafd0859fbbcfdd10f3ea275 (diff)
downloadlibgfbgraph-5d66f02ca8abf5efd2dc0be99bc73644114c1d19.tar.gz
doc: Documentation updated to look gorgeous.
-rw-r--r--configure.ac1
-rw-r--r--docs/reference/Makefile.am2
-rw-r--r--docs/reference/gfbgraph-docs.xml67
-rw-r--r--docs/reference/version.xml.in1
4 files changed, 59 insertions, 12 deletions
diff --git a/configure.ac b/configure.ac
index 8a55020..ea94c83 100644
--- a/configure.ac
+++ b/configure.ac
@@ -55,5 +55,6 @@ Makefile
libgfbgraph.pc
docs/Makefile
docs/reference/Makefile
+docs/reference/version.xml
gfbgraph/Makefile
tests/Makefile])
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index d531b92..2591630 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -86,7 +86,7 @@ include $(top_srcdir)/gtk-doc.make
# Other files to distribute
# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST +=
+EXTRA_DIST += version.xml.in
# Files not to distribute
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
diff --git a/docs/reference/gfbgraph-docs.xml b/docs/reference/gfbgraph-docs.xml
index b09c62e..6262a95 100644
--- a/docs/reference/gfbgraph-docs.xml
+++ b/docs/reference/gfbgraph-docs.xml
@@ -3,38 +3,83 @@
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+ <!ENTITY version SYSTEM "version.xml">
]>
<book id="index">
<bookinfo>
- <title>gfbgraph Reference Manual</title>
- <releaseinfo>
- for gfbgraph [VERSION].
- The latest version of this documentation can be found on-line at
- <ulink role="online-location" url="http://[SERVER]/gfbgraph/index.html">http://[SERVER]/gfbgraph/</ulink>.
- </releaseinfo>
+ <title>GFBGraph Reference Manual</title>
+ <releaseinfo>Version &version;</releaseinfo>
+ <authorgroup>
+ <author>
+ <firstname>Álvaro</firstname>
+ <surname>Peña</surname>
+ <affiliation>
+ <address>
+ <email>alvaropg@gmail.org</email>
+ </address>
+ </affiliation>
+ </author>
+ </authorgroup>
+
+ <copyright>
+ <year>2013</year>
+ <holder>The GFBGraph authors</holder>
+ </copyright>
+
+ <legalnotice>
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the <citetitle>GNU Free
+ Documentation License</citetitle>, Version 1.1 or any later
+ version published by the Free Software Foundation with no
+ Invariant Sections, no Front-Cover Texts, and no Back-Cover
+ Texts. You may obtain a copy of the <citetitle>GNU Free
+ Documentation License</citetitle> from the Free Software
+ Foundation by visiting
+ <ulink type="http" url="http://www.fsf.org">their Web site
+ </ulink> or by writing to:
+ <address>
+ <street>51 Franklin Street</street>, Fifth Floor
+ <city>Boston</city>,
+ <state>MA</state>
+ <postcode>02110-1335</postcode>
+ <country>USA</country>
+ </address>
+ </para>
+ </legalnotice>
</bookinfo>
<chapter>
- <title>[Insert title here]</title>
- <xi:include href="xml/gfbgraph-album.xml"/>
+ <title>Authorization</title>
<xi:include href="xml/gfbgraph-authorizer.xml"/>
- <xi:include href="xml/gfbgraph-common.xml"/>
- <xi:include href="xml/gfbgraph-connectable.xml"/>
+ <xi:include href="xml/gfbgraph-simple-authorizer.xml"/>
<xi:include href="xml/gfbgraph-goa-authorizer.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Nodes</title>
+ <xi:include href="xml/gfbgraph-album.xml"/>
+ <xi:include href="xml/gfbgraph-connectable.xml"/>
<xi:include href="xml/gfbgraph-node.xml"/>
<xi:include href="xml/gfbgraph-photo.xml"/>
- <xi:include href="xml/gfbgraph-simple-authorizer.xml"/>
<xi:include href="xml/gfbgraph-user.xml"/>
+ </chapter>
+ <chapter>
+ <title>Other</title>
+ <xi:include href="xml/gfbgraph-common.xml"/>
</chapter>
+
<chapter id="object-tree">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
+
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
+
<index id="deprecated-api-index" role="deprecated">
<title>Index of deprecated API</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/docs/reference/version.xml.in
@@ -0,0 +1 @@
+@VERSION@