Undo of Macros

OpenOffice.org (Later) Writer

Document - ID	Specification Owner	Last Change	Status
	Henning Brinkmann	11/03/03	draft
Conforms to	
Applies to	Writer
Task ID(s)	PCD Ease of Use 25, i53097
Category	feature

Abstract

If the user executes a macro start and end point are listed in the undo history.

i-Team Members

	Name	E-mail Address
User Experience	Mathias Müller-Prove /MMP	mprove@sun.com
Development	Henning Brinkmann /HB	Henning.Brinkmann@sun.com
Quality Assurance	Eric Saváry /ES	Eric.Savary@sun.com
Documentation	Frank Peters /FPE	fpe@sun.com
		mail to iTeam

Approved for Implementation

	Approved by	Date
User Experience	<Name>	<Date>
Development		
Quality Assurance		
Documentation		
String Review		

Document Change History

Rev. Level	Change	Initials	Date
draft		HB	09/30/03
	review	MMP	11/03/03
	created task i53097, target OOoLater	MMP	08/09/05

Contents

Glossary	1

1	Motivation	1

2	User Scenarios	1

3	Goals	1

4	Requirements and Dependencies	1

4.1	Requirements	1

4.2	Technical Dependencies	1

5	Competitive Analyses	1

6	Detailed Specification	1

6.1	Macros	1

6.2	Error Conditions	2

7	Future Tasks	2

8	Notes	2

9	References	2

Glossary

Term	Description
<Term 1>	

Motivation

User Scenarios

Goals

Requirements and Dependencies

Requirements

<State the requirement(s) of this feature here.>

Technical Dependencies

<Are there any technical dependencies for this feature? Does the implementation of this feature create any technical dependencies to other program parts?>

Competitive Analyses

<Describe or reference to solutions which are already on the market. Describe what is done well or what is done bad.>

Detailed Specification

Macros

The execution of macros will be indicated by events from the framework. A start event will mark the start of a macro's execution. An end event will mark the completion of a macro. For each start events and each end events an object will be generated in the undo stack. These entries are just markers and represent no change of the document. Thus they are not shown in the menu entries Edit→Undo, Edit→Redo and Edit→Repeat. On execution of an undo/redo/repeat they will be skipped.

Table 1 shows the representation of the required undo objects.

Action	String (see String list)	Comment
Start macro	STR_START_MACRO	$1 is replaced by the name of the started macro.
End macro	STR_END_MACRO	$1 is replaced by the name of the completed macro.

Table 1Representation of macro start/end

String list

Item	English	German	Comments
STR_START_MACRO	-- Macro started: $1 --	-- Makro gestartet: $1 --	
STR_END_MACRO	-- Macro completed: $1 --	-- Makro beendet: $1 --	

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

<If there are features which couldn't be implemented but have to be implemented in the future. State these in here with a description why the feature couldn't be implemented right now.>

Notes

MMP-1 Issue /high, ad 6.3 Macros: why don't we treat the execution of a macro as one step?

MMP-2 Issue /high ad 6.3 Macos: if we display these comments in the undo history, are the items diabled? The user should not be able to choose the comments. What are the lables for the steps in the macro. They can become very meaningless for the user if some Basic is executed.

References

<Give references to related documentation, such as engineering designs, technical specs, and other sources for related units. Also include links to documents that other sections in this spec need to refer to, such as user opinions usability test reports.>

Required - Give references to related documentation, such as engineering designs, technical specs, and other sources for related units. Also include links to documents that other sections in this spec need to refer to, such as user opinions usability test reports.

Undo of Macros

Page 2

http://specs.openoffice.org/writer/undo/Undo_Macros.sxw

Henning Brinkmann

2003-09-29T17:32:13

Matthias Müller-Prove