MFB: Upgrade to the new-reference-structure

- Split reference.xml into book.xml, setup.xml, and examples.xml
- Moved from reference.xml to book.xml:
  - The intro text (partintro), and link to various pages
- Moved from reference.xml to setup.xml:
  - The other: requirements, installation, configuration, and resources
- Moved from reference.xml to examples.xml: the examples
- Removed the now empty reference.xml as this function contains no functions
- Changed the constants section to be an <appendix> (constants.xml)
- Changed the contexts section to be an <appendix> (contexts.xml)
- Changed the intro ID from <extname>.intro to intro.<extname>


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248846 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2007-12-23 20:01:14 +00:00
parent 1d185da766
commit 4cb536602c
4 changed files with 134 additions and 73 deletions

View file

@ -0,0 +1,52 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- Purpose: utilspec.audio -->
<!-- Membership: pecl, external -->
<book xml:id="book.oggvorbis" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>OGG/Vorbis</title>
<titleabbrev>oggvorbis</titleabbrev>
<!-- {{{ preface -->
<preface xml:id="intro.oggvorbis">
&reftitle.intro;
<para>
The OGG/Vorbis file format, as defined by <link
xlink:href="&url.ogg.vorbis;">&url.ogg.vorbis;</link>, is a scheme
for compressing audio streams by multiple factors with a minimum of
quality loss. This extension adds Ogg Vorbis support to PHP&apos;s
<link linkend="wrappers">URL Wrappers</link>. When used in read mode,
compressed OGG/Vorbis data is expanded to raw PCM audio in one of six PCM
encoding formats listed below.
</para>
</preface>
<!-- }}} -->
&reference.oggvorbis.setup;
&reference.oggvorbis.constants;
&reference.oggvorbis.contexts;
&reference.oggvorbis.examples;
</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.2 $ -->
<section xml:id="oggvorbis.constants" xmlns="http://docbook.org/ns/docbook">
<!-- $Revision: 1.3 $ -->
<appendix xml:id="oggvorbis.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<table>
@ -40,7 +40,7 @@
</tbody>
</tgroup>
</table>
</section>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -1,62 +1,14 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- Purpose: utilspec.audio -->
<!-- Membership: pecl, external -->
<!-- $Revision: 1.2 $ -->
<reference xml:id="ref.oggvorbis" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>oggvorbis</title>
<titleabbrev>OGG/Vorbis</titleabbrev>
<partintro>
<section xml:id="oggvorbis.intro">
&reftitle.intro;
<simpara>
The OGG/Vorbis file format, as defined by <link
xlink:href="&url.ogg.vorbis;">&url.ogg.vorbis;</link>, is a scheme
for compressing audio streams by multiple factors with a minimum of
quality loss. This extension adds Ogg Vorbis support to PHP&apos;s
<link linkend="wrappers">URL Wrappers</link>. When used in read mode,
compressed OGG/Vorbis data is expanded to raw PCM audio in one of six PCM
encoding formats listed below.
</simpara>
</section>
<section xml:id="oggvorbis.requirements">
&reftitle.required;
<para>
This extension requires <literal>PHP &gt;= 4.3.0</literal>,
<link xlink:href="&url.ogg.vorbis.downloads;">libogg</link> &gt;= 1.0, and
<link xlink:href="&url.ogg.vorbis.downloads;">libvorbis</link> &gt;= 1.0.
</para>
</section>
<section xml:id="oggvorbis.configuration">
&reftitle.runtime;
&no.config;
</section>
&reference.oggvorbis.configure;
&reference.oggvorbis.contexts;
&reference.oggvorbis.constants;
</partintro>
<refentry xml:id="oggvorbis.usage">
<refnamediv>
<refname>Usage</refname>
<refpurpose>
Examples on using the ogg:// wrapper.
</refpurpose>
</refnamediv>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Reading an OGG/Vorbis file</title>
<programlisting role="php">
<chapter xml:id="oggvorbis.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.examples;
<section xml:id="oggvorbis.examples-basisc">
<title>Examples on using the ogg:// wrapper.</title>
<para>
<example>
<title>Reading an OGG/Vorbis file</title>
<programlisting role="php">
<![CDATA[
<?php
dl("oggvorbis.so");
@ -87,14 +39,14 @@ fclose($fp);
?>
]]>
</programlisting>
</example>
</para>
</programlisting>
</example>
</para>
<para>
<example>
<title>Encode an audio file to OGG/Vorbis</title>
<programlisting role="php">
<para>
<example>
<title>Encode an audio file to OGG/Vorbis</title>
<programlisting role="php">
<![CDATA[
<?php
dl('oggvorbis.so');
@ -118,12 +70,11 @@ fclose($pcm);
fclose($ogg);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</reference>
</programlisting>
</example>
</para>
</section>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:

View file

@ -0,0 +1,58 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="oggvorbis.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="oggvorbis.requirements">
&reftitle.required;
<para>
This extension requires <literal>PHP &gt;= 4.3.0</literal>,
<link xlink:href="&url.ogg.vorbis.downloads;">libogg</link> &gt;= 1.0, and
<link xlink:href="&url.ogg.vorbis.downloads;">libvorbis</link> &gt;= 1.0.
</para>
</section>
<!-- }}} -->
<!-- {{{ Installation -->
&reference.oggvorbis.configure;
<!-- }}} -->
<!-- {{{ Configuration -->
<section xml:id="oggvorbis.configuration">
&reftitle.runtime;
&no.config;
</section>
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="oggvorbis.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
-->