org.eclipse.mylyn.wikitext.core.parser.util
Class MarkupToEclipseToc

java.lang.Object
  extended by org.eclipse.mylyn.wikitext.core.parser.util.MarkupToEclipseToc
Direct Known Subclasses:
SplittingMarkupToEclipseToc

public class MarkupToEclipseToc
extends Object

A conversion utility targeting the Eclipse help table of contents format.

Since:
1.0
Author:
David Green

Constructor Summary
MarkupToEclipseToc()
           
 
Method Summary
protected  String computeFile(OutlineItem item)
           
 String createToc(OutlineItem root)
           
protected  XmlStreamWriter createXmlStreamWriter(Writer out)
           
 String getBookTitle()
           
 String getHtmlFile()
           
 MarkupLanguage getMarkupLanguage()
           
 String parse(String markupContent)
           
 void setBookTitle(String bookTitle)
           
 void setHelpPrefix(String helpPrefix)
          the prefix to URLs in the toc.xml, typically the relative path from the plugin to the help files.
 void setHtmlFile(String htmlFile)
           
 void setMarkupLanguage(MarkupLanguage markupLanguage)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MarkupToEclipseToc

public MarkupToEclipseToc()
Method Detail

parse

public String parse(String markupContent)

createToc

public String createToc(OutlineItem root)

computeFile

protected String computeFile(OutlineItem item)

getMarkupLanguage

public MarkupLanguage getMarkupLanguage()

setMarkupLanguage

public void setMarkupLanguage(MarkupLanguage markupLanguage)

getBookTitle

public String getBookTitle()

setBookTitle

public void setBookTitle(String bookTitle)

getHtmlFile

public String getHtmlFile()

setHtmlFile

public void setHtmlFile(String htmlFile)

createXmlStreamWriter

protected XmlStreamWriter createXmlStreamWriter(Writer out)

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.