X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fir-set.n;h=74f0a739c5fbd58972829e6034468dedbf180b28;hb=707b62b5378bac707f83b60aed5aff0b73ab04ca;hp=9359d7d290fb1116a4aabb9665ef6321a92e12a2;hpb=666316a92ba28594acd7e2611f3a05be34f14722;p=ir-tcl-moved-to-github.git diff --git a/doc/ir-set.n b/doc/ir-set.n index 9359d7d..74f0a73 100644 --- a/doc/ir-set.n +++ b/doc/ir-set.n @@ -1,7 +1,7 @@ -.\" Copyright (c) 1995, 1996 Index Data +.\" Copyright (c) 1995-2004 Index Data .\" All rights reserved. -.\" $Id: ir-set.n,v 1.3 1996-11-14 17:11:13 adam Exp $ -.TH ir-set N "24 June 1996" "IrTcl" "IR Set" +.\" $Id: ir-set.n,v 1.6 2004-04-26 09:09:06 adam Exp $ +.TH ir-set n "24 June 1996" "IrTcl" "IR Set" .SH NAME ir-set \- IR set .SH SYNOPSIS @@ -25,7 +25,8 @@ Operations that are used to search a target: Sets the database(s) to be used in the following search request(s). .TP .BI "" zs " setName [" name "]" -Sets/gets the name of the result-set to be (re)searched. +Sets/gets the name of the result-set to be (re)searched. default name +of result-set is \fBdefault\fR. .TP .BI "" zs " replaceIndicator [" b "]" Sets/gets the replace-indicator as 0 (false) or 1 (true); default is @@ -139,7 +140,7 @@ Two special operators are supported: the \fB?\fR operator matches exactly one character; the \fB*\fR operator matches the whole item (don't care). The format of the data returned is determined by the \fItype\fR argument. -If \fItype\fR is \fBfield\fR the matcing part of the record is returned +If \fItype\fR is \fBline\fR the matcing part of the record is returned as a list of MARC tag specifications. Each MARC tag specification item consists of three elements: tag, indicator and field-list. The field-list part is a list of field specifications. Each field specification is a tuple @@ -153,6 +154,11 @@ Returns the SUTRS record at the given \fIposition\fR as a single string token. If the record at the position is not present or is not a SUTRS record an error is returned. .TP +.BI "" zs " getXml " position +Returns the XML record at the given \fIposition\fR as a single +string token. If the record at the position is not present or is not a +XML record an error is returned. +.TP .BI "" zs " getGrs " position " [" spec " " spec " " ... "]" Extracts information about the GRS-1 record at the specified \Iposition\fR. The \fIspec\fR arguments determine the parts of the GRS-1 record to