cvs: phpdoc /en/reference/swish book.xml constants.xml examples.xml reference.xml setup.xml

From: Date: Sun, 23 Dec 2007 22:51:03 +0000
Subject: cvs: phpdoc /en/reference/swish book.xml constants.xml examples.xml reference.xml setup.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-795@lists.php.net to get a copy of this message
bjori Sun Dec 23 22:51:03 2007 UTC Modified files: /phpdoc/en/reference/swish book.xml examples.xml setup.xml constants.xml reference.xml Log: 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 example to its own chapter (examples.xml) NOTE: The chapter now has the swish.examples ID, the section is now swish.examples-basic - Moved the requirements, install and configuration sections to setup.xml

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/swish/book.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/swish/book.xml diff -u /dev/null phpdoc/en/reference/swish/book.xml:1.2 --- /dev/null Sun Dec 23 22:51:03 2007 +++ phpdoc/en/reference/swish/book.xml Sun Dec 23 22:51:03 2007 @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> +<!-- Purpose: utilspec.nontext --> +<!-- Membership: pecl, external --> +<!-- State: experimental --> + +<book xml:id="book.swish" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title>swish</title> + + <!-- {{{ preface --> + <preface xml:id="intro.swish"> + &reftitle.intro; + <para> + The swish extension provides the bindings for Swish-e API. + Swish-e stands for "Simple Web Indexing System for Humans - Enhanced" and + is an open source system for indexing and search. + Swish-e itself is licensed under GPL license, but uses a clause that + allows applications to link against the library if every copy of the + combined work is accompanied by the URL to Swish-e source code. Here it + is: <link xlink:href="http://swish-e.org">http://swish-e.org</link>. + </para> + + &warn.experimental; + </preface> + <!-- }}} --> + + &reference.swish.setup; + &reference.swish.constants; + &reference.swish.examples; + <!-- FIXME: This extension defines some classess, see classes.xml --> + &reference.swish.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 +--> + http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/swish/examples.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/swish/examples.xml diff -u /dev/null phpdoc/en/reference/swish/examples.xml:1.2 --- /dev/null Sun Dec 23 22:51:03 2007 +++ phpdoc/en/reference/swish/examples.xml Sun Dec 23 22:51:03 2007 @@ -0,0 +1,78 @@ +<chapter xml:id="swish.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + &reftitle.examples; + <section xml:id="swish.examples-basic"> + <title>Basic usage</title> + <para> + <example> + <title>Basic search query</title> + <programlisting role="php"> +<![CDATA[ +<?php + +try { + + $swish = new Swish("index.swish-e"); + $results = $swish->query("test OR text"); + + echo "Found ", $results->hits, " results\n"; + while ($result = $results->nextResult()) { + var_dump($result); + break; //break after the first result + } + +} catch (SwishException $e) { + echo "Error: ", $e->getMessage(), "\n"; +} + +?> +]]> + </programlisting> + </example> + </para> + &example.outputs.similar; + <screen> +<![CDATA[ +Found 9 results +object(SwishResult)#3 (8) { + ["swishreccount"]=> + int(1) + ["swishrank"]=> + int(1000) + ["swishfilenum"]=> + int(10) + ["swishdbfile"]=> + string(13) "index.swish-e" + ["swishdocpath"]=> + string(23) "README.SUBMITTING_PATCH" + ["swishtitle"]=> + NULL + ["swishdocsize"]=> + int(4557) + ["swishlastmodified"]=> + int(1072136752) +} +]]> + </screen> + </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 +--> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/swish/setup.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/swish/setup.xml diff -u /dev/null phpdoc/en/reference/swish/setup.xml:1.2 --- /dev/null Sun Dec 23 22:51:03 2007 +++ phpdoc/en/reference/swish/setup.xml Sun Dec 23 22:51:03 2007 @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 1.2 $ --> + +<chapter xml:id="swish.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + &reftitle.setup; + + <!-- {{{ Requirements --> + <section xml:id="swish.requirements"> + &reftitle.required; + <para> + PECL/swish requires PHP 5.1.3 or newer. + </para> + </section> + <!-- }}} --> + + <!-- {{{ Installation --> + <section xml:id="swish.installation"> + &reftitle.install; + <para> + &pecl.info; + <link xlink:href="&url.pecl.package;swish">&url.pecl.package;swish</link>. + </para> + <para> + The latest PECL/swish Win32 DLL can be downloaded here: + <link xlink:href='&url.pecl.win.ext;php_swish.dll'>php_swish.dll</link>. + </para> + </section> + <!-- }}} --> + + <!-- {{{ Configuration --> + <section xml:id="swish.configuration"> + &reftitle.runtime; + &no.config; + </section> + <!-- }}} --> + + <!-- {{{ Resources --> + <section xml:id="swish.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 +--> + http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/swish/constants.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/swish/constants.xml diff -u phpdoc/en/reference/swish/constants.xml:1.3 phpdoc/en/reference/swish/constants.xml:1.4 --- phpdoc/en/reference/swish/constants.xml:1.3 Wed Jun 20 22:25:31 2007 +++ phpdoc/en/reference/swish/constants.xml Sun Dec 23 22:51:03 2007 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<section xml:id="swish.constants" xmlns="http://docbook.org/ns/docbook"> +<!-- $Revision: 1.4 $ --> +<appendix xml:id="swish.constants" xmlns="http://docbook.org/ns/docbook"> &reftitle.constants; &extension.constants; <variablelist> @@ -215,7 +215,7 @@ </listitem> </varlistentry> </variablelist> -</section> +</appendix> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/swish/reference.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/swish/reference.xml diff -u phpdoc/en/reference/swish/reference.xml:1.9 phpdoc/en/reference/swish/reference.xml:1.10 --- phpdoc/en/reference/swish/reference.xml:1.9 Mon Dec 10 17:06:10 2007 +++ phpdoc/en/reference/swish/reference.xml Sun Dec 23 22:51:03 2007 @@ -1,107 +1,12 @@ <?xml version = '1.0' encoding = 'iso-8859-1'?> -<!-- $Revision: 1.9 $ --> -<!-- Purpose: utilspec.nontext --> -<!-- Membership: pecl, external --> -<!-- State: experimental --> -<reference xml:id="ref.swish" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <title>Swish Functions</title> - <titleabbrev>swish</titleabbrev> - <partintro> - <section xml:id="swish.intro" > - &reftitle.intro; - <para> - The swish extension provides the bindings for Swish-e API. - Swish-e stands for "Simple Web Indexing System for Humans - Enhanced" and - is an open source system for indexing and search. - Swish-e itself is licensed under GPL license, but uses a clause that - allows applications to link against the library if every copy of the - combined work is accompanied by the URL to Swish-e source code. Here it - is: <link xlink:href="http://swish-e.org">http://swish-e.org</link>. - </para> - - &warn.experimental; - - </section> - <section xml:id="swish.requirements" > - &reftitle.required; - <para> - PECL/swish requires PHP 5.1.3 or newer. - </para> - </section> - <section xml:id="swish.install" > - &reftitle.install; - <para> - &pecl.info; - <link xlink:href="&url.pecl.package;swish">&url.pecl.package;swish</link>. - </para> - <para> - The latest PECL/swish Win32 DLL can be downloaded here: - <link xlink:href='&url.pecl.win.ext;php_swish.dll'>php_swish.dll</link>. - </para> - </section> - <section xml:id="swish.configuration"> - &reftitle.runtime; - &no.config; - </section> - <section xml:id="swish.examples"> - &reftitle.examples; - <para> - <example> - <title>Basic search query</title> - <programlisting role="php"> -<![CDATA[ -<?php - -try { - - $swish = new Swish("index.swish-e"); - $results = $swish->query("test OR text"); +<!-- $Revision: 1.10 $ --> - echo "Found ", $results->hits, " results\n"; - while ($result = $results->nextResult()) { - var_dump($result); - break; //break after the first result - } - -} catch (SwishException $e) { - echo "Error: ", $e->getMessage(), "\n"; -} +<reference xml:id="ref.swish" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title>Swish &Functions;</title> -?> -]]> - </programlisting> - </example> - </para> - &example.outputs.similar; - <screen> -<![CDATA[ -Found 9 results -object(SwishResult)#3 (8) { - ["swishreccount"]=> - int(1) - ["swishrank"]=> - int(1000) - ["swishfilenum"]=> - int(10) - ["swishdbfile"]=> - string(13) "index.swish-e" - ["swishdocpath"]=> - string(23) "README.SUBMITTING_PATCH" - ["swishtitle"]=> - NULL - ["swishdocsize"]=> - int(4557) - ["swishlastmodified"]=> - int(1072136752) -} -]]> - </screen> - </section> - &reference.swish.constants; - &reference.swish.classes; - </partintro> - &reference.swish.entities.functions; + &reference.swish.entities.functions; </reference> + <!-- Keep this comment at the end of the file Local variables: mode: sgml
« previous php.doc.cvs (#795) next »