[Tcladdressbook-commits] Help TclAddressBookHelp,1.12,1.13
Status: Alpha
Brought to you by:
bdesgraupes
Menu
▾
▴
[Tcladdressbook-commits] Help TclAddressBookHelp,1.12,1.13
|
From: <bde...@pr...> - 2004-01-26 23:09:28
|
Update of /cvsroot/tcladdressbook/Help In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19529/Help Modified Files: TclAddressBookHelp Log Message: Update for 1.0b1 release Index: TclAddressBookHelp =================================================================== RCS file: /cvsroot/tcladdressbook/Help/TclAddressBookHelp,v retrieving revision 1.12 retrieving revision 1.13 diff -u -d -r1.12 -r1.13 --- TclAddressBookHelp 6 Jan 2004 06:58:51 -0000 1.12 +++ TclAddressBookHelp 26 Jan 2004 23:08:17 -0000 1.13 @@ -1,6 +1,5 @@ -Title: Tcladdressbook Help -Project: addressbook extension for Tcl -Modified: 2004-01-05 06:42:28 + + Abstract @@ -37,24 +36,21 @@ 6. VERSION HISTORY 7. REQUIREMENTS AND PORTABILITY 8. KNOW ISSUES - 9. LICENSE AND DISCLAIMER - 10. SOURCE CODE - 11. CONTRIBUTIONS + 9. SOURCE CODE + 10. CONTRIBUTIONS + 11. LICENSE AND DISCLAIMER 12. SEE ALSO 13. KEYWORDS - - =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- + 1. NAME addressbook - manipulate the Macintosh OSX Address Book database 2. SYNOPSIS - - package require addressbook - addressbook subcommand ?arg arg ...? - +package require addressbook +addressbook subcommand ?arg arg...? 3. INTRODUCTION @@ -173,17 +169,16 @@ 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 multivalue, the returned value is a keyed list itself. Each element of the list corresponds to a single property. For instance: - - the elements of a MultiString or MultiDate value list are two-elements + the elements of a MultiString or MultiDate 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. - the elements of a MultiDictionary value list are lists themselves, + the elements of a MultiDictionary 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 @@ -194,10 +189,10 @@ 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. @@ -212,18 +207,16 @@ addressbook search ?(-groups | -persons)? ?-ids? ?-nocase? property op value This command returns all the records corresponding to the criterion described by the last three arguments: + property is the name of the property you are searching on. - property is the name of the property you are searching on. - - op is an operator specifying the type of comparison. It can be + op is an operator specifying the type of comparison. It can be one of the following symbols: ==, !=, <, <=, >, >=, ^= which may have different interpretations depending on whether the value is numeric or is a string. - - For a numeric value, they correspond respectively to: + For a numeric value, they correspond respectively to: == Equal != Not Equal @@ -235,7 +228,7 @@ The ^= operator is not applicable (and will default to Greater Than or Equal). - For a string value, they correspond respectively to: + For a string value, they correspond respectively to: == Equal != Not Equal @@ -248,7 +241,7 @@ The < and <= operators are not applicable and will both default to Equal. - value is the value you are searching for. In the case of + the argument value is the value you are searching for. In the case of 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 @@ -259,17 +252,17 @@ {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. @@ -302,8 +295,7 @@ 6. VERSION HISTORY - - 1.0 - - + 1.0b1 -- 2004/01/25 -- First public release. @@ -314,42 +306,43 @@ 8. KNOW ISSUES +Tcladdressbook was written by Bernard Desgraupes. Please e-mail any bug or problem you encounter: <bde...@us...> -9. LICENSE AND DISCLAIMER -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 - - -10. SOURCE CODE +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> - 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> +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> - 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> - You can also browse the cvs repository online at +You can also browse the cvs repository online at <http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/tcladdressbook> -11. CONTRIBUTIONS +10. CONTRIBUTIONS Code contributions (Tcl scripts making use of the Tcladdressbook extension) are very welcome. There is a "Contribs" directory in the Tcladdressbook project on SourceForge for code contributions. They must be free software, distributed under an Open Source license acceptable by the SourceForge site (for instance, the same licensing terms as the Tcl language itself). +11. LICENSE AND DISCLAIMER +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 + 12. SEE ALSO -See the TclX extension for keyed lists. See the Mk4Tcl extension for +See the TclX extension for keyed lists: TclX(n). See the Mk4Tcl extension for commands to open directly the database file. 13. KEYWORDS @@ -357,7 +350,7 @@ ---------------------------------------------------------------------- - Last updated 2004-01-06 07:36:29 +Last updated 2004-01-24 13:25:56 |
