Package org.forgerock.doc.maven

Class SiteMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.forgerock.doc.maven.AbstractDocbkxMojo

org.forgerock.doc.maven.SiteMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="site",
      defaultPhase=SITE)
public class SiteMojo
extends AbstractDocbkxMojo

Call other classes to copy docs to site build directory.

Nested Class Summary

Nested classes/interfaces inherited from class org.forgerock.doc.maven.AbstractDocbkxMojo

AbstractDocbkxMojo.Format, AbstractDocbkxMojo.ProfileAttributes

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
SiteMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()	Call other classes to copy docs to site build directory.

Methods inherited from class org.forgerock.doc.maven.AbstractDocbkxMojo

areSectionsAutolabeled, doBuildReleaseZip, doCopyResourceFiles, doCreateArtifacts, doesSectionLabelIncludeComponentLabel, doOverwriteModifiableCopy, doOverwriteProjectFilesWithSharedContent, doUsePreProcessedSources, getArtifactItems, getAsciidocSourceDirectory, getAsciidoctorPluginVersion, getBackstageDirectory, getBackstageProductName, getBaseConfiguration, getBaseDir, getBootstrapCustomization, getBrandingArtifactId, getBrandingGroupId, getBrandingVersion, getBuildDirectory, getChunkedHTMLCustomization, getCommonContentArtifactId, getCommonContentGroupId, getCommonContentVersion, getDocbkxModifiableSourcesDirectory, getDocbkxOutputDirectory, getDocbkxSourceDirectory, getDocbkxVersion, getDocNames, getDocsSite, getDocumentSrcName, getDraftWatermarkURL, getEoslJson, getEpubCustomization, getExclusions, getFaviconLink, getFoCustomization, getFontsDirectory, getFopHyphVersion, getFopLogLevel, getFormats, getGoogleAnalyticsId, getInclusions, getJavaScriptFileName, getJCiteSourcePaths, getJCiteVersion, getLatestJson, getLinkTesterVersion, getLocaleTag, getManpagesCustomization, getMavenAssemblyVersion, getMavenDependencyVersion, getMavenFilteringVersion, getMavenResourcesVersion, getMaxImageHeightInInches, getPlantUmlVersion, getPlexusUtilsVersion, getPluginManager, getPreSiteCss, getProject, getProjectName, getProjectVersion, getRelativeResourcesDirectoryPath, getReleaseCss, getReleaseDate, getReleaseDirectory, getReleaseFaviconLink, getReleaseVersion, getReleaseVersionPath, getResourcesDirectory, getSession, getSingleHTMLCustomization, getSiteDirectory, getSkipUrlPatterns, getWebHelpCss, getWebHelpCustomization, getWebHelpLogo, getXCiteVersion, getXhtml5Customization, isDraftMode, isXincludeSupported, keepCustomIndexHtml, path, runLinkTester, skipLinkCheck, useAnsi, useSyntaxHighlighting

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SiteMojo

public SiteMojo()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Call other classes to copy docs to site build directory.

Throws:

org.apache.maven.plugin.MojoExecutionException - Failed to copy docs successfully.