[prev in list] [next in list] [prev in thread] [next in thread]
List: midgard-dev
Subject: [midgard-dev] cvs: /midgard/doc Makefile faq.sgml manual.sgml /midgard/doc/functions group.sgml host
From: hukka <midgard-dev () greywolves ! org>
Date: 1999-10-05 17:17:49
[Download RAW message or body]
hukka Tue Oct 5 21:00:58 1999 EDT
Modified files:
/midgard/doc Makefile faq.sgml manual.sgml
/midgard/doc/functions group.sgml host.sgml other.sgml style.sgml
topic.sgml
Log:
Bunch of changes that I did during my offline time... :(
Index: midgard/doc/Makefile
diff -u midgard/doc/Makefile:1.5 midgard/doc/Makefile:1.6
--- midgard/doc/Makefile:1.5 Fri Sep 17 16:02:32 1999
+++ midgard/doc/Makefile Tue Oct 5 21:00:53 1999
@@ -1,6 +1,16 @@
-all: html
+all: faq funcref manual
-html: manual/book1.html
+faq: faq/a1.html
+
+faq/a1.html: faq.sgml
+ sgmltools -bhtml faq.sgml
+
+funcref: funcref/part1.html
+
+funcref/part1.html: funcref.sgml
+ sgmltools -bhtml funcref.sgml
+
+manual: manual/book1.html
manual/book1.html: manual.sgml functions/topic.sgml functions/host.sgml \
functions/style.sgml functions/group.sgml functions/other.sgml faq.sgml sgmltools \
-bhtml manual.sgml
Index: midgard/doc/faq.sgml
diff -u midgard/doc/faq.sgml:1.10 midgard/doc/faq.sgml:1.11
--- midgard/doc/faq.sgml:1.10 Wed Sep 29 18:02:28 1999
+++ midgard/doc/faq.sgml Tue Oct 5 21:00:53 1999
@@ -1,4 +1,17 @@
-<appendix id="app.faq">
+<!-- $Id -->
+<!DOCTYPE appendix PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!ENTITY midgard.version.1.0 "Midgard 1.0 'Land Rover'">
+<!ENTITY midgard.version.1.0.1 "Midgard 1.0.1 'Land Rover fixed'">
+<!ENTITY midgard.version.1.0.2 "Midgard 1.0.2 'Land Rover'">
+<!ENTITY midgard.version.1.1 "Midgard 1.1 'Iron River'">
+<!ENTITY midgard.version.1.1.1 "Midgard 1.1.1 'Iron River'">
+<!ENTITY midgard.version.1.2 "Midgard 1.2 'Mad King'">
+<!ENTITY midgard.version.1.2.1 "Midgard 1.2.1 'Mad King'">
+<!ENTITY midgard.version.1.2.2 "Midgard 1.2.2 'Mad King'">
+<!ENTITY midgard.version.1.2.3 "Midgard 1.2.3 'Mad King'">
+<!ENTITY midgard.version.1.3 "Midgard 1.3 'Broken Shinai'">
+]>
+<appendix id="faq">
<title>Frequently Asked Questions</title>
<titleabbrev>Midgard FAQ</titleabbrev>
Index: midgard/doc/manual.sgml
diff -u midgard/doc/manual.sgml:1.8 midgard/doc/manual.sgml:1.9
--- midgard/doc/manual.sgml:1.8 Fri Sep 24 15:45:00 1999
+++ midgard/doc/manual.sgml Tue Oct 5 21:00:53 1999
@@ -1,10 +1,6 @@
<!DOCTYPE BOOK PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
-<!ENTITY reference.topic SYSTEM "functions/topic.sgml">
-<!ENTITY reference.group SYSTEM "functions/group.sgml">
-<!ENTITY reference.host SYSTEM "functions/host.sgml">
-<!ENTITY reference.style SYSTEM "functions/style.sgml">
-<!ENTITY reference.other SYSTEM "functions/other.sgml">
-<!ENTITY appendix.faq SYSTEM "faq.sgml">
+<!ENTITY funcref SYSTEM "funcref.sgml" SUBDOC>
+<!ENTITY appendix.faq SYSTEM "faq.sgml" SUBDOC>
<!ENTITY midgard.version.1.0 "Midgard 1.0 'Land Rover'">
<!ENTITY midgard.version.1.0.1 "Midgard 1.0.1 'Land Rover fixed'">
<!ENTITY midgard.version.1.0.2 "Midgard 1.0.2 'Land Rover'">
@@ -30,92 +26,7 @@
</authorgroup>
</bookinfo>
- <part id="funcref">
- <title>Function Reference</title>
-
- <preface>
- <title>Introduction to Midgard functions</title>
-
- <sect1>
- <title>List functions</title>
- <para>
- The list functions return a set of records from the
- database. They are given a variable set of arguments to
- specify the search and sort criteria used in querying the
- database. The list functions return a php object whose
- member variable N contains the number of returned records
- and the member function fetch() fills the object fields with
- information of the records each in turn. The type of the
- records determines the set of fields that are returned. The
- list functions generally only return simple and short fields
- of the records. You need to use a get function to access the
- rest of the record.
- </para>
- </sect1>
-
- <sect1>
- <title>Get functions</title>
- <para>
- The get functions return the contents of a database
- record. They take the record id as argument and return the
- contents of the record as a php object. Access rights are
- checked to determine how much information of the record is
- returned to the user.
- </para>
- </sect1>
-
- <sect1>
- <title>Create functions</title>
- <para>
- The create functions add records to the database. They are
- given a set of field values as arguments and they return the
- id number of the created record on success or zero on
- failure. The functions only create the record if the user
- has proper privileges and there are not yet record's with
- the same name and properties in the database. The functions
- also set the creation timestamps and creator information.
- </para>
- </sect1>
-
- <sect1>
- <title>Update functions</title>
- <para>
- The update functions modify records in the database. They
- are given the record id and a set of field values as
- arguments and they return true if the record was
- successfully modified. Only users with enough access rights
- are allowed to modify records. The modification timestamp
- and revision information of the record is also updated.
- Normally the update functions allow users to change only a
- restricted set of fields of a record. For example the type
- code of an article or the name of a user preference is set
- at creation time and cannot be changed afterwards. There are
- also a few extra update functions that update a special set
- of fields of a record. Examples of such extra functions are
- mgd_update_password and mgd_update_article_score.
- </para>
- </sect1>
-
- <sect1>
- <title>Delete functions</title>
- <para>
- The delete functions remove records from the database. They
- all take a record id as an argument and return true if the
- given record was successfully removed from the database. A
- user is allowed to remove a record only if he has
- appropriate privileges and there are no links pointing to
- the record.
- </para>
- </sect1>
-
- </preface>
-
- &reference.topic;
- &reference.group;
- &reference.host;
- &reference.style;
- &reference.other;
- </part>
+ &funcref;
<part id="appendices">
<title>Appendices</title>
Index: midgard/doc/functions/group.sgml
diff -u midgard/doc/functions/group.sgml:1.5 midgard/doc/functions/group.sgml:1.6
--- midgard/doc/functions/group.sgml:1.5 Mon Sep 27 15:43:07 1999
+++ midgard/doc/functions/group.sgml Tue Oct 5 21:00:55 1999
@@ -1,3 +1,15 @@
+<!DOCTYPE reference PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!ENTITY midgard.version.1.0 "Midgard 1.0 'Land Rover'">
+<!ENTITY midgard.version.1.0.1 "Midgard 1.0.1 'Land Rover fixed'">
+<!ENTITY midgard.version.1.0.2 "Midgard 1.0.2 'Land Rover'">
+<!ENTITY midgard.version.1.1 "Midgard 1.1 'Iron River'">
+<!ENTITY midgard.version.1.1.1 "Midgard 1.1.1 'Iron River'">
+<!ENTITY midgard.version.1.2 "Midgard 1.2 'Mad King'">
+<!ENTITY midgard.version.1.2.1 "Midgard 1.2.1 'Mad King'">
+<!ENTITY midgard.version.1.2.2 "Midgard 1.2.2 'Mad King'">
+<!ENTITY midgard.version.1.2.3 "Midgard 1.2.3 'Mad King'">
+<!ENTITY midgard.version.1.3 "Midgard 1.3 'Broken Shinai'">
+]>
<reference id="ref.group">
<title>Person and group functions</title>
<titleabbrev>Persons and groups</titleabbrev>
Index: midgard/doc/functions/host.sgml
diff -u midgard/doc/functions/host.sgml:1.1 midgard/doc/functions/host.sgml:1.2
--- midgard/doc/functions/host.sgml:1.1 Fri Aug 13 11:26:17 1999
+++ midgard/doc/functions/host.sgml Tue Oct 5 21:00:55 1999
@@ -1,3 +1,15 @@
+<!DOCTYPE reference PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!ENTITY midgard.version.1.0 "Midgard 1.0 'Land Rover'">
+<!ENTITY midgard.version.1.0.1 "Midgard 1.0.1 'Land Rover fixed'">
+<!ENTITY midgard.version.1.0.2 "Midgard 1.0.2 'Land Rover'">
+<!ENTITY midgard.version.1.1 "Midgard 1.1 'Iron River'">
+<!ENTITY midgard.version.1.1.1 "Midgard 1.1.1 'Iron River'">
+<!ENTITY midgard.version.1.2 "Midgard 1.2 'Mad King'">
+<!ENTITY midgard.version.1.2.1 "Midgard 1.2.1 'Mad King'">
+<!ENTITY midgard.version.1.2.2 "Midgard 1.2.2 'Mad King'">
+<!ENTITY midgard.version.1.2.3 "Midgard 1.2.3 'Mad King'">
+<!ENTITY midgard.version.1.3 "Midgard 1.3 'Broken Shinai'">
+]>
<reference id="ref.host">
<title>Host and page functions</title>
<titleabbrev>Hosts and pages</titleabbrev>
Index: midgard/doc/functions/other.sgml
diff -u midgard/doc/functions/other.sgml:1.3 midgard/doc/functions/other.sgml:1.4
--- midgard/doc/functions/other.sgml:1.3 Fri Sep 17 13:27:50 1999
+++ midgard/doc/functions/other.sgml Tue Oct 5 21:00:55 1999
@@ -1,3 +1,15 @@
+<!DOCTYPE reference PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!ENTITY midgard.version.1.0 "Midgard 1.0 'Land Rover'">
+<!ENTITY midgard.version.1.0.1 "Midgard 1.0.1 'Land Rover fixed'">
+<!ENTITY midgard.version.1.0.2 "Midgard 1.0.2 'Land Rover'">
+<!ENTITY midgard.version.1.1 "Midgard 1.1 'Iron River'">
+<!ENTITY midgard.version.1.1.1 "Midgard 1.1.1 'Iron River'">
+<!ENTITY midgard.version.1.2 "Midgard 1.2 'Mad King'">
+<!ENTITY midgard.version.1.2.1 "Midgard 1.2.1 'Mad King'">
+<!ENTITY midgard.version.1.2.2 "Midgard 1.2.2 'Mad King'">
+<!ENTITY midgard.version.1.2.3 "Midgard 1.2.3 'Mad King'">
+<!ENTITY midgard.version.1.3 "Midgard 1.3 'Broken Shinai'">
+]>
<reference id="ref.other">
<title>Other functions</title>
<titleabbrev>Other</titleabbrev>
Index: midgard/doc/functions/style.sgml
diff -u midgard/doc/functions/style.sgml:1.1 midgard/doc/functions/style.sgml:1.2
--- midgard/doc/functions/style.sgml:1.1 Fri Aug 13 11:26:17 1999
+++ midgard/doc/functions/style.sgml Tue Oct 5 21:00:56 1999
@@ -1,3 +1,15 @@
+<!DOCTYPE reference PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!ENTITY midgard.version.1.0 "Midgard 1.0 'Land Rover'">
+<!ENTITY midgard.version.1.0.1 "Midgard 1.0.1 'Land Rover fixed'">
+<!ENTITY midgard.version.1.0.2 "Midgard 1.0.2 'Land Rover'">
+<!ENTITY midgard.version.1.1 "Midgard 1.1 'Iron River'">
+<!ENTITY midgard.version.1.1.1 "Midgard 1.1.1 'Iron River'">
+<!ENTITY midgard.version.1.2 "Midgard 1.2 'Mad King'">
+<!ENTITY midgard.version.1.2.1 "Midgard 1.2.1 'Mad King'">
+<!ENTITY midgard.version.1.2.2 "Midgard 1.2.2 'Mad King'">
+<!ENTITY midgard.version.1.2.3 "Midgard 1.2.3 'Mad King'">
+<!ENTITY midgard.version.1.3 "Midgard 1.3 'Broken Shinai'">
+]>
<reference id="ref.style">
<title>Style and element functions</title>
<titleabbrev>Styles and elements</titleabbrev>
Index: midgard/doc/functions/topic.sgml
diff -u midgard/doc/functions/topic.sgml:1.9 midgard/doc/functions/topic.sgml:1.10
--- midgard/doc/functions/topic.sgml:1.9 Fri Sep 17 15:53:30 1999
+++ midgard/doc/functions/topic.sgml Tue Oct 5 21:00:56 1999
@@ -1,3 +1,15 @@
+<!DOCTYPE reference PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+<!ENTITY midgard.version.1.0 "Midgard 1.0 'Land Rover'">
+<!ENTITY midgard.version.1.0.1 "Midgard 1.0.1 'Land Rover fixed'">
+<!ENTITY midgard.version.1.0.2 "Midgard 1.0.2 'Land Rover'">
+<!ENTITY midgard.version.1.1 "Midgard 1.1 'Iron River'">
+<!ENTITY midgard.version.1.1.1 "Midgard 1.1.1 'Iron River'">
+<!ENTITY midgard.version.1.2 "Midgard 1.2 'Mad King'">
+<!ENTITY midgard.version.1.2.1 "Midgard 1.2.1 'Mad King'">
+<!ENTITY midgard.version.1.2.2 "Midgard 1.2.2 'Mad King'">
+<!ENTITY midgard.version.1.2.3 "Midgard 1.2.3 'Mad King'">
+<!ENTITY midgard.version.1.3 "Midgard 1.3 'Broken Shinai'">
+]>
<reference id="ref.topic">
<title>Topic and article functions</title>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic