tcPhonebook 0.9.4.0
Simple phone book
File system plugin for Total Commander 32 bit
© Maximus's Solutions 2010-2012
http://maximus.in.ua


Contents
Description
Installation
Using
Control
Configuration
Contact editing/creating
Contact viewing
Database
Custom columns
Version history


Description
Displays as user-defined structure and allows to manipulate the phone book contacts directly in the file window of Total Commander.
Each record can contains information about the contact person (name, birthday), data on place of work (post, organization, contacts, address), personal data (contacts, address), other data (contacts, address), and note.
Allows you to import/export contacts in vCard format (file format standard for electronic business cards) in next encodings: ANSI, UTF-8 (import/export) and Quoted-printable (import only); supports work with files that contain multiple contacts.
Has multilingual interface (Chinese, Danish, English, German, Russian, Swedish, Ukrainian).
Supported OS: Windows 7 / Vista / XP / 2000.


Installation
Automatic
  1. Enter in the archive with the plugin (Ctrl+PgDn) and Total Commander will ask you to install it
  2. Follow the instructions of Total Commander
Manual
  1. Unpack the contents of the archive to a separate directory
  2. Install plugin:
    • {Configuration → Options... → Plugins → File system plugins → Configure}
    • Add tcPhonebook.wfx to the list of plugins

Using
You can use this plugin, like any WFX-plugin, from file window in Total Commander after switching to the «Network Neighborhood» with the appropriate button on the drive bar, or by selecting the appropriate item in the drive selection list (Alt+F1, Alt+F2).

→

Control
Actions
The list of actions available for manage contacts in the file windows of Total Commander:

Action
Method
Create contact Starting the service element Create contact or executing internal command create
Create folder Key F7
Edit contact Key combination Alt+Enter
View contact Key Enter or double click
Copy folder or contact Key F5 (assuming that in the opposite file window also tcPhonebook is opened)
Export folder or contact Key F5 (assuming that in the opposite file window real filesystem displaying)
Export all contacts in one file Starting the service element Export all in one file in the plugin root directory, executing internal command export all or copying of this element to the real filesystem
Import folder or contact Key F5 in the real filesystem (assuming that in the opposite file window tcPhonebook is opened)
Copy folder in the same folder with rename Key combination Shift+F5
Rename folder or contact Key combination Shift+F6
Move folder or contact Key F6
Delete folder or contact Key Delete
Open plugin configuration dialog Starting the service element Configuration in the plugin root directory, executing internal command config, key combination Alt+Enter on item with plugin name (Phonebook) in «Network Neighborhood» or Alt+Enter on element [..] in any directory of the plugin file system

Note: In the table for each action specified one or several ways to perform it. You can use this or any other method that provides an interface of Total Commander.

Service elements and internal commands
Service elements of plugin filesystem displayed in the Total Commander file windows, as files with names beginning with symbol # (symbol can be redefined). To perform the task for which the service element is intended, just run it by double clicking or by pressing Enter.
Internal commands of plugin you can use in the Total Commander command line. To perform an internal command, input its name and press Enter.
The following is a list of service elements and their corresponding internal commands:

Service element
Internal command
Appointment
Configuration config Opens main configuration dialog
Create contact create Opens dialog «Create new contact». Displayed only in the plugin root directory
E-mail to selected email Creates a new e-mail letter (in the default mail program) to all address, which is contained in the selected contacts. This action can be performed for files-contacts, but not for folders
Export all in one file export all Exports all contacts in one file in vCard format after request file name and location in the standard system dialog. Copy of the service element in the real file system performs the same action, but through Total Commander dialog.

Note: By default, all service elements are displayed in the plugin filesystem. Disable unclaimed elements you can in the main configuration dialog.

Configuration
Main configuration dialog
You can open plugin configuration dialog, for sample, with key combination Alt+Enter on item with plugin name (Phonebook) in «Network Neighborhood» or by using the service element Configuration in the plugin root directory. Appointment of dialog elements:

Element
Appointment
Display
Group «Display»
Button «Change font» Opens standard system dialog «Font», where you can select the font to be used for displaying text in windows of tcPhonebook
Button «Appearance» Opens dialog for configuring appearance of text and background for window «View contact»
Button «Full name format» Opens dialog which allows you to change format for displaying full name of contact in the Total Commander file windows and in the field «Full name» in windows «View contact» and «Edit contact»
Option «Show .vcf extension with contacts» Enables/disables displaying of file extensions .vcf with contacts in file windows of Total Commander
Group «Show service elements»
Options Enables/disables displaying of an appropriate service element in the plugin file system
Export / Import
Group «Export» (See more details about vCard format file and appointment of its properties)
Option «Export vCard in UTF-8 encoding» Enables/disables to export vCard-file properties in UTF-8 encoding
Option «Export «N» property» Enables/disables to include in the resulting vCard-file property «N» (structured representation of the name) when you exports contact. Disabling of this option may be needed if the exported file, for example, is for a phone that not correctly handle property «N». The name will be defined by property «FN» (formatted name string), if property «N» is not included in the file
Option «Combine «First name» and «Middle name» into one field» If option enabled, then when exporting the property «N» the fields «First name» and «Middle name» will be combined into one string separated by space and put in the resulting file at the place of field «Name». Enabling this option may be needed if the exported file is intended, for example, for a device that does not display the field «Middle name»
Option «Export «LABEL» property» Enables/disables to include in the resulting vCard-file property «LABEL» when you exports contact. Disabling of this option may be needed if the exported file, for example, is for a program which for a program that ignores property «ADR» in the presence of property «LABEL»
Option «Date export format» Specifies the form in which dates will be included in the resulting vCard-file, for example, «BDAY» property (birthday). If you choose the basic format, the date will be presented in the form YYYYMMDD, if extended – YYYY-MM-DD. Use this option, if program, for which exported file is intended, works with one type of date only
Group «Import» (See more details about vCard format file and appointment of its properties)
Option «Contact name source» If this option is set to «Name of source file» then file-contact name will be the same as that of the imported vCard-File, and if option is set to «vCard-properties of source file» the file-contact name will be generated by content of vCard-file properties («N» or «FN»)
Option «Assume property text to be UTF-8 if encoding is not specified» It is intended to make it possible to import the vCard attributes correctly if they are encoded in the UTF-8, but this is not explicitly specified by string «CHARSET=UTF-8». This situation is possible as a result of incorrect forming vCard-file by another program or device.
Possible option values:
  • «Never». Option disabled
  • «If at least one property in UTF-8 is present». Property without specifying the encoding will be assumed as a text in UTF-8, if at least one property of the contact has an explicit specifying of the encoding UTF-8
  • «Always». Any property without specifying the encoding will be assumed as a text in UTF-8
Language
Dropdown list «Language» Allows you to select tcPhonebook interface language
Button «//» Opens language file corresponding to the selected language in a text editor
 
Button «Help» Opens this help file
Button «OK» Saves configuration and closes dialog
Button «Cancel» Discards any changes and closes dialog

Configuration using file tcPhonebook.ini
Most parameters can be set using the main configuration dialog, but some settings can be changed only editing the file tcPhonebook.ini, which is contained in the plugin installation folder.
When plugin is unloaded, open the file tcPhonebook.ini with any text editor that supports UTF-8 encoding (such as Notepad), make the necessary changes and save the file.
This way you can specify the following additional parameters:

Section
Key
Appointment
Examples
[Program] Browser
Sets the browser, which will open the help file by pressing key F1 or button «Help» in the plugin windows. If this key is not specified, will be used browser defined in OS by default.
  • Use Total Commander internal file Lister, file will be opened in the current copy of Total Commander with HTML mode and without following internal link (Lister support internal links in the command line only from Total Commander 8.0):
    Browser=%COMMANDER_PATH%\TOTALCMD.EXE
    BrowserParams=/O /S=L:T5 %0
  • Use browser Mozilla Firefox, file will be opened in a new window of browser and scrolled to the right place in the file, depending help calling context (following internal link):
    Browser=C:\Program Files\Mozilla Firefox\firefox.exe
    BrowserParams=-new-window %1
BrowserParams
Specifies browser command-line. Use the special characters %0 (inserts full name of the help file; for browsers that do not support internal links in the command line) or %1 (inserts full name of the help file with internal link to scroll to the appropriate help section).
[Display] ShowPostalCodeBeforeRegion
Specifies placement of the field «Postal code» when viewing, editing and exporting contacts. If the key value is equal to 1, field «Postal code» will be displayed before the field «Region», otherwise – after. By default (ie if the key is missing), the value is equal to 0.
 
ServiceItemSign
Sets the string-sign with which the name of service elements of plugin filesystem will begin.
Important note: Keep in mind that if this line was changed, the previously created folders and contacts that contain the specified string in the beginning of the name will be mistakenly considered as service elements. Be careful!
Note: Underscore symbol _ is forbidden to use and will be replaced by the symbol #.
Examples displaying service element Configuration depending on the key value:
  • Key is not exists. Will be used default string:
    # Configuration
  • Empty key (ServiceItemSign=). Element name will start with space:
     Configuration
  • Any string (ServiceItemSign=!!!). Element name will start with specified string:
    !!! Configuration

Customize appearance
Dialog «Appearance» can be opened from plugin configuration dialog or from viewing contact window. The dialog is intended to change the display of such items of viewing contact window, as «Fields group name», «Field name» and «Field name» and allows them to set font, size, style, alignment, text color and background color. Also here you can set the background color of unused area and color of grid of contact list.
To change settings, select from the appropriate dropdown listbox element of viewing contact window and set the values you need. To copy/paste formats use the context menu that can be called by right clicking on the area, which contains the formatting options.

Configuring of the full name format
Dialog «Full name format» can be opened from plugin configuration dialog. This dialog allows you to define the order of the full name components (Title, First name, Middle name, Last name, Suffix, Nickname) when they are displayed in the Total Commander file windows (column «Name») and in the dialogs «View contact» and «Edit contact» (field «Full name»). Also in the format string, you can specify additional characters or words: for example, comma before the suffix or «aka» before the nickname.
To insert name component should be used special characters: %P (Title), %F (First name), %M (Middle name), %L (Last name), %S (Suffix), %N (Nickname). Also in the string can be used square brackets – substring enclosed in square brackets will not be displayed if all the components (that are responsible special symbols within the brackets) are empty.
Example
In the properties of contact the components of name are filled as follows: Title Mr., First name John, Middle name III, Last name Smith, Suffix Dr., Nickname Johnny-3.
Configured the following format of full name: %P[ %F][ %M][ %L][, %S][ aka %N].
Then the full name will be displayed as Mr. John III Smith, Dr. aka Johnny-3.
If the component «Suffix» is not filled, then the full name will be displayed as Mr. John III Smith aka Johnny-3.

Contact editing/creating. Windows «Edit contact» and «Create new contact».
This window can be opened in creation mode with service element Create contact, which is present in each folder of plugin file system, – run it like a usual file by double clicking or pressing Enter. Also open this window to create a new contact can be done from the Total Commander command line with internal command create.
To open window in edit mode, use the key combination Alt+Enter or the context menu of a contact in the file window – item «Properties».
Window for editing/creating contact contains the following tabs:
On the «Summary» tab in the corresponding drop-down list, you can select preferred address E-mail, from among all addresses contained on all tabs of this dialog. This address will appear as separate line in the window «View contact» in field group «Summary».
Note: When editing fields on the «Summary» tab their content is transferred into the corresponding fields of other tabs, and vice versa.
Note: Field «Note» can contain multiple lines, but when exporting line breaks will be replaced by spaces.
Also in this window you can specify an arbitrary file name of contact, that will be displayed in the Total Commander file windows, or you can check option «File name as «Full name»», which will allow to use the field «Full name» as the file name of contact.

Special field editor
This editor allows you to edit fields that may contain more than one value (Phone, Mobile phone, Fax, E-mail, Web page). Use the button «...» which is located right near the fields in the dialogs «Create new contact» and «Edit contact».
When you open an editor field contents will be divided into single values (comma is separator of values inside the field) and displayed in a list. To the list you can add new, edit and delete existing values. Upon completion of editing, click «OK» and all the values ​​contained in the list will be combined into one string separated by commas and moved to field for which was opened editor.

Contact viewing. Window «View contact».
Window for viewing contact details can be opened by pressing Enter or by double-clicking on file-contact in the Total Commander file window.
Content of contact fields presented in a list, whose rows are divided into groups in accordance with the tabs in window «Edit contact». Empty fields are not displayed in the list. The contents of each fields group can be hidden/displayed by double-clicking or using arrow keys right/left on the group name row or by single-clicking on triangle to the left of group name.
For some fields, you can perform specific actions according to their type. Action can be done by double-clicking on the name (not the contents) of the field or with hotkey F3. Supports the following actions:
In view contact window is available quick editing of field content – just do double-clicking on the contents (not the name) of field you want to edit, or use hotkey F2. To finish editing, press Enter, to cancel, press Esc or click the left mouse button elsewhere in the list. Keep in mind that the summary fields (Full name, Phone (all), Mobile phone (all), E-mail (all)) are not available for editing. To delete field, remove all text (for «Birthday» disable checkbox near the date) and press Enter. Important note: Any changes made in this window are applied immediately – cancel is not provided.
Button «Edit contact» or hotkey F4 opens dialog «Edit contact».
Button «Customize appearance» opens dialog where you can customize the appearance of text and background elements of the list in this window.

Database
File system of plugin (files-contacts and folders) stored in the file tcPhonebook.db (SQLite database in UTF-8 encoding).
Each time you update the plugin to the next version, the first time you run it, will be backed up database file. Backup files are placed next to the file of the working database, and their names have extension dbbak and contain information about version of database and backup time.

Custom columns
The plugin supports custom columns.
A set of custom columns by default contains the fields that display the basic contact information: Name, All phones, Post, Organization, Locality (work).
Change the current set of columns can be using the context menu of tabstop header, item «Configure this custom columns view...».
Add new or delete an existing columns view may be using the context menu of tabstop header, item «Configure custom columns...» or with the main Total Commander configuration dialog on page «Custom columns».
To switch between columns views can be using the context menu of tabstop header by selecting an item corresponding to the required view.
Note: Custom columns are part of the Total Commander interface. Details are provided in help for Total Commander.

Color scheme
Using Total Commander interface you can specify a color for the service elements (e.g., Create contact) of plugin file system:

Version history
[0.9.4.0] [25 Sep 2012] [0.9.3.6] [06 Jul 2012] [0.9.3.5] [12 Jun 2012] [0.9.3.4] [25 Apr 2012] [0.9.3.3] [06 May 2012] [0.9.3.2a] [25 Apr 2012] [0.9.3.2] [24 Apr 2012] [0.9.3.0] [17 Feb 2012] [0.9.2.6] [23 Nov 2011] [0.9.2.5] [28 Oct 2011] [0.9.2.0] [09 Sep 2011] [0.9.1.0] [28 Jun 2011] [0.9.0.3] [14 Jun 2011] [0.9.0.2] [13 Jun 2011] [0.9.0.0] [12 Jun 2011] [0.8.7.0] [20 Apr 2011] [0.8.6.5] [16 Mar 2011] [0.8.5.0] [25 Feb 2011] [0.8.1.0] [28 Jan 2011] [0.8.0.0] [27 Jan 2011] [0.7.5.0] [05 Jan 2011] [0.7.0.0] [30 Dec 2010]