From 6e32d36c608fe4c1e345e07ba0bf93b1129f58f1 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 5 Mar 2014 12:00:00 +0100 Subject: [PATCH] Add documentation about facets --- doc/tools.xml | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++- doc/zoom.xml | 30 ++++++++++------------ 2 files changed, 92 insertions(+), 17 deletions(-) diff --git a/doc/tools.xml b/doc/tools.xml index 7e4096c..2d9b62b 100644 --- a/doc/tools.xml +++ b/doc/tools.xml @@ -2523,7 +2523,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 +2597,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. + + + + + +
+