Knopflerfish OSGi 5.2.0

org.knopflerfish.ant.taskdefs.bundle
Class MakeHTMLTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.knopflerfish.ant.taskdefs.bundle.MakeHTMLTask
All Implemented Interfaces:
java.lang.Cloneable

public class MakeHTMLTask
extends org.apache.tools.ant.Task

This task is used when building distributions of Knopflerfish. If you don't intend to create a new distribution type of Knopflerfish then you're in the wrong place.

Task that creates web sites given a template and a source file. Currently used to create parts of the docs directory in the KF distribution. It does this by simply replacing certain text strings with others. For more information on which text strings this is please check the source code.

Here is a outline of how to use the task and a description of different parameters and used system properties.

Attribute Description Required
outdir What dir to put the actual the generated file 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 page's title No, default is ""
description The page's description No, default is ""
disable Allows you to disable certain links. This attribute is very ad hoc. It will use the properties htdocs.link.disabled.class and htdocs.link.enabled.class. The task will then use the values of these properties to generate the file. No
javadocRelPath Relative path (from outdir) to javadocs. ../../javadoc

Note: instead of using the attributes fromfile and tofile one can use filesets. It will simply run through and perform the task on all given files.


Field Summary
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
location, project
 
Constructor Summary
MakeHTMLTask()
           
 
Method Summary
 void addConfiguredHtmlFragment(HtmlFragment fragment)
           
 void addFileset(org.apache.tools.ant.types.FileSet fs)
           
 void execute()
           
 void setBundleList(java.lang.String bundleList)
           
 void setDescription(java.lang.String description)
           
 void setDisable(java.lang.String disabled)
           
 void setFromfile(java.lang.String s)
           
 void setJavadocRelPath(java.lang.String s)
           
 void setManstyle(java.lang.String manstyle)
           
 void setOutdir(java.lang.String s)
           
 void setTemplate(java.lang.String template)
           
 void setTitle(java.lang.String title)
           
 void setTofile(java.lang.String s)
           
 
Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MakeHTMLTask

public MakeHTMLTask()
Method Detail

setFromfile

public void setFromfile(java.lang.String s)

setTofile

public void setTofile(java.lang.String s)

setTitle

public void setTitle(java.lang.String title)

setDescription

public void setDescription(java.lang.String description)
Overrides:
setDescription in class org.apache.tools.ant.ProjectComponent

setOutdir

public void setOutdir(java.lang.String s)

setTemplate

public void setTemplate(java.lang.String template)

setBundleList

public void setBundleList(java.lang.String bundleList)

setManstyle

public void setManstyle(java.lang.String manstyle)

setDisable

public void setDisable(java.lang.String disabled)

setJavadocRelPath

public void setJavadocRelPath(java.lang.String s)

addFileset

public void addFileset(org.apache.tools.ant.types.FileSet fs)

addConfiguredHtmlFragment

public void addConfiguredHtmlFragment(HtmlFragment fragment)

execute

public void execute()
Overrides:
execute in class org.apache.tools.ant.Task

Knopflerfish OSGi 5.2.0