Date: 2004-03-29T14:41:57
Editor: AdamJack <[EMAIL PROTECTED]>
Wiki: Gump Wiki
Page: GumpRunDocumentation
URL: http://wiki.apache.org/gump/GumpRunDocumentation
no comment
Change Log:
------------------------------------------------------------------------------
@@ -12,6 +12,21 @@
Note: That said, this could be split into two parts -- with pages for single
modules/projects being creates as available (much sooner) and only the cross entity
pages created last.
+=== Complicatng Factors ===
+
+Given that forrest is used to generate the site, additional content (server.xml,
*.rss|*.atom feed) and other non-documentation artifacts, has to be placed into
{forrest-work}/src/documentation/content after the template is syncronized in, and
before the forrest run occurs. As such the Documenter 'interface' has a prepare()
method that allows the sub-class to implement prepareRun() or not. This is called
prior to those syndication/results steps, and before documentation.
+
+{{{
+ #
+ # Call a method called 'prepareRun(run)', if needed
+ #
+ def prepare(self,run):
+ if not hasattr(self,'prepareRun'): return
+ if not callable(self.prepareRun): return
+ log.info('Prepare to document run using [' + `self` + ']')
+ self.prepareRun(run)
+}}}
+
=== Implementation ===
Documented is achieved using a few classes:
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
