From c3c3a53417ad4b671c7bd36fb92fa94d53396a3c Mon Sep 17 00:00:00 2001 From: scoates Date: Sun, 6 Jun 2010 17:14:38 -0400 Subject: [PATCH] first rev of docs; far from complete --- doc/book.developer.xml | 76 +++++++++++++++++++++++++ doc/book.xml | 41 ++++++++++++++ doc/configure.xml | 39 +++++++++++++ doc/constants.xml | 28 ++++++++++ doc/entities.functions.xml | 1 + doc/functions/prep-get-file.xml | 73 ++++++++++++++++++++++++ doc/ini.xml | 98 +++++++++++++++++++++++++++++++++ doc/reference.xml | 30 ++++++++++ doc/setup.xml | 49 +++++++++++++++++ doc/versions.xml | 31 +++++++++++ 10 files changed, 466 insertions(+) create mode 100644 doc/book.developer.xml create mode 100644 doc/book.xml create mode 100644 doc/configure.xml create mode 100644 doc/constants.xml create mode 100644 doc/entities.functions.xml create mode 100644 doc/functions/prep-get-file.xml create mode 100644 doc/ini.xml create mode 100644 doc/reference.xml create mode 100644 doc/setup.xml create mode 100644 doc/versions.xml diff --git a/doc/book.developer.xml b/doc/book.developer.xml new file mode 100644 index 0000000..6722a3b --- /dev/null +++ b/doc/book.developer.xml @@ -0,0 +1,76 @@ + + + + + + + +%xhtml-lat1; +%xhtml-symbol; +%xhtml-special; +%isopub; + + + + + + +%language-defs.default; +%extensions.default; +%language-snippets.default; + + + + + + + + + +%global.entities; +%file.entities; +%frontpage.entities; +]> + + + Prep + Prep + + + &reftitle.intro; + + + + + + &reference.prep.setup; + &reference.prep.constants; + &reference.prep.examples; + &reference.prep.reference; + + + + + diff --git a/doc/book.xml b/doc/book.xml new file mode 100644 index 0000000..53a2f88 --- /dev/null +++ b/doc/book.xml @@ -0,0 +1,41 @@ + + + + + Prep preprocessor + Prep + + + &reftitle.intro; + + Prep is a hook for PHP that allows developers to write preprocessor scripts + in any language, using any script. + + + + &reference.prep.setup; + &reference.prep.constants; + &reference.prep.reference; + + + + diff --git a/doc/configure.xml b/doc/configure.xml new file mode 100644 index 0000000..9080762 --- /dev/null +++ b/doc/configure.xml @@ -0,0 +1,39 @@ + + + +
+ &reftitle.install; + + + &pecl.info; + &url.pecl.package;prep + + + + The latest PECL/prep Win32 DLL is available here: + php_prep.dll + + +
+ + + diff --git a/doc/constants.xml b/doc/constants.xml new file mode 100644 index 0000000..e927bca --- /dev/null +++ b/doc/constants.xml @@ -0,0 +1,28 @@ + + + + + &reftitle.constants; + &no.constants; + + + diff --git a/doc/entities.functions.xml b/doc/entities.functions.xml new file mode 100644 index 0000000..57f4b92 --- /dev/null +++ b/doc/entities.functions.xml @@ -0,0 +1 @@ +&reference.prep.functions.prep-get-file; diff --git a/doc/functions/prep-get-file.xml b/doc/functions/prep-get-file.xml new file mode 100644 index 0000000..d705bf7 --- /dev/null +++ b/doc/functions/prep-get-file.xml @@ -0,0 +1,73 @@ + + + + + + prep_get_file + Perform a lookup on the original un-preprocessed filename + + + + &reftitle.description; + + stringprep_get_file + stringfrom_file + + + When a PHP script is preprocessed, the result of the preprocessor command + is stored in a temporary file, and the original file is preserved. + + + prep_get_file is used to retrieve the temporary file + name from the original file name (such as __FILE__). + + + + + + &reftitle.parameters; + + + + from_file + + + The original file name; this is used to look up the temporary file + name. + + + + + + + + + &reftitle.returnvalues; + + The temporary file name; &false; on failure + + + + + + + diff --git a/doc/ini.xml b/doc/ini.xml new file mode 100644 index 0000000..9ef2518 --- /dev/null +++ b/doc/ini.xml @@ -0,0 +1,98 @@ + + + +
+ &reftitle.runtime; + &extension.runtime; + + + Prep &ConfigureOptions; + + + + &Name; + &Default; + &Changeable; + &Changelog; + + + + + prep.command + &null; + PHP_INI_PERDIR + + + + +
+ + + &ini.descriptions.title; + + + + + + prep.command + string + + + + The command that Prep will call to handle preprocessing. The file to + process will be passed as the first argument of the + prep.command, and the output of the command will be + used by PHP as the source. + + + The script should exit with a 0 status on success. + If a status of -1 (or 255) is + returned (such as on a PHP parse error), Prep will interpret the error + message and raise it as an E_FATAL error. + + + Returning a status of 1 will cause Prep to ignore + the command's output, and use the original file. This is useful for + performing simple checks in the preprocessor, and returning + 1 if a precondition is not met. + + + Multiple prep.commands may be set in &php.ini;. If + more than one command is set, Prep will pass the script (and the + results of other preprocessor scripts) to the command, in the order in + which they are set. + + + + + + + + + If the PHP_SUPPRESS_PREP environment variable is set, + Prep will skip preprocessing. This variable is set implicitly by Prep, but + may also be set by a user in order to temporarily suppress Preprocessing. + + +
+ + diff --git a/doc/reference.xml b/doc/reference.xml new file mode 100644 index 0000000..d944dbd --- /dev/null +++ b/doc/reference.xml @@ -0,0 +1,30 @@ + + + + + Prep &Functions; + + &reference.prep.entities.functions; + + + + diff --git a/doc/setup.xml b/doc/setup.xml new file mode 100644 index 0000000..78a4a32 --- /dev/null +++ b/doc/setup.xml @@ -0,0 +1,49 @@ + + + + + &reftitle.setup; + +
+ &reftitle.required; + + + +
+ +
+ &reftitle.install; + &no.install; +
+ + &reference.prep.ini; + +
+ &reftitle.resources; + + + +
+ + + + diff --git a/doc/versions.xml b/doc/versions.xml new file mode 100644 index 0000000..62b23d1 --- /dev/null +++ b/doc/versions.xml @@ -0,0 +1,31 @@ + + + + + + + + + +