[Tcladdressbook-commits] Help TclAddressBookHelp,1.19,1.20

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

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

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

Index: TclAddressBookHelp
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -d -r1.19 -r1.20

--- TclAddressBookHelp	1 Aug 2004 06:32:00 -0000	1.19
+++ TclAddressBookHelp	1 Aug 2004 17:56:57 -0000	1.20
@@ -5,7 +5,7 @@
 					Abstract
 
 This is a manual page for the Tcladdressbook extension for Tcl. It 
-documents version 1.1b4.
+documents version 1.1b5.
 
 
    1. NAME
@@ -27,6 +27,7 @@
           addressbook identifier set groupID personID propName ?ident?
           addressbook image personID ?imageData?
           addressbook import vCardData
+          addressbook label personID propName index ?value?
           addressbook parents ?-ids? recordID
           addressbook persons ?-ids? ?-ingroup groupID?
           addressbook property names (-groups | -persons)
@@ -127,16 +128,16 @@
 
  addressbook identifier count personID propName
 This command returns the number of items in a multi-value list property
-(such as Phone, Email, MSNInstant etc.). 
+(such as Phone, Email, Address, MSNInstant etc.). 
 
  addressbook identifier get personID propName index
 This command gets the unique identifier of an item in a multi-value list
-property (such as Phone, Email). It returns the identifier of the
-item at index index in the multi-value list of property 
-propName for the record corresponding to personID. One can
-get the count of identifiers using the addressbook identifier count
+property (such as Phone, Email, Address). It returns the identifier
+of the item at index index in the multi-value list of property propName for the record corresponding to personID. One can get
+the count of identifiers using the addressbook identifier count
 command. Identifiers are used by the addressbook identifier set
-command. See the section Distribution lists and identifiers <#dist> 
+command. 
+See the section Distribution lists and identifiers <#dist> 
 below for explanations about identifiers.
 
  addressbook identifier index personID propName ident
@@ -151,7 +152,7 @@
 which will be used by default if no distribution identifier has
 been specified using the addressbook identifier set command.
 Property propName must be a multi-value list property (such as 
-Phone, Email). 
+Phone, Email, Address). 
  Used without the ident argument, the command will return the
 primary identifier concerning property propName for the
 person personID.
@@ -170,7 +171,7 @@
 distribution identifier for the person personID belonging to the
 group groupID concerning property propName if it was set,
 otherwise the property's primary identifier. Property propName must
-be a multi-value list property (such as Phone, Email).
+be a multi-value list property (such as Phone, Email, Address).
  If the ident argument is specified, this will assign a
 specific distribution identifier for the person's multi-value list
 property so that the group can be used as a distribution list (a mailing
@@ -193,6 +194,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.
 
+ addressbook label personID propName index ?value?
+This command lets you get or set the label of a value in a multi-value property 
+for a particular record. 
+ Used without the value argument, the command will return the
+current label at index index in property propName for the
+person personID. To determine the index range, one can use the 
+addressbook identifier count command.
+ If the value argument is specified, the command will set the
+label at index index to this value.
+
  addressbook parents ?-ids? recordID
 This command returns a list of all the groups the record with unique ID 
 recordID belongs to. The elements of this list are sublists made of one
@@ -369,17 +380,18 @@
 5. 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 Phone, Email etc. For instance, a group could
-be used as a mailing list. The Phone, Email 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 distribution identifier. The AddressBook database also has a notion of
-a primary identifier: it is the identifier which will be used by
-default by the distribution list if no distribution identifier as
-been specified.
+can be addressed by Address, Phone, Email etc. For instance, a
+group could be used as a mailing list. The Address, Phone, Email
+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 distribution identifier. The AddressBook database
+also has a notion of a primary identifier: it is the identifier
+which will be used by default by the distribution list if no 
+distribution identifier as been specified.
 
 
 6. INSTALLATION
@@ -404,6 +416,8 @@
      1.1b3 -- 2004/07/30 -- New command [identifier] to handle 
 distribution lists. Subcommands: count, get, primary, set.
      1.1b4 -- 2004/07/31 -- New command [identifier index].
+     1.1b5 -- 2004/08/01 -- New command [identifier label]. Fixed 
+setting value with [identifier primary].
 
 
 
@@ -458,7 +472,7 @@
 
 
 ----------------------------------------------------------------------
- Last updated 2004-08-01 08:09:58
+ Last updated 2004-08-01 19:36:51
 
 
 



