[Tcladdressbook-commits] Help TclAddressBookHelp,1.17,1.18

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

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

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

Index: TclAddressBookHelp
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -d -r1.17 -r1.18
--- TclAddressBookHelp	30 Jul 2004 13:07:58 -0000	1.17
+++ TclAddressBookHelp	30 Jul 2004 21:30:42 -0000	1.18
@@ -5,7 +5,7 @@
 					Abstract
 
 This is a manual page for the Tcladdressbook extension for Tcl. It 
-documents version 1.1b3.
+documents version 1.1b4.
 
 
    1. NAME
@@ -22,7 +22,8 @@
           addressbook groups ?-ids? ?-ingroup groupID?
           addressbook identifier count personID propName
           addressbook identifier get personID propName index
-          addressbook identifier primary personID propName
+          addressbook identifier index personID propName ident
+          addressbook identifier primary personID propName ?ident?
           addressbook identifier set groupID personID propName ?ident?
           addressbook image personID ?imageData?
           addressbook import vCardData
@@ -39,7 +40,7 @@
           addressbook set recordID propertyName ?value?
           addressbook setme recordID
           addressbook type recordID
-   5. DISTRIBUTION LIST AND IDENTIFIERS
+   5. DISTRIBUTION LISTS AND IDENTIFIERS
    6. INSTALLATION
    7. VERSION HISTORY
    8. REQUIREMENTS AND PORTABILITY
@@ -135,20 +136,33 @@
 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 list and identifiers <#dist> 
+command. See the section Distribution lists and identifiers <#dist> 
 below for explanations about identifiers.
 
- addressbook identifier primary personID propName
-This command returns the primary identifier of property propName in
-the record personID. This is the identifier 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).
+ addressbook identifier index personID propName ident
+This command returns the index in a multi-value list corresponding to the
+identifier given in the ident argument. If ident is not a
+valid identifier, the command raises an error. The valid identifers are the
+values obtained by the addressbook identifier get command.
+
+ addressbook identifier primary personID propName ?ident?
+This command lets you get or set the primary identifier of property 
+propName in the record personID. This is the identifier
+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). ((nl Used without the ident argument, the
+command will return the primary identifier concerning property 
+propName for the person personID.
+ If the ident argument is specified, the command will set the
+primary value to be the value for the given identifier ident. 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 addressbook identifier get command.
 
  addressbook identifier set groupID personID propName ?ident?
 This command lets you get or set the distribution identifier 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.
  Used without the ident argument, the command will return the
 distribution identifier for the person personID belonging to the
@@ -350,7 +364,7 @@
 unique ID recordID.
 
  
-5. DISTRIBUTION LIST AND IDENTIFIERS
+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
@@ -441,7 +455,7 @@
 
 
 ----------------------------------------------------------------------
- Last updated 2004-07-30 14:44:48
+ Last updated 2004-07-30 23:22:23