summaryrefslogtreecommitdiffstats
path: root/src/dom/README
diff options
context:
space:
mode:
authorMenTaLguY <mental@rydia.net>2006-01-16 02:36:01 +0000
committermental <mental@users.sourceforge.net>2006-01-16 02:36:01 +0000
commit179fa413b047bede6e32109e2ce82437c5fb8d34 (patch)
treea5a6ac2c1708bd02288fbd8edb2ff500ff2e0916 /src/dom/README
downloadinkscape-179fa413b047bede6e32109e2ce82437c5fb8d34.tar.gz
inkscape-179fa413b047bede6e32109e2ce82437c5fb8d34.zip
moving trunk for module inkscape
(bzr r1)
Diffstat (limited to 'src/dom/README')
-rw-r--r--src/dom/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/dom/README b/src/dom/README
new file mode 100644
index 000000000..142d67ef3
--- /dev/null
+++ b/src/dom/README
@@ -0,0 +1,25 @@
+Phoebe DOM
+==========
+
+This is the DOM library that is going to provide
+Inkscape with a w3c DOM-idl interface, hopefully
+aiding in scripting and animation.
+
+The name 'Phoebe' in inherited from an older project
+which had its own DOM implementation. The name itself
+is of a moon of Saturn.
+
+The library is intended to be 'vanilla' and generic. The
+library has its own parser, even if it is not used.
+The base code should never be modified to be Inkscape-specific.
+It should not have any dependencies beyond STL, nor
+should it veer away from adherence to the W3C DOM APIs.
+
+The most common usage of this library would probably be
+limited to the classes defined in dom.h. A scriptable
+item would inherit and extend org::w3c::dom::Node, and modify
+the behaviour of the getters and setters for its attributes.
+
+
+
+Bob Jamison