1 | <?PHP
|
---|
2 |
|
---|
3 | /* RDFInt.php - RDF Interfaces for PHP
|
---|
4 | * Copyright 2011 netlabs.org
|
---|
5 | * Author: Christian Langanke, Adrian Gschwend
|
---|
6 | *
|
---|
7 | * Licensed under the Apache License, Version 2.0 (the "License");
|
---|
8 | * you may not use this file except in compliance with the License.
|
---|
9 | * You may obtain a copy of the License at
|
---|
10 | *
|
---|
11 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
12 | *
|
---|
13 | * Unless required by applicable law or agreed to in writing, software
|
---|
14 | * distributed under the License is distributed on an "AS IS" BASIS,
|
---|
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
16 | * See the License for the specific language governing permissions and
|
---|
17 | * limitations under the License.
|
---|
18 | */
|
---|
19 |
|
---|
20 | /**
|
---|
21 | * \mainpage \libname_lit - \libdescription
|
---|
22 | * Copyright \libyear
|
---|
23 | * \htmllinkext{http://www.netlabs.org, netlabs.org}
|
---|
24 | *
|
---|
25 | * \author Christian Langanke
|
---|
26 | * \author Adrian Gschwend
|
---|
27 | * \version \libversion
|
---|
28 | *
|
---|
29 | * <hr>
|
---|
30 | *
|
---|
31 | * \section sec_main_intro Introduction
|
---|
32 | *
|
---|
33 | * \libname provides an implementation of the \c RDF \c API and
|
---|
34 | * the \c RDFa \c API as described in the according specifications of the W3C.
|
---|
35 | * Support for the \c RDF \c Interfaces specification will be included
|
---|
36 | * in a forthcoming version.
|
---|
37 | *
|
---|
38 | * For the following reasons certain classes, methods etc. are not or differently
|
---|
39 | * implemented:
|
---|
40 | * - this library is not an implementation for usage in a Browser-based environment,
|
---|
41 | * so certain classes and methods are not required
|
---|
42 | * - differences between the otherwise very similar \c RDF \c API and the
|
---|
43 | * \c RDFa \c API lead to slight incompatibility with either specification
|
---|
44 | * - for convenience, some mon-standard classes and methods have been implemented
|
---|
45 | * on top of the \c RDF \c API and \c RDFa \c API specifications, some of them
|
---|
46 | * have been taken from the \c RDF \c Interfaces specification.
|
---|
47 | * All of these additions are marked accordingly within the documentation.
|
---|
48 | *
|
---|
49 | * See the section \htmllink{page_appendix_w3cspecs.html,W3C Specifications Overview and Library Compatibility}
|
---|
50 | * for more information.
|
---|
51 | *
|
---|
52 | * \section sec_main_prereq Prerequisites
|
---|
53 | *
|
---|
54 | * For parsing and serializing RDF data, this library requires the \c ARC2 library. \n
|
---|
55 | * Download from \htmllinkext{https://github.com/semsol/arc2/downloads}
|
---|
56 | *
|
---|
57 | * \note For usage under Windows operating systems,
|
---|
58 | * \htmllink{page_appendix_arc2_patch.html, a patch is required} to be able to read files from
|
---|
59 | * the local filesystem.
|
---|
60 | *
|
---|
61 | * \section sec_main_options Options
|
---|
62 | *
|
---|
63 | * See the following sections for further options with using \libname:
|
---|
64 | *
|
---|
65 | * - \htmllink{page_option_fdebug.html,Using fDebug to log debug event messages}
|
---|
66 | * - \htmllink{page_option_unittest.html,Executing RDFint.PHP unittests}
|
---|
67 | * - \htmllink{page_option_doxygen.html,Generating the RDFint.PHP online help}
|
---|
68 | *
|
---|
69 | * \section sec_main_config Configuration
|
---|
70 | *
|
---|
71 | * To setup \libname, the following environment variables must be defined:
|
---|
72 | *
|
---|
73 | * \desctable
|
---|
74 | * \desc{<strong>Environment variable</strong>,<strong>Value</strong>}
|
---|
75 | * \desc{\c PHP_LIBROOT_RDFINT,Root directory of \libname - contains \c rdfa.php}
|
---|
76 | * \desc{\c PHP_LIBROOT_ARC2,Root directory of \c ARC2 - contains \c ARC2.php}
|
---|
77 | * \enddesctable
|
---|
78 | *
|
---|
79 | * \note Also under Windows operating systems, pathnames \c MAY \c NOT contain backslashes!
|
---|
80 | * Instead slashes \c MUST be used.
|
---|
81 | *
|
---|
82 | * \section sec_main_license License
|
---|
83 | *
|
---|
84 | * \libname is distributed under the \htmllink{page_appendix_license.html,Apache License Version 2.0}
|
---|
85 | *
|
---|
86 | */
|
---|
87 |
|
---|
88 | ?>
|
---|