summaryrefslogtreecommitdiff
path: root/writerfilter
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-29 21:55:26 +0430
committerAdolfo Jayme Barrientos <fitojb@ubuntu.com>2021-04-07 17:47:16 +0200
commitea5641baeef73af60d025d185901a303844e2d85 (patch)
tree94b343b35e7b8805beb9a1745fe1de2f382574fb /writerfilter
parent33da78c21f4243a3e469fb7df79ed1745df70078 (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 'writerfilter')
-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