From a7700a89cbccc75a841583be64b0ec1902220193 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 7 Jan 2015 13:03:58 +0100 Subject: [PATCH] Document record render parameters - including base64 --- doc/book.xml | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/doc/book.xml b/doc/book.xml index b812fc0..1c0d40f 100644 --- a/doc/book.xml +++ b/doc/book.xml @@ -2126,28 +2126,37 @@ The type is a string of the format: - format[;charset=from[/opacfrom][,to]][;format=v] + format[;charset=from[/opacfrom][,to]][;format=v][;base64=xpath] - where format specifies the format of the - returned record, from + If charset is given, then from specifies the character set of the record in its original form (as returned by the server), to specifies - the output (returned) - character set encoding. - If to is omitted UTF-8 is assumed. + the output (returned) character set encoding. + If to is omitted, then UTF-8 is assumed. If charset is not given, then no character set conversion takes place. - - - OPAC records may be returned in a different - set from the bibliographic MARC record. If this is this the case, + OPAC records may be returned in a different + set from the bibliographic MARC record. If this is this the case, opacfrom should be set to the character set of the OPAC record part. + + + The format is generic but can only be used to + specify XML indentation when the value v + is 1 (format=1). + + + The base64 allows a full record to be extracted + from base64-encoded string in an XML document. + Specifying the OPAC record character set requires YAZ 4.1.5 or later. + + Specifying the base64 parameter requires YAZ 4.2.35 or later. + The format argument controls whether record data should be XML -- 1.7.10.4