Review of sitemap component documentation

Return-Path: Delivered-To: apmail-cocoon-cvs-archive@www.apache.org Received: (qmail 91248 invoked from network); 24 Feb 2005 13:09:55 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur-2.apache.org with SMTP; 24 Feb 2005 13:09:55 -0000 Received: (qmail 56327 invoked by uid 500); 24 Feb 2005 13:09:54 -0000 Delivered-To: apmail-cocoon-cvs-archive@cocoon.apache.org Received: (qmail 56256 invoked by uid 500); 24 Feb 2005 13:09:54 -0000 Mailing-List: contact cvs-help@cocoon.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@cocoon.apache.org list-help: list-unsubscribe: List-Post: Delivered-To: mailing list cvs@cocoon.apache.org Received: (qmail 56226 invoked by uid 99); 24 Feb 2005 13:09:53 -0000 X-ASF-Spam-Status: No, hits=-9.8 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from minotaur.apache.org (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.28) with SMTP; Thu, 24 Feb 2005 05:09:48 -0800 Received: (qmail 90915 invoked by uid 65534); 24 Feb 2005 13:09:47 -0000 Message-ID: <20050224130947.90914.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Mailer: svnmailer-1.0.0-dev Date: Thu, 24 Feb 2005 13:09:47 -0000 Subject: svn commit: r155185 [2/3] - in cocoon/trunk/src/documentation/xdocs: plan/book.xml plan/index.xml plan/review-sitemap-docs.xml userdocs/selectors/book.xml userdocs/selectors/requestmethod-selector.xml userdocs/selectors/resourceexists-selector.xml To: cvs@cocoon.apache.org From: upayavira@apache.org X-Virus-Checked: Checked X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N Added: cocoon/trunk/src/documentation/xdocs/plan/review-sitemap-docs.xml URL: http://svn.apache.org/viewcvs/cocoon/trunk/src/documentation/xdocs/pla= n/review-sitemap-docs.xml?view=3Dauto&rev=3D155185 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D --- cocoon/trunk/src/documentation/xdocs/plan/review-sitemap-docs.xml (adde= d) +++ cocoon/trunk/src/documentation/xdocs/plan/review-sitemap-docs.xml Thu F= eb 24 05:09:44 2005 @@ -0,0 +1,3068 @@ + + + +

+ Review of sitemap component documentation + + + +

+ + + +

+ This is a coordination table to assist the systematic review of the + "sitemap component documentation" which is the set of documentation + available at=20 + /userdocs/ + for each sitemap component + (actions generators matchers readers selectors serializers transfo= rmers). +

+ This review focusses only on this set of documentation, as part of + the overall documentation + review= . + This set is a key part, because it + addresses the heart of Cocoon - the sitemap components. Having a + well-defined "User Guide" will assist both users and developers to + be more productive. +

+ Please assist by sending discussion to the dev mailing list and + patches of xdocs and java code via the issue tracker. + See the To Do section at the bottom. +

+ This documentation is generated as part of the Cocoon 'build docs'= process. + An anttask (tools/anttasks/SitemapTask) scans the java code looking + for javadoc-like tags (e.g. @cocoon.sitemap.component.name) and + extracts that information. For each component there is also a defa= ult + document at src/documentation/xdocs/userdocs/ which contains addit= ional + manual content. The two sources are merged to form each final xdoc= , with + two new sections being added (Description and Info). Then Forrest = builds + the final set of documents as part of the normal 'build docs' proc= ess. +

These are the SitemapTask attributes that are used in the code: +

@cocoon.sitemap.component.documentation - The documentation (o= ptional)
@cocoon.sitemap.component.name - The name of the component in = the sitemap (required)
@cocoon.sitemap.component.logger - The logger category (option= al)
@cocoon.sitemap.component.label - The label for views (optiona= l)
@cocoon.sitemap.component.mimetype - The mime type for seriali= zers and readers (optional)
@cocoon.sitemap.component.hide - If this tag is specified, the= component is not added to the sitemap (optional)
@cocoon.sitemap.component.documentation.disabled - If this tag= is specified, no documentation is generated (optional)
@cocoon.sitemap.component.configuration - Configuration (optio= nal)
@cocoon.sitemap.component.documentation.caching - Caching info= (optional)
@cocoon.sitemap.component.pooling.min - Pooling min (optional)=
@cocoon.sitemap.component.pooling.max - Pooling max (optional)=
@cocoon.sitemap.component.pooling.grow - Pooling grow (optiona= l)

+ + + +

The table columns are:

Java source - The name of the Java source file and link to jav= adoc.
Document - The name of the generated document and a link to it. + This is also the @cocoon.sitemap.component.name
A - The xdoc is available to supply additional manual content.=
B - The java code is in "core" or as a "block".
C - The javadoc-like tags (SitemapTask attributes) are availab= le in the code.
D - The component parameters are properly described.
E - The code and xdoc are synchronised between Cocoon trunk an= d 2.1 branch.

Cell values are:

blank - Not yet investigated.
y - Yes.
n - No.
- - Not relevant.
* - Has issues, needs more work.

There are 314 entries.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Java source	Document	A	B	C
AbstractAction		n	core	n
AbstractComplementaryConfigurableActi= on		n	core	n
AbstractConfigurableAction		n	core	n
AbstractDatabaseAction		n	databases	n
AbstractFormsAction		n	forms	n
AbstractMultiAction		n	core	n
AbstractValidatorAction		n	core	n
AuthAction		n	authentication-fw	n
AuthAction		n	portal-fw	n
BookmarkAction		n	portal	n
CacheEventAction		n	eventcache	n
ClearCacheAction		n	core	n
ClearPersistentStoreAction		n	core	n
CommandAction		n	scratchpad	n
ComposerAction		n	core	n
ConfigurableComposerAction		n	core	n
ConfigurableServiceableAction		n	core	n
CookieCreatorAction		n	scratchpad	n
CookieValidatorAction		n	scratchpad	n
CopletSetDataAction		n	portal	n
CopySourceAction		n	core	n
DatabaseAddAction		n	databases	n
DatabaseAuthenticatorAction		n	databases	n
DatabaseCookieAuthenticatorAction +		n	databases	n
DatabaseDeleteAction		n	databases	n
DatabaseSelectAction		n	databases	n
DatabaseUpdateAction		n	databases	n
DbXMLAuthenticatorAction		n	xmldb	n
FacesAction		n	faces	n
ExpiresPipelineAction		n	scratchpad	n
FormManagerAction		n	session-fw	n
FormValidatorAction		n	core	n
HandleFormSubmitAction		n	forms	n
HelloAction		n	core	n
HttpCacheAction		n	core	n
HttpHeaderAction		n	core	n
InputModuleAction		n	core	n
JMSPublisherAction		n	jms	n
LinkTranslatorMapAction		n	scratchpad	n
LocaleAction		n	core	n
LoggedInAction		n	authentication-fw	n
LoginAction		n	authentication-fw	n
LoginAction		n	portal	n
LogoutAction		n	authentication-fw	n
LogoutAction		n	portal	n
MailAction		n	mail	n
MakeFormAction		n	forms	n
modular/DatabaseAction		n	databases	n
modular/DatabaseAddAction		n	databases	n
modular/DatabaseDeleteAction		n	databases	n
modular/DatabaseSelectAction		n	databases	n
modular/DatabaseQueryAction		n	databases	n
modular/DatabaseUpdateAction		n	databases	n
ObjectModelAction		n	portal	n
OraAddAction		n	databases	n
OraUpdateAction		n	databases	n
PropagatorAction		n	core	n
RequestParamAction		n	core	n
RequestParameterExistsAction		n	core	n
ResourceExistsAction		n	core	n
SaveAction		n	portal	n
ScriptAction	scri= pt	y	bsf	n
SectionCutterAction		n	scratchpad	n
SendmailAction	se= ndmail	y	mail	n
ServerPagesAction		n	xsp	n
ServiceableAction		n	core	n
SessionAction	ses= sion	n	session-fw	n
SessionFormAction		n	session-fw	n
SessionInvalidatorAction		n	core	n
SessionIsValidAction		n	core	n
SessionPropagatorAction		n	core	n
SessionStateAction		n	core	n
SessionValidatorAction		n	core	n
SetCharacterEncodingAction		n	core	n
TagtestAction		n	taglib	n
modular/TestAction		n	core/samples	n
castor/TestBeanAction		n	scratchpad	n

Java source	Document	A	B	C
AbstractCopletGenerator		n	portal	n
AbstractGenerator		n	core	n
AntBuildGenerator		n	scratchpad	n
AsciiArtSVGGenerator		n	asciiart	n
BasketContentGenerator		n	portal	n
BasketGenerator		n	portal	n
CalendarGenerator	calendar	y	core	y
ClientBindingGenerator		n	scratchpad/flow	n
ComposerGenerator		n	core	n
ConfigurationGenerator		n	authentication-fw	n
ConfigurationGenerator		n	portal-fw	n
DirectoryGenerator	directory	y	core	y
	error	y		n
EventCacheGenerator		n	eventcache	n
ExceptionGenerator		n	core/samples	n
	extractor	y		n
FileGenerator	= file	y	core	y
FormsGenerator		n	mail	n
FragmentExtractorGenerator		n	batik	n
GarbageGenerator		n	scratchpad	n
GenericProxyGenerator		n	proxy	n
HTMLGenerator	= html	y	html	y
HttpProxyGenerator		n	proxy	n
ImageDirectoryGenerator	imagedirectory	y	core	y
IMAPGenerator		n	mail	n
JellyGenerator		n	scratchpad	n
JSGenerator		n	xsp	n
JSPGenerator	j= sp	y	jsp	n
JXTemplateGenerator	jx=	y	core	y
LinkStatusGenerator	linkstatus	y	core	y
LogicsheetCodeGenerator +		n	xsp	n
MarkupCodeGenerator		n	xsp	n
MP3DirectoryGenerator	mp3directory	y	core	y
NekoHTMLGenerator		n	html	y
NotifyingGenerator		n	core	n
ParseExceptionGenerator		n	chaperon	n
PauseGenerator		n	core/test	n
PhpGenerator	p= hp	y	php	n
PortalGenerator		n	portal	n
PortalGenerator		n	portal-fw	n
	profile	y		n
ProfilerGenerator		n	profiler	n
ProgramGenerator		n	xsp	n
xsp/PythonGenerator		n	python	n
RequestAttributeGenerator		n	scratchpad	y
RequestGenerator	request	y	core	y
RequestParameterGenerator		n	scratchpad	n
ScriptGenerator	script	y	bsf	n
SearchGenerator	search	y	lucene	n
ServerPagesGenerator	serverpages	y	xsp	n
ServiceableGenerator		n	core	n
ServletGenerator		n	core	n
SessionAttributeGenerator		n	core	y
SlopGenerator		n	slop	n
StatusGenerator	status	y	core	y
StreamGenerator	stream	y	core	y
SWFGenerator		n	swf	n
TextGenerator		n	chaperon	n
TraversableGenerator		n	repository	n
TraversableSourceDescriptionGenerat= or		n	repository	n
TraxGenerator		n	scratchpad	n
VelocityGenerator	velocity	y	velocity	n
	wsproxy	y		n
WebServiceProxyGenerator		n	proxy	n
XMidiGenerator		n	midi	n
XMLDBGenerator	xmldb	y	xmldb	n
XMLDBCollectionGenerator	xmldbcollection	y	xmldb	n
XPathDirectoryGenerator	xpathdirectory	y	core	y
XPathTraversableGenerator		n	repository	n
XSPGenerator		n	xsp	n

Java source	Document	A	B	C
AbstractPreparableMatcher		n	core	n
AbstractRegexpMatcher		n	core	n
AbstractWildcardMatcher		n	core	n
CookieMatcher		n	core	n
HeaderMatcher		n	core	n
LocaleMatcher		n	core	n
modular/CachingRegexpMatcher		n	core	n
modular/CachingWildcardMatcher		n	core	n
modular/WildcardMatcher		n	core	n
MountTableMatcher		n	core	n
ParameterMatcher		n	core	n
PreparableMatcher		n	core	n
RegexpHeaderMatcher		n	core	n
RegexpHostMatcher		n	core	n
RegexpParameterMatcher		n	core	n
RegexpRequestAttributeMatcher		n	core	n
RegexpRequestParameterMatcher		n	core	n
RegexpSessionAttributeMatcher		n	core	n
RegexpURIMatcher		n	core	n
RegexpURIDefaultsMatcher		n	scratchpad	n
RequestAttributeMatcher		n	core	n
RequestParameterMatcher		n	core	n
SessionAttributeMatcher		n	core	n
WildcardHeaderMatcher	wildcardheader	y	core	n
WildcardHostMatcher		n	core	n
WildcardParameterMatcher		n	core	n
WildcardRequestAttributeMatcher		n	core	n
WildcardRequestParameterMatcher		n	core	n
WildcardSessionAttributeMatcher		n	core	n
WildcardURIMatcher	wildcarduri	y	core	n

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Java source	Document	A	B	C
AbstractReader		n	core	n
AxisRPCReader	axi= srpc	y	axis	n
ComposerReader		n	core	n
DatabaseReader	da= tabase	y	databases	n
DirectoryZipArchiver	directoryziparchiver	y	scratchpad	n
ImageReader	image=	y	core	n
JSPReader	jsp	y	jsp	n
ProxyReader		n	portal	n
ResourceReader	re= source	y	core	n
ServiceableReader		n	core	n

Java source	Document	A	B	C
AbstractRegexpSelector		n	core	n
AbstractSwitchSelector		n	core	n
BrowserSelector	browser	y	core	n
CookieSelector		n	core	n
ComponentsSelector		n	core	n
DateSelector	da= te	y	scratchpad	n
ExceptionSelector		n	core	n
GeneratorSelector		n	xsp	n
HeaderSelector		n	core	n
HostSelector	ho= st	y	core	n
MailCommandSelector		n	mail	n
MediaSelector		n	session-fw	n
NamedPatternsSelector		n	core	n
OutputComponentSelector		n	core	n
ParameterSelector	parameter	y	core	n
RegexpHeaderSelector	regular-expression-header	y	core	n
RegexpRequestParameterSelector		n	core	n
RequestAttributeSelector	requestattribute	y	core	n
RequestMethodSelector	requestmethod	y	core	n
RequestParameterSelector	requestparameter	y	core	n
ResourceExistsSelector		n	core	n
SessionAttributeSelector		n	core	n
SimpleSelector		n	core	n
SitemapComponentSelector		n	core	n
SwitchSelector		n	core	n
XPathExceptionSelector		n	core	n

Java source	Document	A	B	C
AbstractSerializer		n	core	n
AbstractSerializer		n	scratchpad/garbage	n
AbstractTextSerializer		n	core	n
ElementProcessorSerializer		n	poi	n
EncodingSerializer		n	serializers	n
EncodingSerializer		n	scratchpad/garbage	n
FOPSerializer		n	fop	n
HSSFSerializer		n	poi	n
HTMLSerializer	html	y	core	y
HTMLSerializer		n	serializers	n
HTMLSerializer		n	scratchpad/garbage	n
IncludingHTMLSerializer		n	portal	n
iTextSerializer		n	itext	n
LinkSerializer	link	y	core	n
	pcl	y		n
	pdf	y		n
POIFSSerializer		n	poi	n
	= ps	y		n
RTFSerializer		n	jfor	n
Serializer		n	scratchpad/garbage	n
SVGSerializer	svg	y	batik	n
	svgjpeg	y		n
	svgpng	y		n
	svgtiff	y		n
	svgxml	y		n
SWFSerializer		n	swf	n
TextSerializer	text	y	core	n
	vrml	y		n
	wap	y		n
	xhtml	y		n
XHTMLSerializer		n	serializers	n
XHTMLSerializer		n	scratchpad/garbage	n
	xls	y		n
XMidiSerializer		n	midi	n
XMLSerializer	xml	y	core	n
sax/XMLSerializer		n	serializers	n
XMLSerializer		n	serializers	n
XMLSerializer		n	scratchpad/garbage	n
ZipArchiveSerializer	ziparchive	y	core	n

Java source	Document	A	B	C
AbstractConstrainedTransfo= rmer		n	scratchpad	n
AbstractCopletTransformer		n	portal	n
AbstractDOMTransformer		n	core	n
AbstractExtractionTransformer +		n	core	n
AbstractSAXTransformer		n	core	n
AbstractSessionTransformer=		n	session-fw	n
AbstractTransformer		n	core	n
AugmentTransformer	augment	y	core	y
BasketTransformer		n	portal	n
BetwixtTransformer		n	scratchpad	n
CastorTransformer		n	scratchpad	n
CIncludeTransformer	cinclude	y	core	y
CopletTransformer		n	portal	n
DASLTransformer		n	webdav	n
DeliTransformer		n	deli	n
EncodeURLTransformer	encodeurl	y	core	y
ErrorAwareTraxTransformer		n	scratchpad	n
EventLinkTransformer		n	portal	n
ExtendedParserTransformer		n	chaperon	n
	extractor	y		n
FragmentExtractorTransformer		n	batik	n
FilterTransformer	filter	y	core	y
FormsTemplateTransformer		n	forms	n
HTMLEventLinkTransformer		n	portal	n
HTMLRootTransformer		n	portal	n
HTMLTransformer		n	html	n
I18nTransformer	i18n	y	core	y
IncludeTransformer	include	y	scratchpad	y