Mailing-List: contact dev-help@cocoon.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@cocoon.apache.org
Received-SPF: neutral (hermes.apache.org: local policy)
Date: Thu, 16 Dec 2004 19:03:02 +1100
From: David Crossley <crossley@apache.org>
To: dev@cocoon.apache.org
Subject: Re: how to list all sitemap components
Message-ID: <20041216080302.GA580@igg.indexgeo.com.au>
References: <20041215103120.GA20521@igg.indexgeo.com.au>
 <200412151326.iBFDQbbK015609@www2.kc.aoindustries.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <200412151326.iBFDQbbK015609@www2.kc.aoindustries.com>
User-Agent: Mutt/1.4i

Carsten Ziegeler wrote:
> David Crossley wrote: 
> 
> > Okay, i uploaded them to my ASF committer space 
> > www.apache.org ~crossley/review-sitemap-docs/ See the notes 
> > in SVN cocoon-2_1_X/tools/review-sitemap-docs/README.txt
> > and cocoon-2_1_X/tools/review-sitemap-docs/TODO.txt
> > 
> Thanks!!
> 
> So if I read the diff correctly, these classes are not found by the sitemap
> task:
> 65a64,71
> >
> org/apache/cocoon/components/pipeline/impl/AbstractCachingProcessingPipeline
> > org/apache/cocoon/components/pipeline/impl/BaseCachingProcessingPipeline
> > org/apache/cocoon/components/pipeline/impl/CachingPointProcessingPipeline
> > org/apache/cocoon/components/pipeline/impl/CachingProcessingPipeline
> >
> org/apache/cocoon/components/pipeline/impl/ExpiresCachingProcessingPipeline
> > org/apache/cocoon/components/pipeline/impl/NonCachingProcessingPipeline
> > org/apache/cocoon/components/profiler/ProfilingCachingProcessingPipeline
> >
> org/apache/cocoon/components/profiler/ProfilingNonCachingProcessingPipeline
> > org/apache/cocoon/woody/acting/AbstractWoodyAction
> > org/apache/cocoon/woody/acting/HandleFormSubmitAction
> > org/apache/cocoon/woody/acting/MakeFormAction
> > org/apache/cocoon/woody/generation/WoodyGenerator
> > org/apache/cocoon/woody/samples/InitForm1Action
> > org/apache/cocoon/woody/transformation/WoodyTemplateTransformer
> > org/apache/garbage/serializer/AbstractSerializer
> > org/apache/garbage/serializer/EncodingSerializer
> > org/apache/garbage/serializer/HTMLSerializer
> > org/apache/garbage/serializer/XHTMLSerializer
> > org/apache/garbage/serializer/XMLSerializer
> 
> Is this correct?

That is the trouble - i don't know what is "correct".

The file called components-javadoc-sitemaptask-diff.txt
is the difference between the list produced by scanning
javadocs (finding extra clutter, maybe missing some)
and the list produced by the SitemapTask.
diff components-source.txt components-sitemaptask.txt

This is not to say that the scanning javadocs is finding
all components. It is just to provide a method for
comparison.

Here are some examples of components that are not
found by the SitemapTask ...
org/apache/cocoon/matching/RegexpTargetHostMatcher
org/apache/cocoon/transformation/JXTemplateTransformer
org/apache/cocoon/selection/SessionStateSelector
org/apache/cocoon/transformation/CachingCIncludeTransformer
org/apache/cocoon/forms/formmodel/RepeaterAction

The "woody" and "garbage" stuff are probably not relevant.
The PhpGenerator is listed as missing because it caused
'build docs' to crash, so i moved it out of the way.

The *Pipeline components that you listed above are found
by the SitemapTask but not by the scan of javadocs. That
is because the correlate-table.sh script forgot to look
for pipelines. But do we consider them "sitemap components"
that should be documented in the Userdocs?

--David