X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fbook.xml;h=e3217281c81ca1510adc1ea8a518fb6c93049788;hb=089cf6349e1bf28671e20fbde9792d453b443216;hp=6ed3ee0279aa72d350ab72ffe8e432a6b0924207;hpb=e107b0011a295ccc61502d6e5ea79d9125a3fbb4;p=pazpar2-moved-to-github.git
diff --git a/doc/book.xml b/doc/book.xml
index 6ed3ee0..e321728 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -67,7 +67,8 @@
-- XSLT is used to normalize and extract
data from retrieval records for display and analysis. It can be used
against any server which supports the
- Z39.50 protocol. Proprietary
+ Z39.50 and SRU/SRW
+ protocol. Proprietary
backend modules can be used to support a large number of other protocols
(please contact Index Data for further information about this).
@@ -87,7 +88,7 @@
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.
@@ -118,8 +119,8 @@
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
- and online services that support the Z39.50 protocol.
+ thousands of online databases, in addition to the vast number of catalogs
+ and online services that support the Z39.50/SRU/SRW protocols.
Pazpar2 is our attempt to re-think the traditional paradigms for
@@ -148,7 +149,7 @@
Installation
- 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.
@@ -222,6 +223,55 @@
+
+ Installation on Windows (from Source)
+
+ Pazpar2 can be built for Windows using
+ Microsoft Visual Studio.
+ The support files for building YAZ on Windows are located in the
+ win directory. The compilation is performed
+ using the win/makefile which is to be
+ processed by the NMAKE utility part of Visual Studio.
+
+
+ Ensure that the development libraries + header files are
+ available on your system before compiling Pazpar2. For installation
+ of YAZ, refer to the YAZ installation chapter.
+ It is easiest if YAZ and Pazpar2 are unpacked in the same
+ directory (side-by-side).
+
+
+ The compilation is tuned by editing the makefile of Pazpar2.
+ The process is similar to YAZ. Adjust the various directories
+ YAZ_DIR, ZLIB_DIR, ..
+
+
+ Compile Pazpar2 by invoking nmake in
+ the win directory.
+ The resulting binaries of the build process are located in the
+ bin of the Pazpar2 source
+ tree - including the pazpar2.exe and necessary DLLs.
+
+
+ The Windows version of Pazpar2 is a console application. It may
+ be installed as a Windows Service by adding option
+ -install for the pazpar2 program. This will
+ register Pazpar2 as a service and use the other options provided
+ in the same invocation. For example:
+
+ cd \MyPazpar2\etc
+ ..\bin\pazpar2 -install -c pazpar2.cfg -l pazpar2.log
+
+ The Pazpar2 service may now be controlled via the Service Control
+ Panel. It may be unregistered by passing the -remove
+ option. Example:
+
+ cd \MyPazpar2\etc
+ ..\bin\pazpar2 -remove
+
+
+
+
Installation of test1 interface
@@ -235,12 +285,18 @@
Start the Pazpar2 daemon using the 'in-source' binary of the Pazpar2
- daemon.
+ daemon. On Unix the process is:
cd etc
cp pazpar2.cfg.dist pazpar2.cfg
../src/pazpar2 -f pazpar2.cfg -t edu.xml
+ And on Windows:
+
+ cd etc
+ copy pazpar2.cfg.dist pazpar2.cfg
+ ..\bin\pazpar2 -f pazpar2.cfg -t edu.xml
+
This will start a Pazpar2 listener on port 8004. It will proxy
HTTP requests to localhost - port 80, which we assume will be the regular
HTTP server on the system. Inspect and modify pazpar2.cfg as needed
@@ -410,8 +466,8 @@
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
@@ -426,7 +482,7 @@
Your data model
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
@@ -524,7 +580,8 @@
Connecting to non-standard resources
Pazpar2 uses Z39.50 as its switchboard language -- i.e. as far as it
- is concerned, all resources speak Z39.50. It is, however, equipped
+ is concerned, all resources speak Z39.50, or its webservices derivatives,
+ SRU/SRW. It is, however, equipped
to handle a broad range of different server behavior, through
configurable query mapping and record normalization. If you develop
configuration, stylesheets, etc., for a new type of resources, we
@@ -542,8 +599,7 @@
- But what about resources that don't support Z39.50 at all? The NISO
- SRU (MXG) protocol is slowly gathering steam. Other resources might
+ But what about resources that don't support Z39.50 at all? Some resources might
support OpenSearch, private, XML/HTTP-based protocols, or something
else entirely. Some databases exist only as web user interfaces and
will require screen-scraping. Still others exist only as static