[Tcladdressbook-commits] Help TclAddressBookHelp,1.13,1.14

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

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

Modified Files:
	TclAddressBookHelp 
Log Message:
New "add" and "remove" subcommands

Index: TclAddressBookHelp
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -d -r1.13 -r1.14

--- TclAddressBookHelp	26 Jan 2004 23:08:17 -0000	1.13
+++ TclAddressBookHelp	28 Jul 2004 23:11:06 -0000	1.14
@@ -5,17 +5,18 @@
 					Abstract
 
 This is a manual page for the Tcladdressbook extension for Tcl. It 
-documents version 1.0b1.
+documents version 1.1b1.
 
 
    1. NAME
    2. SYNOPSIS
    3. INTRODUCTION
    4. SUBCOMMANDS
+          addressbook add recordID groupID
           addressbook changed
           addressbook count (-groups | -persons) ?-ingroup groupID?
           addressbook create (group | person) name ?-ingroup groupID?
-          addressbook delete recordID ?-fromgroup groupID?
+          addressbook delete recordID
           addressbook export personID
           addressbook getme
           addressbook groups ?-ids? ?-ingroup groupID?
@@ -28,6 +29,7 @@
           addressbook property add (-groups | -persons) propName propType
           addressbook property remove (-groups | -persons) propName
           addressbook record recordID
+          addressbook remove recordID groupID
           addressbook save
           addressbook search ?(-groups | -persons)? ?-ids? ?-nocase? property op value
           addressbook set recordID propertyName ?value?
@@ -50,7 +52,7 @@
 
 2. SYNOPSIS
 package require addressbook
-addressbook subcommand ?arg arg...?
+ addressbook subcommand ?arg arg...?
 
 3. INTRODUCTION
 
@@ -61,6 +63,11 @@
 
 4. SUBCOMMANDS
 
+ addressbook add recordID groupID
+This command lets you add an already existing item (person or group) 
+designated by its unique ID recordID to the group with ID 
+groupID.
+
  addressbook changed
 This command returns 1 if there has been changes made to the database, 0
 otherwise. Changes are made in memory with commands such as addressbook
@@ -81,11 +88,13 @@
 particular group with unique ID groupID. If no error occurs, the
 command returns the unique ID of the created record.
 
- addressbook delete recordID ?-fromgroup groupID?
+ addressbook delete recordID
 This command removes the record with unique ID recordID from the
-database or from a particular subgroup specified by its unique ID with the
--fromgroup option. Note that any changes made to the database won't
-be definitive until you invoke the addressbook save command.
+database. Note that any changes made to the database won't be definitive
+until you invoke the addressbook save command.
+ In version 1.0 of the extension, this command used to accept an option
+called -fromgroup in order to remove the record from a particular
+subgroup. This is achieved now by the addressbook remove command.
 
  addressbook export personID
 This command lets you export the record with unique ID personID as
@@ -169,7 +178,7 @@
 This command returns all the data available in the database concerning
 the record with unique ID recordID.  The returned value
 takes the form of a keyed list.
-The format used for a particular property's value depends on the type of
+ 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
@@ -189,13 +198,18 @@
 addresses: each address will be returned as a Label/Dictionary pair; the
 elements of the dictionary are pairs like {City Paris} or {CountryCode fr}.
 
-Dates are returned as values suitable for use with the clock
+ Dates are returned as values suitable for use with the clock
 format Tcl command. It is the number of seconds relative to "Thu Jan 01
 00:00:00 CET 1970".
-Note that keyed lists can be easily manipulated 
+ Note that keyed lists can be easily manipulated 
 using the keylget and keylset commands defined in the TclX 
 extension.
 
+ addressbook remove recordID groupID
+This command lets you remove an already existing item (person or group) 
+designated by its unique ID recordID from the group with ID 
+groupID.
+
  addressbook save
 This command lets you save the changes made in the database. Commands such
 as addressbook set, addressbook create or addressbook
@@ -245,28 +259,27 @@
 a simple property, value will be a simple string. In the case of  a
 MultiString, MultiInteger or MultiDate property, value  will  be  a
 two-elements list representing  a  label/value  pair.  In  the  case  of  a
-MultiDictionary property,   value   will  be  a  two-elements  list
+MultiDictionary property,  value  will  be  a  two-elements  list
 representing  a  label/dictionary  pair,  the  dictionary  itself  being  a
 two-elements list representing a single key/value pair. For instance:
 
 	{Phone "01 02 03 04 05"}
 	{Home {City Paris}}
 
-One can specify an empty string for the label in order to perform the 
+ One can specify an empty string for the label in order to perform the 
 search over all the possible labels. One can also specify an empty string for 
 the key in order to perform the search over all the possible keys in a dictionary. 
 
-The -groups or -persons options let you specify the
+ The -groups or -persons options let you specify the
 kind of records you want to search. If it is not specified, the default is
 -person. If the -ids option is specified, only IDs of the
 matching records are returned, rather than pairs made of the ID and the
 name. The -nocase argument concerns string comparisons and requires
 that no distinction be made between uppercase and lowercase letters.
-To get a list of all possible properties, use the addressbook 
+ To get a list of all possible properties, use the addressbook 
 property names command. To know the type of a particular property, use 
 the addressbook property type command.
 
-
  addressbook set recordID propertyName ?value?
 This command lets you get or set the value of a particular property for the
 record with unique ID recordID. If the value argument is
@@ -296,6 +309,8 @@
 
 6. VERSION HISTORY
      1.0b1 -- 2004/01/25 -- First public release.
+     1.1b1 -- 2004/08/01 -- New commands "add" and "remove". Modified 
+"delete" command.
 
 
 
@@ -314,19 +329,19 @@
 9. SOURCE CODE
 Tcladdressbook is an Open Source Project. Its source code is public and can 
 be found on the SourceForge site at the following address:
-<http://sourceforge.net/projects/tcladdressbook>
+ <http://sourceforge.net/projects/tcladdressbook>
 
-Tcladdressbook binary releases are available at
-<http://sourceforge.net/project/showfiles.php?group_id=96169> 
+ Tcladdressbook binary releases are available at
+  <http://sourceforge.net/project/showfiles.php?group_id=96169> 
 or on my web page at
-<http://webperso.easyconnect.fr/bdesgraupes/tcl.html>
+  <http://webperso.easyconnect.fr/bdesgraupes/tcl.html>
 
-The code is under CVS control. You can retrieve the latest stage of 
+ The code is under CVS control. You can retrieve the latest stage of 
 development using any CVS client. See instructions at:
-<http://sourceforge.net/cvs/?group_id=96169>
+ <http://sourceforge.net/cvs/?group_id=96169>
 
-You can also browse the cvs repository online at
-<http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/tcladdressbook> 
+ You can also browse the cvs repository online at
+ <http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/tcladdressbook> 
 
 10. CONTRIBUTIONS
 Code contributions (Tcl scripts making use of the Tcladdressbook extension)
@@ -339,7 +354,7 @@
 This software is free software and distributed under the same licensing terms 
 as the Tcl language itself. See license.terms in the Tcl distribution.
 
-© Copyright Bernard Desgraupes 2003-2004
+ © Copyright Bernard Desgraupes 2003-2004
 
 12. SEE ALSO
 See the TclX extension for  keyed  lists: TclX(n).  See  the  Mk4Tcl  extension  for
@@ -350,7 +365,7 @@
 
 
 ----------------------------------------------------------------------
-Last updated 2004-01-24 13:25:56
+ Last updated 2004-07-29 01:09:25
 
 
 



