Adjusted text wrapping

MS-Interoperability

Document - ID	Specification Owner	Last Change	Status
	Hans-Peter Burow	04/27/04	Almost Final
Conforms to	
Applies to	OpenOffice.org Writer
Task ID(s)	116133 – Specification 116134 – String review i28008 – User interface for the compatibility option 108724 - Page header/footer content and footnote/endnote content doesn't have to wrap around floating screen objects. i13832, i24135 – Body content has to wrap around floating screen objects, which are anchored in page header.
Category	Feature

Abstract

Change the positioning of floating screen objects controlled by a compatibility option to meet the requirements of the interoperability to MS Word. The adjustment affects the determination of the paragraph top for the positioning of floating screen objects.

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

	Name	E-mail Address
User Experience	Falko Tesch (FT)	falko.tesch@sun.com
Development	Frank Meies (FME)	frank.meies@sun.com
Quality Assurance	Michael Rüß (MRU)	michael.ruess@sun.com
Documentation	Uwe Fischer (UFI)	uwe.fischer@sun.com

Approved for Implementation

	Approved by	Date
User Experience	Falko Tesch (FT)	04/27/04
Development	Frank Meies (FME)	04/27/04
Quality Assurance	Michael Rüß (MRU)	04/27/04
Documentation	Uwe Fischer (UFI)	04/23/04
String Review	Elizabeth Matthis (EM)	04/15/04

Document Change History

Rev. Level	Change	Initials	Date
1.0	Initial version	PB	03/25/04
1.1	String Review of EM and feature changes of FME	PB	04/23/04
1.2	Add approvals	PB	04/27/04
1.3	Set to final	PB	04/27/04

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	2

6	Detailed Specification	2

6.1	Adjusted text wrapping	2

6.2	Compatibility option	2

6.3	Impact on the user interface	2

6.4	Impact on the file format and the API	4

6.5	Impact on the MS Word filter	4

6.6	G11n	4

6.7	Error Conditions	4

7	Future Tasks	4

8	Notes	4

9	References	4

Glossary

Term	Description
floating screen object	This term denotes the objects 'Writer fly frame' and 'drawing object' in Writer and the objects 'text box', 'graphic', 'frame', 'picture' etc. in MS Word.
Writer fly frame	Floating screen object containing normal Writer content (text, tables, sections, columns, etc.), graphics, or OLE content.
drawing object	Floating screen object known for the draw application – e.g. rectangles, circles, lines, arrows, text boxes etc.

Motivation

MS Word and Writer have different approaches on wrapping text around floating screen objects. This affects the text formatting and therefore the document layout. To enhance interoperability between these products as well as to lower the threshold for users to migrate to Writer it is mandatory to adapt certain behavior from MS Word and integrate them into Writer.

User Scenarios

Interoperability: A user gets a Word document and opens it within Writer. The person who designed the Word document made heavy use of floating screen objects in his text.

Thus the layout of the Word document relies heavily on the precise interpretation of text wrapping around the inserted objects.

Once this specification is implemented the user will have less layout loss in this case when importing and of course exporting the document into/from Writer.

Goals

Goal of this specification is to enhance the interoperability with MS Word, while documents from previous OpenOffice.org respectively StarOffice version retain their layout.

Requirements and Dependencies

Requirements

None.

Technical Dependencies

Not known.

Competitive Analyses

The competitive analyses will consider MS Word only since this specification is about MS interoperability. Since the Detailed Specification is based on a direct comparison that needs to be implemented, a competitive analyses is not needed.

Detailed Specification

The positioning of floating screen objects in Writer will be adjusted. A compatibility option will be introduced to control, if the changed floating screen object positioning is applied or not.

Adjusted text wrapping

These are the single sub-tasks to be solved:

In Word, page header/footer content and footnote/endnote content does not wrap around floating screen objects.

In Word, text body content wraps around floating screen objects, which are anchored in the page header.

Compatibility option

A new document compatibility option will be introduced. By the value of this new compatibility option it's assured that for former created Writer documents the text wrapping doesn't change and that for imported MS Word documents the text wrapping in Writer equals the layout in MS Word.

The proposed name of the option will be “Use OpenOffice.org 1.1 respectively StarOffice 6.0/7 text wrapping“.

If the new option is OFF, the changed text wrapping will be applied. If the new option is ON, the former text wrapping will be applied.

The default value of the option for new documents will be OFF. For former created Writer documents the value is set to ON.

Impact on the user interface

The compatibility option – introduced in previous chapter – will be accessible by the user in the 'Compatibility' tab page, found under menu Tools – Option – Text document – Compatibility via a checkbox. See following string list for the changed string of the checkbox.

Use OpenOffice.org 1.1 text wrapping around objects Figure 1 Extended tab page 'Compatibility' Note that the options dialog and this tab page is due to changes – see specifications 'Option dialog' (found at http://specs.openoffice.org/appwide/separate_modules/OptionsDialog.sxw) and 'Writer Compatibility Page' (found at http://specs.openoffice.org/writer/compatibility/compatibility.sxw)

String list for OpenOffice.org 2.0:

Item	English	German	Comments
Checkbox	Use %PRODUCTNAME 1.1 text wrapping around objects	%PRODUCTNAME 1.1 Textfluss um Objekte verwenden	New checkbox on tab page 'Compatibility', found under menu 'Tools - Options – Text Document – Compatibility'; see def. of text wrap: http://www.webopedia.com/TERM/t/text_wrap.html

String list for StarOffice 8

Item	English	German	Comments
Checkbox	Use %PRODUCTNAME 6.0/7 text wrapping around objects	%PRODUCTNAME 6.0/7 Textfluss um Objekte verwenden	New checkbox on tab page 'Compatibility', found under menu 'Tools - Options – Text Document - Compatibility'; see def. of text wrap: http://www.webopedia.com/TERM/t/text_wrap.html

Impact on the file format and the API

The value of the new document compatibility option “Use OpenOffice.org 1.1 respectively StarOffice 6.0/7 text wrapping” will be saved in the file format as a <config:config-item> tag with the attributes config:name=”UseFormerTextWrapping” and config:type=”boolean” in the <config:config-item-set config-name=”configuration-settings”> tag. The tag can provide the values true or false.

If no value for the new document compatibility option is provided in the file format – as it is for former created Writer documents –, it's value is set to ON.

The access to the value of the new document compatibility option via API will be provided by the service com::sun::star::text::DocumentSettings via the new optional property UseFormerTextWrapping.

Impact on the MS Word filter

On importing MS Word documents the value of the new compatibility option “Use OpenOffice.org 1.1 respectively StarOffice 6.0/7 text wrapping” will be set to OFF.

G11n

Nothing.

Error Conditions

None.

Future Tasks

For any of the four “Wrap text” settings in Word, there seems to be one common internal threshold value, that defines the minimum width that needs to be available to take some text. Example: “Wrap text” is set to “Left only”, but there is only 0.5cm available space to the left of the text box. In this case, there will be no text to the left of the text frame. (issue 4173)

The “Largest only” setting is currently mapped to “Optimal wrap” in writer, but there are some minor differences between the behavior of “Largest only” in Word and “Optimal wrap” in Writer. Therefore a new wrapping mode “Largest only” has to be introduced in Writer. (#110375#)

Old Word frames with “Text wrapping” set to “Around” are currently mapped to Writer text frames with “Optimal wrap”. This has to be changed to “Page wrap”.

Notes

References

Adjusted text wrapping

Page 4

http://specs.openoffice.org/writer/compatibility/adjust-text-wrapping.sxw

Adjusted text wrapping

Oliver-Rainer Düsterhöft

2004-01-22T16:07:28