summaryrefslogtreecommitdiff
path: root/filter
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 /filter
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 'filter')
-rw-r--r--filter/README.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/filter/README.md b/filter/README.md
index 78d469a6859f..19caeb73eaf9 100644
--- a/filter/README.md
+++ b/filter/README.md
@@ -1,24 +1,24 @@
+# LibreOffice Filters
+
Filter registration and some simple filters (also descriptions).
Desperate splitting of code into small shared libraries for historical
reasons presumably (OS/2 and Windows 3.x). The libraries produced from
-the code in each subdirectory of filter/source/graphicfilter are
+the code in each subdirectory of `filter/source/graphicfilter` are
graphic format import or export filters. But they don't have uniform
-API. Some have either a GraphicImport or GraphicExport entry point,
+API. Some have either a `GraphicImport` or `GraphicExport` entry point,
and are loaded and used in a uniform fashion from code in
-svtools/source/filter/filter.cxx. Others have different API and are
-loaded from other places. For instance "icgm" has ImportCGM, and is
-loaded and used by sd/source/filter/cgm/sdcgmfilter.cxx (!).
-Svgreader is used for "File->Open" and then to choose the svg file.
-For "Insert->Picture->From File", see svgio/source/svgreader directory.
+`svtools/source/filter/filter.cxx`. Others have different API and are
+loaded from other places. For instance `icgm` has `ImportCGM`, and is
+loaded and used by `sd/source/filter/cgm/sdcgmfilter.cxx` (!).
+Svgreader is used for "File -> Open" and then to choose the svg file.
+For "Insert -> Picture -> From File", see `svgio/source/svgreader` directory.
-====================
-filter configuration
-====================
+## Filter Configuration
The filter configuration consists of two parts, the type definition in
-filter/source/config/fragments/types/ and the actual filter definition
-in filter/source/config/fragments/filters/.
+`filter/source/config/fragments/types/` and the actual filter definition
+in `filter/source/config/fragments/filters/`.
Each file type e.g. text file should be represented by exactly one
type definition. This type can then be referenced by several different