Menu
▾
▴
[Archetypes-checkins] r12957 - AGX/agx.sphinx/trunk/docs/source/developers
|
From: Robert N. <svn...@pl...> - 2010-07-24 13:47:27
|
Author: rnix
Date: Sat Jul 24 13:47:19 2010
New Revision: 12957
Added:
AGX/agx.sphinx/trunk/docs/source/developers/overview.txt
- copied, changed from r12944, AGX/agx.sphinx/trunk/docs/source/developers/configgraph.txt
Removed:
AGX/agx.sphinx/trunk/docs/source/developers/configgraph.txt
AGX/agx.sphinx/trunk/docs/source/developers/extending_agx.txt
Modified:
AGX/agx.sphinx/trunk/docs/source/developers/index.txt
AGX/agx.sphinx/trunk/docs/source/developers/under_the_hood.txt
Log:
reorganize some stuff
Modified: AGX/agx.sphinx/trunk/docs/source/developers/index.txt
==============================================================================
--- AGX/agx.sphinx/trunk/docs/source/developers/index.txt (original)
+++ AGX/agx.sphinx/trunk/docs/source/developers/index.txt Sat Jul 24 13:47:19 2010
@@ -8,11 +8,8 @@
.. toctree::
:maxdepth: 2
- Under the Hood <under_the_hood>
Setup Development Environment <setup>
- Extending AGX <extending_agx>
- AGX Configuration Overview <configgraph>
+ Under the Hood <under_the_hood>
+ AGX Overview <overview>
Handler Documentation <handler>
API Documentation <api/api>
-
-
Copied: AGX/agx.sphinx/trunk/docs/source/developers/overview.txt (from r12944, AGX/agx.sphinx/trunk/docs/source/developers/configgraph.txt)
==============================================================================
--- AGX/agx.sphinx/trunk/docs/source/developers/configgraph.txt (original)
+++ AGX/agx.sphinx/trunk/docs/source/developers/overview.txt Sat Jul 24 13:47:19 2010
@@ -1,4 +1,113 @@
-Generators Overview
-===================
+AGX Overview
+============
+
+This document shows an overview of package dependencies and the recent
+AGX configuration.
+
+It's a good starting point when writing generators and handlers to figure out
+the right place for your stuff.
+
+AGX Package Dependencies
+------------------------
+
+**Legend**:
+
+.. graphviz::
+ digraph depslegend {
+
+ }
+
+.. graphviz::
+
+ digraph dependencies {
+ size = "9,9"
+
+ "lxml" [style="filled", fillcolor="grey90", label="lxml"]
+ "uuid" [style="filled", fillcolor="grey90", label="uuid"]
+ "odict" [style="filled", fillcolor="grey90", label="odict"]
+ "zodict" [style="filled", fillcolor="grey90", label="zodict"]
+ "Chameleon" [style="filled", fillcolor="grey90", label="Chameleon"]
+ "Jinja2" [style="filled", fillcolor="grey90", label="Jinja2"]
+
+ "zope.location" [style="filled", fillcolor="grey90", label="zope.location"]
+ "zope.configuration" [style="filled", fillcolor="grey90", label="zope.configuration"]
+ "zope.lifecycleevent" [style="filled", fillcolor="grey90", label="zope.lifecycleevent"]
+ "zope.documenttemplate" [style="filled", fillcolor="grey90", label="zope.documenttemplate"]
+
+ "agx.core" [style="filled", fillcolor="gold", label="agx.core"]
+
+ "agx.io.directory" [style="filled", fillcolor="seagreen2", label="agx.io.directory"]
+ "agx.io.python" [style="filled", fillcolor="seagreen2", label="agx.io.directory"]
+ "agx.io.template" [style="filled", fillcolor="seagreen2", label="agx.io.template"]
+ "agx.io.uml" [style="filled", fillcolor="seagreen2", label="agx.io.uml"]
+ "agx.io.xml" [style="filled", fillcolor="seagreen2", label="agx.io.xml"]
+ "agx.io.xmi" [style="filled", fillcolor="seagreen2", label="agx.io.xmi"]
+ "agx.io.zcml" [style="filled", fillcolor="seagreen2", label="agx.io.zcml"]
+
+ "agx.transform.uml2fs" [style="filled", fillcolor="steelblue1", label="agx.transform.uml2fs"]
+ "agx.transform.xmi2uml" [style="filled", fillcolor="steelblue1", label="agx.transform.xmi2uml"]
+
+ "agx.generator.uml" [style="filled", fillcolor="tan1", label="agx.generator.uml"]
+ "agx.generator.pyegg" [style="filled", fillcolor="tan1", label="agx.generator.pyegg"]
+ "agx.generator.zca" [style="filled", fillcolor="tan1", label="agx.generator.zca"]
+
+ "agx.flavour.dev" [style="filled", fillcolor="yellow2", label="agx.flavour.dev"]
+
+ "zodict" -> "uuid"
+ "zodict" -> "odict"
+ "zodict" -> "zope.location"
+ "zodict" -> "zope.lifecycleevent"
+
+ "agx.flavour.dev" -> "agx.generator.uml"
+ "agx.flavour.dev" -> "agx.generator.zca"
+
+ "agx.core" -> "zodict"
+ "agx.core" -> "zope.configuration"
+
+ "agx.io.directory" -> "zodict"
+
+ "agx.io.python" -> "agx.io.directory"
+
+ "agx.io.template" -> "agx.io.directory"
+ "agx.io.template" -> "zope.documenttemplate"
+ "agx.io.template" -> "Chameleon"
+ "agx.io.template" -> "Jinja2"
+
+ "agx.io.uml" -> "zodict"
+
+ "agx.io.xmi" -> "agx.io.xml"
+
+ "agx.io.xml" -> "zodict"
+ "agx.io.xml" -> "lxml"
+
+ "agx.io.zcml" -> "agx.io.xml"
+
+ "agx.transform.xmi2uml" -> "agx.core"
+ "agx.transform.xmi2uml" -> "agx.io.xmi"
+ "agx.transform.xmi2uml" -> "agx.io.uml"
+
+ "agx.transform.uml2fs" -> "agx.core"
+ "agx.transform.uml2fs" -> "agx.io.directory"
+
+ "agx.generator.uml" -> "agx.transform.xmi2uml"
+
+ "agx.generator.pyegg" -> "agx.io.template"
+ "agx.generator.pyegg" -> "agx.io.python"
+ "agx.generator.pyegg" -> "agx.io.uml"
+ "agx.generator.pyegg" -> "agx.transform.uml2fs"
+
+ "agx.generator.zca" -> "agx.generator.pyegg"
+ "agx.generator.zca" -> "agx.io.zcml"
+ }
+
+AGX Configuration
+-----------------
+
+**Legend**:
+
+.. graphviz::
+ digraph configlegend {
+
+ }
.. agxconfiggraph::
Modified: AGX/agx.sphinx/trunk/docs/source/developers/under_the_hood.txt
==============================================================================
--- AGX/agx.sphinx/trunk/docs/source/developers/under_the_hood.txt (original)
+++ AGX/agx.sphinx/trunk/docs/source/developers/under_the_hood.txt Sat Jul 24 13:47:19 2010
@@ -3,13 +3,9 @@
Introducing the tree transformation framework
---------------------------------------------
-
-Historically AGX is the successor of ArchGenXML, a tool to generate Plone
-Content Types from UML diagrams for the Plone CMS.
-
-This modern AGX is now much more than "only" code generation from UML diagrams.
-Basically it consists of transformation processing components and a crafty I/O
-system. Latter could be used apart from tree transformation tasks as well to
+
+Basically AGX consists of transformation processing components and a crafty I/O
+concept. Latter could be used apart from tree transformation tasks as well to
read and write data.
The transform components treat all input/output data as **tree**, which makes it
@@ -24,14 +20,14 @@
source, such as UML.
The framework is based on the Zope Component Architecture (ZCA), thus pluggable
-and highly customizable, and - easy to use once you understand how it works.
+and highly customizable.
We tried to make extension work for developers as easy and as less code
expensive as possible at the same time.
Thus its easy for you to write own generators and hook them in existing
transformation chains. Extending i.e. UML models by profiles with stereotypes
-and tagged values and providing additional generators enables new behaviour in
+and tagged values and providing additional generators enables new behavior in
your generated code.
Naming Conventions
@@ -69,7 +65,7 @@
Trees and Leafs: The Node
-------------------------
-We designed the framework to treat every data as tree - as the term
+We designed the software to treat every data as tree - as the term
*tree transformation* implies.
Most data structures could be described as trees, i.e. a SQL table has its
@@ -133,7 +129,7 @@
Responsible to do atomic transformation related tasks. Finally here data may
be transfered from source to target. I.e creation and adding of target nodes,
copy data to specific target nodes, collecting data on ``Token`` instances
- and any other required task
+ and any other required task.
``Token``
For information and data exchange inside the transformation chain there exist
@@ -203,4 +199,3 @@
controller=>controller [ label = "next" ];
--- [label = "end iteration over transform names",textcolor="maroon",linecolor="red"];
controller=>controller [ label = "persist last target" ];
-
|