svn: /pear/peardoc/trunk/en/package/configuration/ config/avail-container.xml config/intro-editing.xml config/intro.xml config.xml
[email protected] (Christian Weiske) Wed, 22 Dec 2010 18:42:46 +0000
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <[email protected]> |
cweiske Wed, 22 Dec 2010 18:42:46 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=306576
Log:
restructure config docs a bit
Changed paths:
U pear/peardoc/trunk/en/package/configuration/config/avail-container.xml
U pear/peardoc/trunk/en/package/configuration/config/intro-editing.xml
U pear/peardoc/trunk/en/package/configuration/config/intro.xml
U pear/peardoc/trunk/en/package/configuration/config.xml
svn-diffs-306576.txt
(text/x-diff, 12 KB)
Modified: pear/peardoc/trunk/en/package/configuration/config/avail-container.xml
===================================================================
--- pear/peardoc/trunk/en/package/configuration/config/avail-container.xml 2010-12-22 16:18:59 UTC (rev 306575)
+++ pear/peardoc/trunk/en/package/configuration/config/avail-container.xml 2010-12-22 18:42:46 UTC (rev 306576)
@@ -1,12 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
-<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.configuration.config.avail-container">
- <refnamediv>
- <refname>Available Containers</refname>
- <refpurpose>
- Supported formats
- </refpurpose>
- </refnamediv>
- <refsection><info><title>Available Containers</title></info>
+<chapter
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ version="lillet"
+ xml:id="package.configuration.config.avail-container">
+
+ <info>
+ <title>Available Containers</title>
+ </info>
<para>
<variablelist>
@@ -338,5 +339,4 @@
</varlistentry>
</variablelist>
</para>
- </refsection>
-</refentry>
+</chapter>
Modified: pear/peardoc/trunk/en/package/configuration/config/intro-editing.xml
===================================================================
--- pear/peardoc/trunk/en/package/configuration/config/intro-editing.xml 2010-12-22 16:18:59 UTC (rev 306575)
+++ pear/peardoc/trunk/en/package/configuration/config/intro-editing.xml 2010-12-22 18:42:46 UTC (rev 306576)
@@ -1,20 +1,21 @@
<?xml version="1.0" encoding="utf-8"?>
-<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.configuration.config.intro-editing">
- <refnamediv>
- <refname>Editing a configuration</refname>
- <refpurpose>
- How to manipulate your configuration content
- </refpurpose>
- </refnamediv>
+<section
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ version="lillet"
+ xml:id="package.configuration.config.intro-editing">
- <refsection><info><title>Create configuration content</title></info>
-
- <para>
- There are many ways to create content in your <classname>Config</classname> object. You can simply pass it an array like it is shown in the example below:
+ <info>
+ <title>Editing a configuration</title>
+ </info>
- <example><info><title>Create configuration with array</title></info>
+ <para>
+ There are many ways to create content in your <classname>Config</classname> object. You can simply pass it an array like it is shown in the example below:
+
+ <example>
+ <info><title>Create configuration with array</title></info>
- <programlisting role="php">
+ <programlisting role="php">
<![CDATA[
// configuration array
@@ -35,14 +36,15 @@
array('name' => 'conf'));
echo $root->toString('phparray', array('name' => 'conf'));
]]>
- </programlisting>
- </example>
- </para>
- <para>
- You can also ask Config to look for a file on your filesystem and try to parse it. You would then do it like this. This example assumes you have a valid XML file:
- <example><info><title>Create configuration with a file</title></info>
-
- <programlisting role="php">
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ You can also ask Config to look for a file on your filesystem and try to parse it. You would then do it like this. This example assumes you have a valid XML file:
+ <example>
+ <info><title>Create configuration with a file</title></info>
+
+ <programlisting role="php">
<![CDATA[
// Config object
@@ -50,12 +52,12 @@
$root =& $config->parseConfig('/path/to/file.xml', 'xml');
echo $root->toString('phparray', array('name' => 'conf'));
]]>
- </programlisting>
- </example>
- At the moment, Config can parse XML, PHP arrays, ini files, Apache conf and other generic type of configurations with comments and key-value pairs.
- </para>
- <para>
- Of course, it is also possible to create the configuration from scratch as shown in the <link linkend="package.configuration.config.intro">previous section</link> example.
- </para>
- </refsection>
- </refentry>
+ </programlisting>
+ </example>
+ At the moment, Config can parse XML, PHP arrays, ini files, Apache conf and other generic type of configurations with comments and key-value pairs.
+ </para>
+ <para>
+ Of course, it is also possible to create the configuration from scratch as shown in the <link linkend="package.configuration.config.intro">previous section</link> example.
+ </para>
+</section>
+
Modified: pear/peardoc/trunk/en/package/configuration/config/intro.xml
===================================================================
--- pear/peardoc/trunk/en/package/configuration/config/intro.xml 2010-12-22 16:18:59 UTC (rev 306575)
+++ pear/peardoc/trunk/en/package/configuration/config/intro.xml 2010-12-22 18:42:46 UTC (rev 306576)
@@ -1,13 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
-<refentry xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.configuration.config.intro">
- <refnamediv>
- <refname>Introduction</refname>
- <refpurpose>
- What Config can do
- </refpurpose>
- </refnamediv>
- <refsection><info><title>Introduction</title></info>
-
+<chapter
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ version="lillet"
+ xml:id="package.configuration.config.intro">
+
+ <info>
+ <title>Introduction</title>
+ </info>
+
<para>
<classname>Config</classname>
helps you manipulate your configuration whether they are stored in XML files,
@@ -29,7 +30,9 @@
</itemizedlist>
</para>
<para>
- The <classname>Config</classname> object acts as a container
+ The
+ <link linkend="package.configuration.config.config"><classname>Config</classname></link>
+ object acts as a container
for other <classname>Config_Container</classname> objects.
It doesn't do much but makes handling IO operations easier.
@@ -44,7 +47,9 @@
containers and their contents.
</para>
<para>
- A <classname>Config_Container</classname> object can be of different type:
+ A
+ <link linkend="package.configuration.config.config-container"><classname>Config_Container</classname></link>
+ object can be of different type:
<itemizedlist>
<listitem>
<simpara>Section: a section contains other <classname>Config_Container</classname> objects.</simpara>
@@ -153,5 +158,8 @@
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.devshed.com/c/a/PHP/Configuration-Manipulation-With-PHP-Config/">tutorial</link>
of DevShed about the Config package.
</para>
- </refsection>
-</refentry>
+
+
+ &package.configuration.config.intro-editing;
+
+</chapter>
Modified: pear/peardoc/trunk/en/package/configuration/config.xml
===================================================================
--- pear/peardoc/trunk/en/package/configuration/config.xml 2010-12-22 16:18:59 UTC (rev 306575)
+++ pear/peardoc/trunk/en/package/configuration/config.xml 2010-12-22 18:42:46 UTC (rev 306576)
@@ -9,51 +9,56 @@
</abstract>
</info>
- <chapter>
+ &package.configuration.config.intro;
+ &package.configuration.config.avail-container;
+ <!-- &package.configuration.config.intro-compatibility; -->
-&package.configuration.config.intro;
-&package.configuration.config.intro-editing;
-&package.configuration.config.avail-container;
-<!-- &package.configuration.config.intro-compatibility; -->
+ <chapter xml:id="package.configuration.config.config">
+ <info>
+ <title>Config class</title>
+ </info>
+ &package.configuration.config.config.config;
+ &package.configuration.config.config.getroot;
+ &package.configuration.config.config.isconfigtyperegistered;
+ &package.configuration.config.config.parseconfig;
+ &package.configuration.config.config.registerconfigtype;
+ &package.configuration.config.config.setroot;
+ &package.configuration.config.config.writeconfig;
+ </chapter>
-&package.configuration.config.config.config;
-&package.configuration.config.config.getroot;
-&package.configuration.config.config.isconfigtyperegistered;
-&package.configuration.config.config.parseconfig;
-&package.configuration.config.config.registerconfigtype;
-&package.configuration.config.config.setroot;
-&package.configuration.config.config.writeconfig;
-
-&package.configuration.config.config-container.config-container;
-&package.configuration.config.config-container.additem;
-&package.configuration.config.config-container.countchildren;
-&package.configuration.config.config-container.createblank;
-&package.configuration.config.config-container.createcomment;
-&package.configuration.config.config-container.createdirective;
-&package.configuration.config.config-container.createitem;
-&package.configuration.config.config-container.createsection;
-&package.configuration.config.config-container.getattribute;
-&package.configuration.config.config-container.getattributes;
-&package.configuration.config.config-container.getchild;
-&package.configuration.config.config-container.getcontent;
-&package.configuration.config.config-container.getitem;
-&package.configuration.config.config-container.getitemindex;
-&package.configuration.config.config-container.getitemposition;
-&package.configuration.config.config-container.getname;
-&package.configuration.config.config-container.getparent;
-&package.configuration.config.config-container.gettype;
-&package.configuration.config.config-container.isroot;
-&package.configuration.config.config-container.removeitem;
-&package.configuration.config.config-container.searchpath;
-&package.configuration.config.config-container.setattributes;
-&package.configuration.config.config-container.setcontent;
-&package.configuration.config.config-container.setdirective;
-&package.configuration.config.config-container.setname;
-&package.configuration.config.config-container.settype;
-&package.configuration.config.config-container.toarray;
-&package.configuration.config.config-container.tostring;
-&package.configuration.config.config-container.updateattributes;
-&package.configuration.config.config-container.writedatasrc;
-
+ <chapter xml:id="package.configuration.config.config-container">
+ <info>
+ <title>Config_Container class</title>
+ </info>
+ &package.configuration.config.config-container.config-container;
+ &package.configuration.config.config-container.additem;
+ &package.configuration.config.config-container.countchildren;
+ &package.configuration.config.config-container.createblank;
+ &package.configuration.config.config-container.createcomment;
+ &package.configuration.config.config-container.createdirective;
+ &package.configuration.config.config-container.createitem;
+ &package.configuration.config.config-container.createsection;
+ &package.configuration.config.config-container.getattribute;
+ &package.configuration.config.config-container.getattributes;
+ &package.configuration.config.config-container.getchild;
+ &package.configuration.config.config-container.getcontent;
+ &package.configuration.config.config-container.getitem;
+ &package.configuration.config.config-container.getitemindex;
+ &package.configuration.config.config-container.getitemposition;
+ &package.configuration.config.config-container.getname;
+ &package.configuration.config.config-container.getparent;
+ &package.configuration.config.config-container.gettype;
+ &package.configuration.config.config-container.isroot;
+ &package.configuration.config.config-container.removeitem;
+ &package.configuration.config.config-container.searchpath;
+ &package.configuration.config.config-container.setattributes;
+ &package.configuration.config.config-container.setcontent;
+ &package.configuration.config.config-container.setdirective;
+ &package.configuration.config.config-container.setname;
+ &package.configuration.config.config-container.settype;
+ &package.configuration.config.config-container.toarray;
+ &package.configuration.config.config-container.tostring;
+ &package.configuration.config.config-container.updateattributes;
+ &package.configuration.config.config-container.writedatasrc;
</chapter>
</book>