Libreoffice GSoC project: Improving RTF Export

openSUSE Conference (http://conference.opensuse.org/indico/contributionDisplay.py?contribId=81&confId=0), Nurnberg

Source: https://github.com/vmiklos/presentations/tree/master/ooo-opensuse-nurnberg-2k1o

Transcript

1. GSoC project: Improving RTF Export Presentation of a GoOO student Miklos Vajna 22 October 2010 1 / 31
2. Introduction Background Activities in GoOO before SoC Project this summer: development of a new RTF export filter developer side user side 2 / 31
3. Background I’m a student from Budapest University of Technology and Economics, Hungary A few project I am interested in: Frugalware Linux - a distribution BitlBee - an IM to IRC gateway (Skype module) git - I wrote the current git-merge command swig - the binding generator (PHP director support) LibreOffice - packaging, RTF export filter 3 / 31
4. Activities in GoOO before SoC Packager for Frugalware Linux Minor build system fixes trivial support for newer gcj versions git-related patches No C++ coding (steep learning curve) 4 / 31
5. RTF Export Development Summary idea: the concept of RTF is very similar to doc/docx (Microsoft invented them), just with a different markup Novell already created MSWordExportBase target: to support everything which was provided by the old filter, smaller size, new features 5 / 31
6. RTF Export Development The common base MSWordExportBase: tries to map Writer concepts to MSO AttributeOutputBase: 120+ methods for different resources 6 / 31
7. RTF Export Development Other new classes RtfExportFilter: glue between RtfExport and UNO RtfImportFilter: glue between the old RTF import and UNO RtfSdrExport: handles drawings RtfFilter in writerfilter: calls RtfExportFilter and RtfImportFilter via UNO 7 / 31
8. RTF Export Development Is the goal reached? No regressions compared to the old filter: mostly still needs more testing, but it’s enabled by default Smaller code: 47 files changed 7567 insertions(+), 6981 deletions(-) More code - due to better structured code, new features. More features: far from lossless conversion, but a number of new features 8 / 31
9. RTF Export Development Problems German comments No test files for the old filter Can’t wait for the moment when split build will be recommended for development Non-intuitive API’s 9 / 31
10. RTF Export Development Hard to remember API’s To send over an SvStream through UNO: utl::OStreamWrapper() to wrap it, utl::UcbStreamHelper::CreateStream() to unwrap No common base for header / footer - duplicated IsActive() method: class SW_DLLPUBLIC SwFmtHeader: public SfxPoolItem, public SwClient {...} class SW_DLLPUBLIC SwFmtFooter: public SfxPoolItem, public SwClient {...} Getting the streams from a media descriptor: MediaDescriptor::PROP_STREAMFOROUTPUT() - output MediaDescriptor::PROP_INPUTSTREAM() - input 10 / 31
11. RTF Export Development Additional tools fromhex.py - reads a hexdump from RTF and writes it as a binary prettyprint.py - pretty-prints an RTF file oodocdiff.sh - to test sadly it’s mostly useless due to character kerning and other changes 11 / 31
12. RTF Export Development Testing Cloned ooo-test-files from Cedric / Kohei Added 25 test ODT files Tested with headless writer + jodconverter using UNO that can be now replaced with the batch conversion patches 12 / 31
13. RTF Export Development Documentation Chicken and egg problem: pointless to read specs from start to end, but how to just use it as a reference? Necessary resources: Rich Text Format (RTF) Specification, version 1.9.1 (Word 2007) Object Linking and Embedding (OLE) Data Structures ISO/IEC 29500-1:2008 - OOXML spec Word Binary File Format (.doc) Structure Specification 13 / 31
14. RTF Export Development Bookmarks Before: After: 14 / 31
15. RTF Export Development Character properties Before: After: 15 / 31
16. RTF Export Development Charts (and other OLE objects) Before: After: 16 / 31
17. RTF Export Development Drawings Before: After: 17 / 31
18. RTF Export Development Forms Before: After: 18 / 31
19. RTF Export Development Line numbering Before: After: 19 / 31
20. RTF Export Development Mathematical Expressions Before: After: 20 / 31
21. RTF Export Development Editing Mathematical Expressions 21 / 31
22. RTF Export Development Special Page Breaks Test: normal, right (RTF calls it ’odd’), right again (the last one will be a double break) Before: After: 22 / 31
23. RTF Export Development Page Numbering Before: After: 23 / 31
24. RTF Export Development Pictures in Wordpad Before: After: 24 / 31
25. RTF Export Development Post-it Field Before: After: 25 / 31
26. RTF Export Development Sections: Column Break Before: After: 26 / 31
27. RTF Export Development Protected Sections Before: After: 27 / 31
28. RTF Export Development Nested Tables Before: After: 28 / 31
29. RTF Export Development Table of Contents Before: After: 29 / 31
30. Acknowledgements In no particular order: Cedric and Kendy: my mentors Thorsten: testing ideas Kohei: when hacking in the night Bubli: when the Czech guys were not on IRC Petr: patching issues everyone else who helped on #go-oo 30 / 31
31. References LibreOffice: http://www.documentfoundation.org/develop/ SoC: http://code.google.com/soc/ New RTF export filter: http: //cgit.freedesktop.org/~vmiklos/ooo-gsoc/ 31 / 31