public class MarkupToEclipseToc
extends java.lang.Object
Constructor and Description |
---|
MarkupToEclipseToc() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
computeFile(OutlineItem item) |
java.lang.String |
createToc(OutlineItem root) |
protected XmlStreamWriter |
createXmlStreamWriter(java.io.Writer out) |
int |
getAnchorLevel()
Indicates the heading level at which anchors of the form
<anchor id="additions"/> should be
emitted. |
java.lang.String |
getBookTitle() |
java.lang.String |
getCopyrightNotice()
the copyright notice that should appear in the generated output
|
java.lang.String |
getHtmlFile() |
MarkupLanguage |
getMarkupLanguage() |
java.lang.String |
parse(java.lang.String markupContent) |
void |
setAnchorLevel(int anchorLevel)
Provides the heading level at which anchors should be emitted.
|
void |
setBookTitle(java.lang.String bookTitle) |
void |
setCopyrightNotice(java.lang.String copyrightNotice)
the copyright notice that should appear in the generated output
|
void |
setHelpPrefix(java.lang.String helpPrefix)
the prefix to URLs in the toc.xml, typically the relative path from the plugin to the help files.
|
void |
setHtmlFile(java.lang.String htmlFile) |
void |
setMarkupLanguage(MarkupLanguage markupLanguage) |
public java.lang.String parse(java.lang.String markupContent)
public java.lang.String createToc(OutlineItem root)
protected java.lang.String computeFile(OutlineItem item)
public MarkupLanguage getMarkupLanguage()
public void setMarkupLanguage(MarkupLanguage markupLanguage)
public java.lang.String getBookTitle()
public void setBookTitle(java.lang.String bookTitle)
public java.lang.String getHtmlFile()
public void setHtmlFile(java.lang.String htmlFile)
public int getAnchorLevel()
<anchor id="additions"/>
should be
emitted. A level of 0 corresponds to the root of the document, and levels 1-6 correspond to heading levels h1,
h2...h6.
The default is -1.
setAnchorLevel(int)
public void setAnchorLevel(int anchorLevel)
anchorLevel
- a number >= 0 and <= 6getAnchorLevel()
protected XmlStreamWriter createXmlStreamWriter(java.io.Writer out)
public void setHelpPrefix(java.lang.String helpPrefix)
public java.lang.String getCopyrightNotice()
public void setCopyrightNotice(java.lang.String copyrightNotice)
copyrightNotice
- the notice, or null if there should be noneCopyright © 2007, 2013 David Green and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html