summaryrefslogtreecommitdiff
path: root/writerfilter/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'writerfilter/README.md')
-rw-r--r--writerfilter/README.md32
1 files changed, 17 insertions, 15 deletions
diff --git a/writerfilter/README.md b/writerfilter/README.md
index 7a9c8cc57df4..0c027bf42fd4 100644
--- a/writerfilter/README.md
+++ b/writerfilter/README.md
@@ -1,20 +1,22 @@
+# Import Filters for LibreOffice Writer
+
The writerfilter module contains import filters for Writer, using its UNO API.
-Import filter for docx and rtf.
+Import filter for DOCX and RTF.
-== Module contents ==
- * documentation: RNG schema for the OOXML tokenizer, etc.
- * inc: module-global headers (can be included by any files under source)
- * qa: cppunit tests
- * source: the filters themselves
- * util: UNO passive registration config
+* Module contents
+ * `documentation`: RNG schema for the OOXML tokenizer, etc.
+ * `inc`: module-global headers (can be included by any files under source)
+ * `qa`: `cppunit` tests
+ * `source`: the filters themselves
+ * `util`: UNO passive registration config
-== Source contents ==
- * dmapper: the domain mapper, hiding UNO from the tokenizers, used by DOCX and RTF import
- * The incoming traffic of dmapper can be dumped into an XML file in /tmp in
- dbgutil builds, start soffice with the `SW_DEBUG_WRITERFILTER=1`
- environment variable if you want that.
- * filter: the UNO filter service implementations, invoked by UNO and calling
+* Source contents
+ * `dmapper`: the domain mapper, hiding UNO from the tokenizers, used by DOCX and RTF import
+ * The incoming traffic of `dmapper` can be dumped into an XML file in `/tmp` in
+ `dbgutil` builds, start soffice with the `SW_DEBUG_WRITERFILTER=1`
+ environment variable if you want that.
+ * `filter`: the UNO filter service implementations, invoked by UNO and calling
the dmapper + one of the tokenizers
- * ooxml: the docx tokenizer
- * rtftok: the rtf tokenizer
+ * `ooxml`: the docx tokenizer
+ * `rtftok`: the rtf tokenizer