Revision as of 19:49, 5 September 2009

Comments in impress and draw

Specification Status
Author	Christian Lippka
Last Change
Status (Help)	Preliminary

Abstract

This specification is about the collaboration feature to add 'Comments' to presentation and drawing documents. This feature is already available for writer and calc applications where it is currently called 'Notes'.

References

Reference Document	Check	Location (URL)
Prerequisites	[passed/failed]	n/a
Product Requirement, RFE, Issue ID (required)	available	issue 103139
Test case specification (required)	[available/not available]	<PLEASE ENTER LOCATION HERE>
IDL Specification	not available	There is currently no new API for this feature.
Software Specification Rules	n/a	n/a

Contacts

Role	Name	E-Mail Address
Developer	Christian Lippka	cl@openoffice.org
Quality Assurance	Wolfram Garten	wg@openoffice.org
Documentation	Uwe Fischer	ufi@openoffice.org
User Experience	Frank Loehmann	fl@openoffice.org

Detailed Specification

Comments in documents ease collaboration between multiple authors who edit the same document. Comments are text based remarks that are not considered part of the document contents but are used during the creation/editing of a document to transfer information between different authors. This feature was already part of the Writer and Calc application (called 'notes' there) and this specification is about adding this feature to the Impress and Draw application.

Use case

A the user Smith receives a document for review from user Doe. He finds an outdated product image on slide 4. He inserts a comment into slide for telling user Smith to update the product image and sends the document back to user Smith. User Smith opens the file send from user Doe and looks through the comments, finding the comment from user Doe and updates the image. He reply to the comment by user Smith and adds a remark that he is not sure if this is now the correct image. He sends the document to user Doe again who also checks the comments. After he verified that the image is indeed the correct one he deletes the comment and publishes the document.

User interface

Comments can be added to slides (or pages in draw) and master pages. The consist of a position on the page, the authors name, the last edit date and formatted text. If comments are visible, they will be presented by comment handles on the slide with the initials of the author and a running number. These handles have a context menu and when selected a popup window with more information of the comment will be shown. Only the text of comments by the current author (determined by the setting in tools/options/...?) can be changed. Comments from different authors can only be deleted, moved or replaced with a reply.

Commands

insert comment

This command inserts a new comment into the current page and instantly lets the user edit the comments text. It is enabled if the current page is either a slide (drawing page in draw) or a master page. It is not enabled for notes pages, notes master, handout master, outline view and slidesorter view.

show comments

This command switches the visibility of comments. If checked, comment handles will be visible on pages. If unchecked, comment handles will not be visible. This setting will be saved at the application.

delete comment

This command deletes the currently selected comment. This command is disabled if there is no comment selected or if the document is read only.

delete all comments

This command deletes all comment in the document. This command is disabled if there are no comments or if the document is read only.

delete all commenty by author

This command deletes all comments by the author of the currently selected comment. This command is disabled if there is no comment selected or if the document is read only.

reply to comment

This comment replaced a selected comment from a author that is not the current author with a new comment from the current author. The name of the previous author including the last edit date and the text is added to the new comment and pre formatted with italic set. This command is disabled if there is no comment from another author selected or the if document is read only.

show next comment

This comment selects the next comment. It starts searching from the current slide. If it reaches the end of the document, a query box is opened to ask the user if he wants to continue on the beginning of the document. This command is disabled if there are not comments in the document.

show previus comment

This comment selects the previous comment. It starts searching from the current slide. If it reaches the beginning of the doucment, a query box is opened to ask the user if he wants to continue from the end of the document. This command is disabled if there are not comments in the document.

"View", Menu

Item	Sub Item	Sub Item	KBD Shortcut	Icon	Comment
...
Guides
Comments			c	yes	Toggles command "show comments"
"Seperator"
...

"Insert", Menu

Item	Sub Item	Sub Item	KBD Shortcut	Icon	Comment
...
Fields
Comment			c	yes	Executes command "insert comment"
Special Character...
...

Review toolbar

A "Review" toolbar will be added that is initially not visible and it will be shown in the "view/toolbars" menu.

Help | User Interface Element Templates | Example Spec

Migration

Configuration

File Format

Open Issues

@@ Line 61: / Line 61: @@
 | Frank Loehmann
 | fl@openoffice.org
-|-
-|}
-== Acronyms and Abbreviations ==
-{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0;  border: 1px #cccccc solid; border-collapse: collapse; width: 100%"
-|-
-| bgcolor="#dddddd" | '''Acronym / Abbreviation''' || bgcolor="#dddddd" | '''Definition'''
-|-
-| <WYSIWYG>
-| <What You See Is What You Get>
 |-
 |}
@@ Line 146: / Line 136: @@
 |
 | c
-| none
+| yes
 | Toggles command "show comments"
 |-
@@ Line 180: / Line 170: @@
 |
 |
-| e
+|
-| none
+|
-| Inserts a text field that shows the current date.
+|
 |-
 | Comment
@@ Line 188: / Line 178: @@
 |
 | c
-| none
+| yes
 | Executes command "insert comment"
 |-

Difference between revisions of "Impress/Features/Comments"