Initial revision

cole/doc/cole-manual.sgml

@@ -0,0 +1,73 @@
+<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!entity Introduction		SYSTEM "introduction.sgml">
+<!entity Using-cole		SYSTEM "using.sgml">
+<!entity Bugs			SYSTEM "bugs.sgml">
+<!entity BUGS-File		SYSTEM "BUGS">
+<!entity GPL-License-Chapter	SYSTEM "gpl.sgml">
+<!entity Legal			SYSTEM "legal.sgml">
+<!entity cole-Internals		SYSTEM "sgml/internals.sgml">
+<!entity cole-API		SYSTEM "sgml/api.sgml">
+<!entity How-To-Compile		SYSTEM "compile.sgml">
+
+<!entity author-name-full "Roberto Arturo Tena S&aacute;nchez">
+<!entity maintainer-email-ulink "<ulink
+	URL=&#34;mailto:arturo@directmail.org&#34;
+	>&lt;arturo@directmail.org&gt;</ulink>">
+]>
+
+<book id="index">
+
+
+<bookinfo>
+	<title>cole Library Reference Manual</title>
+	<copyright>
+		<year>1998, 1999</year>
+		<holder>&author-name-full;</holder>
+	</copyright>
+</bookinfo>
+
+
+<chapter id="introduction">
+	<title>Introduction</title>
+	&Introduction;
+</chapter>
+
+
+<chapter id="how-to-compile">
+	<title>How to compile cole</title>
+	&How-To-Compile;
+</chapter>
+
+
+<chapter id="libcole">
+	<title>cole Library</title>
+	<para>
+		This is the documentation autogenerated from the source code. It have the cole <link linkend="cole-API">API</link> for this release, and some internal structures and internal calls.
+	</para>
+	<para>
+		Note: what Microsoft calls <userinput>stream</userinput> is called <userinput>file</userinput> in this project, <userinput>storage</userinput> is called <userinput>directory</userinput> and <userinput>docfile</userinput> (a Structured Storage file) is called <userinput>filesystem</userinput>.
+	</para>
+	&Using-cole;
+
+	&cole-API;
+	&cole-Internals;
+</chapter>
+
+
+<chapter id="bugs">
+	<title>Bugs</title>
+	&Bugs;
+</chapter>
+
+
+<chapter id="legal-issues">
+	<title>Legal issues</title>
+	&Legal;
+</chapter> <!-- legal-issues -->
+
+
+&GPL-License-Chapter;
+
+
+</book>
+