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/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 +- 13 files changed, 96 insertions(+), 3 deletions(-) create mode 100644 doc/latex/index.tex create mode 100644 doc/latex/main.tex (limited to 'doc/latex') 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 -- cgit v1.2.3