Configure Events Specification

OpenOffice.org 2.0

Document - ID	Specification Owner	Last Change	Status
	Duncan Foster	June 28, 2004	Final
Conforms to	
Applies to	Every module of OpenOffice.org
Task ID(s)	
Category	Feature

Abstract

The usability of the Events tab of the Tools/Customize (formerly Tools/Configure) dialog is being improved to make it easier for users to create event bindings and align this tab with usability changes in the other tabs.

i-Team Members (The specification owner is part of the i-Team)

	Name	E-mail Address
User Experience	Christian Jansen	Christian.jansen@sun.com
Development	Duncan Foster	Duncan.Foster@Sun.COM
Quality Assurance	Thorsten Martens	Thorsten.Martens@sun.com
Documentation	Uwe Fischer	uwe.fischer@sun.com

Approved for Implementation

	Approved by	Date
User Experience	Christian Jansen	2nd July 2004
Development	Duncan Foster	2nd July 2004
Quality Assurance	Thorsten Martens	2nd July 2004
Documentation	Uwe Fischer	2nd July 2004
String Review		

Document Change History

Rev. Level	Change	Initials	Date
0.1	Initial draft	DF	May 13, 2004
0.2	Revised after comments from CJ	DF	June 11, 2004
0.3	Revised after comments from CJ	DF	June 28, 2004

Contents

Glossary	1

1	Motivation	1

2	User Scenarios	1

3	Goals	2

4	Requirements and Dependencies	2

4.1	Requirements	2

4.2	Technical Dependencies	2

5	Competitive Analyses	2

6	Detailed Specification	2

7.1	Error Conditions	3

8	Future Tasks	3

9	Notes	3

10	References	4

Glossary

Term	Description
Macro	A piece of code that can be written, tested, and executed within OpenOffice.org.
Assignment	The association of a builtin function, script or macro with a menu item, key combination, toolbar icon or event.
Scripting Framework	A framework provided by OpenOffice.org for the execution of code written in different languages such as Basic, Java, JavaScript, BeanShell and Python

Motivation

A number of problems have been identified with the usability of the Tools/Customize dialog. Also scripts available for execution via the Scripting Framework need to be presented to the user in the Tools/Customize dialog. The Events tab needs to be aligned with the changes being made in the other tabs.

User Scenarios

Company A wishes to remind users that the default document format will be changing from Microsoft Office formats to OpenOfrfice.org formats. They write a macro to display this reminder, and bind it to the “Start Application” event. This binding applies to all documents.

Figure 1The existing Events tab. Company B wishes to track the viewing of a certain document. They write a macro to update a database each time it is run, and bind this macro to the “open Document” event. This binding applies only to the given document.

Goals

The goals of redesigning the tab are:

Consistency with other tabs in the Tools/Customize dialog.

Add support for creating assignments to scripts supported by the Scripting Framework.

All of the functionality of the Tools/Customize dialog must be keyboard accessible.

Requirements and Dependencies

Requirements

The current Events tab can be seen in Figure 1. The specification for the redesign of the
Tools/Customize Menu tab can be found at the following URL:
http://specs.openoffice.org/appwide/menus/customize_menu_spec.sxw
the specification for the new Macro Selector dialog can be found at the following URL:
http://specs.openoffice.org/scripting_framework/MacroSelectorSpecification.sxw

Technical Dependencies

The Scripting Framework needs to be available, and StarBasic need to be integrated with the framework.

The Configuration API needs to be implemented.

Competitive Analyses

Detailed Specification

As in previous versions of OpenOffice.org, the events tab is part of the Customize dialog which is accessed from the Tools/Customize menu item. The two Macros listboxes have been removed from the dialog, and the Events listbox expanded to fill the available space. A mockup of the new dialog is shown in Figure 2.

The User should first select the location in which they which to save an event binding. This is done using the “Save In” listbox. This will contain the name of the current document (initially selected on opening the tabpage) and %PRODUCTNAME. The user then selects the event to which they wish to bind a macro and presses the “Assign Macro” button which will launch the Macro Selector (it can also be launched by double-clicking the event name). The User selects the desired macro and clicks OK. The main listbox is updated to show the URL of the selected macro.

All bindings are saved when the User clicks the OK button. Clicking the Cancel button will ignore all changes made since the dialog was opened. Click the Reset button will clear all application and document bindings.

Figure 2A mockup of the new Event tabpage.

String list

Item	English	German	Comments
Tabpage Label	Events		
Text Label	Event		
Text Label	Assigned macro		
Button	~Assign Macro		
Button	Remove ~Macro		
Text Label	Save In		
Button	OK		
Button	Cancel		
Button	Help		
Button	Reset		

Error Conditions

<List all error conditions, and the action the system takes about them. If an alert box comes up, which kind is it? Include exact text of messages, or say what points need to be covered. Error Messages need a string list>

Future Tasks

Notes

What should be the dimensions of the Events listbox? Just large enough to display the current list of events?

References

Macro Selector Specification
http://specs.openoffice.org/scripting_framework/MacroSelectorSpecification.sxw

Customize Toolbars Specification
http://specs.openoffice.org/ui_in_general/toolbars/openoffice_org_toolbar_spec.sxw

Customize Menu

Page 4

http://specs.openoffice.org/appwide/menus/customize_events_spec.sxw

Christian Jansen

2004-01-16T15:58:26