From b5b78b5778397ff4fa517d2a2bb16e580aa65290 Mon Sep 17 00:00:00 2001 From: Silvio Date: Tue, 22 Feb 2011 11:43:41 -0300 Subject: Documentation update (3) --- doc/html/index.html | 64 +++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 57 insertions(+), 7 deletions(-) (limited to 'doc/html/index.html') diff --git a/doc/html/index.html b/doc/html/index.html index 11e7a1b..04bfaaa 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -43,11 +43,61 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

Cinisis Database Reader

-

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 is a CDS/ISIS database reading library written in PHP. It's intended for integrating or migrating existing ISIS databases into other applications. It is a wrapper around other ISIS libraries and tools, providing an uniform interface and iterators for easily fetching data without bothering with internals.

+

Cinisis works with the following ISIS backend libraries:

+ +

Both Malete and Openisis support is outdated in favour os Biblio::Isis as it has proven to be simpler and more functional.

+

Installation and usage

Cinisis database reader
 =======================
 
+Installation
+------------
+
+### Getting Cinisis
+
+Cinisis source code can be obtained via git:
+
+    git clone http://git.devlet.com.br/cinisis.git
+
+This documentation covers just installation with Biblio::Isis library
+and assumes a Debian like operating system.
+
+### Installing BiblioIsis
+
+The Biblio:Isis can be installed directly from package together with
+development files for perl:
+
+    apt-get install libbiblio-isis-perl libperl-dev
+
+### Installing pecl-perl
+
+Then download and build pecl-perl:
+
+    pecl install perl
+
+Due to a bug (see http://pecl.php.net/bugs/bug.php?id=16807), you might
+prefer to install it directly from source:
+
+    svn checkout http://svn.php.net/repository/pecl/perl/trunk pecl-perl
+    cd pecl-perl
+    phpize
+    ./configure
+    make install
+
+You will still need to enable the extension in your php.ini depending on
+how your system is configured.
+
+### Getting spyc
+
+Cinisis config files are written in YAML. You'll need to download Spyc
+library from https://code.google.com/p/spyc/ and put the files at
+the contrib/ folder.
+
 Naming conventions
 ------------------
 
@@ -65,10 +115,10 @@ iterating over all the data from a ISIS database.
 
 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
+    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
@@ -88,7 +138,7 @@ subfield is the data with qualifiers (like subfields a and b from above).
-
Generated on Tue Feb 22 2011 10:19:13 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:15 for Cinisis Database Reader by  doxygen 1.7.1
-- cgit v1.2.3