X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=04f6e2a79e931e59adc1682201c2398008ddb520;hb=5cdddaf1ba96608fcbd221421503b609ded909bf;hp=9f762bc2f8f57639123e73e5ce17b1b25107a9b4;hpb=4bf351b7b4a6f013bb5f9b164eb700dd8b7ed68f;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml index 9f762bc..04f6e2a 100644 --- a/doc/pazpar2_conf.xml +++ b/doc/pazpar2_conf.xml @@ -1,6 +1,6 @@ - %local; @@ -13,10 +13,13 @@ Pazpar2 &version; + Index Data + Pazpar2 conf 5 + File formats and conventions @@ -118,11 +121,11 @@ - relevance / sort / mergekey + relevance / sort / mergekey / facet - Specifies character set normalization for relevancy / sorting - and the mergekey - for the server. These definitions serves as + Specifies character set normalization for relevancy / sorting / + mergekey and facets - for the server. These definitions serves as default for services that don't have these given. For the meaning of these settings refer to the "relevance" element inside service. @@ -412,6 +415,17 @@ + facet + + + Specifies ICU tokenization and transformation rules + for tokens that are used in Pazpar2's facets. The contents + is similar to that of relevance. + + + + + settings @@ -568,7 +582,7 @@ The following discussion of practical issues related to session and settings - management are cast in terms of a user interface based on AJAX/Javascript + management are cast in terms of a user interface based on Ajax/Javascript technology. It would apply equally well to many other kinds of browser-based logic. @@ -588,7 +602,7 @@ Step 1: The Javascript client loads, and asks the webserver for a new Pazpar2 session ID. This can be done using a Javascript call, for instance. Note that - it is possible to submit AJAX HTTPXmlRequest calls either to Pazpar2 or to the + it is possible to submit Ajax HTTPXmlRequest calls either to Pazpar2 or to the webserver that Pazpar2 is proxying for. See (XXX Insert link to Pazpar2 protocol). @@ -723,6 +737,9 @@ +q + + @@ -831,16 +848,27 @@ pz:nativesyntax - The representation (syntax) of the retrieval records. Currently - recognized values are iso2709 and xml. + 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=charset to + iso2709. If omitted, a charset of + MARC-8 is assumed. This is correct for most MARC21/USMARC records. - For iso2709, can also specify a native character set, e.g. "iso2709;latin-1". - If no character set is provided, MARC-8 is assumed. + The value txml is like iso2709 + except that records are converted to TurboMARC instead of MARCXML. - If pz:nativesyntax is not specified, pazpar2 will attempt to determine - the value based on the response from the server. + The value xml is used if Pazpar2 retrieves + records that are already XML (no conversion takes place). @@ -967,10 +995,18 @@ pz:sru - This setting enables SRU/SRW support. It has three possible settings. + 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. 'srw' enables the SRW variation of the protocol. + to be submitted. 'srw' enables the SRW (SRU over SOAP) variation of + the protocol. + + + A value of 'solr' anables SOLR client support. This is supported + for Pazpar version 1.5.0 and later. @@ -981,7 +1017,7 @@ 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. + to 1.1 or 1.2. For SOLR, the current supported/tested version is 1.4 @@ -1033,13 +1069,76 @@ 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 be ignored. The filter takes the form name, name~value, or 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. + substring (~value) given, or matches exactly (=value). If value is omitted all records + with the named + metadata element present will be included. + + + pz:preferred + + + 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:block_timeout + + + (Not yet implemented). Specifies the time for which a block should be released anyway. + + + + + + pz:facetmap:name + + + 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:limitmap:name + + + Specifies attributes for limiting a search to a field - using + the limit parameter for search. 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 two forms: referral to + an exisiting CCL field or a raw PQF string. Leading string + determines type; either ccl: for CCL field or + rpn: for PQF/RPN. + + + + The limitmap facility is supported for Pazpar2 version 1.6.0. + + + + +