/usr/share/doc/refdb/refdb-manual/ch20s02.html is in refdb-doc 1.0.2-3ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Classes and their functions</title><link rel="stylesheet" type="text/css" href="manual.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="home" href="index.html" title="RefDB handbook" /><link rel="up" href="ch20.html" title="Chapter 20. The Perl client module" /><link rel="prev" href="ch20.html" title="Chapter 20. The Perl client module" /><link rel="next" href="ch21.html" title="Chapter 21. Using the backend API to implement new output formats" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Classes and their functions</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch20.html">Prev</a> </td><th width="60%" align="center">Chapter 20. The Perl client module</th><td width="20%" align="right"> <a accesskey="n" href="ch21.html">Next</a></td></tr></table><hr /></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="idp66433312"></a>Classes and their functions</h2></div></div></div><p>Like most Perl modules, the RefDBClient::Client module is object-oriented. This section introduces the two classes that you need to know in order to work with the module. To see a working example, please check the <code class="filename">test.pl</code> script shipped with the module.</p><p>The main class that is used to access all RefDB client functions is called RefDBClient::Client. To get started, create a new instance and set the communication parameters:</p><pre class="programlisting">use RefDBClient::Client;
my $client = new RefDBClient::Client;
$client->set_conninfo("127.0.0.1", "9734", "markus", "pass", "refdbtest",
"/home/markus/literature", "/usr/local/share/refdb/css/refdb.css", "360");
</pre><p>Then you can go ahead and send commands to the server like this:</p><pre class="programlisting">$summary = $client->refdb_listdb("");
$data = $client->get_data();
</pre><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>As you can easily guess the functions implementing the client commands are analogous to the commands found in the <a class="link" href="ch13.html" title="Chapter 13. Administration tools">refdba</a> and <a class="link" href="ch14.html" title="Chapter 14. Tools for reference and notes management">refdbc</a> clients. See the reference pages about these apps for further information about the commands.</p></div><p>There are three helper classes:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>RefDBClient::Risdata provides a simple interface to RIS data</p></li><li class="listitem"><p>ReFDBClient::Simplelist is used internally</p></li><li class="listitem"><p>RefDBClient::Enigma handles the password encryption</p></li></ul></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="sect-risdata"></a>RefDBClient::Risdata</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-risdata-new"></a>new</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">new RefDBClient::Risdata(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>Creates a new Risdata object</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-risdata-read-ris"></a>read_ris</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$data->read_ris(</code></td><td>
<var class="pdparam">$file</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>loads RIS data from a file</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$file</span></dt><dd><p>path of file</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-risdata-get-ris"></a>get_ris</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$data->get_ris(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>returns previously loaded RIS data</p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="sect-simplelist"></a>RefDBClient::Simplelist</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-simplelist-new"></a>new</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">new RefDBClient::Simplelist(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>creates a new Simplelist element</p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="sect-enigma"></a>RefDBClient::Enigma</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-enigma-new"></a>new</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">new RefDBClient::Enigma(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>creates a new Enigma element</p></div></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="sect-client"></a>RefDBClient::Client</h3></div></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-new"></a>new</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">new RefDBClient::Client(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>creates a new Client element</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-set-conninfo"></a>set_conninfo</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->set_conninfo(</code></td><td>
<var class="pdparam">$server_ip</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$port_address</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$username</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$password</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$database</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$pdf_root</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$css_url</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$timeout</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>sets the initial connection parameters of a Client object</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$server_ip</span></dt><dd><p>IP address or hostname of the server that runs refdbd</p></dd><dt><span class="term">$port_address</span></dt><dd><p>Port address at which refdbd listens</p></dd><dt><span class="term">$username</span></dt><dd><p>Username for database password authentication</p></dd><dt><span class="term">$password</span></dt><dd><p>Password for database password authentication</p></dd><dt><span class="term">$database</span></dt><dd><p>Name of the reference database</p></dd><dt><span class="term">$pdf_root</span></dt><dd><p>Path of the root directory of all electronic offprints</p></dd><dt><span class="term">$css_url</span></dt><dd><p>URL of a Cascading Stylesheets file for (X)HTML output</p></dd><dt><span class="term">$timeout</span></dt><dd><p>Timeout in seconds after which a stale connection is taken down</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-get-status"></a>get_status</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->get_status(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>returns the numerical server status</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-get-status-msg"></a>get_status_msg</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->get_status_msg(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>returns the server status message</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-get-data"></a>get_data</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->get_data(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>returns the data of the most recent command</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-get-summary"></a>get_summary</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->get_summary(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>returns the summary of the most recent command</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-addstyle"></a>refdb_addstyle</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_addstyle(</code></td><td>
<var class="pdparam">$styledata</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>adds a citation/bibliography style to the database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$styledata</span></dt><dd><p>XML data representing the bibliography style</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-adduser"></a>refdb_adduser</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_adduser(</code></td><td>
<var class="pdparam">$host</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$database</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$newuserpassword</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$username</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>adds new users to the database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$host</span></dt><dd><p>host specification from which the user is allowed to connect</p></dd><dt><span class="term">$database</span></dt><dd><p>name of the reference database</p></dd><dt><span class="term">$newuserpassword</span></dt><dd><p>password (required only for new users)</p></dd><dt><span class="term">$username</span></dt><dd><p>name of the user, as used to authenticate at the database engine</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-deleteuser"></a>refdb_deleteuser</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_deleteuser(</code></td><td>
<var class="pdparam">$host</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$database</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$username</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>deletes users from the database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$host</span></dt><dd><p>host specification from which the user is allowed to connect</p></dd><dt><span class="term">$database</span></dt><dd><p>name of the reference database</p></dd><dt><span class="term">$username</span></dt><dd><p>name of the user, as used to authenticate at the database engine</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-addword"></a>refdb_addword</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_addword(</code></td><td>
<var class="pdparam">$words</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>adds reserved words to the main database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$words</span></dt><dd><p>space-separated list of words</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-deleteword"></a>refdb_deleteword</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$summary = $client->refdb_deleteword(</code></td><td>
<var class="pdparam">$words</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>removes reserved words from the main database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$words</span></dt><dd><p>space-separated list of words</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-confserv"></a>refdb_confserv</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_confserv(</code></td><td>
<var class="pdparam">$command</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>sends a configuration command to the server</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$command</span></dt><dd><p>the command proper, optionally followed by an argument</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-createdb"></a>refdb_createdb</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_createdb(</code></td><td>
<var class="pdparam">$dbname</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$encoding</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>creates a new database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$dbname</span></dt><dd><p>name of the reference database</p></dd><dt><span class="term">$encoding</span></dt><dd><p>character encoding</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-deletedb"></a>refdb_deletedb</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_deletedb(</code></td><td>
<var class="pdparam">$databasename</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>deletes a reference database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$dbname</span></dt><dd><p>name of the database</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-deletestyle"></a>refdb_deletestyle</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_deletestyle(</code></td><td>
<var class="pdparam">$stylename_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>deletes citation/bibliography styles</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$stylename_regexp</span></dt><dd><p>regular expression describing the names of the styles to be deleted</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-getstyle"></a>refdb_getstyle</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_getstyle(</code></td><td>
<var class="pdparam">$stylename</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves a citation/bibliography style as a citestylex doc</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$stylename</span></dt><dd><p>name of the style</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-listdb"></a>refdb_listdb</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_listdb(</code></td><td>
<var class="pdparam">$dbname_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>lists matching databases</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$dbname_regexp</span></dt><dd><p>regular expression describing the database names</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-listuser"></a>refdb_listuser</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_listuser(</code></td><td>
<var class="pdparam">$dbname</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$username_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>lists matching user names</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$username_regexp</span></dt><dd><p>regular expression describing the user names</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-listword"></a>refdb_listword</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_listword(</code></td><td>
<var class="pdparam">$word_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>lists matching journal name words</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$wordname_regexp</span></dt><dd><p>regular expression describing the word names</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-liststyle"></a>refdb_liststyle</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_liststyle(</code></td><td>
<var class="pdparam">$stylename_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>lists matching citation/bibliography styles</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$stylename_regexp</span></dt><dd><p>regular expression describing the style names</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-viewstat"></a>refdb_viewstat</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_viewstat(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>requests version/connection info from the server</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-scankw"></a>refdb_scankw</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_scankw(</code></td><td>
<var class="pdparam">$dbname</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>runs a thorough keyword scan in the given database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$dbname</span></dt><dd><p>name of the reference database</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-addref"></a>refdb_addref</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_addref(</code></td><td>
<var class="pdparam">$owner</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$refdata</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$type</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$encoding</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>adds references to the database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$owner</span></dt><dd><p>name of the dataset owner, if different from current user</p></dd><dt><span class="term">$refdata</span></dt><dd><p>string containing the reference data</p></dd><dt><span class="term">$type</span></dt><dd><p>data type, must be one of 'ris' or 'risx'</p></dd><dt><span class="term">$encoding</span></dt><dd><p>character encoding of the input data (only for RIS data)</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-checkref"></a>refdb_checkref</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_checkref(</code></td><td>
<var class="pdparam">$risdata</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$type</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$encoding</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$outtype</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Checks new references against the references in the database without adding them permanently</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$risdata</span></dt><dd><p>string containing the reference data</p></dd><dt><span class="term">$type</span></dt><dd><p>data type, must be one of 'ris' or 'risx'</p></dd><dt><span class="term">$encoding</span></dt><dd><p>character encoding of the input data (only for RIS data)</p></dd><dt><span class="term">$outtype</span></dt><dd><p>output data type, must be one of 'scrn' or 'xhtml'</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-updateref"></a>refdb_updateref</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_updateref(</code></td><td>
<var class="pdparam">$owner</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$is_personal</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$risdata</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$type</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$encoding</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>updates references in the database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$owner</span></dt><dd><p>name of the dataset owner, if different from current user</p></dd><dt><span class="term">$is_personal</span></dt><dd><p>set to 't' if only the personal information shall be updated</p></dd><dt><span class="term">$refdata</span></dt><dd><p>string containing the reference data</p></dd><dt><span class="term">$type</span></dt><dd><p>data type, must be one of 'ris' or 'risx'</p></dd><dt><span class="term">$encoding</span></dt><dd><p>character encoding of the input data (only for RIS data)</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-deleteref"></a>refdb_deleteref</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_deleteref(</code></td><td>
<var class="pdparam">$idlist</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>deletes references from the database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$idlist</span></dt><dd><p>string specifying the IDs of the references to be deleted</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-addnote"></a>refdb_addnote</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_addnote(</code></td><td>
<var class="pdparam">$owner</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$xnotedata</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>adds notes to the database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$owner</span></dt><dd><p>owner of the note, if different from the current user</p></dd><dt><span class="term">$xnotedata</span></dt><dd><p>XML data specifying the note</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-updatenote"></a>refdb_updatenote</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_updatenote(</code></td><td>
<var class="pdparam">$owner</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$is_personal</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$xnotedata</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>updates references in the database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$owner</span></dt><dd><p>owner of the note, if different from the current user</p></dd><dt><span class="term">$is_personal</span></dt><dd><p>set to 't' if only the personal information shall be updated</p></dd><dt><span class="term">$xnotedata</span></dt><dd><p>XML data specifying the note</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-deletenote"></a>refdb_deletenote</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_deletenote(</code></td><td>
<var class="pdparam">$idlist</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>deletes notes from the database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$idlist</span></dt><dd><p>string specifying the ID values of the notes to be deleted</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-addlink"></a>refdb_addlink</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_addlink(</code></td><td>
<var class="pdparam">$linkspec</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>links notes to database objects</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$linkspec</span></dt><dd><p>string specifying the link(s) to be created</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-deletelink"></a>refdb_deletelink</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_deletelink(</code></td><td>
<var class="pdparam">$linkspec</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>unlinks notes from database objects</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$linkspec</span></dt><dd><p>string specifying the link(s) to be deleted</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-getas"></a>refdb_getas</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_getas(</code></td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$name_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves matching series authors</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$name_regexp</span></dt><dd><p>regular expression describing the names to be retrieved</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-getau"></a>refdb_getau</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_getau(</code></td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$name_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves matching authors</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$name_regexp</span></dt><dd><p>regular expression describing the names to be retrieved</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-geted"></a>refdb_geted</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_geted(</code></td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$name_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves matching editors</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$name_regexp</span></dt><dd><p>regular expression describing the names to be retrieved</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-getkw"></a>refdb_getkw</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_getkw(</code></td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$keyword_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves matching keywords</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$keyword_regexp</span></dt><dd><p>regular expression describing the keywords to be retrieved</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-getjf"></a>refdb_getjf</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_getjf(</code></td><td>
<var class="pdparam">$is_all</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$journal_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves matching periodicals (full names)</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$is_all</span></dt><dd><p>set to 't' if all synonymous journal names shall be returned</p></dd><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$name_regexp</span></dt><dd><p>regular expression describing the names to be retrieved</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-getjo"></a>refdb_getjo</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_getjo(</code></td><td>
<var class="pdparam">$is_all</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$journal_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves matching periodical names (abbrev)</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$is_all</span></dt><dd><p>set to 't' if all synonymous journal names shall be returned</p></dd><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$name_regexp</span></dt><dd><p>regular expression describing the names to be retrieved</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-getj1"></a>refdb_getj1</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_getj1(</code></td><td>
<var class="pdparam">$is_all</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$journal_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves matching periodical names (custom abbrev 1)</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$is_all</span></dt><dd><p>set to 't' if all synonymous journal names shall be returned</p></dd><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$name_regexp</span></dt><dd><p>regular expression describing the names to be retrieved</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-getj2"></a>refdb_getj2</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_getj2(</code></td><td>
<var class="pdparam">$is_all</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$journal_regexp</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves matching periodical names (custom abbrev 2)</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$is_all</span></dt><dd><p>set to 't' if all synonymous journal names shall be returned</p></dd><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$name_regexp</span></dt><dd><p>regular expression describing the names to be retrieved</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-getref"></a>refdb_getref</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_getref(</code></td><td>
<var class="pdparam">$type</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$format_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$sort_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$listname</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$encoding</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$query_string</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves references</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$type</span></dt><dd><p>select output format</p></dd><dt><span class="term">$format_string</span></dt><dd><p>specify additional fields to be retrieved</p></dd><dt><span class="term">$sort_string</span></dt><dd><p>specify sorting key</p></dd><dt><span class="term">$listname</span></dt><dd><p>specify a list name if the search is to be confined to a particular personal reference list</p></dd><dt><span class="term">$encoding</span></dt><dd><p>the character encoding for the output data</p></dd><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$query_string</span></dt><dd><p>the query that describes the datasets to be retrieved</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-countref"></a>refdb_countref</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_countref(</code></td><td>
<var class="pdparam">$listname</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$query_string</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Counts matching references</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$listname</span></dt><dd><p>specify a list name if the search is to be confined to a particular personal reference list</p></dd><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$query_string</span></dt><dd><p>the query that describes the datasets to be counted</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-pickref"></a>refdb_pickref</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_pickref(</code></td><td>
<var class="pdparam">$idlist</var>
<var class="pdparam">$listname</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>adds references to the users personal reference list</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$idlist</span></dt><dd><p>specifies the ID values of the references to be picked</p></dd><dt><span class="term">$listname</span></dt><dd><p>the name of the personal list that the references should be added to. If this string is empty, the default personal list is used instead,</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-dumpref"></a>refdb_dumpref</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_dumpref(</code></td><td>
<var class="pdparam">$idlist</var>
<var class="pdparam">$listname</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>removes references from personal reference list</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$idlist</span></dt><dd><p>specifies the ID values of the references to be dumped</p></dd><dt><span class="term">$listname</span></dt><dd><p>the name of the personal list that the references should be added to. If this string is empty, the default personal list is used instead,</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-getnote"></a>refdb_getnote</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_getnote(</code></td><td>
<var class="pdparam">$type</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$format_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$sort_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$encoding</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$query_string</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves references</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$type</span></dt><dd><p>select output format</p></dd><dt><span class="term">$format_string</span></dt><dd><p>specify additional fields to be retrieved</p></dd><dt><span class="term">$sort_string</span></dt><dd><p>specify sorting key</p></dd><dt><span class="term">$encoding</span></dt><dd><p>the character encoding for the output data</p></dd><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$query_string</span></dt><dd><p>the query that describes the datasets to be retrieved</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-countnote"></a>refdb_countnote</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_countnote(</code></td><td>
<var class="pdparam">$listname</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$limit_string</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$query_string</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>Counts matching extended notes</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$listname</span></dt><dd><p>specify a list name if the search is to be confined to a particular personal reference list</p></dd><dt><span class="term">$limit_string</span></dt><dd><p>Limits the matching datasets. Must be in the form 'limit[:offset]', where limit is the number of returned datasets, and offset the number of datasets to skip.</p></dd><dt><span class="term">$query_string</span></dt><dd><p>the query that describes the datasets to be counted</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-selectdb"></a>refdb_selectdb</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_selectdb(</code></td><td>
<var class="pdparam">$dbname</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>selects an existing database as the current database</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$dbname</span></dt><dd><p>name of the reference database</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-whichdb"></a>refdb_whichdb</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_whichdb(</code></td><td><code>void)</code>;</td><td> </td></tr></table><div class="funcprototype-spacer"> </div></div><p>displays information about the current database</p></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-texbib"></a>refdb_texbib</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_texbib(</code></td><td>
<var class="pdparam">$style</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$cite_data</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves a bibliography in bibtex format based on citationlistx data</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$style</span></dt><dd><p>the name of the citation/bibliography style</p></dd><dt><span class="term">$cite_data</span></dt><dd><p>XML data describing the references</p></dd></dl></div></div><div class="sect3"><div class="titlepage"><div><div><h4 class="title"><a id="refdbclient-client-refdb-dbib"></a>refdb_dbib</h4></div></div></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">$client->refdb_dbib(</code></td><td>
<var class="pdparam">$type</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$style</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$encoding</var>
, </td></tr><tr><td> </td><td>
<var class="pdparam">$cite_data</var>
<code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div><p>retrieves an XML/SGML bibliography based on citationlistx data</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">$type</span></dt><dd><p>type of the bibliography output</p></dd><dt><span class="term">$style</span></dt><dd><p>name of the citation/bibliography style</p></dd><dt><span class="term">$encoding</span></dt><dd><p>character encoding of the output data</p></dd><dt><span class="term">$cite_data</span></dt><dd><p>XML data specifying the references</p></dd></dl></div></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch20.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch20.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch21.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 20. The Perl client module </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 21. Using the backend API to implement new output formats</td></tr></table></div></body></html>
|