[Tcladdressbook-commits] Help TclAddressBookHelp.aida,1.19,1.20

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

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

Modified Files:
	TclAddressBookHelp.aida 
Log Message:
Doc new command [addressbook label]

Index: TclAddressBookHelp.aida
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.aida,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -d -r1.19 -r1.20
--- TclAddressBookHelp.aida	1 Aug 2004 06:32:10 -0000	1.19
+++ TclAddressBookHelp.aida	1 Aug 2004 17:57:08 -0000	1.20
@@ -5,7 +5,7 @@
 :Author:		Bernard Desgraupes <bde...@ea...>
 :Homepage:		<http://webperso.easyconnect.fr/bdesgraupes/>
 :Created: 		2003-11-26 14:30:03
-:Modified:	 	2004-08-01 08:09:34
+:Modified:	 	2004-08-01 19:26:59
 :Keywords:		Address book, data base
 
 ((if $aida_params(target) eq "Pdf"
@@ -102,16 +102,17 @@
 
 ((s3 addressbook identifier count ((i personID i)) ((i propName i))
 This command returns the number of items in a multi-value list property
-(such as ((i Phone, Email, MSNInstant i)) etc.). 
+(such as ((i Phone, Email, Address, MSNInstant i)) etc.). 
 
 ((s3 addressbook identifier get ((i personID i)) ((i propName i)) ((i index i))
 This command gets the unique identifier of an item in a multi-value list
-property (such as ((i Phone, Email i))). It returns the identifier of the
-item at index ((i index i)) in the multi-value list of property 
-((i propName i)) for the record corresponding to ((i personID i)). One can
-get the count of identifiers using the ((b addressbook identifier count b))
+property (such as ((i Phone, Email, Address i))). It returns the identifier
+of the item at index ((i index i)) in the multi-value list of property ((i
+propName i)) for the record corresponding to ((i personID i)). One can get
+the count of identifiers using the ((b addressbook identifier count b))
 command. Identifiers are used by the ((b addressbook identifier set b))
-command. See the section ((lk #dist ))Distribution lists and identifiers lk)) 
+command. 
+See the section ((lk #dist ))Distribution lists and identifiers lk)) 
 below for explanations about identifiers.
 
 ((s3 addressbook identifier index ((i personID i)) ((i propName i)) ((i ident i))
@@ -126,7 +127,7 @@
 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))). 
+((i Phone, Email, Address 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)).
@@ -145,7 +146,7 @@
 ((i distribution identifier i)) for the person ((i personID i)) belonging to the
 group ((i groupID i)) concerning property ((i propName i)) if it was set,
 otherwise the property's primary identifier. Property ((i propName i)) must
-be a multi-value list property (such as ((i Phone, Email i))).
+be a multi-value list property (such as ((i Phone, Email, Address i))).
 ((nl If the ((i ident i)) argument is specified, this will assign a
 specific ((i distribution identifier i)) for the person's multi-value list
 property so that the group can be used as a distribution list (a mailing
@@ -168,6 +169,16 @@
 created in the database corresponding to the information contained in the
 VCard. Note that the data can be binary if the VCard contains an image.
 
+((s3 addressbook label ((i personID i)) ((i propName i)) ((i index i)) ?((i value i))?
+This command lets you get or set the label of a value in a multi-value property 
+for a particular record. 
+((nl Used without the ((i value i)) argument, the command will return the
+current label at index ((i index i)) in property ((i propName i)) for the
+person ((i personID i)). To determine the index range, one can use the 
+((b addressbook identifier count b)) command.
+((nl If the ((i value i)) argument is specified, the command will set the
+label at index ((i index i)) to this value.
+
 ((s3 addressbook parents ?-ids? ((i recordID i))
 This command returns a list of all the groups the record with unique ID 
 ((i recordID i)) belongs to. The elements of this list are sublists made of one
@@ -205,7 +216,7 @@
 Dictionary, Integer, Real, String, MultiArray, MultiData, MultiDate,
 MultiDictionary, MultiInteger, MultiReal, MultiString. i))
 
-((s3 addressbook property remove (-groups | -persons | recordID) ((i propName i))
+((s3 addressbook property remove (-groups | -persons | ((i recordID i))) ((i propName i))
 This command lets you remove a property from the database, either for
 person or for group records. The name of the property is specified in the
 ((i propName i)) argument. If the third argument is either ((b -groups b)) or
@@ -347,18 +358,18 @@
 ((s1 DISTRIBUTION LISTS AND IDENTIFIERS
 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
-can be addressed by ((i Phone, Email i)) etc. For instance, a group could
-be used as a mailing list. The ((i Phone, Email i)) properties are
-multi-value list properties: since a person can have several e-mail
-addresses, one must specify which one is to be used in the distribution list.
-Labels (such as Home, Work etc.) are not sufficient to specify precisely an
-e-mail because they are not unique: one can have several e-mails with the
-label Work. Here the identifiers come in: each value of a multi-value list
-property has an identifier. One of them can be designated as the ((i
-distribution identifier i)). The AddressBook database also has a notion of
-a ((i primary identifier i)): it is the identifier which will be used by
-default by the distribution list if no ((i distribution identifier i)) as
-been specified.
+can be addressed by ((i Address, Phone, Email i)) etc. For instance, a
+group could be used as a mailing list. The ((i Address, Phone, Email i))
+properties are multi-value list properties: since a person can have several
+e-mail addresses, one must specify which one is to be used in the
+distribution list. Labels (such as Home, Work etc.) are not sufficient to
+specify precisely an e-mail because they are not unique: one can have
+several e-mails with the label Work. Here the identifiers come in: each
+value of a multi-value list property has an identifier. One of them can be
+designated as the ((i distribution identifier i)). The AddressBook database
+also has a notion of a ((i primary identifier i)): it is the identifier
+which will be used by default by the distribution list if no 
+((i distribution identifier i)) as been specified.
 
 
 ((s1 INSTALLATION
@@ -384,6 +395,8 @@
 ((li 1.1b3 -- 2004/07/30 -- New command [identifier] to handle 
 distribution lists. Subcommands: count, get, primary, set.
 ((li 1.1b4 -- 2004/07/31 -- New command [identifier index].
+((li 1.1b5 -- 2004/08/01 -- New command [identifier label]. Fixed 
+setting value with [identifier primary].
 lu))