X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=de76d9d7d5250eb83e053ce006690cab573bb641;hb=refs%2Fheads%2Fbranch-1.4.4;hp=cf97dfb2f2576b216a9f8ba79f552857e39fa8bf;hpb=6639c716d02ad6117ae6053ca18160dbb21a404a;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml index cf97dfb..de76d9d 100644 --- a/doc/pazpar2_conf.xml +++ b/doc/pazpar2_conf.xml @@ -48,18 +48,33 @@ FORMAT - The configuration file is XML-structured. It must be valid XML. All + The configuration file is XML-structured. It must be well-formed XML. All elements specific to Pazpar2 should belong to the namespace http://www.indexdata.com/pazpar2/1.0 (this is assumed in the - following examples). The root element is named pazpar2. + following examples). The root element is named "pazpar2". Under the root element are a number of elements which group categories of information. The categories are described below. + threads + + This section is optional and is supported for Pazpar2 version 1.3.1 and + later . It is identified by element "threads" which + may include one attribute "number" which specifies + the number of worker-threads that the Pazpar2 instance is to use. + A value of 0 (zero) disables worker-threads (all work is carried out + in main thread). + + server - This section governs overall behavior of the server. The data + This section governs overall behavior of a server endpoint. It is identified + by the element "server" which takes an optional attribute, "id", which + identifies this particular Pazpar2 server. Any string value for "id" + may be given. + + The data elements are described below. From Pazpar2 version 1.2 this is a repeatable element. @@ -157,9 +172,9 @@ One of these elements is required for every data element in the internal representation of the record (see . It governs - subsequent processing as pertains to sorting, relevance - ranking, merging, and display of data elements. It supports - the following attributes: + subsequent processing as pertains to sorting, relevance + ranking, merging, and display of data elements. It supports + the following attributes: @@ -257,7 +272,7 @@ longest element (strlen), 'range' (calculate a range of values across all matching records), 'all' (include all elements), or 'no' (don't merge; this is the - default); + default); @@ -265,9 +280,22 @@ mergekey - If set to yes, the value of this - metadata element is appended to the resulting mergekey. - By default metadata is not part of a mergekey. + If set to 'required', the value of this + metadata element is appended to the resulting mergekey if + the metadata is present in a record instance. + If the metadata element is not present, the a unique mergekey + will be generated instead. + + + If set to 'optional', the value of this + metadata element is appended to the resulting mergekey if the + the metadata is present in a record instance. If the metadata + is not present, it will be empty. + + + If set to 'no' or the mergekey attribute is + omitted, the metadata will not be used in the creation of a + mergekey. @@ -275,23 +303,23 @@ setting - This attribute allows you to make use of static database - settings in the processing of records. Three possible values - are allowed. 'no' is the default and doesn't do anything. - 'postproc' copies the value of a setting with the same name - into the output of the normalization stylesheet(s). 'parameter' - makes the value of a setting with the same name available - as a parameter to the normalization stylesheet, so you - can further process the value inside of the stylesheet, or use - the value to decide how to deal with other data values. + This attribute allows you to make use of static database + settings in the processing of records. Three possible values + are allowed. 'no' is the default and doesn't do anything. + 'postproc' copies the value of a setting with the same name + into the output of the normalization stylesheet(s). 'parameter' + makes the value of a setting with the same name available + as a parameter to the normalization stylesheet, so you + can further process the value inside of the stylesheet, or use + the value to decide how to deal with other data values. - The purpose of using settings in this way can either be to - control the behavior of normalization stylesheet in a database- - dependent way, or to easily make database-dependent values - available to display-logic in your user interface, without having - to implement complicated interactions between the user interface - and your configuration system. + The purpose of using settings in this way can either be to + control the behavior of normalization stylesheet in a database- + dependent way, or to easily make database-dependent values + available to display-logic in your user interface, without having + to implement complicated interactions between the user interface + and your configuration system. @@ -432,6 +460,7 @@ + @@ -766,7 +795,7 @@ - + pz:requestsyntax @@ -828,11 +857,48 @@ + pz:negotiation_charset + + + Sets character set for Z39.50 negotiation. Most targets do not support + this, and some will even close connection if set (crash on server + side or similar). If set, you probably want to set it to + UTF-8. + + + + + pz:xslt - Provides the path of an XSLT stylesheet which will be used to - map incoming records to the internal representation. + Is a comma separated list of of files that specifies + how to convert incoming records to the internal representation. + + + The suffix of each file specifies the kind of tranformation. + Suffix ".xsl" makes an XSL transform. Suffix + ".mmap" will use the MMAP transform (described below). + + + The special value "auto" will use a file + which is the pz:requestsyntax's + value followed by + '.xsl'. + + + When mapping MARC records, XSLT can be bypassed for increased + performance with the alternate "MARC map" format. Provide the + path of a file with extension ".mmap" containing on each line: + + <field> <subfield> <metadata element> + For example: + + 245 a title + 500 $ description + 773 * citation + To map the field value specify a subfield of '$'. To store a + concatenation of all subfields, specify a subfield of '*'. @@ -886,7 +952,7 @@ - + pz:apdulog @@ -896,55 +962,88 @@ - + - pz:sru - - - This setting enables SRU/SRW support. It has three possible settings. - 'get', enables SRU access through GET requests. 'post' enables SRU/POST - support, less commonly supported, but useful if very large requests are - to be submitted. 'srw' enables the SRW variation of the protocol. - - + pz:sru + + + This setting enables SRU/SRW support. It has three possible settings. + 'get', enables SRU access through GET requests. 'post' enables SRU/POST + support, less commonly supported, but useful if very large requests are + to be submitted. 'srw' enables the SRW variation of the protocol. + + - + - pz:sru_version - - - This allows SRU version to be specified. If unset Pazpar2 - will the default of YAZ (currently 1.2). Should be set - to 1.1 or 1.2. - - + pz:sru_version + + + This allows SRU version to be specified. If unset Pazpar2 + will the default of YAZ (currently 1.2). Should be set + to 1.1 or 1.2. + + - + - pz:pqf_prefix - - - Allows you to specify an arbitrary PQF query language substring. The provided - string is prefixed the user's query after it has been normalized to PQF - internally in pazpar2. This allows you to attach complex 'filters' to - queries for a gien target, sometimes necessary to select sub-catalogs - in union catalog systems, etc. - - + pz:pqf_prefix + + + Allows you to specify an arbitrary PQF query language substring. + The provided string is prefixed the user's query after it has been + normalized to PQF internally in pazpar2. + This allows you to attach complex 'filters' to queries for a given + target, sometimes necessary to select sub-catalogs + in union catalog systems, etc. + + + + + + pz:pqf_strftime + + + Allows you to extend a query with dates and operators. + The provided string allows certain substitutions and serves as a + format string. + The special two character sequence '%%' gets converted to the + original query. Other characters leading with the percent sign are + conversions supported by strftime. + All other characters are copied verbatim. For example, the string + @and @attr 1=30 @attr 2=3 %Y %% + would search for current year combined with the original PQF (%%). + + + + + + pz:sort + + + Specifies sort criteria to be applied to the result set. + Only works for targets which support the sort service. + + - pz:sort - - - Specifies sort criteria to be applied to the result set. Only works for targets - which support the sort service. - - + pz:recordfilter + + + Specifies a filter which allows Pazpar2 to only include + records that meet a certain criteria in a result. Unmatched records + will be ignored. The filter takes the form name[~value] , which + will include only records with metadata element (name) that has the + substring (value) given. If value is omitted all records with the + metadata present will be included. + + - + + SEE ALSO