README.md

   1 A quick overview of the LibreOffice code structure.
   2
   3 ## Overview
   4
   5 You can develop for LibreOffice in one of two ways, one
   6 recommended and one much less so. First the somewhat less recommended
   7 way: it is possible to use the SDK, for which you can read the API
   8 docs [here](http://api.libreoffice.org/). This re-uses the (extremely
   9 generic) APIs we provide for macro scripting in StarBasic.
  10
  11 The best way to add a generally useful feature to LibreOffice
  12 is to work on the code base however. Overall this way makes it easier
  13 to compile and build your code, it avoids any arbitrary limitations of
  14 our scripting APIs, and in general is far more simple and intuitive -
  15 if you are a reasonably able C++ programmer.
  16
  17
  18 ## The important bits of code
  19
  20 Each module should have a `README` file inside it which has some
  21 degree of documentation for that module; patches are most welcome to
  22 improve those. We have those turned into a web page here:
  23
  24 http://docs.libreoffice.org/
  25
  26 However, there are two hundred modules, many of them of only
  27 peripheral interest for a specialist audience. So - where is the
  28 good stuff, the code that is most useful. Here is a quick overview of
  29 the most important ones:
  30
  31 Module    | Description
  32 ----------|-------------------------------------------------
  33 sal/      | this provides a simple System Abstraction Layer
  34 tools/    | this provides basic internal types: 'Rectangle', 'Color' etc.
  35 vcl/      | this is the widget toolkit library and one rendering abstraction
  36 svx/      | graphics related helper code, including much of 'draw' / 'impress'
  37 sfx2/     | core framework: document model / load/save / signals for actions etc.
  38 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
  39
  40 Then applications
  41
  42 Module    | Description
  43 ----------|-------------------------------------------------
  44 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
  45 sw/       | writer.
  46 sc/       | calc
  47 sd/       | draw / impress
  48
  49 There are several other libraries that are helpful from a graphical perspective:
  50
  51 Module    | Description
  52 ----------|-------------------------------------------------
  53 basebmp/  | enables a VCL compatible rendering API to render to bitmaps, as used for LibreOffice Online, Android, iOS, etc.
  54 basegfx/  | algorithms and data-types for graphics as used in the canvas
  55 canvas/   | new (UNO) canvas rendering model with various backends
  56 cppcanvas/ | C++ helper classes for using the UNO canvas
  57 drawinglayer/ | code to render and manage document drawing shapes and break them down into primitives we can render more easily.
  58
  59
  60 ## Finding out more
  61
  62 Beyond this, you can read the `README` files, send us patches, ask
  63 on the mailing list libreoffice@lists.freedesktop.org (no subscription
  64 required) or poke people on IRC `#libreoffice-dev` on irc.freenode.net -
  65 we're a friendly and generally helpful mob. We know the code can be
  66 hard to get into at first, and so there are no silly questions.