[Tcladdressbook-commits] Help tcladdressbook.n,1.7,1.8

[Bernard D. <bde...@us...>]

Update of /cvsroot/tcladdressbook/Help
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31522/Help

Modified Files:
	tcladdressbook.n 
Log Message:
Doc and examples for the [identifier index] command

Index: tcladdressbook.n
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/tcladdressbook.n,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8
--- tcladdressbook.n	30 Jul 2004 13:07:48 -0000	1.7
+++ tcladdressbook.n	30 Jul 2004 21:30:32 -0000	1.8
@@ -85,20 +85,34 @@
 \fI propName\fP for the record corresponding to \fI personID\fP. One can
 get the count of identifiers using the \fBaddressbook identifier count\fP
 command. Identifiers are used by the \fBaddressbook identifier set\fP
-command. See the section Distribution list and identifiers <#dist> 
+command. See the section Distribution lists and identifiers <#dist> 
 below for explanations about identifiers.
-.SS addressbook identifier primary \fI personID\fP \fI propName\fP
+.SS addressbook identifier index \fI personID\fP \fI propName\fP \fI ident\fP
 .PP
-This command returns the primary identifier of property \fI propName\fP in
-the record \fI personID\fP. This is the identifier which will be used by
-default if no \fI distribution identifier\fP has been specified using the
-\fBaddressbook identifier set\fP command. Property \fI propName\fP must
-be a multi-value list property (such as \fI Phone, Email\fP).
+This command returns the index in a multi-value list corresponding to the
+identifier given in the \fI ident\fP argument. If \fI ident\fP is not a
+valid identifier, the command raises an error. The valid identifers are the
+values obtained by the \fBaddressbook identifier get\fP command.
+.SS addressbook identifier primary \fI personID\fP \fI propName\fP ?\fI ident\fP?
+.PP
+This command lets you get or set the primary identifier of property 
+\fI propName\fP in the record \fI personID\fP. This is the identifier
+which will be used by default if no \fI distribution identifier\fP has
+been specified using the \fBaddressbook identifier set\fP command.
+Property \fI propName\fP must be a multi-value list property (such as 
+\fI Phone, Email\fP). ((nl Used without the \fI ident\fP argument, the
+command will return the \fI primary identifier\fP concerning property 
+\fI propName\fP for the person \fI personID\fP.
+.PP
+ If the \fI ident\fP argument is specified, the command will set the
+primary value to be the value for the given identifier \fI ident\fP. This
+value must be a valid identifier used by the multi-value list: one can get
+the identifiers of any element of a multi-value list using the \fBaddressbook identifier get\fP command.
 .SS addressbook identifier set \fI groupID\fP \fI personID\fP \fI propName\fP ?\fI ident\fP?
 .PP
 This command lets you get or set the \fI distribution identifier\fP for a
 multi-value list property of a person in a group. See the section
-Distribution list and identifiers <#dist> below for 
+Distribution lists and identifiers <#dist> below for 
 explanations about identifiers.
 .PP
  Used without the \fI ident\fP argument, the command will return the
@@ -331,7 +345,7 @@
 This command returns the type (\fI ABPerson\fP or \fI ABGroup\fP) of the record with 
 unique ID \fI recordID\fP.
  
-.SH DISTRIBUTION LIST AND IDENTIFIERS
+.SH DISTRIBUTION LISTS AND IDENTIFIERS
 .PP
 Identifiers are necessary when one wants to use a group as a distribution
 list, that is send something to all the members of the group. The members