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

java.lang.Object
  Task
      org.eclipse.mylyn.wikitext.core.util.anttask.MarkupTask
          org.eclipse.mylyn.wikitext.core.util.anttask.MarkupToDitaTask

public class MarkupToDitaTask
extends MarkupTask

An Ant task for converting markup to OASIS DITA format.

Since:

1.0

Author:

David Green

Nested Class Summary

static class

MarkupToDitaTask.BreakStrategy

Field Summary

protected File

file

Constructor Summary

MarkupToDitaTask()

Method Summary

void	addFileset(FileSet set) Adds a set of files to process.
void	execute()
String	getBookTitle() Get the book title.
String	getDoctype() The XML doctype of the ditamap.
File	getFile()
String	getFilenameFormat() The format of the DocBook output file.
String	getTopicDoctype() the XML doctype of topics
String	getTopicFolder()
MarkupToDitaTask.BreakStrategy	getTopicStrategy()
boolean	isOverwrite()
void	setBookTitle(String bookTitle) The book title.
void	setDoctype(String doctype) Set the XML doctype of the ditamap.
void	setFile(File file)
void	setFilenameFormat(String filenameFormat) The format of the DocBook output file.
void	setOverwrite(boolean overwrite)
void	setTopicDoctype(String topicDoctype) the XML doctype of topics The doctype should look something like this:
void	setTopicFolder(String topicFolder)
void	setTopicStrategy(MarkupToDitaTask.BreakStrategy topicStrategy)

Methods inherited from class org.eclipse.mylyn.wikitext.core.util.anttask.MarkupTask

createMarkupLanguage, getInternalLinkPattern, getMarkupLanguage, isFailOnValidationError, isFailOnValidationWarning, isValidate, performValidation, setFailOnValidationError, setFailOnValidationWarning, setInternalLinkPattern, setMarkupLanguage, setValidate

Methods inherited from class java.lang.Object

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

Field Detail

file

protected File file

Constructor Detail

MarkupToDitaTask

public MarkupToDitaTask()

Method Detail

addFileset

public void addFileset(FileSet set)

Adds a set of files to process.

execute

public void execute()
             throws BuildException

Throws:

BuildException

getFilenameFormat

public String getFilenameFormat()

The format of the DocBook output file. Consists of a pattern where the '$1' is replaced with the filename of the input file. Default value is $1.ditamap

See Also:

setFilenameFormat(String)

setFilenameFormat

public void setFilenameFormat(String filenameFormat)

The format of the DocBook output file. Consists of a pattern where the '$1' is replaced with the filename of the input file. Default value is $1.ditamap

getBookTitle

public String getBookTitle()

Get the book title.

Returns:

the title, or null if the source filename is to be used as the title.

setBookTitle

public void setBookTitle(String bookTitle)

The book title.

Parameters:

bookTitle - the title, or null if the source filename is to be used as the title.

setDoctype

public void setDoctype(String doctype)

Set the XML doctype of the ditamap. The doctype should look something like this:

 <!DOCTYPE bookmap PUBLIC \"-//OASIS//DTD DITA 1.1 BookMap//EN\"  \"http://docs.oasis-open.org/dita/v1.1/OS/dtd/bookmap.dtd\">
 

getDoctype

public String getDoctype()

The XML doctype of the ditamap.

getTopicDoctype

public String getTopicDoctype()

the XML doctype of topics

setTopicDoctype

public void setTopicDoctype(String topicDoctype)

the XML doctype of topics The doctype should look something like this:

 <!DOCTYPE topic PUBLIC \"-//OASIS//DTD DITA 1.1 Topic//EN\">
 

isOverwrite

public boolean isOverwrite()

setOverwrite

public void setOverwrite(boolean overwrite)

getTopicFolder

public String getTopicFolder()

setTopicFolder

public void setTopicFolder(String topicFolder)

getFile

public File getFile()

setFile

public void setFile(File file)

getTopicStrategy

public MarkupToDitaTask.BreakStrategy getTopicStrategy()

setTopicStrategy

public void setTopicStrategy(MarkupToDitaTask.BreakStrategy topicStrategy)