MFB: Upgrade to the new-reference-structure

- (Created missing setup sections in setup.xml, if any)
 - Moved the intro to book.xml
 - Changed the intro ID from <extname>.intro to intro.<extname>
 - Moved the constants entity to book.xml
 - Changed constants.xml to be an appendix
 - Moved the examples into its own chapter (examples.xml)
	NOTE: The "ingres.examples" ID was renamed to ingres.examples-basic and the example chapter uses the 'ingres.examples' ID now
 - Moved the requirements and resources sections to setup.xml
 - Moved the configure entity to setup.xml


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248841 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2007-12-23 18:42:15 +00:00
parent f5db399f29
commit 12612a6fad
5 changed files with 188 additions and 94 deletions

View file

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- Purpose: database.vendors -->
<!-- Membership: pecl, external -->
<book xml:id="book.ingres" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Ingres II</title>
<!-- {{{ preface -->
<preface xml:id="intro.ingres">
&reftitle.intro;
<para>
These functions allow you to access Ingres II database servers.
</para>
<note>
<para>
If you already used PHP extensions to access other database
servers, note that Ingres doesn't allow concurrent queries and/or
transaction over one connection, thus you won't find any result
or transaction handle in this extension. The result of a query
must be treated before sending another query, and a transaction
must be committed or rolled back before opening another
transaction (which is automatically done when sending the first
query).
</para>
</note>
</preface>
<!-- }}} -->
&reference.ingres-ii.setup;
&reference.ingres-ii.constants;
&reference.ingres-ii.examples;
&reference.ingres-ii.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<section xml:id="ingres.constants" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.12 $ -->
<appendix xml:id="ingres.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<variablelist>
@ -301,7 +301,7 @@
</listitem>
</varlistentry>
</variablelist>
</section>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -0,0 +1,69 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="ingres.examples" xmlns="http://docbook.org/ns/docbook">
&reftitle.examples;
<section xml:id="ingres.examples-basic">
<para>
This simple example shows how to connect, execute a query, print
resulting rows and disconnect from an Ingres database.
<example>
<title>Simple Ingres Example</title>
<programlisting role="php">
<![CDATA[
<?php
// Connecting, selecting database
$link = ingres_connect('database', 'user', 'password')
or die('Could not connect: ' . ingres_error($link));
echo 'Connected successfully';
// Select from a table that exists in all Ingres databases
$query = 'SELECT * FROM iirelation';
$returncode = ingres_query($query,$link) or die('Query failed: ' .
ingres_error($link));
// Print results in HTML
// relid - table name
// relowner - table owner
echo "<table>\n";
while ($iirelation = ingres_fetch_object(INGRES_BOTH, $link)) {
echo "\t<tr>\n";
echo "\t\t<td>" . $iirelation->relid . "</td>\n";
echo "\t\t<td>" . $iirelation->relowner . "</td>\n";
echo "\t</tr>\n";
}
echo "</table>\n";
// Commit transaction
ingres_commit($link);
// Closing connection
ingres_close($link);
?>
]]>
</programlisting>
</example>
</para>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View file

@ -1,97 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- Purpose: database.vendors -->
<!-- Membership: pecl, external -->
<!-- $Revision: 1.15 $ -->
<reference xml:id="ref.ingres" xmlns="http://docbook.org/ns/docbook">
<title>Ingres II Functions</title>
<titleabbrev>Ingres II</titleabbrev>
<partintro>
<section xml:id="ingres.intro">
&reftitle.intro;
<para>
These functions allow you to access Ingres II database servers.
</para>
<note>
<para>
If you already used PHP extensions to access other database
servers, note that Ingres doesn't allow concurrent queries and/or
transaction over one connection, thus you won't find any result
or transaction handle in this extension. The result of a query
must be treated before sending another query, and a transaction
must be committed or rolled back before opening another
transaction (which is automatically done when sending the first
query).
</para>
</note>
</section>
<section xml:id="ingres.requirements">
&reftitle.required;
<para>
To compile PHP with Ingres support, you need the Ingres OpenAPI library
and header files.
</para>
</section>
&reference.ingres-ii.configure;
&reference.ingres-ii.ini;
<section xml:id="ingres.resources">
&reftitle.resources;
<para>
<function>ingres_connect</function> and
<function>ingres_pconnect</function> return an Ingres II link identifier.
</para>
</section>
&reference.ingres-ii.constants;
<section xml:id="ingres.examples">
&reftitle.examples;
<para>
This simple example shows how to connect, execute a query, print
resulting rows and disconnect from an Ingres database.
<example>
<title>Simple Ingres Example</title>
<programlisting role="php">
<![CDATA[
<?php
// Connecting, selecting database
$link = ingres_connect('database', 'user', 'password')
or die('Could not connect: ' . ingres_error($link));
echo 'Connected successfully';
// Select from a table that exists in all Ingres databases
$query = 'SELECT * FROM iirelation';
$returncode = ingres_query($query,$link) or die('Query failed: ' .
ingres_error($link));
// Print results in HTML
// relid - table name
// relowner - table owner
echo "<table>\n";
while ($iirelation = ingres_fetch_object(INGRES_BOTH, $link)) {
echo "\t<tr>\n";
echo "\t\t<td>" . $iirelation->relid . "</td>\n";
echo "\t\t<td>" . $iirelation->relowner . "</td>\n";
echo "\t</tr>\n";
}
echo "</table>\n";
// Commit transaction
ingres_commit($link);
// Closing connection
ingres_close($link);
?>
]]>
</programlisting>
</example>
</para>
</section>
</partintro>
<title>Ingres II &Functions;</title>
&reference.ingres-ii.entities.functions;

View file

@ -0,0 +1,57 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="ingres.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="ingres.requirements">
&reftitle.required;
<para>
To compile PHP with Ingres support, you need the Ingres OpenAPI library
and header files.
</para>
</section>
<!-- }}} -->
<!-- {{{ Installation -->
&reference.ingres-ii.configure;
<!-- }}} -->
<!-- {{{ Configuration -->
&reference.ingres-ii.ini;
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="ingres.resources">
&reftitle.resources;
<para>
<function>ingres_connect</function> and
<function>ingres_pconnect</function> return an Ingres II link identifier.
</para>
</section>
<!-- }}} -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->