aboutsummaryrefslogtreecommitdiffstats
path: root/src/documentation/content/xdocs/relnotes.xml
blob: 0037817bda586fa79d0ef9f6ed2952b00d18fcc7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
<?xml version="1.0" standalone="no"?>
<!--
  Licensed to the Apache Software Foundation (ASF) under one or more
  contributor license agreements.  See the NOTICE file distributed with
  this work for additional information regarding copyright ownership.
  The ASF licenses this file to You under the Apache License, Version 2.0
  (the "License"); you may not use this file except in compliance with
  the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->
<!-- $Id$ -->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
  <header>
    <title>Release Notes</title>
    <version>$Revision$</version>
  </header>

    <body>
<section>
  <title>FOP 0.92 beta</title>
  <p>
    This is the third release after the big redesign effort. FOP 0.92 beta has now
    stabilized the API. In addition it contains many bug fixes and new features.
  </p>
  <p>
    We would like to encourage you to download the code and to play with it. 
    We're still in the process of stabilizing 
    the code. We welcome any feedback you might have and even more, any
    other form of help to get the project forward.
  </p>
  <p>Caveats:</p>
  <ul>
    <li>
      This release is still a beta release. If you intend to use this software in a production
      environment, please perform careful testing.
    </li>
    <li>
      The API has changed between 0.91beta this release.
      Please consult the <a href="0.94/upgrading.html">"Upgrading"</a> page for details.
    </li>
    <li>
      You may experience different behaviour compared to version 0.20.5.
      Please consult the <a href="0.94/upgrading.html">"Upgrading"</a> page for details.
    </li>
  </ul>
  <p>Known Issues:</p>
  <ul>
    <li>
      PCL, MIF and SVG output support have not been restored, yet.
    </li>
    <li>
      Java2D/AWT support contains some problems, for example with 
      block-containers.
    </li>
    <li>
      Auto table layout is not implemented, yet.
    </li>
    <li>
      The collapsing border model on tables is not implemented, yet. Please 
      use border-collapse="separate" for now.
    </li>
    <li>
      Footnotes may overlap with text of the region-body in multi-column 
      documents.
    </li>
    <li>
      Space resolution does not work between footnote regions.
    </li>
    <li>
      There's a problem involving nested block-containers and 
      reference-orientation 180/-180 (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=36391">Bugzilla #36391</a>)
    </li>
    <li>
      block-containers with no height currently don't create a fence for
      spaces as they should (they behave like a normal block).
    </li>
    <li>
      Preserved linefeeds in fo:character are not handled correctly.
    </li>
    <li>
      An empty block currently produces a fence for stacking constraints
      which it shouldn't.
    </li>
    <li>
      There are several small problems around white space handling.
    </li>
    <li>
      Images currently don't shrink so they fit on a page when they are 
      too big and shrinking is allowed to happen.
    </li>
    <li>
      Block-level content in fo:inlines may produce unwelcome results.
    </li>
    <li>
      inline-container may not work as expected.
    </li>
    <li>
      letter-spacing and word-spacing properties may not work as expected.
    </li>
    <li>
      leaders with leader-pattern="use-content" may not work as expected.
    </li>
    <li>
      keep-with-previous doesn't work inside tables and lists, yet.
    </li>
    <li>
      White space on direct inline-level children of a marker is not 
      handled correctly.
    </li>
    <li>
      If two consecutive pages don't have the same available width, the 
      content currently isn't properly fit into the available space on
      the new page.
    </li>
    <li>
      background-images on page-number-citations are not placed correctly.
    </li>
    <li>
      Not all FO elements can be referenced by their "id", most notably:
      table-body, table-header, table-footer and table-row.
    </li>
    <li>
      The backgrounds of table-body, table-header, table-footer and 
      table-column are not painted, yet.
    </li>
    <li>
      Border and padding conditionality are not supported on table-cells, yet.
    </li>
    <li>
      Copy/Paste from PDF content in Acrobat Reader is not supported for
      text using embedded TrueType fonts.
    </li>
    <li>
      Column balancing in multi-column documents may not work as expected
      (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=36356">Bugzilla #36356</a>)
    </li>
    <li>
      Omitting fo:table-column or having fo:table-column without a column-width 
      and attempting to create columns implicitly from the first
      table row is not implemented, yet (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=35656">Bugzilla #35656</a>).
    </li>
    <li>
      Internal basic-links don't point to the exact location on a page, yet, as they
      did in 0.20.5. Currently you land in the upper left corner of the page.
    </li>
  </ul>
</section>
<section>
<title>FOP 0.91 beta</title>
  <p>
    This is the second release after the big redesign effort. FOP 0.91 beta is mostly a bug
    fix release but also contains some new features.
  </p>
  <p>
    We would like to encourage you to download the code and to play with it. 
    We're still in the process of adding new major features and stabilizing 
    the code. We welcome any feedback you might have and even more, any
    other form of help to get the project forward.
  </p>
  <p>Caveats:</p>
  <ul>
    <li>
      This release is an beta release. If you intend to use this software in a production
      environment, please perform careful testing.
    </li>
    <li>
      The API is not to be considered stable, yet. Please be prepared 
      for the API to be changed in a backwards-incompatible way.
    </li>
    <li>
      You may experience different behaviour compared to version 0.20.5.
      Please consult the <a href="0.94/upgrading.html">"Upgrading"</a> page indicated above for details.
    </li>
  </ul>
  <p>Known Issues:</p>
  <ul>
    <li>
      PCL, MIF and SVG output support have not been restored, yet.
    </li>
    <li>
      Java2D/AWT support contains some problems, for example with 
      block-containers.
    </li>
    <li>
      Support for kerning has not been restored, yet.
    </li>
    <li>
      Auto table layout is not implemented, yet.
    </li>
    <li>
      The collapsing border model on tables is not implemented, yet. Please 
      use border-collapse="separate" for now.
    </li>
    <li>
      Footnotes may overlap with text of the region-body in multi-column 
      documents.
    </li>
    <li>
      Space resolution does not work between footnote regions.
    </li>
    <li>
      There's a problem involving nested block-containers and 
      reference-orientation 180/-180 (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=36391">Bugzilla #36391</a>)
    </li>
    <li>
      block-containers with no height currently don't create a fence for
      spaces as they should (they behave like a normal block).
    </li>
    <li>
      Preserved linefeeds in fo:character are not handled correctly.
    </li>
    <li>
      Zero-width spaces are not handled correctly.
    </li>
    <li>
      An empty block currently produces a fence for stacking constraints
      which it shouldn't.
    </li>
    <li>
      There are several small problems around white space handling.
    </li>
    <li>
      Images currently don't shrink so they fit on a page when they are 
      too big and shrinking is allowed to happen.
    </li>
    <li>
      Block-level content in fo:inlines may produce unwelcome results.
    </li>
    <li>
      inline-container may not work as expected.
    </li>
    <li>
      letter-spacing and word-spacing properties may not work as expected.
    </li>
    <li>
      leaders with leader-pattern="use-content" may not work as expected.
    </li>
    <li>
      keep-with-previous doesn't work inside tables and lists, yet.
    </li>
    <li>
      White space on direct inline-level children of a marker is not 
      handled correctly.
    </li>
    <li>
      If two consecutive pages don't have the same available width, the 
      content currently isn't properly fit into the available space on
      the new page.
    </li>
    <li>
      background-images on page-number-citations are not placed correctly.
    </li>
    <li>
      Not all FO elements can be referenced by their "id", most notably:
      table-body, table-header, table-footer and table-row.
    </li>
    <li>
      The backgrounds of table-body, table-header, table-footer and 
      table-column are not painted, yet.
    </li>
    <li>
      Border and padding conditionality are not supported on table-cells, yet.
    </li>
    <li>
      Copy/Paste from PDF content in Acrobat Reader is not supported for
      text using embedded TrueType fonts.
    </li>
    <li>
      Column balancing in multi-column documents may not work as expected
      (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=36356">Bugzilla #36356</a>)
    </li>
    <li>
      Omitting fo:table-column or having fo:table-column without a column-width 
      and attempting to create columns implicitly from the first
      table row is not implemented, yet (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=35656">Bugzilla #35656</a>).
    </li>
    <li>
      Leaders with the "rule" pattern don't work for PostScript output.
    </li>
    <li>
      break-after may in some cases cause subsequent content to be swallowed. 
      Please use break-before, if possible.
    </li>
    <li>
      Internal basic-links don't point to the exact location on a page, yet, as they
      did in 0.20.5. Currently you land in the upper left corner of the page.
    </li>
  </ul>
</section>
<section>
  <title>FOP 0.90 alpha 1</title>
  <p>
    This is the first preview release after the big redesign effort.
  </p>
  <p>
    We would like to encourage you to download the code and to play with it. 
    We're still in the process of adding new major features and stabilizing 
    the code. We welcome any feedback you might have and even more, any
    other form of help to get the project forward.
  </p>
  <p>Caveats:</p>
  <ul>
    <li>
      This release is a (unstable) preview release and not intended for use in a
      production environment. Use at your own risk!
    </li>
    <li>
      The API is not to be considered stable, yet. Please be prepared 
      for the API to be changed in a backwards-incompatible way.
    </li>
    <li>
      You may experience different behaviour compared to version 0.20.5.
      Please consult the <a href="0.94/upgrading.html">"Upgrading"</a> page indicated above for details.
    </li>
  </ul>
  <p>Known Issues:</p>
  <ul>
    <li>
      PCL, MIF and SVG output support have not been restored, yet.
    </li>
    <li>
      Java2D/AWT support contains some problems, for example with 
      block-containers.
    </li>
    <li>
      Support for kerning has not been restored, yet.
    </li>
    <li>
      Auto table layout is not implemented, yet.
    </li>
    <li>
      The collapsing border model on tables is not implemented, yet. Please 
      use border-collapse="separate" for now.
    </li>
    <li>
      Footnotes may overlap with text of the region-body in multi-column 
      documents.
    </li>
    <li>
      Space resolution does not work between footnote regions.
    </li>
    <li>
      There's a problem involving nested block-containers and 
      reference-orientation 180/-180 (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=36391">Bugzilla #36391</a>)
    </li>
    <li>
      block-containers with no height currently don't create a fence for
      spaces as they should (they behave like a normal block).
    </li>
    <li>
      Preserved linefeeds in fo:character are not handled correctly.
    </li>
    <li>
      Zero-width spaces are not handled correctly.
    </li>
    <li>
      An empty block currently produces a fence for stacking constraints
      which it shouldn't.
    </li>
    <li>
      There are several small problems around white space handling.
    </li>
    <li>
      Images currently don't shrink so they fit on a page when they are 
      too big and shrinking is allowed to happen.
    </li>
    <li>
      Block-level content in fo:inlines may produce unwelcome results.
    </li>
    <li>
      inline-container may not work as expected.
    </li>
    <li>
      letter-spacing and word-spacing properties may not work as expected.
    </li>
    <li>
      leaders with leader-pattern="use-content" may not work as expected.
    </li>
    <li>
      keep-with-previous doesn't work inside tables and lists, yet.
    </li>
    <li>
      White space on direct inline-level children of a marker is not 
      handled correctly.
    </li>
    <li>
      If two consecutive pages don't have the same available width, the 
      content currently isn't properly fit into the available space on
      the new page.
    </li>
    <li>
      background-images on page-number-citations are not placed correctly.
    </li>
    <li>
      Not all FO elements can be referenced by their "id", most notably:
      table-body, table-header, table-footer and table-row.
    </li>
    <li>
      The backgrounds of table-body, table-header, table-footer and 
      table-column are not painted, yet.
    </li>
    <li>
      Border and padding conditionality are not supported on table-cells, yet.
    </li>
    <li>
      Copy/Paste from PDF content in Acrobat Reader is not supported for
      text using embedded TrueType fonts.
    </li>
    <li>
      Column balancing in multi-column documents may not work as expected
      (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=36356">Bugzilla #36356</a>)
    </li>
    <li>
      Omitting fo:table-column or having fo:table-column without a column-width 
      and attempting to create columns implicitly from the first
      table row is not implemented, yet (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=35656">Bugzilla #35656</a>).
    </li>
    <li>
      Leaders with the "rule" pattern don't work for PostScript output.
    </li>
  </ul>
</section>
<section>
  <title>FOP 0.20.5</title>
  <p>This was the last release in the 0.20.x series (aka maintenance branch).</p>
  <p>Important changes since the last release (0.20.4):</p>
  <ul>
    <li>Some hyphenation patterns (cs, da, de, de_DR, el, en, en_US, fr, nl,
      no, sk, tr) have been removed due to licensing reasons
      (en_GB hyphenation has been renamed to en).
      We're still working on this issue
      (see <a href="http://wiki.apache.org/xmlgraphics-fop/FOPAudits/March2003">
      Wiki</a> for details).
    </li>
    <li>Documentation is now built with <a href="http://xml.apache.org/forrest/">
        Forrest</a> (version 0.4). You need to install Forrest if you want build the docs
        yourself. (See
        <a href="http://xml.apache.org/forrest/your-project.html">Using Forrest</a>)
    </li>
    <li>The following JARs have been updated:
        Xerces to version 2.2.1, Xalan to version 2.4.1 and Batik to version 1.5beta4.
    </li>
    <li>FOP has been compiled with Jimi support, but Jimi is not included in the
        FOP distribution. To use it, first download
        <a href="http://java.sun.com/products/jimi/">Jimi</a>, then extract
        the archive, then
        copy JimiProClasses.zip to FOP's lib dir and rename it to jimi-1.0.jar.
    </li>
    <li>FOP has been compiled with JAI support, but JAI is not included in the
        FOP distribution. To use it, simply install
        <a href="http://java.sun.com/products/java-media/jai">JAI</a>.
    </li>
    <li>Links in PDF won't generate multiple link rectangles anymore. If this causes
        a problem you can set the system property "links.merge" to "no".
    </li>
    <li>FOP has been compiled with cryptography support. See 
      <a href="0.94/pdfencryption.html">
      PDF encryption</a> for details about installation and usage.
    </li>
    <li>The behaviour of leader has changed. See
      <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=19341">bug #19341</a>,
      <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=19465">bug #19465</a>
      and <code>leader.fo</code> (examples).
    </li>
    <li>
      For a more detailed list of changes, see the CHANGES file in the root of the
      FOP distribution.
    </li>
  </ul>

</section>
<section>
  <title>FOP 0.20.4</title>
  <p>Important changes since 0.20.3:</p>
    <ul>
       <li>FOP should now work with any JAXP1.1 compliant parser/transformer.
         It has been successfully tested with Xerces/Xalan, Saxon and JDK1.4
         (which includes Crimson and Xalan).
       </li>
       <li>The following JARs have been updated:
         Xerces to version 2.0.1, Xalan to version 2.3.1 and Batik to version 1.5beta2.
      </li>
      <li>FOP has been compiled with Jimi support this time
        but you still have to download
        <a href="http://java.sun.com/products/jimi/">Jimi</a>
        and copy it to lib/ to get PNG support (no need to build FOP yourself though).
      </li>
      <li>Building FOP with JDK1.2 does not work. Running is ok except
        support for additional truetype fonts in AWT Viewer.
      </li>
      <li>Logging has been changed from LogKit to Avalon's Logger Interface.
        (see <a href="0.94/embedding.html">Embedding</a> for details).
      </li>
      <li>Building under JDK 1.4:
         You need to add a method in
         <code>src/org/apache/fop/svg/PDFGraphics2D.java</code>
         (search for jdk1.4 and remove the comments)
      </li>
      <li>To decrease the size of the distributions, ant, xml-docs, design-docs
        and the hyphenation sources have been removed from the binary distribution.
        Javadocs have been removed from the source distribution (use
        <code>build javadocs</code> to generate them).
      </li>
      <li>Documentaion generation is broken in the maintenance branch at the moment
       (Stylebook needs xerces1). The docs for this release are generated from the trunk.
      </li>
      <li>
        For a more detailed list of changes, see the CHANGES file in the root of the FOP distribution.
      </li>
      </ul>
 </section>

<section>
  <title>FOP 0.20.3</title>
  <p>Important Information:</p>
    <ul>
       <li>This version supports the
         <a href="http://www.w3.org/TR/2001/REC-xsl-20011015/">XSL-FO Version 1.0
         W3C Recommendation</a> syntax. So don't forget to update your
         Stylesheets:
         <br/>Just rename the <code>master-name</code> property to <code>master-reference</code>
         on <code>fo:page-sequence</code>, <code>fo:single-page-master-reference</code>,
         <code>fo:repeatable-page-master-reference</code> and
         <code>fo:conditional-page-master-reference</code>.</li>
       <li>JDK 1.2 (or later) is required</li>
       <li>Jimi has been removed for licensing reasons
         <br/>If you need PNG support you have to download
           <a href="http://java.sun.com/products/jimi/">Jimi</a>,
           copy it to lib/ and build FOP yourself</li>
      <li>Building under JDK 1.4:
        <br/>You need to add a method in
         <code>src/org/apache/fop/svg/PDFGraphics2D.java</code>
         (search for jdk1.4 and remove the comments)
       </li>
       <li>
        For a more detailed list of changes, see the CHANGES file in the root of the FOP distribution.
       </li>
      </ul>
 </section>

    </body>
</document>