Added an id for the API reference <part>. Added the FDL <legalnotice>.

2000-11-29  Federico Mena Quintero  <federico@helixcode.com>

	* evolution-devel-guide.sgml: Added an id for the API reference <part>.
	Added the FDL <legalnotice>.
	Added the preface and toplevel reference entities.
	Added entities for Evolution, Wombat, and Camel.
	Added an appendix for the GNU FDL.

	* preface.sgml: New file with the introduction to the Evolution
	Developer's Guide.

	* reference.sgml: Split the toplevel reference part into its own
	file.

	* fdl.sgml: Added the GNU Free Documentation License.

	* calendar/evolution-calendar.sgml: Added an id for the <part>.

	* calendar/public-reference.sgml: Added an id for the <reference>.
	Moved this file over from calendar/reference.sgml.

	* Makefile.am (local_entities): Added a list of the SGML files
	that define entities for inclusion in the toplevel document.  This
	way we can track documentation file dependencies down to all
	levels.
	(html/index.html): Made the toplevel document depend on
	$(local_entities).  Also, removed the "html" target and put its
	contents directly here; this way we avoid having .PHONY targets.
	(EXTRA_DIST): Removed the evolution_devel_guideDATA; it made no
	sense.
	(content_files): Added preface.sgml and reference.sgml.

svn path=/trunk/; revision=6715

1 files changed, 45 insertions, 0 deletions

diff --git a/doc/devel/reference.sgml b/doc/devel/reference.sgml
new file mode 100644
index 0000000000..3773821a0f
--- /dev/null
+++ b/doc/devel/reference.sgml
@@ -0,0 +1,45 @@
+  <part id="evolution-api-reference">
+    <title>&Evolution; API Reference</title>
+
+    <partintro>
+      <para>
+	This part presents the class and function reference for the
+	different libraries and interfaces that &Evolution; provides.
+	Classes are described together with their methods; individual
+	functions are grouped by functional group.
+      </para>
+
+      <para>
+	&Evolution; provides two kinds of interfaces, public and
+	private.  The public interfaces are those designed to be used
+	from third-party applications or components; if you wanted to
+	write an application that uses &Evolution;'s data repositories
+	to display data in a particular way, you would use the public
+	interfaces.  The private interfaces are those used inside
+	&Evolution; itself; these are generally not interesting unless
+	you intend to make modifications to the &Evolution; code base.
+      </para>
+
+      <para>
+	While the public and private interfaces are described in
+	separate reference sections, we have decided to put them
+	together in the same book, this guide, because we want to
+	encourage you to regard &Evolution; as something more than a
+	black box that stores and dispatches personal information.  We
+	want you to make modifications to the &Evolution; core if
+	these would allow you to present or store your data in better
+	ways.  &Evolution; is free software; we want you to learn from
+	its design and implementation details so that you can make it
+	even better for the whole world to use.
+      </para>
+    </partintro>
+
+    &calendar-public-reference;
+  </part>
+
+<!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("evolution-devel-guide.sgml" "book" "book" "")
+End:
+-->