org.eclipse.mylyn.wikitext.core.util.anttask
Class MarkupToEclipseHelpTask

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.eclipse.mylyn.wikitext.core.util.anttask.MarkupTask
              extended by org.eclipse.mylyn.wikitext.core.util.anttask.MarkupToHtmlTask
                  extended by org.eclipse.mylyn.wikitext.core.util.anttask.MarkupToEclipseHelpTask
All Implemented Interfaces:
Cloneable

public class MarkupToEclipseHelpTask
extends MarkupToHtmlTask

An Ant task for converting lightweight markup such as Textile to eclipse help format.

Since:
1.0
Author:
David Green

Nested Class Summary
 
Nested classes/interfaces inherited from class org.eclipse.mylyn.wikitext.core.util.anttask.MarkupToHtmlTask
MarkupToHtmlTask.Attribute, MarkupToHtmlTask.Stylesheet
 
Field Summary
 
Fields inherited from class org.eclipse.mylyn.wikitext.core.util.anttask.MarkupToHtmlTask
file, formatOutput, htmlFilenameFormat, linkRel, multipleOutputFiles, navigationImages, overwrite, prependImagePrefix, title
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
MarkupToEclipseHelpTask()
           
 
Method Summary
 String getHelpPrefix()
          the prefix to URLs in the toc.xml, typically the relative path from the plugin to the help files.
 String getXmlFilenameFormat()
           
 void setHelpPrefix(String helpPrefix)
          the prefix to URLs in the toc.xml, typically the relative path from the plugin to the help files.
 void setXmlFilenameFormat(String xmlFilenameFormat)
          The format of the XML table of contents output file.
 
Methods inherited from class org.eclipse.mylyn.wikitext.core.util.anttask.MarkupToHtmlTask
addFileset, addStylesheet, computeHtmlFile, execute, getDefaultAbsoluteLinkTarget, getEmitDoctype, getFile, getHtmlDoctype, getHtmlFilenameFormat, getLinkRel, getPrependImagePrefix, getTitle, isFormatOutput, isMultipleOutputFiles, isNavigationImages, isOverwrite, isSuppressBuiltInCssStyles, isUseInlineCssStyles, isXhtmlStrict, processFile, setDefaultAbsoluteLinkTarget, setEmitDoctype, setFile, setFormatOutput, setHtmlDoctype, setHtmlFilenameFormat, setLinkRel, setMultipleOutputFiles, setNavigationImages, setOverwrite, setPrependImagePrefix, setSuppressBuiltInCssStyles, setTitle, setUseInlineCssStyles, setXhtmlStrict
 
Methods inherited from class org.eclipse.mylyn.wikitext.core.util.anttask.MarkupTask
addConfiguredMarkupLanguageConfiguration, createMarkupLanguage, getInternalLinkPattern, getMarkupLanguage, getMarkupLanguageConfiguration, getSourceEncoding, isFailOnValidationError, isFailOnValidationWarning, isValidate, performValidation, readFully, setFailOnValidationError, setFailOnValidationWarning, setInternalLinkPattern, setMarkupLanguage, setMarkupLanguageConfiguration, setSourceEncoding, setValidate
 
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, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MarkupToEclipseHelpTask

public MarkupToEclipseHelpTask()
Method Detail

getXmlFilenameFormat

public String getXmlFilenameFormat()
See Also:
setXmlFilenameFormat(String)

setXmlFilenameFormat

public void setXmlFilenameFormat(String xmlFilenameFormat)
The format of the XML table of contents output file. Consists of a pattern where the '$1' is replaced with the filename of the input file. Default value is $1-toc.xml


getHelpPrefix

public String getHelpPrefix()
the prefix to URLs in the toc.xml, typically the relative path from the plugin to the help files. For example, if the help file is in 'help/index.html' then the help prefix would be 'help'


setHelpPrefix

public void setHelpPrefix(String helpPrefix)
the prefix to URLs in the toc.xml, typically the relative path from the plugin to the help files. For example, if the help file is in 'help/index.html' then the help prefix would be 'help'



Copyright © 2011 FuseSource, Corp.. All Rights Reserved.