summaryrefslogtreecommitdiff
path: root/sd
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 /sd
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 'sd')
-rw-r--r--sd/README.md48
1 files changed, 25 insertions, 23 deletions
diff --git a/sd/README.md b/sd/README.md
index c250d81e7c6c..4413a0776210 100644
--- a/sd/README.md
+++ b/sd/README.md
@@ -1,43 +1,45 @@
+# LibreOffice Impress / Draw Application
+
The core directory for the impress/draw applications.
Think of impress as a hack on top of draw.
-
-sd module contains impress/draw specific code, non-shared UI and part
-of ppt and pptx filter, few other filters too.
+`sd` module contains impress/draw specific code, non-shared UI and part
+of `ppt` and `pptx` filter, few other filters too.
the slideshow UI lives here as well, the slideshow engine is in
-slideshow module though (including the 3D transitions engine
-slideshow/source/engine/opengl).
+`slideshow` module though (including the 3D transitions engine
+`slideshow/source/engine/opengl`).
-the most used filters are ODF's odp, binary ppt and OOXML's
-pptx. their locations are listed below:
+the most used filters are ODF's `odp`, binary ppt and OOXML's
+`pptx`. their locations are listed below:
- * odp import and export filters are in xmloff module (mostly xmloff/source/draw)
+ * `odp` import and export filters are in `xmloff` module (mostly `xmloff/source/draw`)
- * ppt import is in sd/source/filter/ppt (big shared chunks are also in svx)
- * ppt export is in sd/source/filter/eppt (big shared chunks are also in svx)
+ * `ppt` import is in `sd/source/filter/ppt` (big shared chunks are also in `svx`)
+ * `ppt` export is in `sd/source/filter/eppt` (big shared chunks are also in `svx`)
- * pptx import is in oox/source/ppt (and uses a lot of
- oox/source/drawingml and oox/source/*)
- * pptx export is in sd/source/filter/eppt (mostly in pptx-* source
- files) and shared part is in oox/source/export
+ * `pptx` import is in `oox/source/ppt` (and uses a lot of
+ `oox/source/drawingml` and `oox/source/*`)
+ * `pptx` export is in `sd/source/filter/eppt` (mostly in `pptx-*` source
+ files) and shared part is in `oox/source/export`
-== PPTX export/import filters ==
+## PPTX Export / Import Filters
PPTX export filter is split into 2 parts. Impress related part is in
-sd/source/filter/eppt/pptx-* and the other part is in
-oox/source/export/ because it contains mostly code related to
-DrawingML, which is shared with writer and calc ooxml export.
+`sd/source/filter/eppt/pptx-*` and the other part is in
+`oox/source/export/` because it contains mostly code related to
+`DrawingML`, which is shared with writer and calc ooxml export.
The export filter was written in 2009 IIRC and was not much extended
feature-wise lately.
-FUTURE work: add custom shapes export (see below). enhance text
+## Future Works
+Add custom shapes export (see below). enhance text
output, we don't write text style for indentation levels now, need to
-export a:lvl1pPr, a:lvl2pPr, ... elements.
+export `a:lvl1pPr`, `a:lvl2pPr`, ... elements.
-PPTX import was written by Sun/Oracle and then extended in LibreOffice
-a lot during bug fixing. It is located in oox/source/ppt and
-oox/source/drawingml. The areas with most bugs (at least until today)
+`PPTX` import was written by Sun/Oracle and then extended in LibreOffice
+a lot during bug fixing. It is located in `oox/source/ppt` and
+`oox/source/drawingml`. The areas with most bugs (at least until today)
were shape placeholders and text style inheritance.