X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fpazpar2_conf.xml;h=dcc1fdf5ea897e1fa8200be7a172634f4dad77ed;hb=7087f7cc9945cfacfbe7341a1099eef773914772;hp=8ae9b97cc8ff480587419a6e758366676e4a0632;hpb=022710cf16caff9ab16cf3375e222f335b4e4327;p=pazpar2-moved-to-github.git diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml index 8ae9b97..dcc1fdf 100644 --- a/doc/pazpar2_conf.xml +++ b/doc/pazpar2_conf.xml @@ -124,15 +124,25 @@ - + - relevance / sort / mergekey / facet + icu_chain 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. + of these settings refer to the + element inside service. + + + + + + relevance / sort / mergekey / facet + + + Obsolete. Use element icu_chain instead. @@ -316,6 +326,17 @@ + + + facetrule + + + Specifies the ICU rule set to be used for normalizing + facets. If facetrule is omitted from metadata, the + rule set 'facet' is used. + + + setting @@ -346,15 +367,40 @@ - + - relevance + xslt - Specifies ICU tokenization and transformation rules - for tokens that are used in Pazpar2's relevance ranking. - The 'id' attribute is currently not used, and the 'locale' - attribute must be set to one of the locale strings + Defines a XSLT stylesheet. The xslt + element takes exactly one attribute id + which names the stylesheet. This can be referred to in target + settings . + + + The content of the xslt element is the embedded stylesheet XML + + + + + icu_chain + + + Specifies a named ICU rule set. The icu_chain element must include + attribute 'id' which specifies the identifier (name) for the ICU + rule set. + Pazpar2 uses the particular rule sets for particular purposes. + Rule set 'relevance' is used to normalize + terms for relevance ranking. Rule set 'sort' is used to + normalize terms for sorting. Rule set 'mergekey' is used to + normalize terms for making a mergekey and, finally. Rule set 'facet' + is normally used to normalize facet terms, unless + facetrule is given for a + metadata field. + + + The icu_chain element must also include a 'locale' + attribute which must be set to one of the locale strings defined in ICU. The child elements listed below can be in any order, except the 'index' element which logically belongs to the end of the list. The stated tokenization, @@ -411,12 +457,33 @@ + relevance + + + Specifies the ICU rule set used for relevance ranking. + The child element of 'relevance' must be 'icu_chain' and the + 'id' attribute of the icu_chain is ignored. This + definition is obsolete and should be replaced by the equivalent + construct: + + <icu_chain id="relevance" locale="en">..<icu_chain> + + + + + + sort - Specifies ICU tokenization and transformation rules - for tokens that are used in Pazpar2's sorting. The contents - is similar to that of relevance. + Specifies the ICU rule set used for sorting. + The child element of 'sort' must be 'icu_chain' and the + 'id' attribute of the icu_chain is ignored. This + definition is obsolete and should be replaced by the equivalent + construct: + + <icu_chain id="sort" locale="en">..<icu_chain> + @@ -426,8 +493,14 @@ Specifies ICU tokenization and transformation rules - for tokens that are used in Pazpar2's mergekey. The contents - is similar to that of relevance. + for tokens that are used in Pazpar2's mergekey. + The child element of 'mergekey' must be 'icu_chain' and the + 'id' attribute of the icu_chain is ignored. This + definition is obsolete and should be replaced by the equivalent + construct: + + <icu_chain id="mergekey" locale="en">..<icu_chain> + @@ -437,8 +510,14 @@ Specifies ICU tokenization and transformation rules - for tokens that are used in Pazpar2's facets. The contents - is similar to that of relevance. + for tokens that are used in Pazpar2's facets. + The child element of 'facet' must be 'icu_chain' and the + 'id' attribute of the icu_chain is ignored. This + definition is obsolete and should be replaced by the equivalent + construct: + + <icu_chain id="facet" locale="en">..<icu_chain> + @@ -506,14 +585,12 @@ merge="longest" rank="2"/> - - - - - - - - + + + + + + @@ -602,29 +679,31 @@ - The following discussion of practical issues related to session and settings - 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. + The following discussion of practical issues related to session + and settings 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. - Typically, a Javascript client is not allowed to directly alter the parameters - of a session. There are two reasons for this. One has to do with access - to information; typically, information about a user will be stored in a - system on the server side, or it will be accessible in some way from the server. - However, since the Javascript client cannot be entirely trusted (some hostile - agent might in fact 'pretend' to be a regular ws client), it is more robust - to control session settings from scripting that you run as part of your - webserver. Typically, this can be handled during the session initialization, - as follows: + Typically, a Javascript client is not allowed to directly alter the + parameters of a session. There are two reasons for this. One has to do + with access to information; typically, information about a user will + be stored in a system on the server side, or it will be accessible in + some way from the server. However, since the Javascript client cannot + be entirely trusted (some hostile agent might in fact 'pretend' to be + a regular ws client), it is more robust to control session settings + from scripting that you run as part of your webserver. Typically, this + can be handled during the session initialization, as follows: - 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 - webserver that Pazpar2 is proxying for. See (XXX Insert link to Pazpar2 protocol). + 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 webserver that Pazpar2 is proxying + for. See (XXX Insert link to Pazpar2 protocol). @@ -634,19 +713,20 @@ - Step 3: The webserver initializes a new Pazpar2 settings, and sets user-specific - parameters as necessary, using the init webservice command. A new session ID is - returned. + Step 3: The webserver initializes a new Pazpar2 settings, and sets + user-specific parameters as necessary, using the init webservice + command. A new session ID is returned. - Step 4: The webserver returns this session ID to the Javascript client, which then - uses the session ID to submit searches, show results, etc. + Step 4: The webserver returns this session ID to the Javascript + client, which then uses the session ID to submit searches, show + results, etc. - Step 5: When the Javascript client ceases to use the session, Pazpar2 destroys - any session-specific information. + Step 5: When the Javascript client ceases to use the session, + Pazpar2 destroys any session-specific information. @@ -654,8 +734,8 @@ Each file contains a root element named <settings>. It may contain one or more <set> elements. The settings and set - elements may contain the following attributes. Attributes in the set node - overrides those in the setting root element. Each set node must + elements may contain the following attributes. Attributes in the set + node overrides those in the setting root element. Each set node must specify (directly, or inherited from the parent node) at least a target, name, and value. @@ -684,6 +764,11 @@ multiple overlapping settings with the same name and target value, the 'precedence' attribute determines what happens. + + For Pazpar2 1.6.4 or later, the target ID may be user-defined, in + which case, the actual host, port, etc is given by setting + . + @@ -920,13 +1005,21 @@ - pz:xslt + pz:xslt - Is a comma separated list of of files that specifies + 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). @@ -1093,12 +1186,13 @@ 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, name~value, or name=value, which + records that meet a certain criteria in a result. + Unmatched records 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, or matches exactly (=value). If value is omitted all records - with the named - metadata element 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. @@ -1107,9 +1201,11 @@ 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. + 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. @@ -1118,7 +1214,8 @@ pz:block_timeout - (Not yet implemented). Specifies the time for which a block should be released anyway. + (Not yet implemented). + Specifies the time for which a block should be released anyway. @@ -1140,7 +1237,7 @@ - + pz:limitmap:name @@ -1163,9 +1260,45 @@ + + + pz:url + + + Specifies URL for the target and overrides the target ID. + + + + pz:url is only recognized for + Pazpar2 1.6.4 and later. + + + + + + + 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. + + + + - +