From 16243f5da245028624661f8b6bbd3900d1fdc9d3 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 19 Feb 2014 12:57:52 +0100 Subject: [PATCH] Doc: target settings in alphabetical order --- doc/pazpar2_conf.xml | 488 ++++++++++++++++++++++++++------------------------ 1 file changed, 250 insertions(+), 238 deletions(-) diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml index 66704eb..42c7e26 100644 --- a/doc/pazpar2_conf.xml +++ b/doc/pazpar2_conf.xml @@ -1102,152 +1102,28 @@ behavior of the client function. - - - pz:cclmap:xxx - - - This establishes a CCL field definition or other setting, for - the purpose of mapping end-user queries. XXX is the field or - setting name, and the value of the setting provides parameters - (e.g. parameters to send to the server, etc.). Please consult - the YAZ manual for a full overview of the many capabilities of - the powerful and flexible CCL parser. - - - Note that it is easy to establish a set of default parameters, - and then override them individually for a given target. - - - - - pz:requestsyntax - - - This specifies the record syntax to use when requesting - records from a given server. The value can be a symbolic name like - marc21 or xml, or it can be a Z39.50-style dot-separated OID. - - - - - pz:elements - - - The element set name to be used when retrieving records from a - server. - - - - - pz:piggyback - - - Piggybacking enables the server to retrieve records from the - server as part of the search response in Z39.50. Almost all - servers support this (or fail it gracefully), but a few - servers will produce undesirable results. - Set to '1' to enable piggybacking, '0' to disable it. Default - is 1 (piggybacking enabled). - - - - - pz:nativesyntax - - - Specifies how Pazpar2 shoule map retrieved records to XML. Currently - supported values are xml, - iso2709 and txml. - - - The value iso2709 makes Pazpar2 convert retrieved - MARC records to MARCXML. In order to convert to XML, the exact - chacater set of the MARC must be known (if not, the resulting - XML is probably not well-formed). The character set may be - specified by adding: - ;charset to - iso2709. If omitted, a charset of - MARC-8 is assumed. This is correct for most MARC21/USMARC records. - - - The value txml is like iso2709 - except that records are converted to TurboMARC instead of MARCXML. - - - The value xml is used if Pazpar2 retrieves - records that are already XML (no conversion takes place). - - - - - pz:queryencoding + pz:allow - The encoding of the search terms that a target accepts. Most - targets do not honor UTF-8 in which case this needs to be specified. - Each term in a query will be converted if this setting is given. + Allows or denies access to the resources it is applied to. Possible + values are '0' and '1'. + The default is '1' (allow access to this resource). - pz:negotiation_charset + pz:apdulog - 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. + If the 'pz:apdulog' setting is defined and has other value than 0, + then Z39.50 APDUs are written to the log. - pz:xslt - - - Is a comma separated list of of stylesheet names that specifies - how to convert incoming records to the internal representation. - - - For each name, the embedded stylesheets (XSL) that comes with the - service definition are consulted first and takes precedence over - external files; see - of service definition). - If the name does not match an embedded stylesheet it is - considered a filename. - - - 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 '*'. - - - - pz:authentication @@ -1283,25 +1159,45 @@ + - pz:allow + pz:block_timeout - Allows or denies access to the resources it is applied to. Possible - values are '0' and '1'. - The default is '1' (allow access to this resource). + (Not yet implemented). + Specifies the time for which a block should be released anyway. + - pz:maxrecs + pz:cclmap:xxx - Controls the maximum number of records to be retrieved from a - server. The default is 100. + This establishes a CCL field definition or other setting, for + the purpose of mapping end-user queries. XXX is the field or + setting name, and the value of the setting provides parameters + (e.g. parameters to send to the server, etc.). Please consult + the YAZ manual for a full overview of the many capabilities of + the powerful and flexible CCL parser. + + + Note that it is easy to establish a set of default parameters, + and then override them individually for a given target. + + + + + + pz:elements + + + The element set name to be used when retrieving records from a + server. + pz:extendrecs @@ -1322,15 +1218,24 @@ + - pz:presentchunk + pz:facetmap:name - Controls the chunk size in present requests. Pazpar2 will - make (maxrecs / chunk) request(s). The default is 20. + Specifies that for field name, the target + supports (native) facets. The value is the name of the + field on the target. + + + At this point only Solr targets have been tested with this + facility. + + + pz:id @@ -1342,60 +1247,107 @@ - - pz:zproxy + + + pz:limitmap:name - The 'pz:zproxy' setting has the value syntax - 'host.internet.adress:port', it is used to tunnel Z39.50 - requests through the named Z39.50 proxy. + Specifies attributes for limiting a search to a field - using + the limit parameter for search. It can be used to filter locally + or remotely (search in a target). In some cases the mapping of + a field to a value is identical to an existing cclmap field; in + other cases the field must be specified in a different way - for + example to match a complete field (rather than parts of a subfield). + + The value of limitmap may have one of three forms: referral to + an existing CCL field, a raw PQF string or a local limit. Leading string + determines type; either ccl: for CCL field, + rpn: for PQF/RPN, or local: + for filtering in Pazpar2. The local filtering may be followed + by a field a metadata field (default is to use the name of the + limitmap itself). + + + For Pazpar2 version 1.6.23 and later the limitmap may include multiple + specifications, separated by , (comma). + For example: + ccl:title,local:ltitle,rpn:@attr 1=4. + + + + The limitmap facility is supported for Pazpar2 version 1.6.0. + Local filtering is supported in Pazpar2 1.6.6. + + - pz:apdulog + pz:maxrecs - If the 'pz:apdulog' setting is defined and has other value than 0, - then Z39.50 APDUs are written to the log. + Controls the maximum number of records to be retrieved from a + server. The default is 100. - pz:sru + pz:nativesyntax - This setting enables - SRU/Solr - support. - It has four 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. 'soap' enables the SRW (SRU over SOAP) variation of - the protocol. + Specifies how Pazpar2 shoule map retrieved records to XML. Currently + supported values are xml, + iso2709 and txml. - A value of 'solr' enables Solr client support. This is supported - for Pazpar version 1.5.0 and later. + The value iso2709 makes Pazpar2 convert retrieved + MARC records to MARCXML. In order to convert to XML, the exact + chacater set of the MARC must be known (if not, the resulting + XML is probably not well-formed). The character set may be + specified by adding: + ;charset to + iso2709. If omitted, a charset of + MARC-8 is assumed. This is correct for most MARC21/USMARC records. + + + The value txml is like iso2709 + except that records are converted to TurboMARC instead of MARCXML. + + + The value xml is used if Pazpar2 retrieves + records that are already XML (no conversion takes place). - pz:sru_version + pz:negotiation_charset - 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. For Solr, the current supported/tested version - is 1.4 and 3.x. + 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:piggyback + + + Piggybacking enables the server to retrieve records from the + server as part of the search response in Z39.50. Almost all + servers support this (or fail it gracefully), but a few + servers will produce undesirable results. + Set to '1' to enable piggybacking, '0' to disable it. Default + is 1 (piggybacking enabled). + + + + pz:pqf_prefix @@ -1438,11 +1390,35 @@ - pz:sort + pz:preferred - Specifies sort criteria to be applied to the result set. - Only works for targets which support the sort service. + Specifies that a target is preferred, e.g. possible local, faster + target. Using block=pref on show command will wait for all these + targets to return records before releasing the block. + If no target is preferred, the block=pref will identical to block=1, + which release when one target has returned records. + + + + + + pz:presentchunk + + + Controls the chunk size in present requests. Pazpar2 will + make (maxrecs / chunk) request(s). The default is 20. + + + + + + pz:queryencoding + + + The encoding of the search terms that a target accepts. Most + targets do not honor UTF-8 in which case this needs to be specified. + Each term in a query will be converted if this setting is given. @@ -1463,27 +1439,81 @@ + + + pz:requestsyntax + + + This specifies the record syntax to use when requesting + records from a given server. The value can be a symbolic name like + marc21 or xml, or it can be a Z39.50-style dot-separated OID. + + + + - pz:preferred + pz:sort - Specifies that a target is preferred, e.g. possible local, faster - target. Using block=pref on show command will wait for all these - targets to return records before releasing the block. - If no target is preferred, the block=pref will identical to block=1, - which release when one target has returned records. + Specifies sort criteria to be applied to the result set. + Only works for targets which support the sort service. + + + pz:sortmap:field + + + Specifies native sorting for a target where + field is a sort criteria (see command + show). The value has to components separated by colon: strategy and + native-field. Strategy is one of z3950, + type7, cql, + sru11, or embed. + The second component, native-field, is the field that is recognized + by the target. + + + + Only supported for Pazpar2 1.6.4 and later. + + + + + - pz:block_timeout + pz:sru - (Not yet implemented). - Specifies the time for which a block should be released anyway. + This setting enables + SRU/Solr + support. + It has four 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. 'soap' enables the SRW (SRU over SOAP) variation of + the protocol. + + + A value of 'solr' enables Solr client support. This is supported + for Pazpar version 1.5.0 and later. + + + 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. For Solr, the current supported/tested version + is 1.4 and 3.x. + + + + pz:termlist_term_count @@ -1493,6 +1523,7 @@ + pz:termlist_term_factor @@ -1511,96 +1542,77 @@ - - pz:facetmap:name + + pz:url - Specifies that for field name, the target - supports (native) facets. The value is the name of the - field on the target. + Specifies URL for the target and overrides the target ID. - At this point only Solr targets have been tested with this - facility. + pz:url is only recognized for + Pazpar2 1.6.4 and later. - - pz:limitmap:name + + pz:xslt - Specifies attributes for limiting a search to a field - using - the limit parameter for search. It can be used to filter locally - or remotely (search in a target). In some cases the mapping of - a field to a value is identical to an existing cclmap field; in - other cases the field must be specified in a different way - for - example to match a complete field (rather than parts of a subfield). + Is a comma separated list of of stylesheet names that specifies + how to convert incoming records to the internal representation. - The value of limitmap may have one of three forms: referral to - an existing CCL field, a raw PQF string or a local limit. Leading string - determines type; either ccl: for CCL field, - rpn: for PQF/RPN, or local: - for filtering in Pazpar2. The local filtering may be followed - by a field a metadata field (default is to use the name of the - limitmap itself). + For each name, the embedded stylesheets (XSL) that comes with the + service definition are consulted first and takes precedence over + external files; see + of service definition). + If the name does not match an embedded stylesheet it is + considered a filename. - For Pazpar2 version 1.6.23 and later the limitmap may include multiple - specifications, separated by , (comma). - For example: - ccl:title,local:ltitle,rpn:@attr 1=4. + 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 limitmap facility is supported for Pazpar2 version 1.6.0. - Local filtering is supported in Pazpar2 1.6.6. - - - - - - - pz:url - - Specifies URL for the target and overrides the target ID. + 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 '*'. - - - pz:url is only recognized for - Pazpar2 1.6.4 and later. - - - - pz:sortmap:field + + pz:zproxy - Specifies native sorting for a target where - field is a sort criteria (see command - show). The value has to components separated by colon: strategy and - native-field. Strategy is one of z3950, - type7, cql, - sru11, or embed. - The second component, native-field, is the field that is recognized - by the target. + The 'pz:zproxy' setting has the value syntax + 'host.internet.adress:port', it is used to tunnel Z39.50 + requests through the named Z39.50 proxy. - - - Only supported for Pazpar2 1.6.4 and later. - - - -- 1.7.10.4