Introduction

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

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 default document at src/documentation/xdocs/userdocs/ which contains additional 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' process.

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

Coordination table

The table columns are:

Cell values are:

There are 314 entries.

Actions

Java source Document A B C D E
AbstractAction n core n
AbstractComplementaryConfigurableAction 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 script y bsf n
SectionCutterAction n scratchpad n
SendmailAction sendmail y mail n
ServerPagesAction n xsp n
ServiceableAction n core n
SessionAction session 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

Generators

Java source Document A B C D E
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 jsp 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 php 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
TraversableSourceDescriptionGenerator 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

Matchers

Java source Document A B C D E
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

Readers

Java source Document A B C D E
AbstractReader n core n
AxisRPCReader axisrpc y axis n
ComposerReader n core n
DatabaseReader database y databases n
DirectoryZipArchiver directoryziparchiver y scratchpad n
ImageReader image y core n
JSPReader jsp y jsp n
ProxyReader n portal n
ResourceReader resource y core n
ServiceableReader n core n

Selectors

Java source Document A B C D E
AbstractRegexpSelector n core n
AbstractSwitchSelector n core n
BrowserSelector browser y core n
CookieSelector n core n
ComponentsSelector n core n
DateSelector date y scratchpad n
ExceptionSelector n core n
GeneratorSelector n xsp n
HeaderSelector n core n
HostSelector host 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

Serializers

Java source Document A B C D E
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

Transformers

Java source Document A B C D E
AbstractConstrainedTransformer 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
JPathTransformer n core y
JXTemplateTransformer jx-template n core n
LDAPTransformer ldap y naming n
LuceneIndexTransformer n lucene n
LexicalTransformer lexer y chaperon n
LinkTransformer n portal n
LinkRewriterTransformer n linkrewriter n
LogTransformer log y core y
NewEventLinkTransformer n portal n
ParserTransformer parser y chaperon n
PatternTransformer pattern y chaperon n
ProxyTransformer n portal n
ReadDOMSessionTransformer readdomsession y core y
RoleFilterTransformer n core y
RSSTransformer n portal n
SendMailTransformer n mail n
ServiceableTransformer n core n
SessionTransformer n session-fw n
SessionPostTransformer n session-fw n
SessionPreTransformer n session-fw n
SimpleFormInstanceExtractionTransformer n core y
SimpleFormTransformer n core y
SourcePropsWritingTransformer n repository n
SourceWritingTransformer sourcewriting y core y
SQLTransformer sql y databases n
TagTransformer n taglib n
TraxTransformer n core n
VariableRewriterTransformer n linkrewriter n
Web3RfcTransformer n web3 n
WriteDOMSessionTransformer writedomsession y core y
XIncludeTransformer xinclude y core y
XMLDBTransformer n xmldb n
TraxTransformer xslt y core y

To Do

Not a list of everything to be done, just a few notes ...

Other notes...

The "@cocoon.sitemap.component.documentation.caching" tag cannot be the last element or it will suck the rest of the javadoc description in with it.

Be careful with "@cocoon.sitemap.component.name" - it is also used for another purpose.