From f253764c93f49dcdfe01b9e3f4d2a1352406b8f1 Mon Sep 17 00:00:00 2001 From: Silvio Date: Tue, 22 Feb 2011 10:37:10 -0300 Subject: Documentation update --- doc/html/index.html | 70 ++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 53 insertions(+), 17 deletions(-) (limited to 'doc/html/index.html') diff --git a/doc/html/index.html b/doc/html/index.html index 5a3b3dd..11e7a1b 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -1,43 +1,79 @@ - -Cinisis Database Reader: Main Page +Cinisis Database Reader: Cinisis Database Reader - + +
+
+

Cinisis Database Reader

+
-

Cinisis Database Reader Documentation

+

Cinisis is a CDS/ISIS database reading library written in PHP. It's intended for integrating or migrating existing ISIS databases into other applications.

+

Usage:

+
Cinisis database reader
+=======================
+
+Naming conventions
+------------------
+
+The following naming conventions are used through Cinisis aiming to help
+iterating over all the data from a ISIS database.
+
+  - Database:  an ISIS database.
+  - Entry:     a given MFN in the database.
+  - Value:     all the data from a given entry in the database.
+  - Field:     a numbered set of values from a given entry.
+  - Row:       a single value from a given field.
+  - Main item: the data in a row without a qualifier.
+  - Subfield:  every data in a row within a qualifier.
+  - Item:      either a main item or subfield withing a row.
+
+Example:
+
+  MFN 1 with entry
+  10: First  row of field 10^aWith a subfield^bAnd another one
+  10: Second row of field 10^bJust with the second subfield
+  20: This is the main item^yAnd this is another item
+
+For that entry we have fields 10 and 20, where field 10 has two rows (i.e, two
+repetitions). The main field is the data wich is has no qualifier (^) and a
+subfield is the data with qualifiers (like subfields a and b from above).
+
-
Generated on Mon Sep 20 13:53:30 2010 for Cinisis Database Reader by  + +doxygen 1.7.1
-- cgit v1.2.3