dtcm_entry(special file)

NAME
dtcm_entry — format of calendar/appointment entry

DESCRIPTION

The calendar entry file format defines how one entry is saved to a file or used in a drag-and-drop transaction with another client. A grammar for the entry format is:
appt_file::=header_string entry_definition
::=T{
`n **Calendar Appointment
**&'
T}
entry_definition::=appt_def
`&' old_appt
|old_appt;
old_appt::=T{
date_mark start_mark end_mark
repeat_mark
T}
|duration_mark text_mark
date_mark::=` Date: ' date_value `&'
date_value::=Date as mm/ dd/ yyyy
start_mark::=` Start: ' start_value `&'
start_value::=T{
Entry begin time as hh:mm[ampm ], where hh and mm
represent two-digit hours and minutes and the optional ampm suffix is the string am or pm
T}
end_mark::=` End: ' end_value `&'
end_value::=Entry begin time as hh:mm[ampm ]
repeat_mark::=` Repeat: ' repeat_value `&'
repeat_value::=T{
`One Time' | `Daily' | `Weekly'
| `Every Two Weeks'
T}
|T{
`Monthly By Date' | `Yearly'
| `Monthly By Weekday'
T}
|T{
`Monday Thru Friday' | `Mon,
Wed, Fri' | `Tuesday, Thursday'
T}
duration_mark::=` For: ' duration_value `&'
duration_value::=T{
Integer that describes the number of repetitions.
T}
text_mark::=` What: ' text_value
text_value::=T{
Up to 5 lines of text. Each line after the
first must have a leading <tab> character.
T}
appt_def::=T{
appt_start_marker attr_list appt_end_marker
T}
attr_list::=attr_def att_list
|attr_def
appt_start_marker::=appt_marker
`:string:begin&'
appt_end_marker::=appt_marker
`:string:end&'
appt_marker::=T{
`-//CDE_XAPIA_PRIVATE/CS/API/ENTRYATTR//NONSGML
ApptDelimiter//EN'
T}
attr_def::=T{
attr_name
`:' attr_type `:' attr_value `&'
T}
attr_type::=`string' | `integer' | `reminder'
|T{
`accesslist' | `repeatdefinition'
| `custom'
T}
attr_name::=T{
XAPIA string. The span of characters that
can be used in the definition of an attribute name is specified in the CAE Specification, XAPIA Calendar API.
T}
tgroup dispwid="6.02in"Caret

An example entry:

        ** Calendar Appointment **
-//CDE_XAPIA_PRIVATE/CS/API/ENTRYATTR//NONSGML ApptDelimiter//EN:string:begin
-//XAPIA/CS/API/ENTRYATTR//NONSGML Start Date//EN:integer:775148400
-//XAPIA/CS/API/ENTRYATTR//NONSGML End Date//EN:integer:775148900
-//XAPIA/CS/API/ENTRYATTR//NONSGML Type//EN:string:CSA_TYPE_EVENT
-//CDE_XAPIA_PRIVATE/CS/API/ENTRYATTR//NONSGML Showtime//EN:integer:1
-//XAPIA/CS/API/ENTRYATTR//NONSGML Summary//EN:string:Foundation planning meeting
        in Hari's office
-//XAPIA/CS/API/ENTRYATTR//NONSGML Status//EN:integer:0
-//XAPIA/CS/API/ENTRYATTR//NONSGML Recurrence Rule//EN:string:M60 #12
-//XAPIA/CS/API/ENTRYATTR//NONSGML Audio Reminder//EN:reminder:-60:
-//XAPIA/CS/API/ENTRYATTR//NONSGML Flashing Reminder//EN:reminder:-60:
-//XAPIA/CS/API/ENTRYATTR//NONSGML Mail Reminder//EN:reminder:-1800:hseldon@trantor
-//XAPIA/CS/API/ENTRYATTR//NONSGML Popup Reminder//EN:reminder:300:
-//CDE_XAPIA_PRIVATE/CS/API/ENTRYATTR//NONSGML ApptDelimiter//EN:string:end
        Date: 7/25/1994
        Start:  8:00am
        End:  9:00am
        Repeat: Every Two Weeks, last
        For:26
        What: Foundation planning meeting
                in Hari's office

SEE ALSO

csa/csa.h - csacsa(5), csa_add_entry(3), csa_call_callbacks(3), csa_delete_calendar(3), csa_delete_entry(3), csa_free(3), csa_free_time_search(3), csa_list_calendar_attributes(3), csa_list_calendars(3), csa_list_entries(3), csa_list_entry_attributes(3), csa_list_entry_sequence(3), csa_logoff(3), csa_logon(3), csa_look_up(3), csa_query_configuration(3), csa_read_calendar_attributes(3), csa_read_entry_attributes(3), csa_read_next_reminder(3), csa_register_callback(3), csa_unregister_callback(3), csa_update_calendar_attributes(3), csa_update_entry_attributes(3).