[Tcladdressbook-commits] Help TclAddressBookHelp.html,1.7,1.8

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:/tmp/cvs-serv1103/Help

Modified Files:
	TclAddressBookHelp.html 
Log Message:
Updated syntax for [getme] and [record]

Index: TclAddressBookHelp.html
===================================================================
RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp.html,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -d -r1.7 -r1.8

--- TclAddressBookHelp.html	13 Dec 2003 17:29:01 -0000	1.7
+++ TclAddressBookHelp.html	16 Dec 2003 07:38:00 -0000	1.8
@@ -11,11 +11,8 @@
 <!--  :Author:		Bernard Desgraupes <A HREF="mailto:bde...@ea...">bde...@ea...</A> -->
 <!--  :Homepage:		<A HREF="http://webperso.easyconnect.fr/bdesgraupes/">http://webperso.easyconnect.fr/bdesgraupes/</A> -->
 <!--  :Created: 		2003-11-26 14:30:03 -->
-<!-- :Modified:	 	2003-12-11 08:18:03 -->
-<!--  :Keywords:		Address book, data base -->
-
-
-<HR><BLOCKQUOTE><P><I> 
+<!-- :Modified:	 	2003-12-13 18:24:43 -->
+<!--  :Keywords:		Address book, data base --><P><HR><BLOCKQUOTE><P><I> 
 This is a manual page for the Tcladdressbook extension for Tcl.
 </I></P></BLOCKQUOTE><HR>
 <UL>
@@ -28,7 +25,7 @@
 <UL><UL><LI><A HREF="#M7">addressbook create (group | person) <I>name</I> ?-ingroup <I>groupID</I>?</A></UL></UL>
 <UL><UL><LI><A HREF="#M8">addressbook delete <I>recordID</I> ?-fromgroup <I>groupID</I>?</A></UL></UL>
 <UL><UL><LI><A HREF="#M9">addressbook export <I>personID</I></A></UL></UL>
-<UL><UL><LI><A HREF="#M10">addressbook getme <I>varname</I></A></UL></UL>
+<UL><UL><LI><A HREF="#M10">addressbook getme</A></UL></UL>
 <UL><UL><LI><A HREF="#M11">addressbook groups ?-ids? ?-ingroup <I>groupID</I>?</A></UL></UL>
 <UL><UL><LI><A HREF="#M12">addressbook image <I>personID</I> ?<I>imageData</I>?</A></UL></UL>
 <UL><UL><LI><A HREF="#M13">addressbook import <I>vCardData</I></A></UL></UL>
@@ -37,7 +34,7 @@
 <UL><UL><LI><A HREF="#M16">addressbook property names (-groups | -persons)</A></UL></UL>
 <UL><UL><LI><A HREF="#M17">addressbook property add (-groups | -persons) <I>propName</I> <I>propType</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M18">addressbook property remove (-groups | -persons) <I>propName</I></A></UL></UL>
-<UL><UL><LI><A HREF="#M19">addressbook record <I>recordID varname</I></A></UL></UL>
+<UL><UL><LI><A HREF="#M19">addressbook record <I>recordID</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M20">addressbook save</A></UL></UL>
 <UL><UL><LI><A HREF="#M21">addressbook search ?(-groups | -persons)? ?-ids? ?-nocase? <I>property op value</I></A></UL></UL>
 <UL><UL><LI><A HREF="#M22">addressbook set <I>recordID propertyName</I> ?<I>value</I>?</A></UL></UL>
@@ -50,112 +47,72 @@
 <LI><A HREF="#M29">SOURCE CODE</A>
 <LI><A HREF="#M30">SEE ALSO</A>
 <LI><A HREF="#M31">KEYWORDS</A>
-</UL>
-
-
-
-<H2><A NAME="M1"></A> NAME</H2>
-addressbook - manipulate the Macintosh OSX Address Book database
-
-<H2><A NAME="M2"></A> SYNOPSIS</H2>
+</UL><P><P><H2><A NAME="M1"></A> NAME</H2>
+addressbook - manipulate the Macintosh OSX Address Book database<P><H2><A NAME="M2"></A> SYNOPSIS</H2>
 <PRE>
  package require addressbook
  addressbook subcommand ?arg arg ...?
-</PRE>
-
-<H2><A NAME="M3"></A> INTRODUCTION</H2>
-
-The argument <I>subcommand</I> indicates what operation to perform. Any
+</PRE><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.
-
-
-<H2><A NAME="M4"></A> SUBCOMMANDS</H2>
-
-<H4><A NAME="M5"></A> addressbook changed</H4>
+subcommands are explained in the next sections.<P><H2><A NAME="M4"></A> SUBCOMMANDS</H2><P><H4><A NAME="M5"></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
 set</B>, <B>addressbook create</B>, <B>addressbook delete</B>. To make
 these changes permanent, one must call the <B>addressbook save</B>
-command. 
-
-<H4><A NAME="M6"></A> addressbook count (-groups | -persons) ?-ingroup <I>groupID</I>?</H4>
+command. <P><H4><A NAME="M6"></A> addressbook count (-groups | -persons) ?-ingroup <I>groupID</I>?</H4>
 This command returns the count of existing groups or persons in the 
 database. One can specify a particular group with the -ingroup option 
-to count only the subgroups or members in this group.
-
-<H4><A NAME="M7"></A> addressbook create (group | person) <I>name</I> ?-ingroup <I>groupID</I>?</H4>
+to count only the subgroups or members in this group.<P><H4><A NAME="M7"></A> addressbook create (group | person) <I>name</I> ?-ingroup <I>groupID</I>?</H4>
 This command lets you create a new group or a new person record. The 
 <I>name</I> argument is the name to give to the new group or the last name of
 the person for which a new record is created. With the <I>-ingroup</I>
 option one can make the newly created record a subgroup or a member of the
 particular group with unique ID <I>groupID</I>. If no error occurs, the
-command returns the unique ID of the created record.
-
-<H4><A NAME="M8"></A> addressbook delete <I>recordID</I> ?-fromgroup <I>groupID</I>?</H4>
+command returns the unique ID of the created record.<P><H4><A NAME="M8"></A> addressbook delete <I>recordID</I> ?-fromgroup <I>groupID</I>?</H4>
 This command removes the record with unique ID <I>recordID</I> from the
 database or from a particular subgroup specified by its unique ID with the
 <I>-fromgroup</I> option. Note that any changes made to the database won't
-be definitive until you invoke the <B>addressbook save</B> command.
-
-<H4><A NAME="M9"></A> addressbook export <I>personID</I></H4>
+be definitive until you invoke the <B>addressbook save</B> command.<P><H4><A NAME="M9"></A> addressbook export <I>personID</I></H4>
 This command lets you export the record with unique ID <I>personID</I> as
 a VCard. The result should be considered as binary data since it can
-contain an image associated to the record.
-
-<H4><A NAME="M10"></A> addressbook getme <I>varname</I></H4>
-This command retrieves all the data available in the database concerning
-the logged-in user ("Me") and stores it in the variable specified by
-the <I>varname</I> argument. The value of this variable takes the form of 
+contain an image associated to the record.<P><H4><A NAME="M10"></A> addressbook getme</H4>
+This command returns all the data available in the database concerning
+the logged-in user ("Me"). The returned value takes the form of 
 a keyed list: see the <B>addressbook record</B> command for a description 
 of this format. Keyed lists can be very easily manipulated with the 
-<B>keylget</B> and <B>keylset</B> commands defined in the TclX extension.
-
-<H4><A NAME="M11"></A> addressbook groups ?-ids? ?-ingroup <I>groupID</I>?</H4>
+<B>keylget</B> and <B>keylset</B> commands defined in the TclX extension.<P><H4><A NAME="M11"></A> addressbook groups ?-ids? ?-ingroup <I>groupID</I>?</H4>
 This command returns a list of all the existing group records: if no option
 is specified, it is a list whose elements are sublists made of two
 elements. The first element is the unique ID associated with the group and
 the second is its name. If the <I>-ids</I> argument is specified, the
 returned list will contain only the unique IDs of the groups. If the 
 <I>-ingroup</I> option is specified, only the subgroups contained in the group
-with ID <I>groupID</I> will be returned.
-
-<H4><A NAME="M12"></A> addressbook image <I>personID</I> ?<I>imageData</I>?</H4>
+with ID <I>groupID</I> will be returned.<P><H4><A NAME="M12"></A> addressbook image <I>personID</I> ?<I>imageData</I>?</H4>
 If no <I>imageData</I> argument is specified, this command returns the
 custom image associated with the record corresponding to the unique ID 
 <I>personID</I>. The returned bytes are binary data. If no image exists, it
 raises an error. If an <I>imageData</I> argument is specified, it should
 contain valid binary data defining an image which will be associated the
-record with unique ID <I>personID</I>.
-
-<H4><A NAME="M13"></A> addressbook import <I>vCardData</I></H4>
+record with unique ID <I>personID</I>.<P><H4><A NAME="M13"></A> addressbook import <I>vCardData</I></H4>
 This command imports data in VCard format. The data specified by the 
 <I>vCardData</I> argument must be valid data in VCard format: a new record is
 created in the database corresponding to the information contained in the
-VCard. Note that the data can be binary if the VCard contains an image.
-
-<H4><A NAME="M14"></A> addressbook parents ?-ids? <I>recordID</I></H4>
+VCard. Note that the data can be binary if the VCard contains an image.<P><H4><A NAME="M14"></A> addressbook parents ?-ids? <I>recordID</I></H4>
 This command returns a list of all the groups the record with unique ID 
 <I>recordID</I> belongs to. The elements of this list are sublists made of one
 or two items: the unique ID and, possibly, the name of the record if this
 field exists. If the <I>-ids</I> option is specified, only IDs are
-returned. 
-
-<H4><A NAME="M15"></A> addressbook persons ?-ids? ?-ingroup <I>groupID</I>?</H4>
+returned. <P><H4><A NAME="M15"></A> addressbook persons ?-ids? ?-ingroup <I>groupID</I>?</H4>
 This command returns a list of all the existing person records: if no
 option is specified, it is a list whose elements are sublists made of one
 or two items: the unique ID and, possibly, the name of the record if this
 field exists. If the <I>-ids</I> argument is specified, the returned list
 will contain only the unique IDs. If the <I>-ingroup</I> option is
 specified, only the members belonging to the group with ID <I>groupID</I>
-will be returned.
-
-<H4><A NAME="M16"></A> addressbook property names (-groups | -persons)</H4>
+will be returned.<P><H4><A NAME="M16"></A> addressbook property names (-groups | -persons)</H4>
 This command returns a list of all the properties defined in the database
 for group or person records. New properties can be created or removed with
-the <B>addressbook property add</B> and <B>addressbook property remove</B> commands.
-
-<H4><A NAME="M17"></A> addressbook property add (-groups | -persons) <I>propName</I> <I>propType</I></H4>
+the <B>addressbook property add</B> and <B>addressbook property remove</B> commands.<P><H4><A NAME="M17"></A> addressbook property add (-groups | -persons) <I>propName</I> <I>propType</I></H4>
 This command lets you add a new property to the database, either for person
 or for group records. The name of the new property is specified by the 
 <I>propName</I> argument: it must be unique. One can get the list of all the
@@ -163,22 +120,15 @@
 The type of the property is specified by the <I>propType</I> argument.
 This argument can have one of the following values: <I>Array, Data, Date,
 Dictionary, Integer, Real, String, MultiArray, MultiData, MultiDate,
-MultiDictionary, MultiInteger, MultiReal, MultiString.</I>
-
-<H4><A NAME="M18"></A> addressbook property remove (-groups | -persons) <I>propName</I></H4>
+MultiDictionary, MultiInteger, MultiReal, MultiString.</I><P><H4><A NAME="M18"></A> addressbook property remove (-groups | -persons) <I>propName</I></H4>
 This command lets you remove a property from the database, either for
 person or for group records. The name of the property is specified in the
 <I>propName</I> argument. One can get the list of all the existing
-properties with the <B>addressbook property names</B> command.
-
-<H4><A NAME="M19"></A> addressbook record <I>recordID varname</I></H4>
-This command retrieves all the data available in the database concerning
-the record with unique ID <I>recordID</I> and stores it in the variable
-specified by the <I>varname</I> argument.  The value of this variable
+properties with the <B>addressbook property names</B> command.<P><H4><A NAME="M19"></A> addressbook record <I>recordID</I></H4>
+This command returns all the data available in the database concerning
+the record with unique ID <I>recordID</I>.  The returned value
 takes the form of a keyed list: see the <B>addressbook record</B> command
-for a description of this format. Keyed lists can be very easily manipulated 
-with the <B>keylget</B> and <B>keylset</B> commands defined in the TclX 
-extension. One can also use the usual Tcl commands concerning lists.
+for a description of this format.
 <P> The format used for a particular 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
@@ -198,22 +148,19 @@
 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
 addresses: each address will be returned as a Label/Dictionary pair; the
-elements of the dictionary are pairs like {City Paris} or {CountryCode fr}.
-
-</UL>
+elements of the dictionary are pairs like {City Paris} or {CountryCode fr}.<P></UL>
 <P> Dates are returned as values suitable for use with the <B>clock
 format</B> Tcl command. It is the number of seconds relative to "Thu Jan 01
 00:00:00 CET 1970".
-
-<H4><A NAME="M20"></A> addressbook save</H4>
+<P> Note that keyed lists can be very easily manipulated 
+with the <B>keylget</B> and <B>keylset</B> commands defined in the TclX 
+extension. One can also use the usual Tcl commands concerning lists.<P><H4><A NAME="M20"></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
 delete</B> modify the data in memory: to make the changes definitive in the
 database, one must call explicitely the <B>addressbook save</B> command.
 To check whether there has been changes in the database, use the 
-<B>addressbook changed</B> command.
-
-<H4><A NAME="M21"></A> addressbook search ?(-groups | -persons)? ?-ids? ?-nocase? <I>property op value</I></H4>
+<B>addressbook changed</B> command.<P><H4><A NAME="M21"></A> addressbook search ?(-groups | -persons)? ?-ids? ?-nocase? <I>property op value</I></H4>
 This command returns all the records corresponding to the criterion 
 described by the last three arguments:
 <UL>
@@ -237,9 +184,7 @@
 	>=	Greater Than or Equal
 	^=	not applicable
 </PRE>
-The <TT>^=</TT> operator is not applicable (and will default to Greater Than or Equal).
-
-	<LI> For a string value, they correspond respectively to: 
+The <TT>^=</TT> operator is not applicable (and will default to Greater Than or Equal).<P>	<LI> For a string value, they correspond respectively to: 
 <PRE>
 	==	Equal
 	!=	Not Equal
@@ -249,36 +194,22 @@
 	>=	Contains Substring
 	^=	Prefix Match
 </PRE>
-The <TT>&lt;</TT> and <TT>&lt;=</TT> operators are not applicable and will both default to Equal.
-
-</UL>
-
-
-	<LI> <I>value</I> is the value property you are searching
-
-</UL>
+The <TT>&lt;</TT> and <TT>&lt;=</TT> operators are not applicable and will both default to Equal.<P></UL><P>	<LI> <I>value</I> is the value property you are searching<P></UL>
 <P> The <I>-groups</I> or <I>-persons</I> arguments let you specify the
 kind of records you want to search. If it is not specified, the default is
 <I>-person</I>. If the <I>-ids</I> option is specified, only IDs of the
 matching records are returned, rather than pairs made of the ID and the
 name. The <I>-nocase</I> argument concerns string comparisons and requires
-that no distinction be made between uppercase and lowercase letters.
-
-<H4><A NAME="M22"></A> addressbook set <I>recordID propertyName</I> ?<I>value</I>?</H4>
+that no distinction be made between uppercase and lowercase letters.<P><H4><A NAME="M22"></A> addressbook set <I>recordID propertyName</I> ?<I>value</I>?</H4>
 This command lets you get or set the value of a particular property for the
 record with unique ID <I>recordID</I>. If the <I>value</I> argument is
 not specified, it returns the current value of the property specified in
 the <I>propertyName</I> argument. If <I>value</I> is specified, the
 property <I>propertyName</I> will be set to this value. See the 
 <B>addressbook record</B> command for a description of the format used for the
-various kinds of properties.
-
-<H4><A NAME="M23"></A> addressbook type <I>recordID</I></H4>
+various kinds of properties.<P><H4><A NAME="M23"></A> addressbook type <I>recordID</I></H4>
 This command returns the type (ABPerson or ABGroup) of the record with 
-unique ID <I>recordID</I>.
-
-
-<H2><A NAME="M24"></A> INSTALLATION</H2>
+unique ID <I>recordID</I>.<P><H2><A NAME="M24"></A> INSTALLATION</H2>
 The extension is made of two files: the dynamic library (called
 addressbook1.0.dylib in version 1.0) and a file pkgIndex.tcl necessary for
 Tcl to be able to locate the extension upon request. Both files are
@@ -288,63 +219,25 @@
 <B>auto_path</B> Tcl variable. If you use the extension within the AlphaX
 editor (version 8.0b11 or greater), you can also install it in the 
 <I>Tclextensions</I> folder which is located at the same level as the
-application. 
-
-
-<H2><A NAME="M25"></A> VERSION HISTORY</H2>
+application. <P><H2><A NAME="M25"></A> VERSION HISTORY</H2>
 <UL>
-	<LI> 1.0 - 
-
-</UL>
-
-
-<H2><A NAME="M26"></A> REQUIREMENTS AND PORTABILITY</H2>
+	<LI> 1.0 - <P></UL><P><H2><A NAME="M26"></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
-in version 10.2 of the System (aka Jaguar).
-
-
-<H2><A NAME="M27"></A> KNOW ISSUES</H2>
+in version 10.2 of the System (aka Jaguar).<P><H2><A NAME="M27"></A> KNOW ISSUES</H2>
 Please e-mail any bug or problem you encounter: 
-<A HREF="mailto:bde...@us...">bde...@us...</A>
-
-
-<H2><A NAME="M28"></A> LICENSE AND DISCLAIMER</H2>
+<A HREF="mailto:bde...@us...">bde...@us...</A><P><H2><A NAME="M28"></A> LICENSE AND DISCLAIMER</H2>
 This software is free software and distributed under the same licensing terms 
-as the Tcl language itself. See license.terms in the Tcl distribution.
-
-<P> © Copyright Bernard Desgraupes 2003
-
-
-<H2><A NAME="M29"></A> SOURCE CODE</H2>
+as the Tcl language itself. See license.terms in the Tcl distribution.<P><P> © Copyright Bernard Desgraupes 2003<P><H2><A NAME="M29"></A> SOURCE CODE</H2>
 Tcladdressbook is an Open Source Project. Its source code is public and can 
 be found on the SourceForge site at the following address:
-<A HREF="http://sourceforge.net/projects/tcladdressbook">http://sourceforge.net/projects/tcladdressbook</A>
-
-<P> Tcladdressbook binary releases are available at
+<A HREF="http://sourceforge.net/projects/tcladdressbook">http://sourceforge.net/projects/tcladdressbook</A><P><P> Tcladdressbook binary releases are available at
 <A HREF="http://sourceforge.net/project/showfiles.php?group_id=96169">http://sourceforge.net/project/showfiles.php?group_id=96169</A> or on my web 
-page at <A HREF="http://webperso.easyconnect.fr/bdesgraupes/tcl.html">http://webperso.easyconnect.fr/bdesgraupes/tcl.html</A>
-
-<P> The code is under CVS control. You can retrieve the latest stage of 
+page at <A HREF="http://webperso.easyconnect.fr/bdesgraupes/tcl.html">http://webperso.easyconnect.fr/bdesgraupes/tcl.html</A><P><P> The code is under CVS control. You can retrieve the latest stage of 
 development using any CVS client. See instructions at:
-<A HREF="http://sourceforge.net/cvs/?group_id=96169">http://sourceforge.net/cvs/?group_id=96169</A>
-
-<P> You can also browse the cvs repository online at
-<A HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/tcladdressbook">http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/tcladdressbook</A> 
-
-
-<H2><A NAME="M30"></A> SEE ALSO</H2>
-The Mk4Tcl extension.
-
-<H2><A NAME="M31"></A> KEYWORDS</H2>
-Address book, data base
-
-
-
-
-
-
-
-
+<A HREF="http://sourceforge.net/cvs/?group_id=96169">http://sourceforge.net/cvs/?group_id=96169</A><P><P> You can also browse the cvs repository online at
+<A HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/tcladdressbook">http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/tcladdressbook</A> <P><H2><A NAME="M30"></A> SEE ALSO</H2>
+The Mk4Tcl extension.<P><H2><A NAME="M31"></A> KEYWORDS</H2>
+Address book, data base<P>
 </BODY>
 </HTML>




