From b5b78b5778397ff4fa517d2a2bb16e580aa65290 Mon Sep 17 00:00:00 2001 From: Silvio Date: Tue, 22 Feb 2011 11:43:41 -0300 Subject: Documentation update (3) --- README.txt | 51 +++++++++++- doc/html/annotated.html | 2 +- doc/html/classBiblioIsisDb-members.html | 2 +- doc/html/classBiblioIsisDb.html | 2 +- doc/html/classCinisis-members.html | 2 +- doc/html/classCinisis.html | 2 +- doc/html/classCinisisDisplayHelper-members.html | 2 +- doc/html/classCinisisDisplayHelper.html | 2 +- doc/html/classCinisisHttpHelper-members.html | 2 +- doc/html/classCinisisHttpHelper.html | 2 +- doc/html/classIsisAudit-members.html | 2 +- doc/html/classIsisAudit.html | 2 +- doc/html/classIsisConnector-members.html | 2 +- doc/html/classIsisConnector.html | 2 +- doc/html/classIsisEntryIterator-members.html | 2 +- doc/html/classIsisEntryIterator.html | 2 +- doc/html/classIsisFinder-members.html | 2 +- doc/html/classIsisFinder.html | 2 +- doc/html/classIsisItemIterator-members.html | 2 +- doc/html/classIsisItemIterator.html | 2 +- doc/html/classIsisMainItemIterator-members.html | 2 +- doc/html/classIsisMainItemIterator.html | 2 +- doc/html/classIsisMap-members.html | 2 +- doc/html/classIsisMap.html | 2 +- doc/html/classIsisMethodIterator-members.html | 2 +- doc/html/classIsisMethodIterator.html | 2 +- .../classIsisNormalItemFilterIterator-members.html | 2 +- doc/html/classIsisNormalItemFilterIterator.html | 2 +- doc/html/classIsisReader-members.html | 2 +- doc/html/classIsisReader.html | 2 +- doc/html/classIsisRowIterator-members.html | 2 +- doc/html/classIsisRowIterator.html | 2 +- doc/html/classIsisSubfieldIterator-members.html | 2 +- doc/html/classIsisSubfieldIterator.html | 2 +- doc/html/classIsisValueIterator-members.html | 2 +- doc/html/classIsisValueIterator.html | 2 +- doc/html/classMaleteDb-members.html | 2 +- doc/html/classMaleteDb.html | 2 +- doc/html/classPhpIsisDb-members.html | 2 +- doc/html/classPhpIsisDb.html | 2 +- doc/html/classSchemaDb-members.html | 2 +- doc/html/classSchemaDb.html | 2 +- doc/html/classes.html | 2 +- doc/html/functions.html | 2 +- doc/html/functions_0x5f.html | 2 +- doc/html/functions_0x61.html | 2 +- doc/html/functions_0x62.html | 2 +- doc/html/functions_0x63.html | 2 +- doc/html/functions_0x65.html | 2 +- doc/html/functions_0x66.html | 2 +- doc/html/functions_0x67.html | 2 +- doc/html/functions_0x68.html | 2 +- doc/html/functions_0x69.html | 2 +- doc/html/functions_0x6a.html | 2 +- doc/html/functions_0x6b.html | 2 +- doc/html/functions_0x6c.html | 2 +- doc/html/functions_0x6d.html | 2 +- doc/html/functions_0x6e.html | 2 +- doc/html/functions_0x6f.html | 2 +- doc/html/functions_0x70.html | 2 +- doc/html/functions_0x72.html | 2 +- doc/html/functions_0x73.html | 2 +- doc/html/functions_0x74.html | 2 +- doc/html/functions_0x76.html | 2 +- doc/html/functions_0x77.html | 2 +- doc/html/functions_0x79.html | 2 +- doc/html/functions_func.html | 2 +- doc/html/functions_vars.html | 2 +- doc/html/hierarchy.html | 2 +- doc/html/index.html | 64 +++++++++++++-- doc/html/interfaceIsisDb-members.html | 2 +- doc/html/interfaceIsisDb.html | 2 +- doc/html/pages.html | 2 +- doc/html/todo.html | 2 +- doc/latex/classBiblioIsisDb.pdf | Bin 4432 -> 4432 bytes doc/latex/classIsisAudit.pdf | Bin 5896 -> 5896 bytes doc/latex/classIsisConnector.pdf | Bin 5892 -> 5892 bytes doc/latex/classIsisFinder.pdf | Bin 5893 -> 5893 bytes doc/latex/classIsisMap.pdf | Bin 5892 -> 5892 bytes doc/latex/classIsisReader.pdf | Bin 5892 -> 5892 bytes doc/latex/classMaleteDb.pdf | Bin 4661 -> 4661 bytes doc/latex/classPhpIsisDb.pdf | Bin 4491 -> 4491 bytes doc/latex/doxygen.sty | 4 +- doc/latex/index.tex | 90 +++++++++++++++++++++ doc/latex/interfaceIsisDb.pdf | Bin 5431 -> 5431 bytes doc/latex/main.tex | 3 + doc/latex/refman.tex | 2 +- index.php | 15 +++- 88 files changed, 285 insertions(+), 88 deletions(-) create mode 100644 doc/latex/index.tex create mode 100644 doc/latex/main.tex diff --git a/README.txt b/README.txt index f0cf0a9..c23ad25 100644 --- a/README.txt +++ b/README.txt @@ -1,6 +1,49 @@ 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 ------------------ @@ -18,10 +61,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 diff --git a/doc/html/annotated.html b/doc/html/annotated.html index 3024315..a72e9bc 100644 --- a/doc/html/annotated.html +++ b/doc/html/annotated.html @@ -88,7 +88,7 @@ Here are the classes, structs, unions and interfaces with brief descriptions: -
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
diff --git a/doc/html/classBiblioIsisDb-members.html b/doc/html/classBiblioIsisDb-members.html index b8fa2e7..78f8fd2 100644 --- a/doc/html/classBiblioIsisDb-members.html +++ b/doc/html/classBiblioIsisDb-members.html @@ -87,7 +87,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classBiblioIsisDb.html b/doc/html/classBiblioIsisDb.html index a27bc6f..f4b6948 100644 --- a/doc/html/classBiblioIsisDb.html +++ b/doc/html/classBiblioIsisDb.html @@ -679,7 +679,7 @@ Public Attributes -
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classCinisis-members.html b/doc/html/classCinisis-members.html index 8eb1f75..d2e914d 100644 --- a/doc/html/classCinisis-members.html +++ b/doc/html/classCinisis-members.html @@ -78,7 +78,7 @@ This is the complete list of members for -
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classCinisis.html b/doc/html/classCinisis.html index 813cc5b..3e0522f 100644 --- a/doc/html/classCinisis.html +++ b/doc/html/classCinisis.html @@ -408,7 +408,7 @@ Public Attributes -
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classCinisisDisplayHelper-members.html b/doc/html/classCinisisDisplayHelper-members.html index 17a4850..31fa55a 100644 --- a/doc/html/classCinisisDisplayHelper-members.html +++ b/doc/html/classCinisisDisplayHelper-members.html @@ -102,7 +102,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classCinisisDisplayHelper.html b/doc/html/classCinisisDisplayHelper.html index 6aee45b..759c47d 100644 --- a/doc/html/classCinisisDisplayHelper.html +++ b/doc/html/classCinisisDisplayHelper.html @@ -1134,7 +1134,7 @@ Static Protected Member Functions -
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classCinisisHttpHelper-members.html b/doc/html/classCinisisHttpHelper-members.html index ae42a36..3940b8f 100644 --- a/doc/html/classCinisisHttpHelper-members.html +++ b/doc/html/classCinisisHttpHelper-members.html @@ -69,7 +69,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classCinisisHttpHelper.html b/doc/html/classCinisisHttpHelper.html index 6e884f8..8080367 100644 --- a/doc/html/classCinisisHttpHelper.html +++ b/doc/html/classCinisisHttpHelper.html @@ -170,7 +170,7 @@ Static Public Member Functions -
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisAudit-members.html b/doc/html/classIsisAudit-members.html index ec08c92..4aff7ef 100644 --- a/doc/html/classIsisAudit-members.html +++ b/doc/html/classIsisAudit-members.html @@ -124,7 +124,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisAudit.html b/doc/html/classIsisAudit.html index c2a070c..5b9b592 100644 --- a/doc/html/classIsisAudit.html +++ b/doc/html/classIsisAudit.html @@ -155,7 +155,7 @@ Public Attributes -
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisConnector-members.html b/doc/html/classIsisConnector-members.html index 302d117..a638840 100644 --- a/doc/html/classIsisConnector-members.html +++ b/doc/html/classIsisConnector-members.html @@ -114,7 +114,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisConnector.html b/doc/html/classIsisConnector.html index 99ff52b..2a54130 100644 --- a/doc/html/classIsisConnector.html +++ b/doc/html/classIsisConnector.html @@ -761,7 +761,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:14 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisEntryIterator-members.html b/doc/html/classIsisEntryIterator-members.html index 9a81720..940c471 100644 --- a/doc/html/classIsisEntryIterator-members.html +++ b/doc/html/classIsisEntryIterator-members.html @@ -72,7 +72,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisEntryIterator.html b/doc/html/classIsisEntryIterator.html index 600176e..9d793ce 100644 --- a/doc/html/classIsisEntryIterator.html +++ b/doc/html/classIsisEntryIterator.html @@ -211,7 +211,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisFinder-members.html b/doc/html/classIsisFinder-members.html index daa09ac..662f5ea 100644 --- a/doc/html/classIsisFinder-members.html +++ b/doc/html/classIsisFinder-members.html @@ -121,7 +121,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisFinder.html b/doc/html/classIsisFinder.html index 8db323f..ed1ceaa 100644 --- a/doc/html/classIsisFinder.html +++ b/doc/html/classIsisFinder.html @@ -412,7 +412,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisItemIterator-members.html b/doc/html/classIsisItemIterator-members.html index 5d29e44..1ebd0c4 100644 --- a/doc/html/classIsisItemIterator-members.html +++ b/doc/html/classIsisItemIterator-members.html @@ -72,7 +72,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisItemIterator.html b/doc/html/classIsisItemIterator.html index 56a21b8..b09e530 100644 --- a/doc/html/classIsisItemIterator.html +++ b/doc/html/classIsisItemIterator.html @@ -218,7 +218,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisMainItemIterator-members.html b/doc/html/classIsisMainItemIterator-members.html index d17996d..845aebc 100644 --- a/doc/html/classIsisMainItemIterator-members.html +++ b/doc/html/classIsisMainItemIterator-members.html @@ -74,7 +74,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisMainItemIterator.html b/doc/html/classIsisMainItemIterator.html index 919d275..2fe2fe6 100644 --- a/doc/html/classIsisMainItemIterator.html +++ b/doc/html/classIsisMainItemIterator.html @@ -249,7 +249,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisMap-members.html b/doc/html/classIsisMap-members.html index 1fb47fc..a072397 100644 --- a/doc/html/classIsisMap-members.html +++ b/doc/html/classIsisMap-members.html @@ -97,7 +97,7 @@ This is the complete list of members for -
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisMap.html b/doc/html/classIsisMap.html index 18e644c..9153645 100644 --- a/doc/html/classIsisMap.html +++ b/doc/html/classIsisMap.html @@ -703,7 +703,7 @@ Static Public Member Functions -
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisMethodIterator-members.html b/doc/html/classIsisMethodIterator-members.html index 58037ed..0ba2b32 100644 --- a/doc/html/classIsisMethodIterator-members.html +++ b/doc/html/classIsisMethodIterator-members.html @@ -72,7 +72,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisMethodIterator.html b/doc/html/classIsisMethodIterator.html index cfda6bf..7b5f682 100644 --- a/doc/html/classIsisMethodIterator.html +++ b/doc/html/classIsisMethodIterator.html @@ -211,7 +211,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisNormalItemFilterIterator-members.html b/doc/html/classIsisNormalItemFilterIterator-members.html index daec0fa..cca653e 100644 --- a/doc/html/classIsisNormalItemFilterIterator-members.html +++ b/doc/html/classIsisNormalItemFilterIterator-members.html @@ -67,7 +67,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisNormalItemFilterIterator.html b/doc/html/classIsisNormalItemFilterIterator.html index 874d11d..2c1a4c2 100644 --- a/doc/html/classIsisNormalItemFilterIterator.html +++ b/doc/html/classIsisNormalItemFilterIterator.html @@ -98,7 +98,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisReader-members.html b/doc/html/classIsisReader-members.html index 451437e..e442134 100644 --- a/doc/html/classIsisReader-members.html +++ b/doc/html/classIsisReader-members.html @@ -77,7 +77,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisReader.html b/doc/html/classIsisReader.html index 8d7167e..b6dc783 100644 --- a/doc/html/classIsisReader.html +++ b/doc/html/classIsisReader.html @@ -372,7 +372,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisRowIterator-members.html b/doc/html/classIsisRowIterator-members.html index 3b48d5b..53987c3 100644 --- a/doc/html/classIsisRowIterator-members.html +++ b/doc/html/classIsisRowIterator-members.html @@ -72,7 +72,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisRowIterator.html b/doc/html/classIsisRowIterator.html index 81c5150..6bd88dd 100644 --- a/doc/html/classIsisRowIterator.html +++ b/doc/html/classIsisRowIterator.html @@ -211,7 +211,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisSubfieldIterator-members.html b/doc/html/classIsisSubfieldIterator-members.html index 80cda42..82bd562 100644 --- a/doc/html/classIsisSubfieldIterator-members.html +++ b/doc/html/classIsisSubfieldIterator-members.html @@ -72,7 +72,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisSubfieldIterator.html b/doc/html/classIsisSubfieldIterator.html index abdeae9..12522b4 100644 --- a/doc/html/classIsisSubfieldIterator.html +++ b/doc/html/classIsisSubfieldIterator.html @@ -218,7 +218,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisValueIterator-members.html b/doc/html/classIsisValueIterator-members.html index 7e71ffb..e856aff 100644 --- a/doc/html/classIsisValueIterator-members.html +++ b/doc/html/classIsisValueIterator-members.html @@ -72,7 +72,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classIsisValueIterator.html b/doc/html/classIsisValueIterator.html index e99567f..50f28ef 100644 --- a/doc/html/classIsisValueIterator.html +++ b/doc/html/classIsisValueIterator.html @@ -211,7 +211,7 @@ Public Member Functions -
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classMaleteDb-members.html b/doc/html/classMaleteDb-members.html index 6d66b5b..5271740 100644 --- a/doc/html/classMaleteDb-members.html +++ b/doc/html/classMaleteDb-members.html @@ -77,7 +77,7 @@ This is the complete list of members for -
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classMaleteDb.html b/doc/html/classMaleteDb.html index 41050df..10b7aec 100644 --- a/doc/html/classMaleteDb.html +++ b/doc/html/classMaleteDb.html @@ -332,7 +332,7 @@ Public Attributes -
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classPhpIsisDb-members.html b/doc/html/classPhpIsisDb-members.html index 96462a8..01cb432 100644 --- a/doc/html/classPhpIsisDb-members.html +++ b/doc/html/classPhpIsisDb-members.html @@ -77,7 +77,7 @@ This is the complete list of members for
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classPhpIsisDb.html b/doc/html/classPhpIsisDb.html index 11d7b0a..f7393ef 100644 --- a/doc/html/classPhpIsisDb.html +++ b/doc/html/classPhpIsisDb.html @@ -348,7 +348,7 @@ Public Attributes -
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classSchemaDb-members.html b/doc/html/classSchemaDb-members.html index f552abe..2a731ec 100644 --- a/doc/html/classSchemaDb-members.html +++ b/doc/html/classSchemaDb-members.html @@ -70,7 +70,7 @@ This is the complete list of members for -
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classSchemaDb.html b/doc/html/classSchemaDb.html index be4312c..492c248 100644 --- a/doc/html/classSchemaDb.html +++ b/doc/html/classSchemaDb.html @@ -172,7 +172,7 @@ Static Public Member Functions -
Generated on Tue Feb 22 2011 10:19:16 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:18 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/classes.html b/doc/html/classes.html index 88ba0a1..0428234 100644 --- a/doc/html/classes.html +++ b/doc/html/classes.html @@ -74,7 +74,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
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
diff --git a/doc/html/functions.html b/doc/html/functions.html index b842aa8..1ba7677 100644 --- a/doc/html/functions.html +++ b/doc/html/functions.html @@ -125,7 +125,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x5f.html b/doc/html/functions_0x5f.html index 4e8555b..bd82943 100644 --- a/doc/html/functions_0x5f.html +++ b/doc/html/functions_0x5f.html @@ -121,7 +121,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x61.html b/doc/html/functions_0x61.html index 5c20486..55f152c 100644 --- a/doc/html/functions_0x61.html +++ b/doc/html/functions_0x61.html @@ -102,7 +102,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x62.html b/doc/html/functions_0x62.html index 2cdcdfe..04972d7 100644 --- a/doc/html/functions_0x62.html +++ b/doc/html/functions_0x62.html @@ -105,7 +105,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x63.html b/doc/html/functions_0x63.html index ec51cc7..972b148 100644 --- a/doc/html/functions_0x63.html +++ b/doc/html/functions_0x63.html @@ -141,7 +141,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x65.html b/doc/html/functions_0x65.html index 2afa4ec..fac519c 100644 --- a/doc/html/functions_0x65.html +++ b/doc/html/functions_0x65.html @@ -127,7 +127,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x66.html b/doc/html/functions_0x66.html index 13c0fcf..309a47c 100644 --- a/doc/html/functions_0x66.html +++ b/doc/html/functions_0x66.html @@ -111,7 +111,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x67.html b/doc/html/functions_0x67.html index ad764ff..cafe0c2 100644 --- a/doc/html/functions_0x67.html +++ b/doc/html/functions_0x67.html @@ -177,7 +177,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x68.html b/doc/html/functions_0x68.html index 70ddc46..ae62a1c 100644 --- a/doc/html/functions_0x68.html +++ b/doc/html/functions_0x68.html @@ -123,7 +123,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x69.html b/doc/html/functions_0x69.html index fe39e44..6b1c144 100644 --- a/doc/html/functions_0x69.html +++ b/doc/html/functions_0x69.html @@ -102,7 +102,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x6a.html b/doc/html/functions_0x6a.html index f89bd2e..033c35e 100644 --- a/doc/html/functions_0x6a.html +++ b/doc/html/functions_0x6a.html @@ -105,7 +105,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x6b.html b/doc/html/functions_0x6b.html index 3a8faab..769a07c 100644 --- a/doc/html/functions_0x6b.html +++ b/doc/html/functions_0x6b.html @@ -108,7 +108,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x6c.html b/doc/html/functions_0x6c.html index a4e0892..a0216bc 100644 --- a/doc/html/functions_0x6c.html +++ b/doc/html/functions_0x6c.html @@ -108,7 +108,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x6d.html b/doc/html/functions_0x6d.html index 9de17eb..a1a6bd9 100644 --- a/doc/html/functions_0x6d.html +++ b/doc/html/functions_0x6d.html @@ -115,7 +115,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x6e.html b/doc/html/functions_0x6e.html index 61ef1a4..3923c2b 100644 --- a/doc/html/functions_0x6e.html +++ b/doc/html/functions_0x6e.html @@ -123,7 +123,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x6f.html b/doc/html/functions_0x6f.html index 7f43396..e1910f7 100644 --- a/doc/html/functions_0x6f.html +++ b/doc/html/functions_0x6f.html @@ -106,7 +106,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x70.html b/doc/html/functions_0x70.html index ad43720..388d805 100644 --- a/doc/html/functions_0x70.html +++ b/doc/html/functions_0x70.html @@ -102,7 +102,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x72.html b/doc/html/functions_0x72.html index 9066fd7..22a5e07 100644 --- a/doc/html/functions_0x72.html +++ b/doc/html/functions_0x72.html @@ -133,7 +133,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x73.html b/doc/html/functions_0x73.html index 23face2..db3604e 100644 --- a/doc/html/functions_0x73.html +++ b/doc/html/functions_0x73.html @@ -117,7 +117,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x74.html b/doc/html/functions_0x74.html index 3aa048b..8103250 100644 --- a/doc/html/functions_0x74.html +++ b/doc/html/functions_0x74.html @@ -104,7 +104,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x76.html b/doc/html/functions_0x76.html index e9b10f7..033d613 100644 --- a/doc/html/functions_0x76.html +++ b/doc/html/functions_0x76.html @@ -108,7 +108,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x77.html b/doc/html/functions_0x77.html index 986f696..0a86d5b 100644 --- a/doc/html/functions_0x77.html +++ b/doc/html/functions_0x77.html @@ -177,7 +177,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_0x79.html b/doc/html/functions_0x79.html index 5d7bcd2..aa17114 100644 --- a/doc/html/functions_0x79.html +++ b/doc/html/functions_0x79.html @@ -102,7 +102,7 @@ Here is a list of all documented class members with links to the class documenta -
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
diff --git a/doc/html/functions_func.html b/doc/html/functions_func.html index 26129f9..ae53be7 100644 --- a/doc/html/functions_func.html +++ b/doc/html/functions_func.html @@ -621,7 +621,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on Tue Feb 22 2011 10:19:13 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/functions_vars.html b/doc/html/functions_vars.html index 9f18cfa..0813f05 100644 --- a/doc/html/functions_vars.html +++ b/doc/html/functions_vars.html @@ -96,7 +96,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
Generated on Tue Feb 22 2011 10:19:13 for Cinisis Database Reader by  +
Generated on Tue Feb 22 2011 11:43:16 for Cinisis Database Reader by  doxygen 1.7.1
diff --git a/doc/html/hierarchy.html b/doc/html/hierarchy.html index b8e0cce..f9f70f6 100644 --- a/doc/html/hierarchy.html +++ b/doc/html/hierarchy.html @@ -98,7 +98,7 @@ This inheritance list is sorted roughly, but not completely, alphabetically:
    -
    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
    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
    diff --git a/doc/html/interfaceIsisDb-members.html b/doc/html/interfaceIsisDb-members.html index cffbf73..78e6462 100644 --- a/doc/html/interfaceIsisDb-members.html +++ b/doc/html/interfaceIsisDb-members.html @@ -71,7 +71,7 @@ This is the complete list of members for
    Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
    Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
    diff --git a/doc/html/interfaceIsisDb.html b/doc/html/interfaceIsisDb.html index c7afe8a..345036e 100644 --- a/doc/html/interfaceIsisDb.html +++ b/doc/html/interfaceIsisDb.html @@ -237,7 +237,7 @@ Static Public Member Functions
    -
    Generated on Tue Feb 22 2011 10:19:15 for Cinisis Database Reader by  +
    Generated on Tue Feb 22 2011 11:43:17 for Cinisis Database Reader by  doxygen 1.7.1
    diff --git a/doc/html/pages.html b/doc/html/pages.html index 0e6377e..396a319 100644 --- a/doc/html/pages.html +++ b/doc/html/pages.html @@ -62,7 +62,7 @@ Here is a list of all related documentation pages:
      -
      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
      diff --git a/doc/html/todo.html b/doc/html/todo.html index 75dc7cf..2da5ee9 100644 --- a/doc/html/todo.html +++ b/doc/html/todo.html @@ -73,7 +73,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); -
      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
      diff --git a/doc/latex/classBiblioIsisDb.pdf b/doc/latex/classBiblioIsisDb.pdf index 18d6100..256b33f 100644 Binary files a/doc/latex/classBiblioIsisDb.pdf and b/doc/latex/classBiblioIsisDb.pdf differ diff --git a/doc/latex/classIsisAudit.pdf b/doc/latex/classIsisAudit.pdf index 968e337..d51a623 100644 Binary files a/doc/latex/classIsisAudit.pdf and b/doc/latex/classIsisAudit.pdf differ diff --git a/doc/latex/classIsisConnector.pdf b/doc/latex/classIsisConnector.pdf index 8d89888..6d98810 100644 Binary files a/doc/latex/classIsisConnector.pdf and b/doc/latex/classIsisConnector.pdf differ diff --git a/doc/latex/classIsisFinder.pdf b/doc/latex/classIsisFinder.pdf index 41c8a95..6d9f3ad 100644 Binary files a/doc/latex/classIsisFinder.pdf and b/doc/latex/classIsisFinder.pdf differ diff --git a/doc/latex/classIsisMap.pdf b/doc/latex/classIsisMap.pdf index 8cef858..e4516ab 100644 Binary files a/doc/latex/classIsisMap.pdf and b/doc/latex/classIsisMap.pdf differ diff --git a/doc/latex/classIsisReader.pdf b/doc/latex/classIsisReader.pdf index 5356e2e..765f605 100644 Binary files a/doc/latex/classIsisReader.pdf and b/doc/latex/classIsisReader.pdf differ diff --git a/doc/latex/classMaleteDb.pdf b/doc/latex/classMaleteDb.pdf index f0155a0..0a6a4bc 100644 Binary files a/doc/latex/classMaleteDb.pdf and b/doc/latex/classMaleteDb.pdf differ diff --git a/doc/latex/classPhpIsisDb.pdf b/doc/latex/classPhpIsisDb.pdf index 6ca9761..687031c 100644 Binary files a/doc/latex/classPhpIsisDb.pdf and b/doc/latex/classPhpIsisDb.pdf differ diff --git a/doc/latex/doxygen.sty b/doc/latex/doxygen.sty index 0f57a37..cf8af3f 100644 --- a/doc/latex/doxygen.sty +++ b/doc/latex/doxygen.sty @@ -27,9 +27,9 @@ \fancyplain{}{\bfseries\thepage}% } \rfoot[\fancyplain{}{\bfseries\scriptsize% - Generated on Tue Feb 22 2011 10:19:13 for Cinisis Database Reader by Doxygen }]{} + Generated on Tue Feb 22 2011 11:43:15 for Cinisis Database Reader by Doxygen }]{} \lfoot[]{\fancyplain{}{\bfseries\scriptsize% - Generated on Tue Feb 22 2011 10:19:13 for Cinisis Database Reader by Doxygen }} + Generated on Tue Feb 22 2011 11:43:15 for Cinisis Database Reader by Doxygen }} \cfoot{} %---------- Internal commands used in this style file ---------------- diff --git a/doc/latex/index.tex b/doc/latex/index.tex new file mode 100644 index 0000000..c8954a3 --- /dev/null +++ b/doc/latex/index.tex @@ -0,0 +1,90 @@ +\hyperlink{classCinisis}{Cinisis} is a \href{https://secure.wikimedia.org/wikipedia/en/wiki/CDS/ISIS}{\tt 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. + +\hyperlink{classCinisis}{Cinisis} works with the following ISIS backend libraries: + + +\begin{DoxyItemize} +\item \href{http://search.cpan.org/~dpavlin/Biblio-Isis-0.24/lib/Biblio/Isis.pm}{\tt Biblio::Isis} through \href{http://pecl.php.net/package/perl}{\tt Perl PECL extension}, which is the recommended choice. +\item \href{http://malete.org}{\tt GNI's Malete}. +\item \href{http://pecl.php.net/package/isis}{\tt Openisis}. +\end{DoxyItemize} + +Both Malete and Openisis support is outdated in favour os Biblio::Isis as it has proven to be simpler and more functional. + +\subsection*{Installation and usage} + + +\begin{DoxyVerbInclude} +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 +------------------ + +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). +\end{DoxyVerbInclude} + \ No newline at end of file diff --git a/doc/latex/interfaceIsisDb.pdf b/doc/latex/interfaceIsisDb.pdf index c721be0..ddb0179 100644 Binary files a/doc/latex/interfaceIsisDb.pdf and b/doc/latex/interfaceIsisDb.pdf differ diff --git a/doc/latex/main.tex b/doc/latex/main.tex new file mode 100644 index 0000000..c9e80a9 --- /dev/null +++ b/doc/latex/main.tex @@ -0,0 +1,3 @@ +\hyperlink{classCinisis}{Cinisis} -\/ Isis db reading tool. + +This is the introduction. etc... \ No newline at end of file diff --git a/doc/latex/refman.tex b/doc/latex/refman.tex index 9bd6143..e55a179 100644 --- a/doc/latex/refman.tex +++ b/doc/latex/refman.tex @@ -41,7 +41,7 @@ \vspace*{1cm} {\large Generated by Doxygen 1.7.1}\\ \vspace*{0.5cm} -{\small Tue Feb 22 2011 10:19:13}\\ +{\small Tue Feb 22 2011 11:43:15}\\ \end{center} \end{titlepage} \clearemptydoublepage diff --git a/index.php b/index.php index 59ecaf9..f48b34b 100644 --- a/index.php +++ b/index.php @@ -3,9 +3,20 @@ * * Cinisis is a CDS/ISIS * database reading library written in PHP. It's intended for integrating or migrating - * existing ISIS databases into other applications. + * 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. * - * Usage: + * Cinisis works with the following ISIS backend libraries: + * + * - Biblio::Isis through Perl PECL extension, which is the recommended choice. + * - GNI's Malete. + * - Openisis. + * + * 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

      * * \verbinclude README.txt */ -- cgit v1.2.3