Recommended settings for editing this file:
charset: UTF-8
end-line character: Unix
tabs width: 2
tabs replaced with spaces: yes
This class is still a work in progress.
----------------
-- Dependencies:
In the current state, this class have to following dependencies
* PHP 5
* xmlWriter extension (http://www.php.net/manual/en/ref.xmlwriter.php)
* Xslt engine extension (http://www.php.net/manual/en/ref.xsl.php)
And if ou use the XSL caching mechanism
* PDO + PDO::Sqlite extensions (http://www.php.net/manual/en/ref.pdo.php)
----------------
-- Configuration
The most crucials parts of the class are configurable via modifying it's properties below.
Look at the comment to determine how to change them, but you should normally not have to touch anything, except the
general() method.
The class relies on several "defines" to work, and if you will/must alter them, you can find them in the /libs/globals/vars.php.
Here is a list of those defines, with their default values:
DOC_ROOT => An alias to $_SERVER['DOCUMENT_ROOT']. It's the base used to determine every paths.
XSL_ROOT => The emplacement where the XL rendering sets and style sheets are stored.
Default: "DOC_ROOT/../xsl"
XSL_URL_PREFIX => When outputing the XML, is used to compose the XSL style sheet web path, for the browser XSL engine.
Default to "/xsl/"
Exemple XSL path: /xsl/org.sixop.index
XSL_OPEN => The default name of the prepended XSL style sheet.
Default: "open"
XSL_CLOSE => The default name of the appended XSL style sheet.
Default: "close"
INCLUDE_TAG => The tag to bee looking in the XSL files source to trigger an include
Default: ""
SQLITE_ROOT => The emplacement where to store sqLite db files.
Default: DOC_ROOT/../sqlite
----------------
-- XSL generation:
The XSL generation process allows you to mix several XSL files in one, like an PHP include would work.
For this, you need to place an into the XSL contener file.
For exemple:
Will try to include the content of the file "{XSL_ROOT}/{rendering set}/com.sixop.utils[.xsl]"
into the currently generated stylesheet.
Note that there should be no space between the end of the XSL path and the "/>".
The " Include a node, which contains datas you will mostly need on every pages. Page title, location in the site.
Exemple:
en
false
Sixop :: SImple Xml fOr Php