                          README for Calligra Sheets


This is the source tree for Calligra Sheets, the Calligra spreadsheet program.

If you are a developer, you will find more information in the doc/
directory.  Beware that at the current point of time (2.1 beta2), not
all information there may be up to date.  The main task list can be
found in ./TODO.  Note that this file may also contain some out of
date information.

If you are a user, you will find more user-oriented information in
doc/sheets in the top directory of Calligra.


What's where - where's what
---------------------------

./
    Document related code, independent from any visualization.

chart/
    The dialog appearing when the user creates a new chart.
    Used to get the currently selected cell range as data set.

commands/
    Commands used for both, the KPart and the flake shape.

data/
    Icons and templates.

database/
    Database range related code, e.g. auto-filtering.

dialogs/
    Dialogs used for both, the KPart and the flake shape.

doc/
    Developer documentation.

dtd/
    Document Type Definition of the old KSpread file format.

interfaces/
    DBus adaptors and data models.

part/
    Everything, that is only needed for the KPart, i.e. for Calligra Sheets itself and
    for the embedding into non-Calligra applications using the KPart framework.
    Everything means document AND view/controller related.

plugins/
    Functions modules, Kross scripting, tools, etc.

shape/
    The flake shape, that can be embedded into other Calligra apps, and its tool.

tests/
    Unit tests.

ui/
    General user interface (view/controller) related code, i.e. code that's
    used by both visualizations, the KPart and the flake shape.
