MFB: Upgrade to the new-reference-structure

- Moved the intro from reference.xml to book.xml
    - Change the intro ID to intro.<extname>
    - Moved examples into its own chapter
    - Moved the setup sections to setup.xml
    - Changed the constants section to be <appendix>


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248274 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2007-12-14 17:24:23 +00:00
parent 0d4cdaedbf
commit f742cb18ba
6 changed files with 187 additions and 102 deletions

55
reference/curl/book.xml Normal file
View file

@ -0,0 +1,55 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- Purpose: remote.other -->
<!-- Membership: bundled, external -->
<book xml:id="book.curl" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>CURL</title>
<!-- {{{ preface -->
<preface xml:id="intro.curl">
&reftitle.intro;
<para>
PHP supports libcurl, a library created by Daniel Stenberg, that
allows you to connect and communicate to many different types of
servers with many different types of protocols. libcurl currently
supports the http, https, ftp, gopher, telnet, dict, file, and
ldap protocols. libcurl also supports HTTPS certificates, HTTP
POST, HTTP PUT, FTP uploading (this can also be done with PHP's
ftp extension), HTTP form based upload, proxies, cookies, and
user+password authentication.
</para>
<para>
These functions have been added in PHP 4.0.2.
</para>
</preface>
<!-- }}} -->
&reference.curl.setup;
&reference.curl.constants;
&reference.curl.examples;
&reference.curl.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,12 +1,6 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.17 $ -->
<refentry xml:id="curl.constants" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Constants</refname>
<refpurpose>Curl Predefined Constants</refpurpose>
</refnamediv>
<refsect1>
<!-- $Revision: 1.18 $ -->
<appendix xml:id="curl.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<para>
@ -2995,8 +2989,7 @@
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="curl.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.examples;
<section xml:id="curl.examples-basic">
<para>
Once you've compiled PHP with cURL support, you can begin using
the cURL functions. The basic idea behind the cURL functions is
that you initialize a cURL session using the
<function>curl_init</function>, then you can set all your
options for the transfer via the <function>curl_setopt</function>,
then you can execute the session with the
<function>curl_exec</function> and then you finish off
your session using the <function>curl_close</function>.
Here is an example that uses the cURL functions to fetch the
example.com homepage into a file:
<example>
<title>Using PHP's cURL module to fetch the example.com homepage</title>
<programlisting role="php">
<![CDATA[
<?php
$ch = curl_init("http://www.example.com/");
$fp = fopen("example_homepage.txt", "w");
curl_setopt($ch, CURLOPT_FILE, $fp);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_exec($ch);
curl_close($ch);
fclose($fp);
?>
]]>
</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,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.curl-multi-exec" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>curl_multi_exec</refname>

View file

@ -1,97 +1,8 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.19 $ -->
<!-- Purpose: remote.other -->
<!-- Membership: bundled, external -->
<!-- $Revision: 1.20 $ -->
<reference xml:id="ref.curl" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>CURL, Client URL Library Functions</title>
<titleabbrev>CURL</titleabbrev>
<partintro>
<section xml:id="curl.intro">
&reftitle.intro;
<para>
PHP supports libcurl, a library created by Daniel Stenberg, that
allows you to connect and communicate to many different types of
servers with many different types of protocols. libcurl currently
supports the http, https, ftp, gopher, telnet, dict, file, and
ldap protocols. libcurl also supports HTTPS certificates, HTTP
POST, HTTP PUT, FTP uploading (this can also be done with PHP's
ftp extension), HTTP form based upload, proxies, cookies, and
user+password authentication.
</para>
<para>
These functions have been added in PHP 4.0.2.
</para>
</section>
<section xml:id="curl.requirements">
&reftitle.required;
<para>
In order to use PHP's cURL functions you need to install the <link
xlink:href="&url.curl;">libcurl</link> package. PHP requires that you use
libcurl 7.0.2-beta or higher. In PHP 4.2.3, you will need
libcurl version 7.9.0 or higher. From PHP 4.3.0, you will need a libcurl
version that's 7.9.8 or higher. PHP 5.0.0 requires
a libcurl version 7.10.5 or greater.
</para>
</section>
&reference.curl.configure;
<section xml:id="curl.resources">
&reftitle.resources;
<para>
This extension defines two resource types: a cURL handle and a cURL multi
handle.
</para>
</section>
<section>
&reftitle.constants;
<para>
See also the cURL <link linkend="curl.constants">Predefined Constants</link>
</para>
</section>
<section xml:id="curl.examples">
&reftitle.examples;
<para>
Once you've compiled PHP with cURL support, you can begin using
the cURL functions. The basic idea behind the cURL functions is
that you initialize a cURL session using the
<function>curl_init</function>, then you can set all your
options for the transfer via the <function>curl_setopt</function>,
then you can execute the session with the
<function>curl_exec</function> and then you finish off
your session using the <function>curl_close</function>.
Here is an example that uses the cURL functions to fetch the
example.com homepage into a file:
<example>
<title>Using PHP's cURL module to fetch the example.com homepage</title>
<programlisting role="php">
<![CDATA[
<?php
$ch = curl_init("http://www.example.com/");
$fp = fopen("example_homepage.txt", "w");
curl_setopt($ch, CURLOPT_FILE, $fp);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_exec($ch);
curl_close($ch);
fclose($fp);
?>
]]>
</programlisting>
</example>
</para>
</section>
</partintro>
&reference.curl.constants;
<title>CURL, Client URL Library &Functions;</title>
&reference.curl.entities.functions;

64
reference/curl/setup.xml Normal file
View file

@ -0,0 +1,64 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="curl.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="curl.requirements">
&reftitle.required;
<para>
In order to use PHP's cURL functions you need to install the <link
xlink:href="&url.curl;">libcurl</link> package. PHP requires that you use
libcurl 7.0.2-beta or higher. In PHP 4.2.3, you will need
libcurl version 7.9.0 or higher. From PHP 4.3.0, you will need a libcurl
version that's 7.9.8 or higher. PHP 5.0.0 requires
a libcurl version 7.10.5 or greater.
</para>
</section>
<!-- }}} -->
<!-- {{{ Installation -->
&reference.curl.configure;
<!-- }}} -->
<!-- {{{ Configuration -->
<section xml:id="curl.configuration">
&reftitle.runtime;
&no.config;
</section>
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="curl.resources">
&reftitle.resources;
<para>
This extension defines two resource types: a cURL handle and a cURL multi
handle.
</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
-->