org.knopflerfish.ant.taskdefs.bundle
public class BundleUserDocNavigateTask extends org.apache.tools.ant.Task
This task is used when building bundle user documentation for a Knopflerfish release, it builds the navigation frame listing bundles with user documentation. If you don't intend to create a new distribution type of Knopflerfish then you're in the wrong place.
Here is a outline of how to use the task and a description of different parameters and used system properties.
| Attribute | Description | Required |
| outdir | Where to put the generated file (directory). | Yes |
| tofile |
The relative path to where the generated file should be
copied. That is the actual location of the generated file
will be outdir/tofile.
|
Yes |
| template | The file which describes what the page should look like. | Yes |
| title | The title to use on the generated page. | Yes |
| docdir |
The directory with one sub-directory for each user documentation
link to create. Defaults to outdir.
All sub-directories of docdir will result in a link on the generated navigation page. The link will belong to the default category, have a title set to the name of the sub-directory and a link path pointing to the file "index.html" inside the sub-directory. The default link properties may be overridden by specifying other values in a properties file named doc.properties in the sub-directory. The following keys in the properties file are used:
It is possible to generate more than one link from the same doc.properties file. To do this insert a linkCount key with the number of links to create as its value. Then for each link add all the keys defined above with the link number followed by a '.' as key-prefix. Link number prefixes starts with 0 and must be strictly smaller than the value of linkCount. If there is no category value with a link number prefix the un-prefixed category value will be used. I.e., if all links belongs to the same category it suffices to write the category name once. |
Yes |
| defaultcategory | The name of the category to place links under when not specified in the doc-subdirectory. | No, defaults to "bundle". |
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
DOC_PROPS_FILE_NAME |
| Constructor and Description |
|---|
BundleUserDocNavigateTask() |
| Modifier and Type | Method and Description |
|---|---|
void |
execute() |
void |
setDefaultcategory(java.lang.String s) |
void |
setDocdir(java.io.File f) |
void |
setOutdir(java.io.File f) |
void |
setTemplate(java.io.File f) |
void |
setTitle(java.lang.String s) |
void |
setTofile(java.lang.String s) |
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypepublic static final java.lang.String DOC_PROPS_FILE_NAME
public void setOutdir(java.io.File f)
public void setTofile(java.lang.String s)
public void setTemplate(java.io.File f)
public void setTitle(java.lang.String s)
public void setDocdir(java.io.File f)
public void setDefaultcategory(java.lang.String s)
public void execute()
execute in class org.apache.tools.ant.Task