lotuswordpro/README.md

   1 # Import Filter for File Format of Lotus Word Pro (lwp)
   2
   3 ## Description
   4
   5 The import is not direct, but via an intermediate format: StarOffice
   6 XML, the predecessor of ODF (yes, the code is old). The entry point to
   7 the filter is class LotusWordProImportFilter (refer to Source code
   8 section), but that just hooks up the necessary machinery for processing
   9 StarOffice XML produced by the filter. The real fun starts in function
  10 `ReadWordproFile()` (`source/filter/lwpfilter.cxx`); this function
  11 initializes the parser (class `Lwp9Reader`) and the SAX XML handler that
  12 produces the output (class `XFSaxStream`). The Lwp9Reader class then does
  13 the actual parsing.
  14
  15 If the module is built with debug level greater than 0, it is possible
  16 to examine the intermediate XML: set environment variable
  17 `DBG_LWPIMPORT_DIR=` to an existing directory and, on opening an lwp
  18 document, a file named `lwpimport.xml` will be created in that directory.
  19
  20 ## Source Code
  21
  22 ### Module Contents
  23 * `inc`: module-global headers (can be included by any file in source)
  24 * `qa`: `cppunit` tests
  25 * `source`: the filter itself
  26 * `util`: UNO passive registration config
  27
  28 ### Source Contents
  29 * `filter`: `lwp` document format parser
  30 * `filter/LotusWordProImportFilter.cxx`: the entry point to the filter
  31 * `filter/xfilter`: export to StarOffice XML