org.apache.maven.doxia.module.site
Interface SiteModule

All Known Implementing Classes:

AbstractSiteModule, AptSiteModule, ConfluenceSiteModule, DocBookSiteModule, FmlSiteModule, MarkdownSiteModule, TWikiSiteModule, XdocSiteModule, XhtmlSiteModule

public interface SiteModule

Provides definitions for a Doxia module. This is used by the doxia site tools.

Since:

1.0

Version:

$Id: SiteModule.java 746978 2009-02-23 12:20:33Z vsiveton $

Author:

Jason van Zyl

Field Summary

static String

ROLE The Plexus lookup role.

Method Summary

String	getExtension() Returns the default file extension for a given module.
String	getParserId() Returns the parser id for a given module.
String	getSourceDirectory() Returns the directory that contains source files for a given module.

Field Detail

ROLE

static final String ROLE

The Plexus lookup role.

Method Detail

getSourceDirectory

String getSourceDirectory()

Returns the directory that contains source files for a given module.

Returns:

The source directory.

getExtension

String getExtension()

Returns the default file extension for a given module.

Returns:

The default file extension.

getParserId

String getParserId()

Returns the parser id for a given module.

Returns:

The parser id.