org.apache.maven.doxia.module.docbook

Class DocBookSink

public class DocBookSink extends AbstractXmlSink implements DocbookMarkup

A doxia Sink which produces a Docbook model.

Since: 1.0

Version: $Id: DocBookSink.java 568690 2007-08-22 16:30:06Z jdcasey $

Field Summary
static StringDEFAULT_SGML_PUBLIC_ID
DocBook V4.1 SGML public id: "-//OASIS//DTD DocBook V4.1//EN"
static StringDEFAULT_XML_PUBLIC_ID
DocBook XML V4.1.2 XML public id: "-//OASIS//DTD DocBook XML V4.1.2//EN"
static StringDEFAULT_XML_SYSTEM_ID
DocBook XML V4.0 XML system id: "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"
Constructor Summary
DocBookSink(Writer out, boolean isBook)
DocBookSink(Writer writer)
Method Summary
voidanchor(String name)
voidanchor_()
voidauthor()
voidauthor_()
voidbody_()
voidbold()
voidbold_()
voidbook()
voidbook_()
voidclose()
protected voidcontent(String text)
Write SGML escaped text to output, not preserving white space.
voiddate()
voiddate_()
voiddefinedTerm()
voiddefinedTerm_()
voiddefinition()
voiddefinitionList()
voiddefinitionListItem()
voiddefinitionListItem_()
voiddefinitionList_()
voiddefinition_()
static StringescapeSGML(String text, boolean xmlMode)
voidfigureCaption()
voidfigureCaption_()
voidfigureGraphics(String name)
voidfigure_()
voidflush()
StringgetBoldElement()
Returns the current boldBeginTag.
StringgetEncoding()
Returns the current encoding.
StringgetHorizontalRuleElement()
Returns the current horizontalRuleElement.
StringgetItalicElement()
Returns the current italicBeginTag.
StringgetLanguage()
Returns the current language.
StringgetLineBreakElement()
Returns the current lineBreakElement.
StringgetMonospacedElement()
Returns the current monospacedBeginTag.
StringgetPageBreakElement()
Returns the current pageBreakElement.
StringgetPublicId()
Returns the current publicId.
StringgetStyleSheet()
Returns the current styleSheet.
StringgetSystemId()
Returns the current systemId.
protected voidgraphicElement()
voidhead()
voidhead_()
voidhorizontalRule()
booleanisXMLMode()
Returns the current xmlMode.
voiditalic()
voiditalic_()
voidlineBreak()
voidlink(String name)
voidlink_()
voidlist()
voidlistItem()
voidlistItem_()
voidlist_()
protected voidmarkup(String text)
Write text to output, preserving white space.
voidmonospaced()
voidmonospaced_()
voidnonBreakingSpace()
voidnumberedList(int numbering)
voidnumberedListItem()
voidnumberedListItem_()
voidnumberedList_()
voidpageBreak()
voidparagraph()
voidparagraph_()
voidsection1()
voidsection1_()
voidsection2()
voidsection2_()
voidsection3()
voidsection3_()
voidsection4()
voidsection4_()
voidsection5()
voidsection5_()
voidsectionTitle()
voidsectionTitle_()
voidsetBoldElement(String tag)
Sets the current boldBeginTag and constructs the corresponding end tag from it.
voidsetEncoding(String enc)
Sets the encoding.
voidsetHorizontalRuleElement(String element)
Sets the current horizontalRuleElement.
voidsetItalicElement(String tag)
Sets the current italicBeginTag and constructs the corresponding end tag from it.
voidsetLanguage(String language)
Sets the language.
voidsetLineBreakElement(String element)
Sets the current lineBreakElement.
voidsetMonospacedElement(String tag)
Sets the current monospacedBeginTag and constructs the corresponding end tag from it.
voidsetPageBreakElement(String element)
Sets the current pageBreakElement.
voidsetPublicId(String id)
Sets the publicId.
voidsetStyleSheet(String sheet)
Sets the styleSheet.
voidsetSystemId(String id)
Sets the systemId.
voidsetXMLMode(boolean mode)
Sets the xml mode.
voidtable()
voidtableCaption()
voidtableCaption_()
voidtableCell()
voidtableCell_()
voidtableRow()
voidtableRows(int[] justification, boolean grid)
voidtableRows_()
voidtableRow_()
voidtable_()
voidtext(String text)
voidtitle()
voidtitle_()
voidverbatim(boolean boxed)
protected voidverbatimContent(String text)
Write SGML escaped text to output, preserving white space.
voidverbatim_()
protected voidwrite(String text)

Field Detail

DEFAULT_SGML_PUBLIC_ID

public static final String DEFAULT_SGML_PUBLIC_ID
DocBook V4.1 SGML public id: "-//OASIS//DTD DocBook V4.1//EN"

DEFAULT_XML_PUBLIC_ID

public static final String DEFAULT_XML_PUBLIC_ID
DocBook XML V4.1.2 XML public id: "-//OASIS//DTD DocBook XML V4.1.2//EN"

DEFAULT_XML_SYSTEM_ID

public static final String DEFAULT_XML_SYSTEM_ID
DocBook XML V4.0 XML system id: "http://www.oasis-open.org/docbook/xml/4.0/docbookx.dtd"

Constructor Detail

DocBookSink

public DocBookSink(Writer out, boolean isBook)

DocBookSink

public DocBookSink(Writer writer)

Parameters: writer the default writer.

Method Detail

anchor

public void anchor(String name)
{@inheritDoc }

See Also: ANCHOR_TAG

anchor_

public void anchor_()
{@inheritDoc }

See Also: ANCHOR_TAG

author

public void author()
{@inheritDoc }

See Also: CORPAUTHOR_TAG

author_

public void author_()
{@inheritDoc }

See Also: CORPAUTHOR_TAG

body_

public void body_()
{@inheritDoc }

See Also: ARTICLE_TAG

bold

public void bold()
{@inheritDoc }

bold_

public void bold_()
{@inheritDoc }

book

public void book()
{@inheritDoc }

See Also: BOOK_TAG

book_

public void book_()
{@inheritDoc }

See Also: BOOK_TAG

close

public void close()
{@inheritDoc }

content

protected void content(String text)
Write SGML escaped text to output, not preserving white space.

Parameters: text The text to write.

date

public void date()
{@inheritDoc }

See Also: DATE_TAG

date_

public void date_()
{@inheritDoc }

See Also: DATE_TAG

definedTerm

public void definedTerm()
{@inheritDoc }

See Also: TERM_TAG

definedTerm_

public void definedTerm_()
{@inheritDoc }

See Also: TERM_TAG

definition

public void definition()
{@inheritDoc }

See Also: LISTITEM_TAG

definitionList

public void definitionList()
{@inheritDoc }

See Also: VARIABLELIST_TAG

definitionListItem

public void definitionListItem()
{@inheritDoc }

See Also: VARLISTENTRY_TAG

definitionListItem_

public void definitionListItem_()
{@inheritDoc }

See Also: VARLISTENTRY_TAG

definitionList_

public void definitionList_()
{@inheritDoc }

See Also: VARIABLELIST_TAG

definition_

public void definition_()
{@inheritDoc }

See Also: LISTITEM_TAG

escapeSGML

public static final String escapeSGML(String text, boolean xmlMode)

Parameters: text The text to escape. xmlMode xmlMode.

Returns: The escaped text.

figureCaption

public void figureCaption()
{@inheritDoc }

See Also: FIGURE_TAG javax.swing.text.html.HTML.Tag#TITLE

figureCaption_

public void figureCaption_()
{@inheritDoc }

See Also: FIGURE_TAG javax.swing.text.html.HTML.Tag#TITLE

figureGraphics

public void figureGraphics(String name)
{@inheritDoc }

figure_

public void figure_()
{@inheritDoc }

flush

public void flush()
{@inheritDoc }

getBoldElement

public String getBoldElement()
Returns the current boldBeginTag.

Returns: the current boldBeginTag. Defaults to "".

getEncoding

public String getEncoding()
Returns the current encoding.

Returns: the current encoding.

getHorizontalRuleElement

public String getHorizontalRuleElement()
Returns the current horizontalRuleElement.

Returns: the current horizontalRuleElement. Defaults to "".

getItalicElement

public String getItalicElement()
Returns the current italicBeginTag.

Returns: the current italicBeginTag. Defaults to "".

getLanguage

public String getLanguage()
Returns the current language.

Returns: the current language.

getLineBreakElement

public String getLineBreakElement()
Returns the current lineBreakElement.

Returns: the current lineBreakElement. Defaults to "".

getMonospacedElement

public String getMonospacedElement()
Returns the current monospacedBeginTag.

Returns: the current monospacedBeginTag. Defaults to ">".

getPageBreakElement

public String getPageBreakElement()
Returns the current pageBreakElement.

Returns: the current pageBreakElement. Defaults to "".

getPublicId

public String getPublicId()
Returns the current publicId.

Returns: the current publicId.

getStyleSheet

public String getStyleSheet()
Returns the current styleSheet.

Returns: the current styleSheet.

getSystemId

public String getSystemId()
Returns the current systemId.

Returns: the current systemId.

graphicElement

protected void graphicElement()

See Also: MEDIAOBJECT_TAG IMAGEOBJECT_TAG IMAGEDATA_TAG FORMAT_ATTRIBUTE FILEREF_ATTRIBUTE

head

public void head()
{@inheritDoc }

See Also: DEFAULT_XML_PUBLIC_ID DEFAULT_SGML_PUBLIC_ID DEFAULT_XML_SYSTEM_ID ARTICLE_TAG

head_

public void head_()
{@inheritDoc }

See Also: ARTICLEINFO_TAG

horizontalRule

public void horizontalRule()
{@inheritDoc }

isXMLMode

public boolean isXMLMode()
Returns the current xmlMode.

Returns: the current xmlMode.

italic

public void italic()
{@inheritDoc }

italic_

public void italic_()
{@inheritDoc }

lineBreak

public void lineBreak()
{@inheritDoc }

link

public void link(String name)
{@inheritDoc }

See Also: ULINK_TAG URL_ATTRIBUTE LINK_TAG LINKEND_ATTRIBUTE

link_

public void link_()
{@inheritDoc }

See Also: ULINK_TAG LINK_TAG

list

public void list()
{@inheritDoc }

See Also: ITEMIZEDLIST_TAG

listItem

public void listItem()
{@inheritDoc }

See Also: LISTITEM_TAG

listItem_

public void listItem_()
{@inheritDoc }

See Also: LISTITEM_TAG

list_

public void list_()
{@inheritDoc }

See Also: ITEMIZEDLIST_TAG

markup

protected void markup(String text)
Write text to output, preserving white space.

Parameters: text The text to write.

monospaced

public void monospaced()
{@inheritDoc }

monospaced_

public void monospaced_()
{@inheritDoc }

nonBreakingSpace

public void nonBreakingSpace()
{@inheritDoc }

numberedList

public void numberedList(int numbering)
{@inheritDoc }

See Also: ORDEREDLIST_TAG NUMERATION_ATTRIBUTE

numberedListItem

public void numberedListItem()
{@inheritDoc }

See Also: LISTITEM_TAG

numberedListItem_

public void numberedListItem_()
{@inheritDoc }

See Also: LISTITEM_TAG

numberedList_

public void numberedList_()
{@inheritDoc }

See Also: ORDEREDLIST_TAG

pageBreak

public void pageBreak()
{@inheritDoc }

paragraph

public void paragraph()
{@inheritDoc }

See Also: PARA_TAG

paragraph_

public void paragraph_()
{@inheritDoc }

See Also: PARA_TAG

section1

public void section1()
{@inheritDoc }

See Also: SECTION_TAG

section1_

public void section1_()
{@inheritDoc }

See Also: SECTION_TAG

section2

public void section2()
{@inheritDoc }

See Also: SECTION_TAG

section2_

public void section2_()
{@inheritDoc }

See Also: SECTION_TAG

section3

public void section3()
{@inheritDoc }

See Also: SECTION_TAG

section3_

public void section3_()
{@inheritDoc }

See Also: SECTION_TAG

section4

public void section4()
{@inheritDoc }

See Also: SECTION_TAG

section4_

public void section4_()
{@inheritDoc }

See Also: SECTION_TAG

section5

public void section5()
{@inheritDoc }

See Also: SECTION_TAG

section5_

public void section5_()
{@inheritDoc }

See Also: SECTION_TAG

sectionTitle

public void sectionTitle()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TITLE

sectionTitle_

public void sectionTitle_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TITLE

setBoldElement

public void setBoldElement(String tag)
Sets the current boldBeginTag and constructs the corresponding end tag from it.

Parameters: tag the tag to set. If tag is null, the empty string is used.

setEncoding

public void setEncoding(String enc)
Sets the encoding.

Parameters: enc the encoding to set.

setHorizontalRuleElement

public void setHorizontalRuleElement(String element)
Sets the current horizontalRuleElement.

Parameters: element the element to set.

setItalicElement

public void setItalicElement(String tag)
Sets the current italicBeginTag and constructs the corresponding end tag from it.

Parameters: tag the tag to set. If tag is null, the empty string is used.

setLanguage

public void setLanguage(String language)
Sets the language.

Parameters: language the language to set.

setLineBreakElement

public void setLineBreakElement(String element)
Sets the current lineBreakElement.

Parameters: element the element to set.

setMonospacedElement

public void setMonospacedElement(String tag)
Sets the current monospacedBeginTag and constructs the corresponding end tag from it.

Parameters: tag the tag to set. If tag is null, the empty string is used.

setPageBreakElement

public void setPageBreakElement(String element)
Sets the current pageBreakElement.

Parameters: element the element to set.

setPublicId

public void setPublicId(String id)
Sets the publicId.

Parameters: id the publicId to set.

setStyleSheet

public void setStyleSheet(String sheet)
Sets the styleSheet.

Parameters: sheet the styleSheet to set.

setSystemId

public void setSystemId(String id)
Sets the systemId.

Parameters: id the systemId to set.

setXMLMode

public void setXMLMode(boolean mode)
Sets the xml mode.

Parameters: mode the mode to set.

table

public void table()
{@inheritDoc }

tableCaption

public void tableCaption()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TABLE FRAME_ATTRIBUTE ROWSEP_ATTRIBUTE COLSEP_ATTRIBUTE javax.swing.text.html.HTML.Tag#TITLE

tableCaption_

public void tableCaption_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TITLE

tableCell

public void tableCell()
{@inheritDoc }

See Also: ENTRY_TAG PARA_TAG

tableCell_

public void tableCell_()
{@inheritDoc }

See Also: ENTRY_TAG PARA_TAG

tableRow

public void tableRow()
{@inheritDoc }

See Also: ROW_TAG

tableRows

public void tableRows(int[] justification, boolean grid)
{@inheritDoc }

See Also: TGROUP_TAG COLS_ATTRIBUTE COLSPEC_TAG

tableRows_

public void tableRows_()
{@inheritDoc }

See Also: TGROUP_TAG TBODY_TAG

tableRow_

public void tableRow_()
{@inheritDoc }

See Also: ROW_TAG

table_

public void table_()
{@inheritDoc }

See Also: INFORMALTABLE_TAG FRAME_ATTRIBUTE ROWSEP_ATTRIBUTE COLSEP_ATTRIBUTE javax.swing.text.html.HTML.Tag#TABLE

text

public void text(String text)
{@inheritDoc }

title

public void title()
{@inheritDoc }

See Also: ARTICLEINFO_TAG javax.swing.text.html.HTML.Tag#TITLE

title_

public void title_()
{@inheritDoc }

See Also: javax.swing.text.html.HTML.Tag#TITLE

verbatim

public void verbatim(boolean boxed)
{@inheritDoc }

See Also: PROGRAMLISTING_TAG

verbatimContent

protected void verbatimContent(String text)
Write SGML escaped text to output, preserving white space.

Parameters: text The text to write.

verbatim_

public void verbatim_()
{@inheritDoc }

See Also: PROGRAMLISTING_TAG

write

protected void write(String text)
{@inheritDoc }
Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.