[Tcladdressbook-commits] Help TclAddressBookHelp.aida,1.17,1.18

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

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

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

Index: TclAddressBookHelp.aida
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.aida,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -d -r1.17 -r1.18
--- TclAddressBookHelp.aida	30 Jul 2004 13:08:10 -0000	1.17
+++ TclAddressBookHelp.aida	30 Jul 2004 21:30:51 -0000	1.18
@@ -5,7 +5,7 @@
 :Author:		Bernard Desgraupes <bde...@ea...>
 :Homepage:		<http://webperso.easyconnect.fr/bdesgraupes/>
 :Created: 		2003-11-26 14:30:03
-:Modified:	 	2004-07-30 12:56:43
+:Modified:	 	2004-07-30 23:21:07
 :Keywords:		Address book, data base
 
 ((if $aida_params(target) eq "Pdf"
@@ -114,12 +114,26 @@
 command. See the section ((lk #dist ))Distribution lists and identifiers lk)) 
 below for explanations about identifiers.
 
-((s3 addressbook identifier primary ((i personID i)) ((i propName i))
-This command returns the primary identifier of property ((i propName i)) in
-the record ((i personID i)). This is the identifier which will be used by
-default if no ((i distribution identifier i)) has been specified using the
-((b addressbook identifier set b)) command. Property ((i propName i)) must
-be a multi-value list property (such as ((i Phone, Email i))).
+((s3 addressbook identifier index ((i personID i)) ((i propName i)) ((i ident i))
+This command returns the index in a multi-value list corresponding to the
+identifier given in the ((i ident i)) argument. If ((i ident i)) is not a
+valid identifier, the command raises an error. The valid identifers are the
+values obtained by the ((b addressbook identifier get b)) command.
+
+((s3 addressbook identifier primary ((i personID i)) ((i propName i)) ?((i ident i))?
+This command lets you get or set the primary identifier of property 
+((i propName i)) in the record ((i personID i)). This is the identifier
+which will be used by default if no ((i distribution identifier i)) has
+been specified using the ((b addressbook identifier set b)) command.
+Property ((i propName i)) must be a multi-value list property (such as 
+((i Phone, Email i))). ((nl Used without the ((i ident i)) argument, the
+command will return the ((i primary identifier i)) concerning property 
+((i propName i)) for the person ((i personID i)).
+((nl If the ((i ident i)) argument is specified, the command will set the
+primary value to be the value for the given identifier ((i ident i)). 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 ((b
+addressbook identifier get b)) command.
 
 ((s3 addressbook identifier set ((i groupID i)) ((i personID i)) ((i propName i)) ?((i ident i))?
 This command lets you get or set the ((i distribution identifier i)) for a