| 1 |
<?php |
| 2 |
// Load globals |
| 3 |
require_once ("../global_vars.php"); |
| 4 |
|
| 5 |
|
| 6 |
// HTML headers |
| 7 |
printf("<HTML>"); |
| 8 |
printf("<HEAD>"); |
| 9 |
printf("<title>LibData Documentation</title>"); |
| 10 |
printf("<link rel=\"stylesheet\" href=\"libdata.css\" type=\"text/css\">\n"); |
| 11 |
printf("</HEAD>"); |
| 12 |
|
| 13 |
// Page header |
| 14 |
require_once ("../".$GLOBAL_ADMIN_HEADER); |
| 15 |
?> |
| 16 |
|
| 17 |
<body> |
| 18 |
|
| 19 |
|
| 20 |
|
| 21 |
<h2>LibData Documentation</h2> |
| 22 |
|
| 23 |
LibData's documentation is site dependent. That is, there is no standard set of documentation |
| 24 |
that will suffice for all installations, security concerns, business models, or audiences. |
| 25 |
<br><br> |
| 26 |
|
| 27 |
A complete LibData installation should include custom written documentation based on the following |
| 28 |
files supplied with the distribution in the install subdirectory. Note that information in some |
| 29 |
files contains security-sensitive information and technical commentary, and should probably |
| 30 |
not be included in documentation intended for a wider audience (i.e. don't just link off to those files): |
| 31 |
<br><br> |
| 32 |
|
| 33 |
<table border="1"> |
| 34 |
<tr> |
| 35 |
<td class="backLight"><b>File</b></td> |
| 36 |
<td class="backLight"><b>Purpose</b></td> |
| 37 |
<td class="backLight"><b>Audience</b></td> |
| 38 |
</tr> |
| 39 |
|
| 40 |
<tr> |
| 41 |
<td class="backLight">documentation.phtml</td> |
| 42 |
<td>This current document. Provided as a place-holder for future |
| 43 |
documentation which each institution should develop to suit their |
| 44 |
own needs.</td> |
| 45 |
<td>Future usage primarily intended for LibData Authors and Managers. |
| 46 |
DBA information should probably not be here.</td> |
| 47 |
</tr> |
| 48 |
|
| 49 |
<tr> |
| 50 |
<td class="backLight">LibData_Intro.rtf</td> |
| 51 |
<td>Introduction and system functionality document (30+ pages), detailing most every LibData function.</td> |
| 52 |
<td>LibData Managers, DBA's, and library planning staff. This document is intended to form the core |
| 53 |
of a customized Author manual in HTML (or other) format here.</td> |
| 54 |
</tr> |
| 55 |
|
| 56 |
<tr> |
| 57 |
<td class="backLight">libdata_install.txt</td> |
| 58 |
<td>Installation procedures for LibData.</td> |
| 59 |
<td>Technical IT personnel with sensitive file-system and database access |
| 60 |
rights.</td> |
| 61 |
</tr> |
| 62 |
|
| 63 |
<tr> |
| 64 |
<td class="backLight">libdata_customize.txt</td> |
| 65 |
<td>Notes on customization, look-and-feel, etc.</td> |
| 66 |
<td>Web Design IT personnel.</td> |
| 67 |
|
| 68 |
</tr> |
| 69 |
|
| 70 |
<tr> |
| 71 |
<td class="backLight">libdata_changelog.txt</td> |
| 72 |
<td>List of changes and LibData version history.</td> |
| 73 |
<td>Technical and web design IT personnel.</td> |
| 74 |
|
| 75 |
</tr> |
| 76 |
|
| 77 |
<tr> <td class="backLight">erdiagram.jpg</td> |
| 78 |
<td>E-R Diagram of the current LibData system, more or less current, to |
| 79 |
illustrate relationships and data dependencies.</td> |
| 80 |
<td>Database and development IT personnel.</td> |
| 81 |
</tr> |
| 82 |
|
| 83 |
<tr> <td class="backLight">elements.jpg</td> |
| 84 |
<td>Graphical illustration of CL/PS pages under-the-hood, starting from |
| 85 |
element atomicity, to underlying structure of an authored page, SQL steps |
| 86 |
involved in assembling a page, and ending with final display.</td> |
| 87 |
<td>General audience from technical to non-technical.</td> |
| 88 |
</tr> |
| 89 |
|
| 90 |
</table> |
| 91 |
|
| 92 |
<?php |
| 93 |
// Page footer |
| 94 |
require_once ("../".$GLOBAL_ADMIN_FOOTER); |
| 95 |
?> |
| 96 |
|
| 97 |
</body> |
| 98 |
</HTML> |
| 99 |
|
Parent Directory
| 
Revision Log