MFB: Upgrade to the new-reference-structure

- Split reference.xml into book.xml and setup.xml
- Moved from reference.xml to book.xml:
  - The intro text (partintro), and link to constants and the new examples page
- Moved from reference.xml to setup.xml:
  - The rest: requirements, installation, configuration, and resources
- Changed the constants section to be an <appendix>
- Changed the intro ID from <extname>.intro to intro.<extname>


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@248208 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2007-12-14 02:21:44 +00:00
parent 13339a9d26
commit bc40b40e49
5 changed files with 253 additions and 130 deletions

69
reference/yaz/book.xml Normal file
View file

@ -0,0 +1,69 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<!-- Purpose: remote.other -->
<!-- Membership: pecl, external -->
<book xml:id="book.yaz" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>YAZ</title>
<!-- {{{ preface -->
<preface xml:id="intro.yaz">
&reftitle.intro;
<para>
This extension offers a PHP interface to the
<productname>YAZ</productname> toolkit that implements the
<link xlink:href="&url.yaz-loc;">Z39.50
Protocol for Information Retrieval</link>.
With this extension you can easily implement a Z39.50 origin (client)
that searches or scans Z39.50 targets (servers) in parallel.
</para>
<para>
The module hides most of the complexity of Z39.50 so it should be
fairly easy to use. It supports persistent stateless connections very
similar to those offered by the various RDB APIs that are available
for PHP. This means that sessions are stateless but shared among
users, thus saving the connect and initialize phase steps in most
cases.
</para>
<para>
<productname>YAZ</productname> is available at <link
xlink:href="&url.yaz;">&url.yaz;</link>. You can find news information,
example scripts, etc. for this extension at <link
xlink:href="&url.yaz-phpyaz;">&url.yaz-phpyaz;</link>.
</para>
<note>
<para>
&pecl.moved-ver;5.0.0.
</para>
</note>
</preface>
<!-- }}} -->
&reference.yaz.setup;
&reference.yaz.constants;
&reference.yaz.examples;
&reference.yaz.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

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<appendix xml:id="yaz.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&no.constants;
</appendix>
<!-- 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

@ -0,0 +1,99 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="yaz.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.examples;
<para>
PHP/YAZ keeps track of connections with targets
(Z-Associations). A resource represents a connection to a
target.
</para>
<para>
The script below demonstrates the parallel searching feature of
the API. When invoked with no arguments it prints a query form; else
(arguments are supplied) it searches the targets as given in array
<literal>host</literal>.
</para>
<para>
<example>
<title>Parallel searching using Yaz</title>
<programlisting role="php">
<![CDATA[
<?php
$host=$_REQUEST[host];
$query=$_REQUEST[query];
$num_hosts = count($host);
if (empty($query) || count($host) == 0) {
echo '<form method="get">
<input type="checkbox"
name="host[]" value="bagel.indexdata.dk/gils" />
GILS test
<input type="checkbox"
name="host[]" value="localhost:9999/Default" />
local test
<input type="checkbox" checked="checked"
name="host[]" value="z3950.loc.gov:7090/voyager" />
Library of Congress
<br />
RPN Query:
<input type="text" size="30" name="query" />
<input type="submit" name="action" value="Search" />
</form>
';
} else {
echo 'You searched for ' . htmlspecialchars($query) . '<br />';
for ($i = 0; $i < $num_hosts; $i++) {
$id[] = yaz_connect($host[$i]);
yaz_syntax($id[$i], "usmarc");
yaz_range($id[$i], 1, 10);
yaz_search($id[$i], "rpn", $query);
}
yaz_wait();
for ($i = 0; $i < $num_hosts; $i++) {
echo '<hr />' . $host[$i] . ':';
$error = yaz_error($id[$i]);
if (!empty($error)) {
echo "Error: $error";
} else {
$hits = yaz_hits($id[$i]);
echo "Result Count $hits";
}
echo '<dl>';
for ($p = 1; $p <= 10; $p++) {
$rec = yaz_record($id[$i], $p, "string");
if (empty($rec)) continue;
echo "<dt><b>$p</b></dt><dd>";
echo nl2br($rec);
echo "</dd>";
}
echo '</dl>';
}
}
?>
]]>
</programlisting>
</example>
</para>
</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,137 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.23 $ -->
<!-- Purpose: remote.other -->
<!-- Membership: pecl, external -->
<!-- $Revision: 1.24 $ -->
<reference xml:id="ref.yaz" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>YAZ &Functions;</title>
<reference xml:id="ref.yaz" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>YAZ Functions</title>
<titleabbrev>YAZ</titleabbrev>
&reference.yaz.entities.functions;
<partintro>
<section xml:id="yaz.intro">
&reftitle.intro;
<para>
This extension offers a PHP interface to the
<productname>YAZ</productname> toolkit that implements the
<link xlink:href="&url.yaz-loc;">Z39.50
Protocol for Information Retrieval</link>.
With this extension you can easily implement a Z39.50 origin (client)
that searches or scans Z39.50 targets (servers) in parallel.
</para>
<para>
The module hides most of the complexity of Z39.50 so it should be
fairly easy to use. It supports persistent stateless connections very
similar to those offered by the various RDB APIs that are available
for PHP. This means that sessions are stateless but shared among
users, thus saving the connect and initialize phase steps in most
cases.
</para>
<para>
<productname>YAZ</productname> is available at <link
xlink:href="&url.yaz;">&url.yaz;</link>. You can find news information,
example scripts, etc. for this extension at <link
xlink:href="&url.yaz-phpyaz;">&url.yaz-phpyaz;</link>.
</para>
<note>
<para>
&pecl.moved-ver;5.0.0.
</para>
</note>
</section>
&reference.yaz.configure;
&reference.yaz.ini;
</reference>
<section xml:id="yaz.resources">
&reftitle.resources;
&no.resource;
</section>
<section xml:id="yaz.constants">
&reftitle.constants;
&no.constants;
</section>
<section xml:id="yaz.examples">
&reftitle.examples;
<para>
PHP/YAZ keeps track of connections with targets
(Z-Associations). A resource represents a connection to a
target.
</para>
<para>
The script below demonstrates the parallel searching feature of
the API. When invoked with no arguments it prints a query form; else
(arguments are supplied) it searches the targets as given in array
<literal>host</literal>.
</para>
<para>
<example>
<title>Parallel searching using Yaz</title>
<programlisting role="php">
<![CDATA[
<?php
$host=$_REQUEST[host];
$query=$_REQUEST[query];
$num_hosts = count($host);
if (empty($query) || count($host) == 0) {
echo '<form method="get">
<input type="checkbox"
name="host[]" value="bagel.indexdata.dk/gils" />
GILS test
<input type="checkbox"
name="host[]" value="localhost:9999/Default" />
local test
<input type="checkbox" checked="checked"
name="host[]" value="z3950.loc.gov:7090/voyager" />
Library of Congress
<br />
RPN Query:
<input type="text" size="30" name="query" />
<input type="submit" name="action" value="Search" />
</form>
';
} else {
echo 'You searched for ' . htmlspecialchars($query) . '<br />';
for ($i = 0; $i < $num_hosts; $i++) {
$id[] = yaz_connect($host[$i]);
yaz_syntax($id[$i], "usmarc");
yaz_range($id[$i], 1, 10);
yaz_search($id[$i], "rpn", $query);
}
yaz_wait();
for ($i = 0; $i < $num_hosts; $i++) {
echo '<hr />' . $host[$i] . ':';
$error = yaz_error($id[$i]);
if (!empty($error)) {
echo "Error: $error";
} else {
$hits = yaz_hits($id[$i]);
echo "Result Count $hits";
}
echo '<dl>';
for ($p = 1; $p <= 10; $p++) {
$rec = yaz_record($id[$i], $p, "string");
if (empty($rec)) continue;
echo "<dt><b>$p</b></dt><dd>";
echo nl2br($rec);
echo "</dd>";
}
echo '</dl>';
}
}
?>
]]>
</programlisting>
</example>
</para>
</section>
</partintro>
&reference.yaz.entities.functions;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

51
reference/yaz/setup.xml Normal file
View file

@ -0,0 +1,51 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<chapter xml:id="yaz.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="yaz.requirements">
&reftitle.required;
&no.requirement;
</section>
<!-- }}} -->
<!-- {{{ Installation -->
&reference.yaz.configure;
<!-- }}} -->
<!-- {{{ Configuration -->
&reference.yaz.ini;
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="yaz.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
-->