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 requirements, configuration and resouces section to setup.xml
 - Moved the configure entity to setup.xml


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248839 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2007-12-23 18:38:36 +00:00
parent ef7b3b8495
commit beea3a0c62
4 changed files with 144 additions and 77 deletions

50
reference/imap/book.xml Normal file
View file

@ -0,0 +1,50 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- Purpose: remote.mail -->
<!-- Membership: bundled, external -->
<book xml:id="book.imap" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>IMAP, POP3 and NNTP</title>
<!-- {{{ preface -->
<preface xml:id="intro.imap">
&reftitle.intro;
<para>
These functions enable you to operate with the <acronym>IMAP</acronym>
protocol, as well as the <acronym>NNTP</acronym>, <acronym>POP3</acronym>
and local mailbox access methods.
</para>
<para>
Be warned however, that some of IMAP functions will not work correctly
with the POP protocol.
</para>
</preface>
<!-- }}} -->
&reference.imap.setup;
&reference.imap.constants;
&reference.imap.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.5 $ -->
<section xml:id="imap.constants" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.6 $ -->
<appendix xml:id="imap.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<variablelist>
@ -733,7 +733,7 @@
</listitem>
</varlistentry>
</variablelist>
</section>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,81 +1,11 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.20 $ -->
<!-- Purpose: remote.mail -->
<!-- Membership: bundled, external -->
<!-- $Revision: 1.21 $ -->
<reference xml:id='ref.imap' xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>IMAP, POP3 and NNTP Functions</title>
<reference xml:id="ref.imap" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>IMAP, POP3 and NNTP &Functions;</title>
<titleabbrev>IMAP</titleabbrev>
<partintro>
<section xml:id="imap.intro">
&reftitle.intro;
<para>
These functions enable you to operate with the <acronym>IMAP</acronym>
protocol, as well as the <acronym>NNTP</acronym>, <acronym>POP3</acronym>
and local mailbox access methods.
</para>
<para>
Be warned however, that some of IMAP functions will not work correctly
with the POP protocol.
</para>
</section>
<section xml:id="imap.requirements">
&reftitle.required;
<para>
This extension requires the c-client library to be installed.
Grab the latest version from <link xlink:href="&url.imap;">&url.imap;</link>
and compile it.
</para>
<para>
It's important that you do not copy the IMAP source files directly into
the system include directory as there may be conflicts. Instead, create
a new directory inside the system include directory, such as
<filename>/usr/local/imap-2000b/</filename> (location and name
depend on your setup and IMAP version), and inside this new
directory create additional directories named <filename>lib/</filename>
and <filename>include/</filename>. From the <filename>c-client</filename>
directory from your IMAP source tree, copy all the <filename>*.h</filename>
files into <filename>include/</filename> and all the
<filename>*.c</filename> files into <filename>lib/</filename>.
Additionally when you compiled IMAP, a file named
<filename>c-client.a</filename> was created. Also put this in the
<filename>lib/</filename> directory but rename it as
<filename>libc-client.a</filename>.
</para>
<note>
<para>
To build the c-client library with SSL or/and Kerberos support read
the docs supplied with the package.
</para>
</note>
<note>
<simpara>
In Mandrake Linux, the IMAP library (<filename>libc-client.a</filename>)
is compiled without Kerberos support. A separate version with SSL
(<filename>client-PHP4.a</filename>) is installed. The library must
be recompiled in order to add Kerberos support.
</simpara>
</note>
</section>
&reference.imap.configure;
<section xml:id="imap.configuration">
&reftitle.runtime;
&no.config;
</section>
<section xml:id="imap.resources">
&reftitle.resources;
<para>
</para>
</section>
&reference.imap.constants;
<section xml:id="imap.seealso">
&reftitle.seealso;
<para>
This document can't go into detail on all the topics touched by
@ -136,7 +66,6 @@
by David Wood and <link xlink:href="&url.imap.book;">Managing
IMAP</link> by Dianna Mullet &amp; Kevin Mullet.
</para>
</section>
</partintro>
&reference.imap.entities.functions;

88
reference/imap/setup.xml Normal file
View file

@ -0,0 +1,88 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="imap.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="imap.requirements">
&reftitle.required;
<para>
This extension requires the c-client library to be installed.
Grab the latest version from <link xlink:href="&url.imap;">&url.imap;</link>
and compile it.
</para>
<para>
It's important that you do not copy the IMAP source files directly into
the system include directory as there may be conflicts. Instead, create
a new directory inside the system include directory, such as
<filename>/usr/local/imap-2000b/</filename> (location and name
depend on your setup and IMAP version), and inside this new
directory create additional directories named <filename>lib/</filename>
and <filename>include/</filename>. From the <filename>c-client</filename>
directory from your IMAP source tree, copy all the <filename>*.h</filename>
files into <filename>include/</filename> and all the
<filename>*.c</filename> files into <filename>lib/</filename>.
Additionally when you compiled IMAP, a file named
<filename>c-client.a</filename> was created. Also put this in the
<filename>lib/</filename> directory but rename it as
<filename>libc-client.a</filename>.
</para>
<note>
<para>
To build the c-client library with SSL or/and Kerberos support read
the docs supplied with the package.
</para>
</note>
<note>
<simpara>
In Mandrake Linux, the IMAP library (<filename>libc-client.a</filename>)
is compiled without Kerberos support. A separate version with SSL
(<filename>client-PHP4.a</filename>) is installed. The library must
be recompiled in order to add Kerberos support.
</simpara>
</note>
</section>
<!-- }}} -->
<!-- {{{ Installation -->
&reference.imap.configure;
<!-- }}} -->
<!-- {{{ Configuration -->
<section xml:id="imap.configuration">
&reftitle.runtime;
&no.config;
</section>
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="imap.resources">
&reftitle.resources;
&no.resource;
</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
-->