sw/source/filter/ww8/README-rtf.txt

   1 #
   2 # This file is part of the LibreOffice project.
   3 #
   4 # This Source Code Form is subject to the terms of the Mozilla Public
   5 # License, v. 2.0. If a copy of the MPL was not distributed with this
   6 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7 #
   8 # This file incorporates work covered by the following license notice:
   9 #
  10 #   Licensed to the Apache Software Foundation (ASF) under one or more
  11 #   contributor license agreements. See the NOTICE file distributed
  12 #   with this work for additional information regarding copyright
  13 #   ownership. The ASF licenses this file to you under the Apache
  14 #   License, Version 2.0 (the "License"); you may not use this file
  15 #   except in compliance with the License. You may obtain a copy of
  16 #   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17 #
  18
  19 ---------------------------------------------------------------------
  20
  21 Summary of new features in RtfExport
  22
  23 ---------------------------------------------------------------------
  24
  25 Miklos Vajna
  26
  27 <vmiklos@vmiklos.hu>
  28 ---------------------------------------------------------------------
  29
  30 Table of Contents
  31
  32 1. Introduction
  33
  34     1.1. Terminology
  35     1.2. General
  36
  37 2. List if fixed bugs
  38 3. List of new features
  39
  40     3.1. Nested tables
  41     3.2. Character properties
  42     3.3. Sections
  43     3.4. Graphics
  44     3.5. Bookmarks
  45     3.6. Fields
  46     3.7. Drawing
  47     3.8. Form fields
  48     3.9. OLE objects
  49
  50 4. Changes in the source code outside RTF
  51
  52
  53 ---------------------------------------------------------------------
  54
  55 1.�Introduction
  56
  57 ---------------------------------------------------------------------
  58
  59 The biggest difference is that the new exporter is a UNO component,
  60 and it?s based on the MSWord base classes, the vision here is that
  61 this way much less code can achieve the same set of features,
  62 reducing the amount of duplicated code.
  63
  64
  65 1.1.�Terminology
  66
  67 --------------
  68
  69   * The "MSO OK, OOo KO" and similar abbreviations describe if the
  70     given new feature is supported by the OOo RTF importer or it can
  71     be tested using Microsoft Office.
  72   * RtfExport refers to the new UNO-based exporter, RtfWriter refers
  73     to the old built-in one.
  74
  75
  76 1.2.�General
  77
  78 --------------
  79
  80 RtfWriter sometimes created documents where the first { is closed in
  81 the middle of the document. MSO ignores this problem, but OOo stops
  82 parsing the rest of the document if this happens, in other words
  83 everything after such a bug is ignored. This can be reproduced by for
  84 example parprops.odt, but it?s triggered in several other cases as
  85 well. RtfExport has no automatic prevention for this, either - but
  86 during development I primarily test the output with OOo, so hopefully
  87 the bug will pop up less frequently.
  88
  89
  90 ---------------------------------------------------------------------
  91
  92 2.�List if fixed bugs
  93
  94 ---------------------------------------------------------------------
  95
  96   * https://bz.apache.org/ooo/show_bug.cgi?id=51469 postit
  97     fields
  98   * https://bz.apache.org/ooo/show_bug.cgi?id=66619 page
  99     margins
 100   * https://bz.apache.org/ooo/show_bug.cgi?id=69856 page
 101     numbers
 102   * https://bz.apache.org/ooo/show_bug.cgi?id=81569 { and } in
 103     document title
 104   * https://bz.apache.org/ooo/show_bug.cgi?id=84703 redlines
 105   * https://bz.apache.org/ooo/show_bug.cgi?id=91166 russian
 106     chars
 107   * https://bz.apache.org/ooo/show_bug.cgi?id=92673 bookmarks
 108     across tables
 109   * https://bz.apache.org/ooo/show_bug.cgi?id=100507 ole
 110     object export
 111   * https://bz.apache.org/ooo/show_bug.cgi?id=103993 same as #
 112     81569 just for doc comments
 113   * https://bz.apache.org/ooo/show_bug.cgi?id=106677
 114     listoverride index starts at zero
 115   * https://bz.apache.org/ooo/show_bug.cgi?id=38344 enhanced
 116     character space
 117
 118
 119 ---------------------------------------------------------------------
 120
 121 3.�List of new features
 122
 123 ---------------------------------------------------------------------
 124
 125
 126 3.1.�Nested tables
 127
 128 --------------
 129
 130 This was new in Word2000 and it?s now supported by RtfExport (MSO OK,
 131 OOo KO)
 132
 133
 134 3.2.�Character properties
 135
 136 --------------
 137
 138 The following are now supported:
 139
 140   * blinking (MSO OK, OOo KO)
 141   * expanded spacing (MSO OK, OOo OK)
 142   * pair kerning (MSO OK, OOo OK)
 143
 144
 145 3.3.�Sections
 146
 147 --------------
 148
 149 RtfExport writes:
 150
 151   * column breaks (MSO OK, OOo OK)
 152   * special breaks (when the next page should be an odd or an even
 153     page; MSO OK, OOo KO)
 154   * the write-protected property of sections is exported properly
 155     (MSO OK, OOo KO)
 156   * better page numbers (inherited type from page styles, restarts;
 157     MSO OK, OOo KO)
 158   * line numbering (MSO OK, OOo KO)
 159
 160
 161 3.4.�Graphics
 162
 163 --------------
 164
 165 PNG graphics are exported in WMF format as well, so that not only MSO
 166 and OOo can display graphics from the output document, but Wordpad as
 167 well.
 168
 169
 170 3.5.�Bookmarks
 171
 172 --------------
 173
 174 Implicit bookmarks like reference to a footnote did not work in OOo
 175 (one got an Error: Reference source not found message when opening
 176 the result), this now works as expected. (MSO OK - the importer
 177 previously autocorrected this as well, OO OK)
 178
 179
 180 3.6.�Fields
 181
 182 --------------
 183
 184   * Table of contents is now written as a field, so it?s properly
 185     read-only (MSO OK, OOo KO)
 186   * Postit comments are now exported. (MSO OK, OOo KO)
 187
 188
 189 3.7.�Drawing
 190
 191 --------------
 192
 193 Drawing objects for Word 97 through Word 2007 (shapes) are now
 194 implemented:
 195
 196   * basic shapes (rectangle, ellipse, etc.)
 197   * lines, including free-form ones
 198   * texts, including vertical ones and their (paragraph and
 199     character) formatting
 200
 201 (MSO OK, OOo KO)
 202
 203
 204 3.8.�Form fields
 205
 206 --------------
 207
 208 All types supported by the RTF format are exported, namely:
 209
 210   * text boxes
 211   * check boxes
 212   * list boxes
 213
 214 (MSO OK, OOo KO)
 215
 216
 217 3.9.�OLE objects
 218
 219 --------------
 220
 221 Their result is exported as a picture - RtfWriter did not export
 222 anything. (MSO OK, OOo OK)
 223
 224 For math, the native data is written as well, so you can edit the
 225 object, too. (MSO OK, OOo KO)
 226
 227
 228 ---------------------------------------------------------------------
 229
 230 4.�Changes in the source code outside RTF
 231
 232 ---------------------------------------------------------------------
 233
 234 These are refactorings I needed for RTF. To my best knowledge they do
 235 not change the output of other filters from a user?s point of view.
 236
 237   * The code that splits runs according to bookmarks is moved from
 238     DocxExport to MSWordExportBase
 239   * WW8_SdrAttrIter has been refactored to MSWord_SdrAttrIter
 240   * MSWordExportBase::SubstituteBullet can avoid replacing bullets
 241   * wwFontHelper::InitFontTable can really load all fonts
 242   * An obvious typo in WW8AttributeOutput::CharTwoLines has been
 243     fixed
 244