[Tcladdressbook-commits] Help TclAddressBookHelp.aida,1.15,1.16
Status: Alpha
Brought to you by:
bdesgraupes
|
From: Bernard D. <bde...@us...> - 2004-07-30 11:17:05
|
Update of /cvsroot/tcladdressbook/Help In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18808/Help Modified Files: TclAddressBookHelp.aida Log Message: Doc [identifier] subcommands (count, get, primary, set) Index: TclAddressBookHelp.aida =================================================================== RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.aida,v retrieving revision 1.15 retrieving revision 1.16 diff -u -d -r1.15 -r1.16 --- TclAddressBookHelp.aida 29 Jul 2004 20:15:05 -0000 1.15 +++ TclAddressBookHelp.aida 30 Jul 2004 11:16:53 -0000 1.16 @@ -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-29 21:50:14 +:Modified: 2004-07-30 12:56:43 :Keywords: Address book, data base ((if $aida_params(target) eq "Pdf" @@ -100,22 +100,44 @@ ((i -ingroup i)) option is specified, only the subgroups contained in the group with ID ((i groupID i)) will be returned. -((s3 addressbook identifier ((i personID i)) ((i groupID i)) ((i propName i)) ?((i label i))? -This command lets you get or set the distribution identifier for a -multi-value list property of a person in a group. -((nl Used without a ((i label i)) argument, this will return the -distribution identifier for the person ((i personID i)) belonging to the +((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 Address, Phone, Email). + +((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 Address, Phone, Email). 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 list 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 Address, Phone, Email i))). + +((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 +multi-value list property of a person in a group. See the section +((lk #dist )) Distribution list and identifiers lk)) below for +explanations about identifiers. +((nl Used without the ((i ident i)) argument, the command will return the +((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 -((nl If the ((i label i)) 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 list for -instance, in the case of an email property). This value must be a label -used by the multi-value list (such as ((i home i)) for an ((i address i)) -property). If ((i label i)) is an empty string, this command resets the -distribution identifier to its default, i-e the multi-value list¹s primary -identifier. +otherwise the property's primary identifier. Property ((i propName i)) must +be a multi-value list property (such as ((i Address, Phone, Email 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 +list for instance, in the case of an email property). 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 image ((i personID i)) ?((i imageData i))? If no ((i imageData i)) argument is specified, this command returns the @@ -306,6 +328,23 @@ This command returns the type (((i ABPerson i)) or ((i ABGroup i))) of the record with unique ID ((i recordID i)). +((a dist )) a)) +((s1 DISTRIBUTION LIST 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, Address i)) etc. For instance, a group could +be used as a mailing list. The ((i Phone, Email, Address 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 The extension is made of two files: the dynamic library (called @@ -324,9 +363,11 @@ ((lu ((li 1.0b1 -- 2004/01/25 -- First public release. ((li 1.1b1 -- 2004/07/28 -- New commands [add] and [remove]. Modified -[delete] command. New command [identifier]. Modified [property remove] +[delete] command. Modified [property remove] command. ((li 1.1b2 -- 2004/07/29 -- New command [setme]. +((li 1.1b3 -- 2004/07/30 -- New command [identifier] to handle +distribution lists. lu)) |