Initial commit

4 files changed, 161 insertions, 0 deletions

diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..f3ddc22
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = reference
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 0000000..0f77dbb
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1,70 @@
+## Process this file with automake to produce Makefile.in
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module
+DOC_MODULE=libplanfahr-0.0
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting functions and macros.
+DOC_SOURCE_DIR=../../src
+
+# Extra options to supply to gtkdoc-scan.
+SCAN_OPTIONS='--rebuild-types'
+
+# Extra options to supply to gtkdoc-scangobj.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-fixref.
+FIXXREF_OPTIONS=
+
+# Used for dependencies.
+HFILE_GLOB=
+CFILE_GLOB=
+
+# Header files to ignore when scanning.
+IGNORE_HFILES = \
+	planfahr.h 	\
+	de-db.h    	\
+	hafas-bin6.h 	\
+	$(NULL)
+
+# Images to copy into HTML directory.
+HTML_IMAGES = 
+
+# Extra XML files that are included by $(DOC_MAIN_SGML_FILE).
+content_files =				\
+	build-howto.xml			\
+	$(NULL)
+
+# Other files to distribute.
+extra_files =
+
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+GTKDOC_CFLAGS =				\
+	-I$(top_srcdir)			\
+	-I$(top_builddir)		\
+	$(GLIB_CFLAGS)			\
+	$(XML_CFLAGS)			\
+	$(NULL)
+
+GTKDOC_LIBS =					\
+	$(top_builddir)/src/libplanfahr-0.0.la	\
+	$(GLIB_LIBS)
+
+# include common portion ...
+include $(top_srcdir)/gtk-doc.make
+
+# kludges
+$(srcdir)/tmpl/*.sgml:
+
+clean: clean-am
+	rm -rf tmpl
diff --git a/docs/reference/build-howto.xml b/docs/reference/build-howto.xml
new file mode 100644
index 0000000..e0922a1
--- /dev/null
+++ b/docs/reference/build-howto.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<refentry id="libplanfahr-build-howto">
+<refmeta>
+<refentrytitle>Compiling with libplanfahr</refentrytitle>
+<manvolnum>3</manvolnum>
+<refmiscinfo>LIBPLANFAHR Library</refmiscinfo>
+</refmeta>
+
+<refnamediv>
+<refname>Compiling with libplanfahr</refname><refpurpose>Notes on compiling</refpurpose>
+</refnamediv>
+
+<refsect2>
+<title>Using pkg-config</title>
+
+<para>
+Like other GNOME libraries, <application>libplanfahr</application> uses
+<application>pkg-config</application> to provide compiler options. The
+package name is "<literal>libplanfahr-0.0</literal>". So in your
+<literal>configure</literal> script, you might specify something like:
+</para>
+
+<informalexample><programlisting>
+PKG_CHECK_MODULES(LIBPLANFAHR, [libplanfahr-0.0])
+AC_SUBST(LIBPLANFAHR_CFLAGS)
+AC_SUBST(LIBPLANFAHR_LIBS)
+</programlisting></informalexample>
+
+<para>
+The "<literal>0.0</literal>" in the package name is the "API version"
+(indicating "the version of the <application>libplanfahr</application> API
+that first appeared in version 0.0") and is essentially just part of
+the package name.
+</para>
+
+</refsect2>
+
+<refsect2>
+<title>Headers</title>
+
+<para>
+Code using <application>libplanfahr</application> should do:
+</para>
+
+<informalexample><programlisting>
+#include &lt;libplanfahr/planfahr.h&gt;
+</programlisting></informalexample>
+
+<para>
+Including individual headers rather than <literal>planfahr.h</literal> is not
+recommended.
+</para>
+
+</refsect2>
+
+</refentry>
diff --git a/docs/reference/libplanfahr-0.0-docs.sgml b/docs/reference/libplanfahr-0.0-docs.sgml
new file mode 100644
index 0000000..db2b5f8
--- /dev/null
+++ b/docs/reference/libplanfahr-0.0-docs.sgml
@@ -0,0 +1,32 @@
+<?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">
+<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude">
+  <bookinfo>
+    <title>libplanfahr Reference Manual</title>
+  </bookinfo>
+
+  <chapter>
+    <title>Tutorial</title>
+    <xi:include href="build-howto.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Core API</title>
+    <xi:include href="xml/lpf-loc.xml"/>
+    <xi:include href="xml/lpf-manager.xml"/>
+    <xi:include href="xml/lpf-stop.xml"/>
+    <xi:include href="xml/lpf-trip.xml"/>
+    <xi:include href="xml/lpf-trip-part.xml"/>
+    <xi:include href="xml/lpf-provider.xml"/>
+  </chapter>
+
+  <index>
+    <title>Index</title>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml">
+    <xi:fallback />
+  </xi:include>
+
+</book>