summaryrefslogtreecommitdiff
path: root/xmloff
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 /xmloff
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 'xmloff')
-rw-r--r--xmloff/README.md13
1 files changed, 6 insertions, 7 deletions
diff --git a/xmloff/README.md b/xmloff/README.md
index 45b78ae202f6..3eb276c096ad 100644
--- a/xmloff/README.md
+++ b/xmloff/README.md
@@ -1,4 +1,4 @@
-## Contains ODF import and export filter logic.
+# ODF Import and Export Filter Logic
The main library "xo" contains the basic ODF import/export filter
implementation for most applications. The document is accessed
@@ -9,7 +9,7 @@ The filter consumes/produces via SAX UNO API interface (implemented in
applications, for example [git:sw/source/filter/xml].
There is a central list of all element or attribute names in
-[git:include/xmloff/xmltoken.hxx]. The main class of the import filter
+`git:include/xmloff/xmltoken.hxx`. The main class of the import filter
is SvXMLImport, and of the export filter SvXMLExport.
The Import filter maintains a stack of contexts for each element being
@@ -37,12 +37,11 @@ consumed by the ODF import filter.
There is some stuff in the "dtd" directory which is most likely related
to the OpenOffice.org XML format but is possibly outdated and obsolete.
-### Add new XML tokens
+## Add New XML Tokens
When adding a new XML token, you need to add its entry in the following three
files:
-* [git:include/xmloff/xmltoken.hxx]
-* [git:xmloff/source/core/xmltoken.cxx]
-* [git:xmloff/source/token/tokens.txt]
-
+* `git:include/xmloff/xmltoken.hxx`
+* `git:xmloff/source/core/xmltoken.cxx`
+* `git:xmloff/source/token/tokens.txt`