KOrganizer documentation

[Ramon van Alteren]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi Carlos, and other kde-quality readers,

I've been travelling a lot by train lately and actually managed to get a 
reasonable amount of kde work done :)

Here's what I did:

Compiled kde-unstable on my laptop as a testing environment.
Reviewed the KOrganizer current stable docs while compiling.

I started a compare against the functionality of KOrganizer of KDE-3.2 stable 
and it's current docs. Swicthed to describing the current GUI-layout in 
kde-unstable because I found too many differences and couldn't see the sense 
in keeping both a stable-3.2 and unstable record since the entire kdepim 
module is on a slightly different release schedule anyway.

Compiled all findings in the attached text document. 

It mostly deals with changes in the lay-out of the configuration of 
KOrganizer.

I'd welcome any comments.
Is this usable for a doc-editor ?
Any tips fort future comparisons ? 

I've found the docs on documentation producing for KDE and I'm busy reading.
A lot has changed since the last documentation update on KOrganizer and  I 
figured it would be easier writing a draft for the new situation rather than 
describing what has changed. 

However I do have a normal day-job which takes a lot of my time so I would be 
very curious whether these desciptions are usable. A change set is fairly 
easy to produce in the travel-time on the train from and to work 
(Well actually that would be on the train-trip from work as I'm usually too 
sleepy to do any meaningfull work on the train-trip to work :)

I'm setting up a kolab environment BTW. Actually I'm looking at the compile 
output right now :) Once it's setup I'd be happy to provide anyone on the 
list with testing accounts for a demonstration domain. Is there a way to get 
a domain delegation from kde.org or should I just register one / use my 
default testing domain?

P.S> The power company in Amsterdam is doing a major upgrade of all powerlines 
into my house tomorrow. I don't expect to be online before thursday evening 
at least, the weekend at the very worst. If you want to mail me personally 
please do so at the ramon at vanalteren.nl address since I got backup MX records 
set up for that domain.

PS2> Is there anyone out there who would be willing to answer a lot of 
(probably) stupid questions on IRC about setting up a development environment 
and getting me started on the KOrganizer code sometime next week? I'm a 
fairly competent C++ programmer but I have absolutely no knowledge of the 
kde-libraries and how they should be used. I've looked at some QT-projects 
before but never got around coding something with the QT-framework. 
A little help would probably get me going.

Cheers Ramon
- -- 
ramon at vanalteren.nl
PGPkey id       0xF6B58AE57C02B1AE
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.3 (GNU/Linux)

iD8DBQFARSiw9rWK5XwCsa4RAirKAJ92qyIwqkKuH0CuL8/tFdzkhZo/wgCggNqs
y8hzGtDdfFqyVMOgHtM//y0=
=BWVr
-----END PGP SIGNATURE-----
-------------- next part --------------
Manual, help:/korganizer/reference.html#reference-windows-preferences

Chapter 3: Any links have been followed (Preferences window description and Configure toolbars detailed description)

Settings:Configure KOrganizer
If I open the menu in Kontact the windowstitle says Configure Kontact :)
If I open the menu in KOrganizer the windowtitle says Configure KOrganizer

Starting KOrganizer from the pager seems to open KMail for some reason.
This might be a kontact related bug/feature.

Settings:Configure KOrganizer -> Personal

KDE-32:	Holidays option is removed
	New option: Mailclient choose between KMail & Sendmail
	New option: Export to HTML with every save
	New option: New events/todos should (Be added to standard resource or ask which resource to use)

KDE-unstable:	New Option: Use Groupware Communication
		Same as KDE-32
		
Settings:Configure KOrganizer -> Time & Date

KDE-32:	Event has been renamed to appointment
	New option: working hours -> Daily start hour
				  -> Daily ending hour
	New option: Exclude holidays
	New option: Exclude Saturdays

KDE-unstable: Same as KDE-32
	
In the Settings:Configure KOrganizer sidebar Views has been moved to a position above Fonts

Settings:Configure KOrganizer -> Views

KDE-32:	New option: Days to show in next-X-days view
	New option: Hour size in schedule view (slider)
	New option: Enable scrolbars in month view cells
	New option: Month view uses full window
	New option: Month view uses category colors
	New option: To-do view uses full window
	New option: Show current time (Marcus Bains line)
	New option: Show seconds on Marcus Bains line
	New option: Time range selection in agenda view starts event editor
	
KDE-unstable: Same as KDE-32

Settings:Configure KOrganizer -> Fonts

KDE-32: New option: Marcus Bains Line
KDE-unstable: Same as KDE-32

Settings:Configure KOrganizer -> Colors

KDE-32: New option: The categories bar seems to be new. It allows you to choose 			a color based on the type of appointment.
KDE-unstable:	Same as KDE-32

Settings:Configure KOrganizer -> Printing

KDE-32: The entire category is gone from the preferences dialog
KDE-unstable: Same as KDE-32

Settings:Configure KOrganizer -> Group Scheduling

KDE-32: Scheduler mail client has been removed (it has been moved to Personal)

Settings:Configure KOrganizer -> Group Automation

KDE-32: New category offering the following options:
		Auto Send Refresh (Never, attendee in Adressbook, selected emails)
		Auto Insert IMIP Replies (Never, if Organizer is in addressbook)
		Auto Insert IMIP Requests (Never, if Organizer is in addressbook)
		Auto Send FreeBusy information (Never, if requested by email in addressbook)
		AutoSave FreeBusy Replies (Never, if attendee is in addressbook)

KDE-unstable:	Same as KDE-32

Settings:COnfigure KOrganizer -> Free/Busy

KDE-unstable: New category offering the following options:
		Publish Tab
			Option: Publish free/busy information automatically
			Spinbox: Minimum &time between uploads in minutes (default 5)
			Spinbox: Publish (default 60) days of free/busy information
			editbox: Server URL
			editbox: Username
			editbox: Password
			Option: Remember password
		Retrieve Tab:
			Option: Retrieve other peoples' free/busy information automatically
			editbox: Server URL
			editbox: Username
			editbox: Password
			Option: Remember password
Note: in my current unstablebuild (february 25) &-shortcut show up as & instead of shortcuts.
		
Settings:Configure KOrganizer -> OutGoing messages 
	Category has been removed
	
Settings:Configure KOrganizer -> Incoming messages 
	Category has been removed
	
Settings:Configure Toolbars
	<Merge> options seems to be new in KDE-32
	<Merge> no longer there in unstable (what's a <merge>??)
	
	The Orientation tab in the toolbars context menu offers a new option in KDE-unstable: Floating. The same behaviour seems to be archieved in KDE-32 by double-clicking on the toolbar handle.
	
Settings:Configure Shortcuts
	KDE-32 & KDE-unstable seem the same.

	
Chapter 4:

Edit event window (also showed for a new event) has new tabs:

KDE-32:		new tab Attachments
KDE-unstable: 	Same as KDE32
		New Tab Free/Busy
		
Edit Event: 
All TABS
			Button Load Template
			Button Save as Template 
			[OK, Apply, Cancel]


TAB: General
KDE-unstable Fields: 	Title
			Location
			Start date & time
			End date & time (duration is automatically calculated)
			checkbox No time associated
			Checkbox Reminder
				Editbox amount of units for the reminder
				Dropdown box for reminder units (minutes, hours, days)
				Play sound 
				Start program
			Dropdown: Show time as (Busy/Free)
			A large free edit field for notes 
			Button allowing user to select a predefined category
				Resulting subscreen allows the user to edit categories and allows user to select multiple categories.
			Drop downbox Access: (Public/Private/Confidential)
			
TAB: Attendees
KDE-unstable Fields:	Label Organizer: <emailadres>
			Button New allows a user to create a new attendee by filling the fields
				Name 
				Email
				Dropdown Role: (Participant, Optional participant, Observer, Chair)
				Dropdown Status: Needs Action, Accepted, Declined, Tentative, Delegated, Completed, In Process)
				Checkbox Request response
			Button Remove removes an attendent from the grid
			Button Select Addressee offers entries from addressbook to choose from.
			
TAB: Recurrence
KDE-unstable Fields:	Checkbox Enable recurrence (activates the tab)
			Label showing the appointment Start & End time/date + Duration
			
			Recurrence rule offers a radiobuttons for the type of recurrence (daily, weekly, montly, yearly)
			And a spinbox for the recur every <rule entry> This part of the screen changes depending on the type of recurrence.
			If the recurrence rule is set to daily it just shows the spinbox. If it says weekly it allows the user to select the weekday the event should reoccur on. Monthly offers choice between every <x>th day of the month or every <x>th <weekday>
			Yearly offers recur on daynr of <month> or daynr of the year.
			
			Recurrence Range shows the start date/time of the recurrence and allows choices between no ending date, end after <x> occurences or End by <date>
			
			Exceptions offers a date dropdown box to select dates when recurrence should not be applied. Dates can be managed with buttons add, change and delete

TAB: Attachments
KDE-unstable Fields:	This tab offers the posibility to add attachments to an event
			Attachmenst can be managed with Add, Edit, Remove & Show buttons. A Grid shows URI and MimeType of the attachment.

			
TAB: Free/Busy
KDE-unstable Fields:	Shows a label with the Organizer and something which looks 			like a gantt-view The appoinment time is highlighted.
			I'm assuming other attendees free/busy information will be showed here when connected with a groupware server. 
			The left side of the view is taken by a list of attendees.
			There is a dropdown box for the scale (Hour, Day, Week, Month & Automatic).
			There are buttons for Center on Start, Zoom to Fit, Pick date and Reload. The Pick date button just shows a warning saying that the appointment already has suitable start- & end dates.
			All other buttons seem to act as expected :)