From 37ca029f0fc8f35584f944a5df48a060a2d9b5e4 Mon Sep 17 00:00:00 2001 From: Silvio Date: Wed, 23 Feb 2011 11:45:39 -0300 Subject: Documentation update (4) --- 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 | 56 +++++++++++++++++++++++++++++++++++++++ doc/latex/interfaceIsisDb.pdf | Bin 5431 -> 5431 bytes doc/latex/refman.tex | 2 +- 12 files changed, 59 insertions(+), 3 deletions(-) (limited to 'doc/latex') diff --git a/doc/latex/classBiblioIsisDb.pdf b/doc/latex/classBiblioIsisDb.pdf index 256b33f..bad3f16 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 d51a623..2f3a2d1 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 6d98810..ab5304a 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 6d9f3ad..e500d8e 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 e4516ab..abe6610 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 765f605..bbb047a 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 0a6a4bc..cb82082 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 687031c..3089039 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 cf8af3f..02080c7 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 11:43:15 for Cinisis Database Reader by Doxygen }]{} + Generated on Wed Feb 23 2011 11:44:08 for Cinisis Database Reader by Doxygen }]{} \lfoot[]{\fancyplain{}{\bfseries\scriptsize% - Generated on Tue Feb 22 2011 11:43:15 for Cinisis Database Reader by Doxygen }} + Generated on Wed Feb 23 2011 11:44:08 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 index c8954a3..8611c8f 100644 --- a/doc/latex/index.tex +++ b/doc/latex/index.tex @@ -61,6 +61,12 @@ 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. +Configuration +------------- + + - Put your databases into the db folder, one folder per database. + - Optionally edit config/config.yaml to set the default database. + Naming conventions ------------------ @@ -87,4 +93,54 @@ 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} + + +\subsection*{Example} + +The following exemple shows how to read a database entry using two different ISIS backends: + + +\begin{DoxyCodeInclude} +open_table(); + +$configs = array( + 0 => array( + 'implementation' => 'PhpIsis', + 'database' => 'dbname', + ), + 1 => array( + 'implementation' => 'BiblioIsis', + 'database' => 'dbname', + ), +); + +foreach ($configs as $config) { + // Get a db instance. + $isis = new Cinisis($config); + + // Test connection. + if ($isis->db) { + $result = $isis->db->read(1); + $entries = $isis->db->entries(); + + // Format output. + echo ''; + echo '
';
+    echo 'Implementation: '. $config['implementation'] ."\n";
+    echo "Rows: $entries\n";
+    print_r($result);
+    echo '
'; + echo ''; + } +} + +$display->close_table(); +$display->footer(); +\end{DoxyCodeInclude} \ No newline at end of file diff --git a/doc/latex/interfaceIsisDb.pdf b/doc/latex/interfaceIsisDb.pdf index ddb0179..0311e2b 100644 Binary files a/doc/latex/interfaceIsisDb.pdf and b/doc/latex/interfaceIsisDb.pdf differ diff --git a/doc/latex/refman.tex b/doc/latex/refman.tex index e55a179..cad4c39 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 11:43:15}\\ +{\small Wed Feb 23 2011 11:44:08}\\ \end{center} \end{titlepage} \clearemptydoublepage -- cgit v1.2.3