diff --git a/README b/README new file mode 100644 index 0000000..208a00c --- /dev/null +++ b/README @@ -0,0 +1,55 @@ +TabellioOOo +=========== + +This file lists and explains the different components. + +addon/ +------ + +The OpenOffice.org extension, it holds the implementation of the various +commands and dialogs exposed in the OOo user interface. + +It follows Python standard coding style except when required by OOo API (which +was created following Java coding style, e.g. it has reverse domain notation). + + +legi2odf/ +--------- + +Conversion script from .legi to Open Document Format, based on XSL +transformations. + + +legi2pdf/ +--------- + +Publication script from .legi to PDF, mix of Python code and XSL +transformations inherited from the docbook-xsl package. + + +odf2legi/ +--------- + +Conversion script from Open Document Format to .legi, it is pure Python and +follows PEP-8. It has unit tests created using the unittest module. + + +ods2xmls/ +--------- + +Transformation script, taking a spreadsheet of several tables, listing actors +(e.g. deputies), and outputting the XML required by the OpenOffice.org addon. + + +server/ +------- + +SCGI server handling calls to various scripts, to provide remote support for +converting and transforming between formats. + + +win32legiopen/ +-------------- + +Win32 client calling to the server to convert from .legi to Open Document +Format, as well as opening the resulting file.