[Libreoffice-commits] core.git: lotuswordpro/README

[David Tardon (via logerrit)]

 lotuswordpro/README |   32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

New commits:
commit bb8fb3237c9d1b9516f5803d476c1db09570c2dc
Author:     David Tardon <dtardon at redhat.com>
AuthorDate: Sun Feb 21 18:24:21 2021 +0100
Commit:     David Tardon <dtardon at redhat.com>
CommitDate: Sun Feb 21 18:26:04 2021 +0100

    expand lotuswordpro README a bit
    
    Change-Id: Ibe5e5b1bef43049065915f80aae5037a782ed698

diff --git a/lotuswordpro/README b/lotuswordpro/README
index 4ec710488b31..a1e3c20e0167 100644
--- a/lotuswordpro/README
+++ b/lotuswordpro/README
@@ -1 +1,31 @@
-Filter for file format of Lotus Word Pro.
+Import filter for file format of Lotus Word Pro.
+
+== Description ==
+
+The import is not direct, but via an intermediate format: StarOffice
+XML, the predecessor of ODF (yes, the code is old). The entry point to
+the filter is class LotusWordProImportFilter (refer to Source code
+section), but that just hooks up the necessary machinery for processing
+StarOffice XML produced by the filter. The real fun starts in function
+ReadWordproFile() (source/filter/lwpfilter.cxx); this function
+initializes the parser (class Lwp9Reader) and the SAX XML handler that
+produces the output (class XFSaxStream). The Lwp9Reader class then does
+the actual parsing.
+
+If the module is built with debug level greater than 0, it is possible
+to examine the intermediate XML: set environment variable
+DBG_LWPIMPORT_DIR= to an existing directory and, on opening an lwp
+document, a file named lwpimport.xml will be created in that directory.
+
+== Source code ==
+
+=== Module contents ===
+* inc: module-global headers (can be included by any file in source)
+* qa: cppunit tests
+* source: the filter itself
+* util: UNO passive registration config
+
+=== Source contents ===
+* filter: lwp document format parser
+* filter/LotusWordProImportFilter.cxx: the entry point to the filter
+* filter/xfilter: export to StarOffice XML