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: -