ZAP User's Guide and Reference

Per Mørkegård Hansen

Adam Dickmeiss

This document is the programmer's guide and reference to the ZAP package version 1.4.7.

The documentation can be used on its own, or as a reference when looking at the example applications provided with the package.


Table of Contents
1. Introduction
2. Installation
3. General Notes
4. Template Invocation
Apache Module
CGI
5. Input Parameters
Parameters in the ZAP Template File
Parameters in General
Individual Input Parameters
General
Search
Scan
Authentication
Referring to Input Parameters
Substitution Rules
6. Result Variables
Global Parameters
$query
$alltargets
Per Server Parameters
$target
$errorcode
$errorstring
$addinfo
$hits
Per Record Parameters
$record
$no
7. Template Sections
Each section in detail
%%def
%%override
%%begin
%%end
%%query-empty
%%query-ok
%%record xxx
%%format xxx
%%records begin
%%records end
%%server-error connection
%%server-error timeout
%%server-error init
%%server-error protocol
%%server-error N
%%server-error
%%CCL-error N
%%CCL-error
%%server-hits N
%%server-hits
%%include
%%sort-record
%%sort-format
Embedded TCL
Handling targets in TCL
Environment Variables
8. CCL
CCL Attributes
U (use attributes)
S (structure attributes)
T (truncation attributes)
C (completeness attributes)
R (relation attributes)
Truncation
Examples
CCL Input Parameters
CCLtermN
CCLfieldN
CCLopand, CCLopor, CCLopnot
CCLcase
9. Record Formatting
GRS-1 Record Formatting
Conditional Statements
MARC record formatting
XML Record Formatting
SUTRS records
10. Advanced Features
Nested Templates
Record manipulation using TCL
Sorting
A. About Index Data
B. License
List of Tables
7-1. CCL Error Codes
List of Examples
1-1. Simple Search Form
1-2. Simple ZAP template
7-1. Checking for specific hit count
7-2. Displaying any hit count
7-3. include
7-4. Tcl embedding
8-1. CCL field definition
9-1. Record Formatting with tag paths
9-2. MARC Formatting
9-3. XML Formatting
9-4. SUTRS Formatting
10-1. Calling Templates
10-2. Getting results from a Template
10-3. Record manipulation using TCL
10-4. Sorting