From 1a559fcb9993dc223496bf837437b7afa9ee5aae Mon Sep 17 00:00:00 2001 From: Sebastian Hammer Date: Fri, 19 Jan 2007 19:08:00 +0000 Subject: [PATCH] Fixed schema and syntax errors --- doc/pazpar2_conf.xml | 199 +++++++++++++++++++++++----------------------- doc/pazpar2_protocol.xml | 4 +- 2 files changed, 103 insertions(+), 100 deletions(-) diff --git a/doc/pazpar2_conf.xml b/doc/pazpar2_conf.xml index b8e86ea..ed4e537 100644 --- a/doc/pazpar2_conf.xml +++ b/doc/pazpar2_conf.xml @@ -8,7 +8,7 @@ %common; ]> - + Pazpar2 @@ -113,109 +113,112 @@ metadata - - 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: - + + + 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: + - - name - - - This is the name of the data element. It is matched - against the 'type' attribute of the 'metadata' element - in the normalized record. A warning is produced if - metdata elements with an unknown name are found in the - normalized record. This name is also used to represent - data elements in the records returned by the - webservice API, and to name sort lists and browse - facets. - - - + + name + + + This is the name of the data element. It is matched + against the 'type' attribute of the 'metadata' element + in the normalized record. A warning is produced if + metdata elements with an unknown name are found in the + normalized record. This name is also used to represent + data elements in the records returned by the + webservice API, and to name sort lists and browse + facets. + + + - type - - - The type of data element. This value governs any - normalization or special processing that might take - place on an element. Possible values are 'generic' - (basic string), 'year' (a range is computed if - multiple years are found in the record). Note: This - list is likely to increase in the future. - - - + type + + + The type of data element. This value governs any + normalization or special processing that might take + place on an element. Possible values are 'generic' + (basic string), 'year' (a range is computed if + multiple years are found in the record). Note: This + list is likely to increase in the future. + + + - brief - - - If this is set to 'yes', then the data element is - includes in brief records in the webservice API. Note - that this only makes sense for metadata elements that - are merged (see below). The default value is 'no'. - - - + brief + + + If this is set to 'yes', then the data element is + includes in brief records in the webservice API. Note + that this only makes sense for metadata elements that + are merged (see below). The default value is 'no'. + + + - sortkey - - - Specifies that this data element is to be used for - sorting. The possible values are 'numeric' (numeric - value), 'skiparticle' (string; skip common, leading - articles), and 'no' (no sorting). The default value is - 'no'. - - - + sortkey + + + Specifies that this data element is to be used for + sorting. The possible values are 'numeric' (numeric + value), 'skiparticle' (string; skip common, leading + articles), and 'no' (no sorting). The default value is + 'no'. + + + - rank - - - Specifies that this element is to be used to help rank - records against the user's query (when ranking is - requested). The value is an integer, used as a - multiplier against the basic TF*IDF score. A value of - 1 is the base, higher values give additional weight to - elements of this type. The default is '0', which - excludes this element from the rank calculation. - - - + rank + + + Specifies that this element is to be used to help rank + records against the user's query (when ranking is + requested). The value is an integer, used as a + multiplier against the basic TF*IDF score. A value of + 1 is the base, higher values give additional weight to + elements of this type. The default is '0', which + excludes this element from the rank calculation. + + + - termlist - - - Specifies that this element is to be used as a - termlist, or browse facet. Values are tabulated from - incoming records, and a highscore of values (with - their associated frequency) is made available to the - client through the webservice API. The possible values - are 'yes' and 'no' (default). - - - + termlist + + + Specifies that this element is to be used as a + termlist, or browse facet. Values are tabulated from + incoming records, and a highscore of values (with + their associated frequency) is made available to the + client through the webservice API. The possible values + are 'yes' and 'no' (default). + + + - merge - - - This governs whether, and how elements are extracted - from individual records and merged into cluster - records. The possible values are: 'unique' (include - all unique elements), 'longest' (include only the - longest element (strlen), 'range' (calculate a range - of values across al matching records), 'all' (include - all elements), or 'no' (don't merge; this is the - default); - - - - + merge + + + This governs whether, and how elements are extracted + from individual records and merged into cluster + records. The possible values are: 'unique' (include + all unique elements), 'longest' (include only the + longest element (strlen), 'range' (calculate a range + of values across al matching records), 'all' (include + all elements), or 'no' (don't merge; this is the + default); + + + + + + @@ -232,7 +235,7 @@ - + Note: In the present version, there is a single retrieval profile. However, in a future release, it will be possible to diff --git a/doc/pazpar2_protocol.xml b/doc/pazpar2_protocol.xml index 404f6c3..9b78ed1 100644 --- a/doc/pazpar2_protocol.xml +++ b/doc/pazpar2_protocol.xml @@ -8,7 +8,7 @@ %common; ]> - + Pazpar2 @@ -181,7 +181,7 @@ search.pz2?session=2044502273&command=stat start First record to show - 0-indexed. - -- 1.7.10.4