[Tcladdressbook-commits] Help TclAddressBookHelp.aida,1.18,1.19
Status: Alpha
Brought to you by:
bdesgraupes
|
From: Bernard D. <bde...@us...> - 2004-08-01 06:32:19
|
Update of /cvsroot/tcladdressbook/Help In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv29354/Help Modified Files: TclAddressBookHelp.aida Log Message: [add] and [remove] take multiple args Index: TclAddressBookHelp.aida =================================================================== RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.aida,v retrieving revision 1.18 retrieving revision 1.19 diff -u -d -r1.18 -r1.19 --- TclAddressBookHelp.aida 30 Jul 2004 21:30:51 -0000 1.18 +++ TclAddressBookHelp.aida 1 Aug 2004 06:32:10 -0000 1.19 @@ -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-30 23:21:07 +:Modified: 2004-08-01 08:09:34 :Keywords: Address book, data base ((if $aida_params(target) eq "Pdf" @@ -45,9 +45,9 @@ ((s1 SUBCOMMANDS -((s3 addressbook add ((i recordID i)) ((i groupID i)) -This command lets you add an already existing item (person or group) -designated by its unique ID ((i recordID i)) to the group with ID +((s3 addressbook add ((i groupID i)) ((i recordID ?recordID ...? i)) +This command lets you add one or more already existing items (persons or +groups) designated by their unique ID ((i recordID i)) to the group with ID ((i groupID i)). ((s3 addressbook changed @@ -126,14 +126,15 @@ 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))). ((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)). +((i Phone, Email 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)). ((nl If the ((i ident i)) argument is specified, the command will set the primary value to be the value for the given identifier ((i ident i)). 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. +the identifiers of any element of a multi-value list using the +((b addressbook identifier get b)) command. ((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 @@ -223,19 +224,19 @@ takes the form of a keyed list. ((nl The format used for a particular property's value depends on the type of the property (string, integer, date, multivalue etc.). Some properties have -a multiple type: MultiString for fields like Email, Phone etc., MultiDate -for fields like ABDate, MultiDictionary for the Address field. In case of a +a multiple type: ((i MultiString i)) for fields like Email, Phone etc., ((i MultiDate i)) +for fields like ABDate, ((i MultiDictionary i)) for the Address field. In case of a multivalue, the returned value is a keyed list itself. Each element of the list corresponds to a single property. For instance: ((lu -((li the elements of a MultiString or MultiDate value list are two-elements +((li the elements of a ((i MultiString i)) or ((i MultiDate i)) value list are two-elements sublists: the first element is the label of the corresponding -property (like Home, Work etc.) and the second is the value itself. -((li the elements of a MultiDictionary value list are lists themselves, +property (like ((i Home, Work i)) etc.) and the second is the value itself. +((li the elements of a ((i MultiDictionary i)) value list are lists themselves, representing a Label/Dictionary pair (dictionary in the AddressBook sense, not a Tcl dictionary as defined in version 8.5 of Tcl). Each element of this list has two elements: the first one is the label describing the -address (like Home, Work etc.) and the second one is a list representing +address (like ((i Home, Work i)) etc.) and the second one is a list representing the dictionary. The lists representing dictionaries contain two-elements sublists: the first item is the key in the dictionary and the second one is the value associated with this key. For instance a person could have two @@ -249,9 +250,9 @@ using the ((b keylget b)) and ((b keylset b)) commands defined in the TclX extension. -((s3 addressbook remove ((i recordID i)) ((i groupID i)) -This command lets you remove an already existing item (person or group) -designated by its unique ID ((i recordID i)) from the group with ID +((s3 addressbook remove ((i groupID i)) ((i recordID ?recordID ...? i)) +This command lets you remove one or more already existing items (persons or +groups) designated by their unique ID ((i recordID i)) from the group with ID ((i groupID i)). ((s3 addressbook save @@ -381,7 +382,8 @@ command. ((li 1.1b2 -- 2004/07/29 -- New command [setme]. ((li 1.1b3 -- 2004/07/30 -- New command [identifier] to handle -distribution lists. +distribution lists. Subcommands: count, get, primary, set. +((li 1.1b4 -- 2004/07/31 -- New command [identifier index]. lu)) |