diff options
| author | Hossein <hossein.ir@gmail.com> | 2021-03-29 21:55:26 +0430 |
|---|---|---|
| committer | Adolfo Jayme Barrientos <fitojb@ubuntu.com> | 2021-04-07 17:47:16 +0200 |
| commit | ea5641baeef73af60d025d185901a303844e2d85 (patch) | |
| tree | 94b343b35e7b8805beb9a1745fe1de2f382574fb /lotuswordpro | |
| parent | 33da78c21f4243a3e469fb7df79ed1745df70078 (diff) | |
Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md
and now, the contents of these files were changed to use Markdown
format. Other than format inconsistency, some README.md files lacked
information about modules, or were out of date. By using LibreOffice
/ OpenOffice wiki and other documentation websites, these files were
updated. Now every README.md file has a title, and some description.
The top-level README.md file is changed to add links to the modules.
The result of processing the Markdown format README.md files can be
seen at: https://docs.libreoffice.org/
Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424
Tested-by: Jenkins
Reviewed-by: Michael Stahl <michael.stahl@allotropia.de>
Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Diffstat (limited to 'lotuswordpro')
| -rw-r--r-- | lotuswordpro/README.md | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/lotuswordpro/README.md b/lotuswordpro/README.md index a1e3c20e0167..fc58c3fe439c 100644 --- a/lotuswordpro/README.md +++ b/lotuswordpro/README.md @@ -1,31 +1,31 @@ -Import filter for file format of Lotus Word Pro. +# Import Filter for File Format of Lotus Word Pro (lwp) -== Description == +## 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 +`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. +`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 == +## 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 +### 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 +### Source Contents +* `filter`: `lwp` document format parser +* `filter/LotusWordProImportFilter.cxx`: the entry point to the filter +* `filter/xfilter`: export to StarOffice XML |