<para><bridgehead>Pz2.js</bridgehead></para>
<para>
- Pazapar2 comes with a small JavaScript library called pz2.js. This library is designed to simplify development of an Ajax-based pazpar2 clients and alleviate programmer from the low-level details like polling the web service, fetching and parsing returned XML output or managing timers, sessions and basic state variables.
+ Pazpar2 comes with a small JavaScript library called pz2.js. This library is designed to simplify development of an Ajax-based pazpar2 client and alleviate programmer from the low-level details like polling the web service, fetching and parsing returned XML output or managing timers, sessions and basic state variables.
</para>
<para>
<para><bridgehead>Using pz2.js</bridgehead></para>
<para>
- Client development with the pz2.js is strongly event based and should be familiar to most JavaScript developers. A simple client (jsdemo) is distributed with pazpar2's source code and shows how to set-up and use pz2.js.
+ Client development with the pz2.js is strongly event based and the style should be familiar to most JavaScript developers. A simple client (jsdemo) is distributed with pazpar2's source code and shows how to set-up and use pz2.js.
</para>
<para>
</screen>
<para>
- Each command callback is a user defined function that takes a hash object as a parameter. The hash object contains parsed pazpar2 responses (hash members that correspond to the elements in the response XML document). Within the handler programmer further processes the data and updates the the viewed document.
+ Each command callback is a user defined function that takes a hash object as a parameter. The hash object contains parsed pazpar2 responses (hash members that correspond to the elements in the response XML document). Within the handler programmer further processes the data and updates the viewed document.
</para>
<screen>
}
function on_record(data) {
- // if detailsstylesheet parameter was set data array will contain raw xml // // and xsl data
+ // if detailsstylesheet parameter was set data array
+ // will contain raw xml and xsl data
Element_appendTransformResult(someDiv, data.xmlDoc, data.xslDoc);
}
</screen>
<para><bridgehead>PARAMATERS ARRAY</bridgehead></para>
<varlistentry><term>pazpar2path</term>
- <listitem><para>server path to pazpar2 (relative to the portal), when pazar2 is installed as a package this does not have to be set </para></listitem>
+ <listitem><para>server path to pazpar2 (relative to the portal), when pazpar2 is installed as a package this does not have to be set </para></listitem>
</varlistentry>
<varlistentry><term>usesessions</term>
<listitem><para>specifies reset method callback function</para></listitem></varlistentry>
<varlistentry><term>termlist</term>
- <listitem><para>coma separated list of facets</para></listitem></varlistentry>
+ <listitem><para>comma separated list of facets</para></listitem></varlistentry>
<varlistentry><term>keepAlive</term>
<listitem><para>ping period, should not be lower than 5000 usec</para></listitem></varlistentry>
<listitem><para>reset state</para></listitem></varlistentry>
<varlistentry><term>init (sesionId)</term>
- <listitem><para>session-mode, intitialize new session or pick up a session already initialized</para></listitem></varlistentry>
+ <listitem><para>session-mode, initialize new session or pick up a session already initialized</para></listitem></varlistentry>
<varlistentry><term>ping ()</term>
<listitem><para>session-mode, intitialize pinging </para></listitem></varlistentry>
<varlistentry><term>search (query, num, sort, filter, showfrom)</term>
- <listitem><para>execute piggy-back search and activate polling on every command specfied by assigning command callback (in the pz2 constructor)</para></listitem></varlistentry>
+ <listitem><para>execute piggy-back search and activate polling on every command specified by assigning command callback (in the pz2 constructor)</para></listitem></varlistentry>
<varlistentry><term>show (start, num, sort)</term>
<listitem><para>start or change parameters of polling for a given window of records</para></listitem></varlistentry>
<varlistentry><term>record (id, offset, syntax, handler)</term>
- <listitem><para>retrieve detailed or raw record. handler temporary overrirdes default callback function.</para></listitem></varlistentry>
+ <listitem><para>retrieve detailed or raw record. handler temporarily overrides default callback function.</para></listitem></varlistentry>
<varlistentry><term>termlist ()</term>
<listitem><para>start polling for termlists</para></listitem></varlistentry>
scenes. Pazpar2 connects to servers, carries out searches, and
retrieves, deduplicates, and stores results internally. Your application
code may periodically inquire about the status of an ongoing operation,
- and ask to see records or other result set facets. Result become
+ and ask to see records or other result set facets. Result becomes
available immediately, and it is easy to build end-user interfaces which
feel extremely responsive, even when searching more than 100 servers
concurrently.
If you wish to connect to commercial or other databases which do not
support open standards, please contact Index Data. We have a licensing
agreement with a third party vendor which will enable Pazpar2 to access
- thousands of online databases, in addition the vast number of catalogs
+ thousands of online databases, in addition to the vast number of catalogs
and online services that support the Z39.50/SRU/SRW protocols.
</para>
<para>
<chapter id="installation">
<title>Installation</title>
<para>
- The Pazpar2 package very small. It includes documentation as well
+ The Pazpar2 package is very small. It includes documentation as well
as the Pazpar2 server. The package also includes a simple user
interface test1 which consists of a single HTML page and a single
JavaScript file to illustrate the use of Pazpar2.
Sometimes, it may be necessary to implement functionality on your
regular webserver that makes use of search results, for example to
implement data import functionality, emailing results, history
- lists, personal citation lists, interlibrary loan functionality
- ,etc. Fortunately, it is simple to exchange information between
+ lists, personal citation lists, interlibrary loan functionality,
+ etc. Fortunately, it is simple to exchange information between
Pazpar2, your browser scripting, and backend server-side scripting.
You can send a session ID and possibly a record ID from your browser
code to your server code, and from there use Pazpar2s webservice API
<title>Your data model</title>
<para>
Pazpar2 does not have a preconceived model of what makes up a data
- model. There are no assumption that records have specific fields or
+ model. There are no assumptions that records have specific fields or
that they are organized in any particular way. The only assumption
is that data comes packaged in a form that the software can work
with (presently, that means XML or MARC), and that you can provide
projects / pazpar2-moved-to-github.git / commitdiff