[Tcladdressbook-commits] Help TclAddressBookHelp.html,1.21,1.22

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

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

Modified Files:
	TclAddressBookHelp.html 
Log Message:
[add] and [remove] take multiple args

Index: TclAddressBookHelp.html
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.html,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -d -r1.21 -r1.22
--- TclAddressBookHelp.html	30 Jul 2004 21:31:13 -0000	1.21
+++ TclAddressBookHelp.html	1 Aug 2004 06:32:19 -0000	1.22
@@ -15,7 +15,7 @@
 <LI><A HREF="#M2">SYNOPSIS</A>
 <LI><A HREF="#M3">INTRODUCTION</A>
 <LI><A HREF="#M4">SUBCOMMANDS</A>
-<UL><UL><LI><A HREF="#M5">addressbook add <I>recordID</I> <I>groupID</I></A></UL></UL>
+<UL><UL><LI><A HREF="#M5">addressbook add <I>groupID</I> <I>recordID ?recordID ...?</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M6">addressbook changed</A></UL></UL>
 <UL><UL><LI><A HREF="#M7">addressbook count (-groups | -persons) ?-ingroup <I>groupID</I>?</A></UL></UL>
 <UL><UL><LI><A HREF="#M8">addressbook create (group | person) <I>name</I> ?-ingroup <I>groupID</I>?</A></UL></UL>
@@ -37,7 +37,7 @@
 <UL><UL><LI><A HREF="#M24">addressbook property add (-groups | -persons) <I>propName</I> <I>propType</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M25">addressbook property remove (-groups | -persons | recordID) <I>propName</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M26">addressbook record <I>recordID</I></A></UL></UL>
-<UL><UL><LI><A HREF="#M27">addressbook remove <I>recordID</I> <I>groupID</I></A></UL></UL>
+<UL><UL><LI><A HREF="#M27">addressbook remove <I>groupID</I> <I>recordID ?recordID ...?</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M28">addressbook save</A></UL></UL>
 <UL><UL><LI><A HREF="#M29">addressbook search ?(-groups | -persons)? ?-ids? ?-nocase? <I>property op value</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M30">addressbook set <I>recordID propertyName</I> ?<I>value</I>?</A></UL></UL>
@@ -59,9 +59,9 @@
 <B>package require addressbook</B>
 <P> <B>addressbook subcommand</B> ?<I>arg arg</I>...?<P><H2><A NAME="M3"></A>INTRODUCTION</H2><P>The argument <I>subcommand</I> indicates what operation to perform. Any
 unique abbreviation for each subcommand is acceptable. The valid
-subcommands are explained in the next sections.<P><H2><A NAME="M4"></A>SUBCOMMANDS</H2><P><H4><A NAME="M5"></A>addressbook add <I>recordID</I> <I>groupID</I></H4>
-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 
+subcommands are explained in the next sections.<P><H2><A NAME="M4"></A>SUBCOMMANDS</H2><P><H4><A NAME="M5"></A>addressbook add <I>groupID</I> <I>recordID ?recordID ...?</I></H4>
+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>.<P><H4><A NAME="M6"></A>addressbook changed</H4>
 This command returns 1 if there has been changes made to the database, 0
 otherwise. Changes are made in memory with commands such as <B>addressbook
@@ -118,13 +118,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>). 
+<P> 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>.
 <P> 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.<P><H4><A NAME="M17"></A>addressbook identifier set <I>groupID</I> <I>personID</I> <I>propName</I> ?<I>ident</I>?</H4>
+the identifiers of any element of a multi-value list using the 
+<B>addressbook identifier get</B> command.<P><H4><A NAME="M17"></A>addressbook identifier set <I>groupID</I> <I>personID</I> <I>propName</I> ?<I>ident</I>?</H4>
 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
 <A HREF="#dist"> Distribution lists and identifiers</A> below for 
@@ -194,19 +196,19 @@
 takes the form of a keyed list.
 <P> 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:
 <UL>
-	<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
@@ -218,9 +220,9 @@
 00:00:00 CET 1970".
 <P> Note that keyed lists can be easily manipulated 
 using the <B>keylget</B> and <B>keylset</B> commands defined in the TclX 
-extension.<P><H4><A NAME="M27"></A>addressbook remove <I>recordID</I> <I>groupID</I></H4>
-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 
+extension.<P><H4><A NAME="M27"></A>addressbook remove <I>groupID</I> <I>recordID ?recordID ...?</I></H4>
+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>.<P><H4><A NAME="M28"></A>addressbook save</H4>
 This command lets you save the changes made in the database. Commands such
 as <B>addressbook set</B>, <B>addressbook create</B> or <B>addressbook
@@ -325,7 +327,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].
 </UL><P><H2><A NAME="M36"></A>REQUIREMENTS AND PORTABILITY</H2>
 This extension is only useful on Macintosh platforms. Version 10.2 or
 greater of the system is required: the AddressBook framework was introduced
@@ -352,6 +355,6 @@
 See the TclX extension for  keyed  lists: TclX(n).  See  the  Mk4Tcl  extension  for
 commands to open directly the database file.<P><H2><A NAME="M42"></A>KEYWORDS</H2>
 Address book, data base.<P><HR>
-<P> Last updated 2004-07-30 23:21:29<P>
+<P> Last updated 2004-08-01 08:09:45<P>
 </BODY>
 </HTML>
\ No newline at end of file