X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Ftools.xml;h=d66d7a3ec228640038a03ce3b64195bb07f2d61d;hb=28a4fb36e751de91911b02fa76eba1f1caa284f5;hp=7e4096cb766e45d0ef59f6a2ff33db99c4728af3;hpb=1d3538f5ffc0a38434e421ae3f2c34618b50d392;p=yaz-moved-to-github.git
diff --git a/doc/tools.xml b/doc/tools.xml
index 7e4096c..d66d7a3 100644
--- a/doc/tools.xml
+++ b/doc/tools.xml
@@ -2402,6 +2402,21 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct,
+
+ solrmarc
+
+
+ The solrmarc decodes solrmarc records.
+ It assumes that the input is pure solrmarc text (no escaping)
+ and will convert all sequences of the form #XX; to a single
+ character of the hexadecimal value as given by XX. The output,
+ presumably, is a valid ISO2709 buffer.
+
+
+ This conversion is available in YAZ 5.0.21 and later.
+
+
+
@@ -2523,7 +2538,7 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct,
- Sorting
+ Sorting
This chapter describes sorting and how it is supported in YAZ.
Sorting applies to a result-set.
@@ -2597,6 +2612,83 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct,
+ Facets
+
+ YAZ supports facets for in Solr, SRU 2.0 and Z39.50 protocols.
+
+
+ Like Type-1/RPN, YAZ supports a string notation for specifying
+ facets. For the API this is performed by
+ yaz_pqf_parse_facet_list.
+
+
+ For ZOOM C the facets are given by option "facets"
+ For yaz-client it is used for the facets command.
+
+
+ The grammar of this specification is as follows:
+
+ facet-spec ::= facet-list
+
+ facet-list ::= facet-list ',' attr-spec | attr-spec
+
+ attr-spec ::= attr-spec '@attr' string | '@attr' string
+
+
+ The notation is inspired by PQF. The string following '@attr'
+ may not include blanks and is of the form
+ type=value,
+ where type is an integer and
+ value is a string or an integer.
+
+
+ The Facets specification is not Bib-1. The following types apply:
+
+
+ Facet attributes
+
+
+
+
+
+ Type
+ Description
+
+
+
+
+ 1
+
+ Field-name. This is often a string, eg "Author", "Year", etc.
+
+
+
+
+ 2
+
+ Sort order. Value should be an integer.
+ Value 0: count descending (frequency). Value 1: alpha ascending.
+
+
+
+
+ 3
+
+ Number of terms requested.
+
+
+
+
+ 4
+
+ Start offset.
+
+
+
+
+
+
+