Tue Feb 7 22:47:43 PST 2012

MathMLDTD/README      |    4 ++++
 UnoControls/README    |    1 +
 accessibility/README  |    1 +
 basctl/README         |    1 +
 basebmp/README        |    7 +++++++
 basegfx/README        |    1 +
 bean/README           |    3 +++
 canvas/README         |   50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 canvas/overview.txt   |   50 --------------------------------------------------
 chart2/README         |    1 +
 comphelper/README     |    1 +
 cppcanvas/README      |    1 +
 crashrep/README       |    1 +
 dbaccess/README       |    1 +
 dtrans/README         |    1 +
 embedserv/README      |    1 +
 extensions/README     |    1 +
 filter/README         |    1 +
 forms/README          |    1 +
 hwpfilter/REDME       |    1 +
 lingucomponent/README |    1 +
 lotuswordpro/README   |    1 +
 o3tl/README           |   30 ++++++++++++++++++++++++++++++
 oox/README            |    4 ++++
 package/README        |    1 +
 padmin/README         |    1 +
 psprint_config/README |    3 +++
 regexp/README         |    6 ++++++
 reportdesign/README   |    1 +
 rsc/README            |   10 ++++++++++
 sax/README            |    1 +
 scaddins/README       |    4 ++++
 sccomp/README         |    1 +
 sot/README            |    1 +
 svtools/README        |    1 +
 toolkit/README        |    1 +
 tools/README          |    1 +
 ucbhelper/README      |    1 +
 unotools/README       |    1 +
 unoxml/README         |    1 +
 vcl/README            |    2 ++
 wizards/README        |    1 +
 writerfilter/README   |   25 ++++++++++++++-----------
 writerperfect/README  |    1 +
 xmerge/README         |    6 ++++++
 xmlsecurity/README    |    1 +
 46 files changed, 175 insertions(+), 61 deletions(-)

New commits:
commit b5fa0ec90515e58d65de080091d861e3f17688ba
Author: Josh Heidenreich <josh.sickmate at gmail.com>
Date:   Wed Feb 8 12:25:13 2012 +1030

    Added READMEs for modules used by LibO Base and LibO Calc.

diff --git a/chart2/README b/chart2/README
new file mode 100644
index 0000000..6e87ad9
--- /dev/null
+++ b/chart2/README
@@ -0,0 +1 @@
+Chart implementation for LibreOffice Calc.
diff --git a/dbaccess/README b/dbaccess/README
new file mode 100644
index 0000000..9f8e085
--- /dev/null
+++ b/dbaccess/README
@@ -0,0 +1 @@
+Database access tools, for "base" database application
diff --git a/reportdesign/README b/reportdesign/README
new file mode 100644
index 0000000..c6e0e67
--- /dev/null
+++ b/reportdesign/README
@@ -0,0 +1 @@
+Part of LibreOffice Base
diff --git a/scaddins/README b/scaddins/README
new file mode 100644
index 0000000..b27348c
--- /dev/null
+++ b/scaddins/README
@@ -0,0 +1,4 @@
+Extra functions for calc.
+
+See also:
+[http://wiki.services.openoffice.org/wiki/Scaddins]
diff --git a/sccomp/README b/sccomp/README
new file mode 100644
index 0000000..30cc749
--- /dev/null
+++ b/sccomp/README
@@ -0,0 +1 @@
+The (linear) solver for LibreOffice Calc.
commit 700b79412698fdf95c12b57bb01c8eacd9195763
Author: Josh Heidenreich <josh.sickmate at gmail.com>
Date:   Wed Feb 8 12:21:04 2012 +1030

    Added and improved READMEs for modules which used to be in filter

diff --git a/filter/README b/filter/README
new file mode 100644
index 0000000..dc98371
--- /dev/null
+++ b/filter/README
@@ -0,0 +1 @@
+Filter registration and some simple filters (also descriptions).
diff --git a/hwpfilter/REDME b/hwpfilter/REDME
new file mode 100644
index 0000000..e840700
--- /dev/null
+++ b/hwpfilter/REDME
@@ -0,0 +1 @@
+Filter for a word processor file format popular in Korea (Hangul Word Processor).
diff --git a/lotuswordpro/README b/lotuswordpro/README
new file mode 100644
index 0000000..4ec7104
--- /dev/null
+++ b/lotuswordpro/README
@@ -0,0 +1 @@
+Filter for file format of Lotus Word Pro.
diff --git a/oox/README b/oox/README
new file mode 100644
index 0000000..43b60bd
--- /dev/null
+++ b/oox/README
@@ -0,0 +1,4 @@
+Support for Office Open XML, the office XML-format designed by Microsoft.
+
+See also:
+[http://wiki.services.openoffice.org/wiki/OOX]
diff --git a/unoxml/README b/unoxml/README
new file mode 100644
index 0000000..6ca6382
--- /dev/null
+++ b/unoxml/README
@@ -0,0 +1 @@
+UNO wrappers for XML services.
diff --git a/writerfilter/README b/writerfilter/README
index 2728cd1..21687e3 100644
--- a/writerfilter/README
+++ b/writerfilter/README
@@ -1,13 +1,16 @@
-The writerfilter module contains import filters for Writer, using its
-UNO API.
+The writerfilter module contains import filters for Writer, using its UNO API.
 
-- inc: global headers (can be included by other modules)
-- prj: information for dmake
-- qa: unittests and subsequenttests
-- source: the filters themselves
+Import filter for docx, doc and rtf.
 
-  * dmapper: the domain mapper, hiding UNO from the tokenizers
-  * doctok: incomplete ww8 (.doc) tokenizer
-  * filter: the uno filter service implementations
-  * ooxml: the docx tokenizer
-  * rtftok: the rtf tokenizer
+== Module contents ==
+ * inc: global headers (can be included by other modules)
+ * prj: information for dmake
+ * qa: unittests and subsequenttests
+ * source: the filters themselves
+
+== Source contents ==
+ * dmapper: the domain mapper, hiding UNO from the tokenizers
+ * doctok: incomplete ww8 (.doc) tokenizer
+ * filter: the uno filter service implementations
+ * ooxml: the docx tokenizer
+ * rtftok: the rtf tokenizer
diff --git a/writerperfect/README b/writerperfect/README
new file mode 100644
index 0000000..388fd7c
--- /dev/null
+++ b/writerperfect/README
@@ -0,0 +1 @@
+Word Perfect filter, wrapper for [[libwpd]].
diff --git a/xmerge/README b/xmerge/README
new file mode 100644
index 0000000..d45f6c4
--- /dev/null
+++ b/xmerge/README
@@ -0,0 +1,6 @@
+For converting documents among from and into formats and also for merging them.
+
+Uses Java and plug-in architecture.
+
+See also:
+[http://xml.openoffice.org/xmerge/]
commit 223cca46ed86ae85ed5adb932a1651420bd8c006
Author: Josh Heidenreich <josh.sickmate at gmail.com>
Date:   Wed Feb 8 09:30:36 2012 +1030

    Added READMEs for modules which used to be in components

diff --git a/MathMLDTD/README b/MathMLDTD/README
new file mode 100644
index 0000000..68b1072
--- /dev/null
+++ b/MathMLDTD/README
@@ -0,0 +1,4 @@
+MathMLDTD implements XML Math format.
+
+See also:
+[http://www.w3.org/TR/REC-MathML]
diff --git a/UnoControls/README b/UnoControls/README
new file mode 100644
index 0000000..72348dc
--- /dev/null
+++ b/UnoControls/README
@@ -0,0 +1 @@
+Separate process and thread for progress bars, etc.
diff --git a/accessibility/README b/accessibility/README
new file mode 100644
index 0000000..9309e27
--- /dev/null
+++ b/accessibility/README
@@ -0,0 +1 @@
+Cares for accessibility.
diff --git a/basctl/README b/basctl/README
new file mode 100644
index 0000000..44cdd8f
--- /dev/null
+++ b/basctl/README
@@ -0,0 +1 @@
+Controls and dialogs for Basic. Contains the Basic IDE.
diff --git a/bean/README b/bean/README
new file mode 100644
index 0000000..213e8be
--- /dev/null
+++ b/bean/README
@@ -0,0 +1,3 @@
+To use Libre Office from Java applications.
+
+LibreOffice's API is completely exposed so that all office components can be fully controlled.
diff --git a/crashrep/README b/crashrep/README
new file mode 100644
index 0000000..306b807
--- /dev/null
+++ b/crashrep/README
@@ -0,0 +1 @@
+Reports crashes (Novell disabled that).
diff --git a/embedserv/README b/embedserv/README
new file mode 100644
index 0000000..fdc64c3
--- /dev/null
+++ b/embedserv/README
@@ -0,0 +1 @@
+To embed LibreOffice via OLE2.
diff --git a/extensions/README b/extensions/README
new file mode 100644
index 0000000..c7f6afa
--- /dev/null
+++ b/extensions/README
@@ -0,0 +1 @@
+Browser plugin, activex control, scanner bits.
diff --git a/forms/README b/forms/README
new file mode 100644
index 0000000..248da82
--- /dev/null
+++ b/forms/README
@@ -0,0 +1 @@
+Embedded forms control and pieces (design forms in documents, fields and database driven).
diff --git a/lingucomponent/README b/lingucomponent/README
new file mode 100644
index 0000000..b2e6717
--- /dev/null
+++ b/lingucomponent/README
@@ -0,0 +1 @@
+Spellcheck, hyphenator, thesaurus, etc.
diff --git a/package/README b/package/README
new file mode 100644
index 0000000..c9055df
--- /dev/null
+++ b/package/README
@@ -0,0 +1 @@
+Reading and writing ZIPs.
diff --git a/wizards/README b/wizards/README
new file mode 100644
index 0000000..c36091f
--- /dev/null
+++ b/wizards/README
@@ -0,0 +1 @@
+Java wizards for db setup, importing, tutorials, etc.
diff --git a/xmlsecurity/README b/xmlsecurity/README
new file mode 100644
index 0000000..3d18558
--- /dev/null
+++ b/xmlsecurity/README
@@ -0,0 +1 @@
+Stuff for document signing.
commit 8b9615be8898ccfa361b0de16af207aeaa6aa594
Author: Josh Heidenreich <josh.sickmate at gmail.com>
Date:   Wed Feb 8 09:06:58 2012 +1030

    Added (and improved) READMEs for modules which used to be in libs-gui

diff --git a/basebmp/README b/basebmp/README
new file mode 100644
index 0000000..f6dc914
--- /dev/null
+++ b/basebmp/README
@@ -0,0 +1,7 @@
+Provides a BitmapDevice: the vcl software renderer
+
+Provides algorithms and data types for bitmap graphics
+e.g. line and fill polygon scan conversion, bitmap format iterators, and a SalGraphics-compatible software renderer
+
+Used for example for wmf / svm files.
+E.g. used when you do -headless, and have no DISPLAY set - it's an all-software backend for the LibO graphic backend. also see [git:vcl/headless].
diff --git a/basegfx/README b/basegfx/README
new file mode 100644
index 0000000..99f0feb
--- /dev/null
+++ b/basegfx/README
@@ -0,0 +1 @@
+Algorithms and data types for graphics (e.g. polygons, vectors, matrices and the like - see that used in [[canvas]]).
diff --git a/canvas/README b/canvas/README
new file mode 100644
index 0000000..ee9dc58
--- /dev/null
+++ b/canvas/README
@@ -0,0 +1,50 @@
+New canvas implementation to improve rendering, various backends implement the new XCanvas API eg. Cairo / DirectX.
+
+== The new OOo Canvas Framework ==
+
+The new OpenOffice.org canvas framework is the successor of the system
+GUI and graphics backend VCL. Basic functionality is available,
+supplying just as much features as necessary to provide a
+VCL-equivalent feature set (except proper BiDi/CTL support).
+
+For migration purposes, the new canvas and VCL will be shipped with
+OpenOffice.org for quite some time, allowing a step-by-step adaptation
+of the applications. Therefore, the canvas and VCL must somehow
+interoperate, since new code, using the canvas, typically is embedded
+in a VCL-based environment (for example, the OOo windows are still
+provided by VCL. To render into such a window via the canvas, a canvas
+must be constructable from a VCL window). Thus, essentially two new
+methods are provided at VCL's window, namely Window::GetCanvas() and
+Window::GetFullScreenCanvas(). Apart from that small link, canvas and
+VCL are completely separated.
+
+The canvas framework currently consists of the following two new
+CVS modules, /gsl/canvas and /gsl/cppcanvas. Additionally, a new
+generic graphics tooling is used (but not exclusively by the canvas,
+Armin's recent drawing layer fixups also make use of it), which
+resides in /graphics/basegfx. From these modules, six libraries are
+currently delivered, namely vclcanvas.uno.dll, javacanvas.jar,
+directxcanvas.uno.dll, canvastools680mi.dll, cppcanvas680mi.dll, and
+basegfx680mi.dll.
+
+
+== The new OOo slideshow engine ==
+
+The new OpenOffice.org slideshow engine will replace the current
+Impress-embedded presentation framework with a fully independent UNO
+component, and it will be based on the new canvas. In its current
+state, it is able to provide a basic set of functionality, enabling
+the playback of simple presentations. It furthermore provides features
+like double-buffering, hardware-accelerated alpha-blending (currently
+not on all platforms) and anti-aliased rendering of all primitives.
+
+In a second step, this new slideshow engine will then be integrated
+with Impress model enhancements and extended PowerPoint import/export
+filters, to implement nearly all of PowerPoint's set of effects.
+
+The new slideshow engine is currently not accessible from the office
+UI, but included in the installations sets. Thus, other developers can
+start to use the new functionality, and base their own implementations
+on top of that. For the records, the respective UNO implementation of
+the slideshow resides in the slideshow.uno.dll library.
+
diff --git a/canvas/overview.txt b/canvas/overview.txt
deleted file mode 100644
index 5d508b0..0000000
--- a/canvas/overview.txt
+++ /dev/null
@@ -1,50 +0,0 @@
-The new OOo Canvas Framework
-============================
-
-The new OpenOffice.org canvas framework is the successor of the system
-GUI and graphics backend VCL. Basic functionality is available,
-supplying just as much features as necessary to provide a
-VCL-equivalent feature set (except proper BiDi/CTL support).
-
-For migration purposes, the new canvas and VCL will be shipped with
-OpenOffice.org for quite some time, allowing a step-by-step adaptation
-of the applications. Therefore, the canvas and VCL must somehow
-interoperate, since new code, using the canvas, typically is embedded
-in a VCL-based environment (for example, the OOo windows are still
-provided by VCL. To render into such a window via the canvas, a canvas
-must be constructable from a VCL window). Thus, essentially two new
-methods are provided at VCL's window, namely Window::GetCanvas() and
-Window::GetFullScreenCanvas(). Apart from that small link, canvas and
-VCL are completely separated.
-
-The canvas framework currently consists of the following two new
-CVS modules, /gsl/canvas and /gsl/cppcanvas. Additionally, a new
-generic graphics tooling is used (but not exclusively by the canvas,
-Armin's recent drawing layer fixups also make use of it), which
-resides in /graphics/basegfx. From these modules, six libraries are
-currently delivered, namely vclcanvas.uno.dll, javacanvas.jar,
-directxcanvas.uno.dll, canvastools680mi.dll, cppcanvas680mi.dll, and
-basegfx680mi.dll. 
-
-
-The new OOo slideshow engine
-============================
-
-The new OpenOffice.org slideshow engine will replace the current
-Impress-embedded presentation framework with a fully independent UNO
-component, and it will be based on the new canvas. In its current
-state, it is able to provide a basic set of functionality, enabling
-the playback of simple presentations. It furthermore provides features
-like double-buffering, hardware-accelerated alpha-blending (currently
-not on all platforms) and anti-aliased rendering of all primitives.
-
-In a second step, this new slideshow engine will then be integrated
-with Impress model enhancements and extended PowerPoint import/export
-filters, to implement nearly all of PowerPoint's set of effects.
-
-The new slideshow engine is currently not accessible from the office
-UI, but included in the installations sets. Thus, other developers can
-start to use the new functionality, and base their own implementations
-on top of that. For the records, the respective UNO implementation of
-the slideshow resides in the slideshow.uno.dll library.
-
diff --git a/comphelper/README b/comphelper/README
new file mode 100644
index 0000000..940d514
--- /dev/null
+++ b/comphelper/README
@@ -0,0 +1 @@
+GUI-related helper classes
diff --git a/cppcanvas/README b/cppcanvas/README
new file mode 100644
index 0000000..246cb2d
--- /dev/null
+++ b/cppcanvas/README
@@ -0,0 +1 @@
+Helper C++ classes for [[canvas]], plus a GDIMetaFile-to-XCanvas converter.
diff --git a/dtrans/README b/dtrans/README
new file mode 100644
index 0000000..23555bc
--- /dev/null
+++ b/dtrans/README
@@ -0,0 +1 @@
+Clipboard abstraction - data transfer.
diff --git a/o3tl/README b/o3tl/README
new file mode 100644
index 0000000..4823d60
--- /dev/null
+++ b/o3tl/README
@@ -0,0 +1,30 @@
+Very basic template functionality, a bit like boost or stl, but specific to LibO
+
+From [http://blog.thebehrens.net/2006/01/15/update-cow_wrapper-is-available-now/]
+The scope for o3tl is admittedly kind of ambitious, as it should contain "...very basic (template)
+functionality, comparable to what's provided by boost or stl, but specific to OOo (what comes to mind
+are e.g. stl adapters for our own data types and UNO, and stuff that could in principle be upstreamed
+to boost, but isn't as of now)."
+
+== Class overview ==
+
+[git:o3tl/inc/o3tl/cow_wrapper.hxx]
+A copy-on-write wrapper.
+
+[git:o3tl/inc/o3tl/heap_ptr.hxx]
+heap_ptr<> owns an object on the heap, which will be automatically deleted, when ~heap_ptr<>() is called.
+
+[git:o3tl/inc/o3tl/lazy_update.hxx]
+This template collects data in input type, and updates the output type with the given update functor,
+but only if the output is requested. Useful if updating is expensive, or input changes frequently, but
+output is only comparatively seldom used.
+
+[git:o3tl/inc/o3tl/range.hxx]
+Represents a range of integer or iterator values.
+
+[git:o3tl/inc/o3tl/vector_pool.hxx]
+Simple vector-based memory pool allocator.
+
+[git:o3tl/inc/o3tl/compat_functional.hxx]
+Some more templates. Contains also templates from STLport's functional header that are not part of the
+C++ standard (STLport has been replaced by direct use of the C++ STL in Libre Office).
diff --git a/padmin/README b/padmin/README
new file mode 100644
index 0000000..9b011ef
--- /dev/null
+++ b/padmin/README
@@ -0,0 +1 @@
+Printer administration dialog - used lpr - obsolete with CUPS and fontconfig, but still used for some things.
diff --git a/psprint_config/README b/psprint_config/README
new file mode 100644
index 0000000..15eb3f1
--- /dev/null
+++ b/psprint_config/README
@@ -0,0 +1,3 @@
+Contains ppds for use by psprint when not using CUPS.
+
+(CH: psprint seems to have been gone ???)
diff --git a/regexp/README b/regexp/README
new file mode 100644
index 0000000..c670bda
--- /dev/null
+++ b/regexp/README
@@ -0,0 +1,6 @@
+This is a regexp parser.
+
+Please see my (not so?) crazy hack idea about removing it from here and the reasoning.
+
+For additional fun, this source file is part of GNU regexp which is geared towards usage in emacs,
+so if you ever wondered why LibreOffice is so great, now you know :-).
diff --git a/rsc/README b/rsc/README
new file mode 100644
index 0000000..09e2cd5
--- /dev/null
+++ b/rsc/README
@@ -0,0 +1,10 @@
+Resource Compiler.
+
+There is some German documentation about it in a subdirectory called [git:rsc/doku].
+Seems to be very old (January 1992).
+
+From rsc.sdw (in German):
+The StarView Resource Compiler (rsc) is used, to convert the system-independent
+resources in the description files to native description files which in turn are
+compiled efficiently (runtime) by the system's native resource compiler in binary
+resources.
diff --git a/sax/README b/sax/README
new file mode 100644
index 0000000..5bd1d1d
--- /dev/null
+++ b/sax/README
@@ -0,0 +1 @@
+Wrapper around expat using UNO.
diff --git a/sot/README b/sot/README
new file mode 100644
index 0000000..2abadba
--- /dev/null
+++ b/sot/README
@@ -0,0 +1 @@
+Compound file storage tools code.
diff --git a/svtools/README b/svtools/README
new file mode 100644
index 0000000..dc35c3f
--- /dev/null
+++ b/svtools/README
@@ -0,0 +1 @@
+Tools on top of VCL. Common dialogs, file and print dialogs, wizards, vcl filters, lots of helper code.
diff --git a/toolkit/README b/toolkit/README
new file mode 100644
index 0000000..960e22a
--- /dev/null
+++ b/toolkit/README
@@ -0,0 +1 @@
+Abstract windowing thing, UNO implementations of windows stuff so that it can be used from Basic.
diff --git a/tools/README b/tools/README
new file mode 100644
index 0000000..990aff8
--- /dev/null
+++ b/tools/README
@@ -0,0 +1 @@
+Predates sal - string etc . functions, url manip, stream stuff, polygons, etc.
diff --git a/ucbhelper/README b/ucbhelper/README
new file mode 100644
index 0000000..ff3d49b
--- /dev/null
+++ b/ucbhelper/README
@@ -0,0 +1 @@
+C++ wrappers to help make using content providers easy.
diff --git a/unotools/README b/unotools/README
new file mode 100644
index 0000000..bac492a
--- /dev/null
+++ b/unotools/README
@@ -0,0 +1 @@
+Helpers for C++ use of UNO.
diff --git a/vcl/README b/vcl/README
index 97ff76a..81afba0 100644
--- a/vcl/README
+++ b/vcl/README
@@ -1,3 +1,5 @@
+Visual Components Library is responsible for the widgets (windowing, buttons, controls, etc.) operating system abstraction, including basic rendering (e.g. the output device).
+
 Welcome to the Visual Class Libraries (vcl) code
 
 source/
