From deec9bd9b0ce663d1100cdef402a9d4d18e1cc72 Mon Sep 17 00:00:00 2001 From: Michael Stahl Date: Tue, 31 Mar 2015 14:55:56 +0200 Subject: README.md: framework is not a wrapper around sfx2 Change-Id: I1af3c4bdabe4dd9578ddf04c621358b08f6866ae --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e362798690e9..501c4a0deee6 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,11 @@ A quick overview of the LibreOffice code structure. You can develop for LibreOffice in one of two ways, one recommended and one much less so. First the somewhat less recommended -way: it is possible to use the SDK, for which you can read the API -docs [here](http://api.libreoffice.org/). This re-uses the (extremely -generic) APIs we provide for macro scripting in StarBasic. +way: it is possible to use the SDK to develop an extension, +for which you can read the API docs [here](http://api.libreoffice.org/) +and [here](http://wiki.services.openoffice.org/wiki/Documentation/DevGuide). +This re-uses the (extremely generic) UNO APIs that are also used by +macro scripting in StarBasic. The best way to add a generally useful feature to LibreOffice is to work on the code base however. Overall this way makes it easier @@ -33,18 +35,18 @@ Module | Description sal/ | this provides a simple System Abstraction Layer tools/ | this provides basic internal types: 'Rectangle', 'Color' etc. vcl/ | this is the widget toolkit library and one rendering abstraction -svx/ | graphics related helper code, including much of 'draw' / 'impress' -sfx2/ | core framework: document model / load/save / signals for actions etc. -framework | UNO wrappers around the core framework, responsible for building toolbars, menus, status bars, and the chrome around the document using widgets from VCL, and XML descriptions from */uiconfig/ files +framework | UNO framework, responsible for building toolbars, menus, status bars, and the chrome around the document using widgets from VCL, and XML descriptions from */uiconfig/* files +sfx2/ | legacy core framework used by Writer/Calc/Draw: document model / load/save / signals for actions etc. +svx/ | drawing model related helper code, including much of Draw/Impress Then applications Module | Description ----------|------------------------------------------------- desktop/ | this is where the 'main' for the application lives, init / bootstrap. the name dates back to an ancient StarOffice that also drew a desktop -sw/ | writer. -sc/ | calc -sd/ | draw / impress +sw/ | Writer +sc/ | Calc +sd/ | Draw / Impress There are several other libraries that are helpful from a graphical perspective: @@ -54,7 +56,7 @@ basebmp/ | enables a VCL compatible rendering API to render to bitmaps, as used basegfx/ | algorithms and data-types for graphics as used in the canvas canvas/ | new (UNO) canvas rendering model with various backends cppcanvas/ | C++ helper classes for using the UNO canvas -drawinglayer/ | code to render and manage document drawing shapes and break them down into primitives we can render more easily. +drawinglayer/ | View code to render drawable objects and break them down into primitives we can render more easily. ## Finding out more -- cgit v1.2.3