[Tcladdressbook-commits] Help tcladdressbook.n,1.6,1.7
Status: Alpha
Brought to you by:
bdesgraupes
Menu
▾
▴
[Tcladdressbook-commits] Help tcladdressbook.n,1.6,1.7
|
From: Bernard D. <bde...@us...> - 2004-07-30 13:07:57
|
Update of /cvsroot/tcladdressbook/Help In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv4475/Help Modified Files: tcladdressbook.n Log Message: More [identifier] doc and examples Index: tcladdressbook.n =================================================================== RCS file: /cvsroot/tcladdressbook/Help/tcladdressbook.n,v retrieving revision 1.6 retrieving revision 1.7 diff -u -d -r1.6 -r1.7 --- tcladdressbook.n 29 Jul 2004 20:14:46 -0000 1.6 +++ tcladdressbook.n 30 Jul 2004 13:07:48 -0000 1.7 @@ -1,7 +1,7 @@ .de uline \Z'\\$1'\v'.25m'\D'l \w'\\$1'u 0'\v'-.25m' .. -.TH tcladdressbook n "" "2004-07-29" "addressbook extension for Tcl" +.TH tcladdressbook n "" "2004-07-30" "addressbook extension for Tcl" .SH NAME .PP addressbook - manipulate the Macintosh OSX Address Book database @@ -73,25 +73,47 @@ returned list will contain only the unique IDs of the groups. If the \fI -ingroup\fP option is specified, only the subgroups contained in the group with ID \fI groupID\fP will be returned. -.SS addressbook identifier \fI personID\fP \fI groupID\fP \fI propName\fP ?\fI label\fP? +.SS addressbook identifier count \fI personID\fP \fI propName\fP .PP -This command lets you get or set the distribution identifier for a -multi-value list property of a person in a group. +This command returns the number of items in a multi-value list property +(such as \fI Phone, Email, MSNInstant\fP etc.). +.SS addressbook identifier get \fI personID\fP \fI propName\fP \fI index\fP .PP - Used without a \fI label\fP argument, this will return the -distribution identifier for the person \fI personID\fP belonging to the +This command gets the unique identifier of an item in a multi-value list +property (such as \fI Phone, Email\fP). It returns the identifier of the +item at index \fI index\fP in the multi-value list of property +\fI propName\fP for the record corresponding to \fI personID\fP. One can +get the count of identifiers using the \fBaddressbook identifier count\fP +command. Identifiers are used by the \fBaddressbook identifier set\fP +command. See the section Distribution list and identifiers <#dist> +below for explanations about identifiers. +.SS addressbook identifier primary \fI personID\fP \fI propName\fP +.PP +This command returns the primary identifier of property \fI propName\fP in +the record \fI personID\fP. This is the identifier which will be used by +default if no \fI distribution identifier\fP has been specified using the +\fBaddressbook identifier set\fP command. Property \fI propName\fP must +be a multi-value list property (such as \fI Phone, Email\fP). +.SS addressbook identifier set \fI groupID\fP \fI personID\fP \fI propName\fP ?\fI ident\fP? +.PP +This command lets you get or set the \fI distribution identifier\fP for a +multi-value list property of a person in a group. See the section +Distribution list and identifiers <#dist> below for +explanations about identifiers. +.PP + Used without the \fI ident\fP argument, the command will return the +\fI distribution identifier\fP for the person \fI personID\fP belonging to the group \fI groupID\fP concerning property \fI propName\fP if it was set, -otherwise the property¹s primary identifier. Property \fI propName\fP must -be a multi-value list property +otherwise the property's primary identifier. Property \fI propName\fP must +be a multi-value list property (such as \fI Phone, Email\fP). .PP - If the \fI label\fP 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 \fI home\fP for an \fI address\fP -property). If \fI label\fP is an empty string, this command resets the -distribution identifier to its default, i-e the multi-value list¹s primary -identifier. + If the \fI ident\fP argument is specified, this will assign a +specific \fI distribution identifier\fP 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 \fBaddressbook identifier +get\fP command. .SS addressbook image \fI personID\fP ?\fI imageData\fP? .PP If no \fI imageData\fP argument is specified, this command returns the @@ -308,6 +330,22 @@ .PP This command returns the type (\fI ABPerson\fP or \fI ABGroup\fP) of the record with unique ID \fI recordID\fP. + +.SH DISTRIBUTION LIST AND IDENTIFIERS +.PP +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 \fI Phone, Email\fP etc. For instance, a group could +be used as a mailing list. The \fI Phone, Email\fP 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 \fI distribution identifier\fP. The AddressBook database also has a notion of +a \fI primary identifier\fP: it is the identifier which will be used by +default by the distribution list if no \fI distribution identifier\fP as +been specified. .SH INSTALLATION .PP The extension is made of two files: the dynamic library (called @@ -327,10 +365,13 @@ 1.0b1 -- 2004/01/25 -- First public release. .IP * 4 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. .IP * 4 1.1b2 -- 2004/07/29 -- New command [setme]. +.IP * 4 +1.1b3 -- 2004/07/30 -- New command [identifier] to handle +distribution lists. .RE .SH REQUIREMENTS AND PORTABILITY .PP |
