Date: 2004-03-29T10:01:14
Editor: AdamJack <[EMAIL PROTECTED]>
Wiki: Gump Wiki
Page: GumpRunDocumentation
URL: http://wiki.apache.org/gump/GumpRunDocumentation
no comment
Change Log:
------------------------------------------------------------------------------
@@ -21,7 +21,9 @@
=== Resolver ===
-This component is important in part because other aspects (e.g. RSS|Atom feeds,
Notification e-mails) need to be able to refer to some aspect (a failed work item, a
project page) without knowing which documenter was user. Also, this can be quite
complicated (especialyl for Forrest with content and content/xdocs) and we need to
centralize the logic to avoid duplication/error.
+This component is important in part because other aspects (e.g. RSS|Atom feeds,
Notification e-mails) need to be able to refer to some entity (a failed work item, a
project page) without knowing which documenter was used.
+
+Also, calculating the URL/path can be quite complicated (especially for Forrest with
content and content/xdocs, and with safe naming) and we need to centralize the logic
to avoid duplication/error.
=== Documenter ===
@@ -46,7 +48,7 @@
If project not in gump set: continue
Document the project(see block below)
-Basically each block looks like this:
+Basically blocks looks like this:
* Select a file for an entity (the resolver determines the name/where)
* Generate xdoc sections (e.g. details, or dependencies or)
@@ -61,8 +63,14 @@
* Generate a section (with table with rows/data) for all Files held by FileHolder
* Generate a section (with list/items) for Statistics
+There are some helper methods for displaying a state icon for an entity.
+
=== xdocs ===
+This is a home grown, DOM-like, approach. A basic XDocPiece base class exists that is
sub-classes for Document or Section or Paragraph, etc. These classes have createX
methods that allow creation of sub-elements into it's own list of children.
Effectively, this encapsulates the xdoc rules in code, since not child can be created
without a method on the parent.
+
+Helper methods exist make common combinations, e.g. to create a Table and add titles
from a list of strings, e.g. to add a line to a table with title/value, two datum.
+When a XDocDocument is serialized it recursively outputs the tag (e.g. <P>), outputs
it's children (including text nodes), then outputs it's closed tag (e.g. </P).
== How we could take them forward ==
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
