Task package index

com.tarsec.javadoc.pdfdoclet

Contains the Javadoc PDF doclet for building Javadocs in PDF format.

ExtPdfDocletDecorator – Decorator for creating PDF Javadoc documentation.

net.findbugs

Tasks for running Findbugs source code analysis.

ExtFindbugsTF – Search for bugs in Java classes with Findbugs.

org.apache.ant

A task for running Ant scripts.

AntTF – Run an Apache Ant script.

org.at4j

Tasks for compressing files and for creating file archives.

At4JUnzipTF – Extract the contents of a Zip archive to a directory.

At4JZipTF – Build a Zip archive using the At4J Zip builder.

BZip2TF – Compress a file using the bzip2 algorithm.

LzmaTF – Compress a file using the LZMA algorithm.

TarTF – Build a Tar archive using the At4J Tar builder.

UntarTF – Extract the contents of a Tar archive to a directory.

org.junit.junit4

A task for running JUnit 4 unit tests.

JUnit4TF – Run a JUnit 4 test suite.

org.schmant.task.base

Contains the tasks that are enabled by default.

AddSystemIdToCatalogTF – Add an external entity and its system ID to an XmlCatalogResolver.

AddUriToCatalogTF – Add an external entity and its URI to a XmlCatalogResolver.

ApiLinksTF – Insert links to Javadoc documentation in an HTML file.

ChmodTF – Change permissions on files or directories.

CompoundTF – Aggregate several tasks to run them sequentially.

CopyTF – Copy one or several files or directories.

DeleteTF – Delete one or several files or directories.

DomParseXmlTF – Parse an XML file and create a DOM document.

EarTF – Build an Ear archive.

ErrorIgnoringTF – Ignore errors in a proxied task.

ExtJarSignerTF – Sign a JAR file using a key in a keystore.

ExtJavacTF – Compile Java source files using the javac command.

ExtJavadocTF – Create API documentation using the javadoc command.

ExtProcessTF – Run an external program.

ExtStandardDocletDecorator – Decorator for creating HTML Javadoc documentation.

ForEachSourceTF – Run an action task for each entity in a collection.

FormatCharacterFileTF – Change character encoding and/or end of line style for a text file.

GZipTF – Compress a file using the gzip algorithm.

HtmlLinkValidationTF – Validate links in an HTML document.

IncludeFilesTF – Include the contents of files in another file.

JarTF – Build a Jar archive.

JavaTF – Run a Java class or a Jar.

JavaWorkspaceBuilderTF – Build Java projects in a workspace.

Jdk6JavacTF – Compile Java source files using the Java 6 javac API:s.

MoveTF – Move and/or rename one or several files and/or directories.

RecursiveActionTF – Run an action task for each entity returned when iterating recursively over a set of source entities.

RecursiveProcessTF – Run a process task for each entity returned when iterating recursively over a set of source entities.

RedirectReportTF – Redirect Report output from a proxied task to a file.

ReplaceSourceFileTF – Replace the source file of one or more proxied process tasks with the target the last task generates.

SchemaFactoryTF – Build an XML schema.

TemplateCompilerTF – Compile an XSL stylesheet.

TextAppendTF – Append text to a file.

TextPrependTF – Prepend text to a file.

TextReplaceTF – Insert, modify or replace text in a file.

TimedExecutionTF – Set a maximum execution time for a proxied task.

TreeCopyTF – Copy files and directories recursively.

TreeDeleteTF – Delete files and directories recursively.

WarTF – Build a War archive.

XsltTF – Run an XSL transformation of an XML document.

ZipTF – Build a Zip archive.

org.schmant.task.taskpackage

Contains the tasks for processing and building task packages.

ArgumentInterpreterLinksTF – Insert links to the User's Guide's argument interpretation documentation in an HTML file.

SchmantTaskrefTF – Build task reference documentation for one or several task packages.

TaskFactoryLinksTF – Insert links to the task reference documentation in an HTML file.

org.tmatesoft.svn

Subversion tasks.

SvnExportTF – Export files and directories from a Subversion repository.

SvnUrlToUrlCopyTF – Copy contents within a Subversion repository.

Building task package documentation

The task package documentation can be built after installing Schmant using the tools/build_task_reference_docs.js script.

By default, Schmant comes bundled with task reference documentation for only the task packages that are included in the distribution. By building the task reference documentation after installing Schmant, it can be made to include the documentation for all locally installed task packages too.

Unix

To build the task reference documentation on Unix, cd to the $SCHMANT_HOME directory and execute the following script (on one line):

For example:

Windows

To build the task reference documentation on Windows, cd to the $SCHMANT_HOME directory and execute the following script (on one line):

For example: