![[me]](../me/logo/logo.png)
organizer(3)
[Home]
[Commands]
[Variables]
[Macro-Dev]
[Glossary]
NAME
SYNOPSIS
DESCRIPTION
organizer is a calendar and address organizer, enabling notes to be stored against the calendar days; addresses may be archived into an address book.
organizer uses the MicroEmacs 2009 in-built registry to store information within a registry file called <username>.eof. organizer may be entered directly from the command line, or via the menu (via Tools).
organizer is displayed within a single osd dialog box, tab selections at the top of the window enable the different forms of information to be displayed. Navigation is typically performed using the mouse, where the mouse is absent then the TAB key may be used to move between the fields. The information presented is defined as follows:-
Month
Shows the calendar month, starting with the current month, the current day is hi-lighted and any notes that have been entered are displayed in the Notes entry box at the bottom of the page.
The default mode of operation is note entries for the current month, however specifying the <year> as the wild card '*' (star) enables annual events to be entered into the organizer. Annual events are automatically inserted into the calendar each year, typically used for birthdays etc.
The entry controls to the dialog are defined as follows:-
<-
Advances to the previous month.
->
Advances to the next month.
<Month>
A pull down dialog enabling month selection.
<year>
A text entry field specifying the current year as a 4 digit number. A value of * is the wild card year for specifying annual events.
Notes
A free form text entry box allowing a note to be attached to the currently selected day.
Save
Saves the entry back to file.
Month To Buffer
Dumps a view of the month to the currently active buffer, any notes are also dumped to the buffer.
Close
Week
Shows the calendar week in the current buffer, the days of the week are shown in a column ordering. Note that selection of the week is typically performed from the Month view, moving to the Week view (via the tab) selects the week appropriate to the previously selected day within the month view.
The entry controls on the dialog are defined as follows:-
<-
Advances to the previous week.
->
Advances to the next week.
<year>
A text entry field specifying the current year as a 4 digit number. The value of * for viewing and setting annual events is not valid in this view.
Notes
A free form text entry box allowing a note to be attached to the currently selected day.
<day>
Selecting a date in the day column changes the view to the Day view.
Save
Saves the entry back to file.
Week To Buffer
Dumps a view of the week to the currently active buffer, any notes are also dumped to the buffer.
Close
Note: The start day in the week view may be configured to commence on a day other than Sunday from the Setup tab.
Day
Shows an extended view of the notes attached to the current day, day selection is typically performed from the Month or Week views. The entry controls on the dialog are defined as follows:-
<-
Advances to the previous day.
->
Advances to the next day.
<year>
A text entry field specifying the current year as a 4 digit number. A value of * is the wild card year for specifying annual events.
<month>
A pull down dialog enabling month selection.
<day>
A text entry enabling the current day to be entered.
Notes
A free form text entry box allowing a note to be attached to the currently selected day.
Save
Saves the entry back to file.
Day To Buffer
Dumps a view of the day to the currently active buffer, any notes are printed in the buffer.
Close
Lists
The lists pane provides support for multiple list generation and manipulation. Each list consists of zero or more ordered items each of which has a text field in which the user can enter information.
Entry to the dialog is defined as follows:-
List
New
Lines Per Item
Sets the number of lines to use when displaying a list item.
New
Creates a new list item at the end of the current list.
Up
Moves the currently selected item (left click on the item number) up the list.
Down
Moves the currently selected item down the list.
Insert
Inserts a new list item before the currently selected item.
Delete
Deletes the currently selected item.
Save
Saves the entry back to file.
List To Buffer
Dumps a view of the list to the currently active buffer.
Close
Address
The address pane provides entry to the address book, enabling personal and business details to be retained against a single name, tabbed selection of Work or Home selects the information that is displayed. A search engine is provide to locate names within the database, and provision is made to save some text against a name. Entries in the database are, by default, organized by record number, sorting may be explicitly performed from the Sort button.
Entry to the dialog is defined as follows:-
<Record No>
The identity number of the record, a value of * denotes that this is a new record that is being inserted.
<<
Moves to the start of the database.
>>
Moves to the end of the database, showing record *, a new entry may be entered.
<
Moves to the previous record.
>
Moves to the next record.
Name
The name of the individual, entered as fore-name and surname.
Nickname
A pseudo name assigned to an individual.
Partner
Shown in the Home view only. The forename and surname of any partner.
Chld
Shown in the Home view only in the Extended Address Book Mode. The names of any children (up to 3).
DOB
Date of Birth, shown in the Home view only in the Extended Address Book Mode. The dates of birth of the parents, any children in addition to an anniversary date.
Company
Shown in the Work view only. The name of the company.
Address
The address of the individual/company.
Tel/Fax/Mobile
Telecommunication information.
Email/WWW/FTP
Electronic communication information.
Notes
Notes associated with the individual.
Save
Saves the address information to file.
Dup
Duplicates the currently selected address entry, creating a new record card. Typically used to construct a similar entry for a different individual.
Delete
Deletes the currently selected entry.
Addr to Buffer
Dumps the currently selected address to the current buffer.
Close
Find
find provides access to a search engine, enabling addresses to be located in the address book.
Search For
The string to search for.
In Field
Pull-down menu allowing the selection of the field to be searched in.
Match
Selects how strict the search should be; typically Any Part is used as this is the least in-exact search. The default mode is configured in the Setup tab.
Case/magic
Selects the search criteria. The default mode is configured in the Setup tab.
First
Finds the first record that matches the search criteria
Next
Finds the next record that matches the search criteria, from the currently displayed record.
Reverse
Searches in reverse order.
Close
Sort
sort provides a mechanism to re-sort the data base into a different order. The sort is performed on up to 3 different keys enabling conflicting primary sort fields to be resolved by the secondary sort criteria. The default sort order is <Record No>, <None>, <None>.
Sort Keys
The Primary, Secondary and Tertiary sort fields are selected by a pull down menu. The fields to be used for sorting are selected from the list.
Sort
Performs the sort, based on the settings of the Sort Keys.
Close
Setup
The setup pane configures a number of general settings of the organizer.
Current Organizer File
The full pathname of the organizer file. By default this is set to <userpath><userName>.eof and can be altered using
user-setup(3).
Change Name
Allows the displayed name of the month and the day to be modified.
First Day of the week
Selects the first day of the week, this sets the first day to be displayed in the Week view and the first column in the Month view.
Min New Year Days
The number of days that must appear in the first week of the New Year for the week to be considered week 1. Modifying the value of this field modifies the week number.
The Calendar section allows the wordy representation of the calendar date to be modified. Typically used to modify the names to the native language.
Change Month Name
Select the existing month representation from the left-hand box and type in a new selection into the right-hand box.
Change Week Day Name
As Change Month Name, enables the day of the week representation to be modified.
First Day Of The Week
Selects the first day that appears in the Week view.
Minimum Days of New Year in first week
Specifies the number of days that must appear in the first week of the New Year for the week to be designated as week 1. This value allows the week number to be aligned with the calender weeks of standard diaries. The default value is 7 days; but may be reduced to 5 or 6 for typical alignment.
The Address Book section allows the operation of the address book to be modified.
Use Extended Address Book
The extended address book allows additional information to be added to the personal address book. The extended information is limited to the amount of personal information attributed to an individual, including Date of Birth and Child information.
Import From File
The Import from file allows the address book to be imported from a file. The import data format is a single line per entry, comma , separated. The field order is defined as follows, the * entries indicate the Extended Address Book fields:-
Record No, First Name, Surname, Nick Name, Selected, Notes, Partner First Name, Partner Surname, Home Address, Home Telephone, Home Fax, Home Mobile, Home E-Mail, Home WWW Page, Home FTP Site, Work Company, Work Address, Work Telephone, Work Fax, Work Mobile, Work E-Mail, Work WWW Page, Work FTP Site, Date-Of-Birth*, Partner DOB*, Date-Of-Marriage*, Child1 Name*, Child1 DOB*, Child2 Name*, Child2 DOB*, Child3 Name*, Child3 DOB*.
Export To File
Exports the address book to a file, the address book is exported in the current sort order, with the fields defined as above. The exported address book may then be imported into a 3rd party package i.e. Microsoft Access, etc.
The Default Address Find Settings section defines the default search criteria used in the address book search function.
Whole/Start/Any Part
Radio buttons determine how the search is performed on the string.
- Whole matches the whole string exactly.
- Start matches the first part of the string only (i.e. Ab*).
- Any Part finds entries that include the search string at any position within the data base search field.
Case Insensitive
Checked, matches the strings regardless of case. (default).
Magic Mode
Allows magic strings to be included in the search string.
NOTES
organizer is a macro that is implemented in organiz*.emf files. Organizer uses
osd(2) to create and manage the dialogs.
The maximum size of a text note is 1024 characters.
With an new address is created it is added to the end of the address list regardless of the current sort criteria.
Organizer replaces the original Calendar utility.
SEE ALSO
(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12