diff options
| author | Silvio <silvio@devlet.com.br> | 2011-02-22 10:37:10 -0300 |
|---|---|---|
| committer | Silvio Rhatto <silvio@devlet.com.br> | 2011-02-22 10:37:10 -0300 |
| commit | f253764c93f49dcdfe01b9e3f4d2a1352406b8f1 (patch) | |
| tree | b6a4d1d70cdb9cdfca0ec5984a458be1431313f7 /doc/html/index.html | |
| parent | 8b55b69339146f0b03b01dd1c12501754cbd9de0 (diff) | |
| download | cinisis-f253764c93f49dcdfe01b9e3f4d2a1352406b8f1.tar.gz cinisis-f253764c93f49dcdfe01b9e3f4d2a1352406b8f1.tar.bz2 | |
Documentation update
Diffstat (limited to 'doc/html/index.html')
| -rw-r--r-- | doc/html/index.html | 70 |
1 files changed, 53 insertions, 17 deletions
diff --git a/doc/html/index.html b/doc/html/index.html index 5a3b3dd..11e7a1b 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -1,43 +1,79 @@ -<!-- This comment will put IE 6, 7 and 8 in quirks mode --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> -<title>Cinisis Database Reader: Main Page</title> +<title>Cinisis Database Reader: Cinisis Database Reader</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javaScript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> -<!-- Generated by Doxygen 1.6.3 --> +<!-- Generated by Doxygen 1.7.1 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div class="navigation" id="top"> <div class="tabs"> - <ul> + <ul class="tablist"> <li class="current"><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> - <li> + <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> - <img id="MSearchSelect" src="search/search.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> </div> </li> </ul> </div> </div> +<div class="header"> + <div class="headertitle"> +<h1><a class="el" href="classCinisis.html">Cinisis</a> Database Reader </h1> </div> +</div> <div class="contents"> -<h1>Cinisis Database Reader Documentation</h1></div> +<p><a class="el" href="classCinisis.html">Cinisis</a> is a <a href="https://secure.wikimedia.org/wikipedia/en/wiki/CDS/ISIS">CDS/ISIS</a> database reading library written in PHP. It's intended for integrating or migrating existing ISIS databases into other applications.</p> +<p>Usage:</p> +<div class="fragment"><pre class="fragment">Cinisis database reader +======================= + +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). +</pre></div> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" @@ -52,8 +88,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </iframe> </div> -<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Sep 20 13:53:30 2010 for Cinisis Database Reader by +<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 22 2011 10:19:13 for Cinisis Database Reader by <a href="http://www.doxygen.org/index.html"> -<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> </body> </html> |