Changeset 26 for php/trunk/doxygen/doc_page_main.php

Timestamp:

Jul 13, 2011, 1:45:03 AM (14 years ago)

Author:

cla

Message:

rdfint

• reworked docs
  • added related pages for ARC2 patch and W3C specs
• reworked main and license page

File:

• php/trunk/doxygen/doc_page_main.php (modified) (2 diffs)

php/trunk/doxygen/doc_page_main.php

@@ -19 +19 @@
 
 /**
- * \mainpage RDFInt.php - RDF Interfaces for PHP
- * Copyright \libyear 
- * \htmllink{http://www.netlabs.org, netlabs.org}
+ * \mainpage \libname_lit - \libdescription
+ * Copyright \libyear
+ * \htmllinkext{http://www.netlabs.org, netlabs.org}
  *
  * \author Christian Langanke
@@ -27 +27 @@
  * \version \libversion
  *
- * \htmlonly <hr> \endhtmlonly
+ * <hr>
  *
- * \section sec_intro Introduction
+ * \section sec_main_intro Introduction
  *
- * \section sec_install 1. Installation
+ * \libname provides an implementation of the \c RDF \c API and
+ * the \c RDFa \c API as described in the according specifications of the W3C.
+ * Support for the \c RDF \c Interfaces specification will be covered
+ * in a forthcoming version.
  *
- * \section sec_prereq 2. Prerequisites
+ * For the following reasons certain classes, methods etc. are not or differently
+ * implemented:
+ * - this library is not an implementation for usage in a Browser-based environment,
+ *   so certain classes and methods are not required
+ * - differences between the otherwise very similar \c RDF \c API and the
+ *   \c RDFa \c API lead to slight incompatibility with either specification
+ * - for convenience, some on-standard classes and methods have been implemented
+ *   on top of the  \c RDF \c API and \c RDFa \c API specifications, some of them
+ *   have been taken from the \c RDF \c Interfaces specification.
+ *   All of these additions are marked accordingly within the documentation.
  *
- * \subsection sec_install_download 2.1 Download
+ * See the section \htmllink{page_w3cspecs.html,W3C Specifications Overview and Library Compatibility}
+ * for more information.
  *
- * \subsection sec_install_config 2.2 Configuration
+ * \section sec_main_prereq Prerequisites
  *
- * \section apx_License Appendix A. License
+ * For parsing and serializing RDF data, this library requires the \c ARC2 library. \n
+ * Download from \htmllinkext{https://github.com/semsol/arc2/downloads}
  *
- * \section apx_samples Appendix B. Examples
+ * \note For usage under Windows operating systems,
+ * \htmllink{page_arc2_patch.html, a patch is required} to be able to read files from
+ * the local filesystem.
  *
- * \section apx_refs Appendix C. References
+ * \section sec_main_options Options
+ *
+ * For debugging purposes, the classes of \libname can provide debug event messages.
+ * To catch these messages, the debug message logger \c fDebug is required. \n
+ * Download from  \htmllinkext{http://fdebug.de/en/site/download/}
+ *
+ * See the provided samples of \libname for sample code, if you intend
+ * to use \c fDebug for your code as well.
+ *
+ * \section sec_main_config Configuration
+ *
+ * To setup \libname, the following environment variables must be defined:
+ *
+ * \desctable
+ * \desc{<strong>Environment&nbsp;variable</strong>,<strong>Value</strong>}
+ * \desc{\c PHP_LIBROOT_RDFINT,Root directory of \libname - contains \c rdfa.php}
+ * \desc{\c PHP_LIBROOT_ARC2,Root directory of \c ARC2 - contains \c ARC2.php}
+ * \enddesctable
+ *
+ * If \c fDebug is to be used, the following environment variable must be defined:
+ * \desctable
+ * \desc{<strong>Environment&nbsp;variable</strong>,<strong>Value</strong>}
+ * \desc{\c PHP_LIBROOT_FDEBUG,Root directory of \c fDebug - contains subdirectories \c client and \c server. 
+ *                   As an alternative the directory containing the file \c fdebug.lib.php can be specified.}
+ * \enddesctable
+ *
+ * \note Also under Windows operating systems, pathnames \c MAY \c NOT contain backslashes!
+ *       Instead slashes \c MUST be used.
+ *
+ * \section sec_main_license License
+ *
+ * \libname is distributed under the \htmllink{page_license.html,Apache License Version 2.0}
+ *
  */