Package org.apache.maven.doxia.module.docbook

Class DocBookSink

java.lang.Object

org.apache.maven.doxia.sink.impl.AbstractSink

org.apache.maven.doxia.sink.impl.SinkAdapter

org.apache.maven.doxia.sink.impl.AbstractXmlSink

org.apache.maven.doxia.module.docbook.DocBookSink

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.XmlMarkup, DocbookMarkup, SimplifiedDocbookMarkup, org.apache.maven.doxia.sink.Sink

public class DocBookSink
extends org.apache.maven.doxia.sink.impl.AbstractXmlSink
implements DocbookMarkup, SimplifiedDocbookMarkup

Docbook Sink implementation.
It uses the Docbook v4.4 DTD http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SGML_PUBLIC_ID	Deprecated. since 1.1, use DocbookMarkup.DEFAULT_SGML_PUBLIC_ID instead of.
static final String	DEFAULT_SGML_SYSTEM_ID	Deprecated. since 1.1, use DocbookMarkup.DEFAULT_SGML_SYSTEM_ID instead of.
static final String	DEFAULT_XML_PUBLIC_ID	Deprecated. since 1.1, use DocbookMarkup.DEFAULT_XML_PUBLIC_ID instead of.
static final String	DEFAULT_XML_SYSTEM_ID	Deprecated. since 1.1, use DocbookMarkup.DEFAULT_XML_SYSTEM_ID instead of.
protected Stack<List<String>>	inlineStack	Keep track of the closing tags for inline events.

Fields inherited from interface org.apache.maven.doxia.module.docbook.DocbookMarkup

ANCHOR_TAG, ARABIC_STYLE, ARTICLE_TAG, ARTICLEINFO_TAG, BOOK_TAG, BOOKINFO_TAG, CHAPTER_TAG, COLS_ATTRIBUTE, COLSEP_ATTRIBUTE, COLSPEC_TAG, CORPAUTHOR_TAG, DATE_TAG, EMAIL_TAG, ENTRY_TAG, FIGURE_TAG, FILEREF_ATTRIBUTE, FORMALPARA_TAG, FORMAT_ATTRIBUTE, FRAME_ATTRIBUTE, IMAGEDATA_TAG, IMAGEOBJECT_TAG, INFO_TAG, INFORMALFIGURE_TAG, INFORMALTABLE_TAG, ITEMIZEDLIST_TAG, LINK_TAG, LINKEND_ATTRIBUTE, LISTITEM_TAG, LOWERALPHA_STYLE, LOWERROMAN_STYLE, MEDIAOBJECT_TAG, NUMERATION_ATTRIBUTE, ORDEREDLIST_TAG, PARA_TAG, PROGRAMLISTING_TAG, ROW_TAG, ROWSEP_ATTRIBUTE, SECTION_TAG, SIMPARA_TAG, TBODY_TAG, TERM_TAG, TGROUP_TAG, THEAD_TAG, ULINK_TAG, UPPERALPHA_STYLE, UPPERROMAN_STYLE, URL_ATTRIBUTE, URL_TAG, VARIABLELIST_TAG, VARLISTENTRY_TAG, XREF_TAG

Fields inherited from interface org.apache.maven.doxia.markup.Markup

COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR

Fields inherited from interface org.apache.maven.doxia.module.docbook.SimplifiedDocbookMarkup

ABBREV_TAG, ABSTRACT_TAG, ACRONYM_TAG, AFFILIATION_TAG, ANCHOR_TAG, APPENDIX_TAG, ARABIC_STYLE, ARTICLE_TAG, ARTICLEINFO_TAG, ATTRIBUTION_TAG, AUDIODATA_TAG, AUDIOOBJECT_TAG, AUTHOR_TAG, AUTHORBLURB_TAG, AUTHORGROUP_TAG, AUTHORINITIALS_TAG, BIBLIODIV_TAG, BIBLIOGRAPHY_TAG, BIBLIOMISC_TAG, BIBLIOMIXED_TAG, BIBLIOMSET_TAG, BLOCKQUOTE_TAG, CAPTION_TAG, CITETITLE_TAG, COL_TAG, COLGROUP_TAG, COLS_ATTRIBUTE, COLSEP_ATTRIBUTE, COLSPEC_TAG, COMMAND_TAG, COMPUTEROUTPUT_TAG, COPYRIGHT_TAG, CORPAUTHOR_TAG, DATE_TAG, EDITION_TAG, EDITOR_TAG, EMAIL_TAG, EMPHASIS_TAG, ENTRY_TAG, ENTRYTBL_TAG, EPIGRAPH_TAG, EXAMPLE_TAG, FIGURE_TAG, FILENAME_TAG, FILEREF_ATTRIBUTE, FIRSTNAME_TAG, FOOTNOTE_TAG, FOOTNOTEREF_TAG, FORMAT_ATTRIBUTE, FRAME_ATTRIBUTE, HOLDER_TAG, HONORIFIC_TAG, ID_ATTRIBUTE, IMAGEDATA_TAG, IMAGEOBJECT_TAG, INFORMALTABLE_TAG, INLINEMEDIAOBJECT_TAG, ISSUENUM_TAG, ITEMIZEDLIST_TAG, JOBTITLE_TAG, KEYWORD_TAG, KEYWORDSET_TAG, LANG_ATTRIBUTE, LEGALNOTICE_TAG, LINEAGE_TAG, LINEANNOTATION_TAG, LINK_TAG, LINKEND_ATTRIBUTE, LISTITEM_TAG, LITERAL_TAG, LITERALLAYOUT_TAG, LOWERALPHA_STYLE, LOWERROMAN_STYLE, MEDIAOBJECT_TAG, NOTE_TAG, NUMERATION_ATTRIBUTE, OBJECTINFO_TAG, OPTION_TAG, ORDEREDLIST_TAG, ORGNAME_TAG, OTHERCREDIT_TAG, OTHERNAME_TAG, PARA_TAG, PHRASE_TAG, PROGRAMLISTING_TAG, PUBDATE_TAG, PUBLISHERNAME_TAG, QUOTE_TAG, RELEASEINFO_TAG, REMAP_ATTRIBUTE, REPLACEABLE_TAG, REVDESCRIPTION_TAG, REVHISTORY_TAG, REVISION_TAG, REVISIONFLAG_ATTRIBUTE, REVNUMBER_TAG, REVREMARK_TAG, ROW_TAG, ROWSEP_ATTRIBUTE, SECTION_TAG, SECTIONINFO_TAG, SIDEBAR_TAG, SPANSPEC_TAG, SUBJECT_TAG, SUBJECTSET_TAG, SUBJECTTERM_TAG, SUBSCRIPT_TAG, SUBTITLE_TAG, SUPERSCRIPT_TAG, SURNAME_TAG, SYSTEMITEM_TAG, TABLE_TAG, TBODY_TAG, TD_TAG, TERM_TAG, TEXTDATA_TAG, TEXTOBJECT_TAG, TFOOT_TAG, TGROUP_TAG, TH_TAG, THEAD_TAG, TITLE_TAG, TITLEABBREV_TAG, TR_TAG, TRADEMARK_TAG, ULINK_TAG, UPPERALPHA_STYLE, UPPERROMAN_STYLE, URL_ATTRIBUTE, USERINPUT_TAG, VARIABLELIST_TAG, VARLISTENTRY_TAG, VIDEODATA_TAG, VIDEOOBJECT_TAG, VOLUMENUM_TAG, XREF_TAG, YEAR_TAG

Fields inherited from interface org.apache.maven.doxia.sink.Sink

JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5, SECTION_LEVEL_6

Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup

BANG, CDATA, DOCTYPE_START, ENTITY_START, XML_NAMESPACE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DocBookSink(Writer writer)	Constructor, initialize the Writer.
protected	DocBookSink(Writer writer, String encoding)	Constructor, initialize the Writer and tells which encoding is used.
protected	DocBookSink(Writer writer, String encoding, String languageId)	Constructor, initialize the Writer and tells which encoding and languageId are used.

Method Summary

Modifier and Type	Method	Description
void	anchor(String name)
void	anchor_()
void	author()
void	author_()
void	body_()
void	bold()
void	bold_()
void	close()
void	comment(String comment)
protected void	content(String text)	Write SGML escaped text to output, not preserving white space.
void	date()
void	date_()
void	definedTerm()
void	definedTerm_()
void	definition()
void	definition_()
void	definitionList()
void	definitionList_()
void	definitionListItem()
void	definitionListItem_()
static String	escapeSGML(String text, boolean xmlMode)	Deprecated. Use HtmlTools#escapeHTML(String,boolean).
void	figure()
void	figure_()
void	figureCaption()
void	figureCaption_()
void	figureGraphics(String name)
void	flush()
String	getBoldElement()	Returns the current boldBeginTag.
String	getEncoding()	Returns the encoding.
String	getHorizontalRuleElement()	Returns the current horizontalRuleElement.
String	getItalicElement()	Returns the current italicBeginTag.
String	getLanguage()	Returns the current language.
String	getLineBreakElement()	Returns the current lineBreakElement.
String	getMonospacedElement()	Returns the current monospacedBeginTag.
String	getPageBreakElement()	Returns the current pageBreakElement.
String	getPublicId()	Returns the current publicId.
String	getStyleSheet()	Returns the current styleSheet.
String	getSystemId()	Returns the current systemId.
protected void	graphicElement()	Deprecated. do not use!
void	head()
void	head_()
void	header()
void	header_()
void	horizontalRule()
protected void	init()
void	inline()
void	inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void	inline_()
boolean	isXMLMode()	Deprecated. xml mode is not used.
void	italic()
void	italic_()
void	lineBreak()
void	link(String name)
void	link_()
void	list()
void	list_()
void	listItem()
void	listItem_()
protected void	markup(String text)	Write text to output, preserving white space.
void	monospaced()
void	monospaced_()
void	nonBreakingSpace()
void	numberedList(int numbering)
void	numberedList_()
void	numberedListItem()
void	numberedListItem_()
void	pageBreak()
void	paragraph()
void	paragraph_()
protected void	resetState()	Deprecated. since 1.1.2, use init() instead of.
void	section1()
void	section1_()
void	section2()
void	section2_()
void	section3()
void	section3_()
void	section4()
void	section4_()
void	section5()
void	section5_()
void	sectionTitle()
void	sectionTitle_()
void	sectionTitle1()
void	sectionTitle1_()
void	sectionTitle2()
void	sectionTitle2_()
void	sectionTitle3()
void	sectionTitle3_()
void	sectionTitle4()
void	sectionTitle4_()
void	sectionTitle5()
void	sectionTitle5_()
void	setBoldElement(String tag)	Sets the current boldBeginTag and constructs the corresponding end tag from it.
void	setEncoding(String enc)	Sets the encoding.
void	setHorizontalRuleElement(String element)	Sets the current horizontalRuleElement.
void	setItalicElement(String tag)	Sets the current italicBeginTag and constructs the corresponding end tag from it.
void	setLanguage(String language)	Sets the language.
void	setLineBreakElement(String element)	Sets the current lineBreakElement.
void	setMonospacedElement(String tag)	Sets the current monospacedBeginTag and constructs the corresponding end tag from it.
void	setPageBreakElement(String element)	Sets the current pageBreakElement.
void	setPublicId(String id)	Sets the publicId.
void	setSkip(boolean skip)	Setter for the field skip.
void	setStyleSheet(String sheet)	Sets the styleSheet.
void	setSystemId(String id)	Sets the systemId.
void	setXMLMode(boolean mode)	Deprecated. xml mode is not used.
void	sidebar()
void	sidebar_()
void	table()
void	table_()
void	tableCaption()
void	tableCaption_()
void	tableCell()
void	tableCell_()
void	tableHeaderCell()
void	tableHeaderCell_()
void	tableRow()
void	tableRow_()
void	tableRows(int[] justification, boolean grid)
void	tableRows_()
void	text(String text)
void	title()
void	title_()
void	unknown(String name, Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes)	Unknown events just log a warning message but are ignored otherwise.
void	verbatim(boolean boxed)
void	verbatim_()
protected void	verbatimContent(String text)	Write SGML escaped text to output, preserving white space.
protected void	write(String text)
protected MutableAttributeSet	writeXmlHeader(String root)	writeXmlHeader.

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink

getNameSpace, setInsertNewline, setNameSpace, writeEndTag, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag, writeStartTag

Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter

address, address, address_, anchor, article, article, article_, author, blockquote, blockquote, blockquote_, body, body, content, content, content_, data, data, data_, date, definedTerm, definition, definitionList, definitionListItem, division, division, division_, figure, figureCaption, figureGraphics, footer, footer, footer_, head, header, horizontalRule, lineBreak, lineBreakOpportunity, lineBreakOpportunity, link, list, listItem, navigation, navigation, navigation_, numberedList, numberedListItem, paragraph, rawText, section, section_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, sidebar, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, time, time, time_, title, verbatim

Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink

enableLogging, getLog, unifyEOLs

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SGML_PUBLIC_ID

public static final String DEFAULT_SGML_PUBLIC_ID

Deprecated.

since 1.1, use DocbookMarkup.DEFAULT_SGML_PUBLIC_ID instead of.

DocBook V4.4 SGML public id: "-//OASIS//DTD DocBook V4.4//EN"

See Also:

• Constant Field Values

DEFAULT_XML_PUBLIC_ID

public static final String DEFAULT_XML_PUBLIC_ID

Deprecated.

since 1.1, use DocbookMarkup.DEFAULT_XML_PUBLIC_ID instead of.

DocBook XML V4.4 XML public id: "-//OASIS//DTD DocBook XML V4.4//EN"

See Also:

• Constant Field Values

DEFAULT_XML_SYSTEM_ID

public static final String DEFAULT_XML_SYSTEM_ID

Deprecated.

since 1.1, use DocbookMarkup.DEFAULT_XML_SYSTEM_ID instead of.

DocBook XML V4.4 XML system id: "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"

See Also:

• Constant Field Values

DEFAULT_SGML_SYSTEM_ID

public static final String DEFAULT_SGML_SYSTEM_ID

Deprecated.

since 1.1, use DocbookMarkup.DEFAULT_SGML_SYSTEM_ID instead of.

DocBook XML V4.4 SGML system id: "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"

See Also:

• Constant Field Values

inlineStack

protected Stack<List<String>> inlineStack

Keep track of the closing tags for inline events.

Constructor Details

DocBookSink

protected DocBookSink(Writer writer)

Constructor, initialize the Writer.

Parameters:

writer - not null writer to write the result. Should be an UTF-8 Writer. You could use newXmlWriter methods from WriterFactory.

DocBookSink

protected DocBookSink(Writer writer,
 String encoding)

Constructor, initialize the Writer and tells which encoding is used.

Parameters:

writer - not null writer to write the result.

encoding - the encoding used, that should be written to the generated HTML content if not null.

DocBookSink

protected DocBookSink(Writer writer,
 String encoding,
 String languageId)

Constructor, initialize the Writer and tells which encoding and languageId are used.

Parameters:

writer - not null writer to write the result.

encoding - the encoding used, that should be written to the generated HTML content if not null.

languageId - language identifier for the root element as defined by IETF BCP 47, Tags for the Identification of Languages; in addition, the empty string may be specified.

Since:

1.1

Method Details

escapeSGML

public static String escapeSGML(String text,
 boolean xmlMode)

Deprecated.

Use HtmlTools#escapeHTML(String,boolean).

escapeSGML

Parameters:

text - The text to escape.

xmlMode - xmlMode.

Returns:

The escaped text.

setXMLMode

public void setXMLMode(boolean mode)

Deprecated.

xml mode is not used.

Sets the xml mode.

Parameters:

mode - the mode to set.

isXMLMode

public boolean isXMLMode()

Deprecated.

xml mode is not used.

Returns the current xmlMode.

Returns:

the current xmlMode.

setEncoding

public void setEncoding(String enc)

Sets the encoding. The encoding specified here must be consistent with then encoding used in the Writer used by this DocBookSink instance.

Parameters:

enc - the encoding to set.

getEncoding

public String getEncoding()

Returns the encoding.

Returns:

the encoding set (can be null).

setStyleSheet

public void setStyleSheet(String sheet)

Sets the styleSheet.

Parameters:

sheet - the styleSheet to set.

getStyleSheet

public String getStyleSheet()

Returns the current styleSheet.

Returns:

the current styleSheet.

setPublicId

public void setPublicId(String id)

Sets the publicId.

Parameters:

id - the publicId to set.

getPublicId

public String getPublicId()

Returns the current publicId.

Returns:

the current publicId.

setSystemId

public void setSystemId(String id)

Sets the systemId.

Parameters:

id - the systemId to set.

getSystemId

public String getSystemId()

Returns the current systemId.

Returns:

the current systemId.

setLanguage

public void setLanguage(String language)

Sets the language.

Parameters:

language - the language to set.

getLanguage

public String getLanguage()

Returns the current language.

Returns:

the current language.

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.

getItalicElement

public String getItalicElement()

Returns the current italicBeginTag.

Returns:

the current italicBeginTag. Defaults to <emphasis>.

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.

getBoldElement

public String getBoldElement()

Returns the current boldBeginTag.

Returns:

the current boldBeginTag. Defaults to <emphasis role=\"bold\">.

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.

getMonospacedElement

public String getMonospacedElement()

Returns the current monospacedBeginTag.

Returns:

the current monospacedBeginTag. Defaults to <literal>.

setHorizontalRuleElement

public void setHorizontalRuleElement(String element)

Sets the current horizontalRuleElement.

Parameters:

element - the element to set.

getHorizontalRuleElement

public String getHorizontalRuleElement()

Returns the current horizontalRuleElement.

Returns:

the current horizontalRuleElement. Defaults to "".

setPageBreakElement

public void setPageBreakElement(String element)

Sets the current pageBreakElement.

Parameters:

element - the element to set.

getPageBreakElement

public String getPageBreakElement()

Returns the current pageBreakElement.

Returns:

the current pageBreakElement. Defaults to "".

setLineBreakElement

public void setLineBreakElement(String element)

Sets the current lineBreakElement.

Parameters:

element - the element to set.

getLineBreakElement

public String getLineBreakElement()

Returns the current lineBreakElement.

Returns:

the current lineBreakElement. Defaults to "".

resetState

protected void resetState()

Deprecated.

since 1.1.2, use init() instead of.

Reset all variables.

init

protected void init()

Overrides:

init in class org.apache.maven.doxia.sink.impl.AbstractSink

head

public void head()

Specified by:

head in interface org.apache.maven.doxia.sink.Sink

Overrides:

head in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.DEFAULT_XML_PUBLIC_ID
• SimplifiedDocbookMarkup.DEFAULT_XML_SYSTEM_ID
• SimplifiedDocbookMarkup.ARTICLE_TAG

writeXmlHeader

protected MutableAttributeSet writeXmlHeader(String root)

writeXmlHeader.

Parameters:

root - not null.

Returns:

an attribute set.

Since:

1.1

See Also:

• SimplifiedDocbookMarkup.DEFAULT_XML_PUBLIC_ID
• SimplifiedDocbookMarkup.DEFAULT_XML_SYSTEM_ID
• SimplifiedDocbookMarkup.ARTICLE_TAG

head_

public void head_()

Specified by:

head_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

head_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ARTICLEINFO_TAG

title

public void title()

Specified by:

title in interface org.apache.maven.doxia.sink.Sink

Overrides:

title in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ARTICLEINFO_TAG
• SimplifiedDocbookMarkup.TITLE_TAG

title_

public void title_()

Specified by:

title_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

title_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

author

public void author()

Specified by:

author in interface org.apache.maven.doxia.sink.Sink

Overrides:

author in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.CORPAUTHOR_TAG

author_

public void author_()

Specified by:

author_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

author_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.CORPAUTHOR_TAG

date

public void date()

Specified by:

date in interface org.apache.maven.doxia.sink.Sink

Overrides:

date in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.DATE_TAG

date_

public void date_()

Specified by:

date_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

date_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.DATE_TAG

body_

public void body_()

Specified by:

body_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

body_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ARTICLE_TAG

sidebar

public void sidebar()

Specified by:

sidebar in interface org.apache.maven.doxia.sink.Sink

Overrides:

sidebar in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SIDEBAR_TAG

sidebar_

public void sidebar_()

Specified by:

sidebar_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sidebar_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SIDEBAR_TAG

section1

public void section1()

Specified by:

section1 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section1 in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTION_TAG

section1_

public void section1_()

Specified by:

section1_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section1_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTION_TAG

section2

public void section2()

Specified by:

section2 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section2 in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTION_TAG

section2_

public void section2_()

Specified by:

section2_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section2_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTION_TAG

section3

public void section3()

Specified by:

section3 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section3 in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTION_TAG

section3_

public void section3_()

Specified by:

section3_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section3_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTION_TAG

section4

public void section4()

Specified by:

section4 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section4 in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTION_TAG

section4_

public void section4_()

Specified by:

section4_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section4_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTION_TAG

section5

public void section5()

Specified by:

section5 in interface org.apache.maven.doxia.sink.Sink

Overrides:

section5 in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTION_TAG

section5_

public void section5_()

Specified by:

section5_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

section5_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTION_TAG

sectionTitle

public void sectionTitle()

Specified by:

sectionTitle in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle_

public void sectionTitle_()

Specified by:

sectionTitle_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle1

public void sectionTitle1()

Specified by:

sectionTitle1 in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle1 in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle1_

public void sectionTitle1_()

Specified by:

sectionTitle1_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle1_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle2

public void sectionTitle2()

Specified by:

sectionTitle2 in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle2 in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle2_

public void sectionTitle2_()

Specified by:

sectionTitle2_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle2_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle3

public void sectionTitle3()

Specified by:

sectionTitle3 in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle3 in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle3_

public void sectionTitle3_()

Specified by:

sectionTitle3_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle3_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle4

public void sectionTitle4()

Specified by:

sectionTitle4 in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle4 in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle4_

public void sectionTitle4_()

Specified by:

sectionTitle4_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle4_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle5

public void sectionTitle5()

Specified by:

sectionTitle5 in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle5 in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

sectionTitle5_

public void sectionTitle5_()

Specified by:

sectionTitle5_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

sectionTitle5_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

header

public void header()

Specified by:

header in interface org.apache.maven.doxia.sink.Sink

Overrides:

header in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTIONINFO_TAG

header_

public void header_()

Specified by:

header_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

header_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.SECTIONINFO_TAG

list

public void list()

Specified by:

list in interface org.apache.maven.doxia.sink.Sink

Overrides:

list in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ITEMIZEDLIST_TAG

list_

public void list_()

Specified by:

list_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

list_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ITEMIZEDLIST_TAG

listItem

public void listItem()

Specified by:

listItem in interface org.apache.maven.doxia.sink.Sink

Overrides:

listItem in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.LISTITEM_TAG

listItem_

public void listItem_()

Specified by:

listItem_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

listItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.LISTITEM_TAG

numberedList

public void numberedList(int numbering)

Specified by:

numberedList in interface org.apache.maven.doxia.sink.Sink

Overrides:

numberedList in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ORDEREDLIST_TAG
• SimplifiedDocbookMarkup.NUMERATION_ATTRIBUTE

numberedList_

public void numberedList_()

Specified by:

numberedList_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

numberedList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ORDEREDLIST_TAG

numberedListItem

public void numberedListItem()

Specified by:

numberedListItem in interface org.apache.maven.doxia.sink.Sink

Overrides:

numberedListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.LISTITEM_TAG

numberedListItem_

public void numberedListItem_()

Specified by:

numberedListItem_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

numberedListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.LISTITEM_TAG

definitionList

public void definitionList()

Specified by:

definitionList in interface org.apache.maven.doxia.sink.Sink

Overrides:

definitionList in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.VARIABLELIST_TAG

definitionList_

public void definitionList_()

Specified by:

definitionList_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

definitionList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.VARIABLELIST_TAG

definitionListItem

public void definitionListItem()

Specified by:

definitionListItem in interface org.apache.maven.doxia.sink.Sink

Overrides:

definitionListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.VARLISTENTRY_TAG

definitionListItem_

public void definitionListItem_()

Specified by:

definitionListItem_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

definitionListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.VARLISTENTRY_TAG

definedTerm

public void definedTerm()

Specified by:

definedTerm in interface org.apache.maven.doxia.sink.Sink

Overrides:

definedTerm in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TERM_TAG

definedTerm_

public void definedTerm_()

Specified by:

definedTerm_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

definedTerm_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TERM_TAG

definition

public void definition()

Specified by:

definition in interface org.apache.maven.doxia.sink.Sink

Overrides:

definition in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.LISTITEM_TAG

definition_

public void definition_()

Specified by:

definition_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

definition_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.LISTITEM_TAG

paragraph

public void paragraph()

Specified by:

paragraph in interface org.apache.maven.doxia.sink.Sink

Overrides:

paragraph in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.PARA_TAG

paragraph_

public void paragraph_()

Specified by:

paragraph_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

paragraph_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.PARA_TAG

verbatim

public void verbatim(boolean boxed)

Specified by:

verbatim in interface org.apache.maven.doxia.sink.Sink

Overrides:

verbatim in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.PROGRAMLISTING_TAG

verbatim_

public void verbatim_()

Specified by:

verbatim_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

verbatim_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.PROGRAMLISTING_TAG

horizontalRule

public void horizontalRule()

Specified by:

horizontalRule in interface org.apache.maven.doxia.sink.Sink

Overrides:

horizontalRule in class org.apache.maven.doxia.sink.impl.SinkAdapter

pageBreak

public void pageBreak()

Specified by:

pageBreak in interface org.apache.maven.doxia.sink.Sink

Overrides:

pageBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter

figure

public void figure()

Specified by:

figure in interface org.apache.maven.doxia.sink.Sink

Overrides:

figure in class org.apache.maven.doxia.sink.impl.SinkAdapter

figure_

public void figure_()

Specified by:

figure_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

figure_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

graphicElement

protected void graphicElement()

Deprecated.

do not use!

graphicElement

See Also:

• SimplifiedDocbookMarkup.MEDIAOBJECT_TAG
• SimplifiedDocbookMarkup.IMAGEOBJECT_TAG
• SimplifiedDocbookMarkup.IMAGEDATA_TAG
• SimplifiedDocbookMarkup.FORMAT_ATTRIBUTE
• SimplifiedDocbookMarkup.FILEREF_ATTRIBUTE

figureGraphics

public void figureGraphics(String name)

Specified by:

figureGraphics in interface org.apache.maven.doxia.sink.Sink

Overrides:

figureGraphics in class org.apache.maven.doxia.sink.impl.SinkAdapter

figureCaption

public void figureCaption()

Specified by:

figureCaption in interface org.apache.maven.doxia.sink.Sink

Overrides:

figureCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.FIGURE_TAG
• SimplifiedDocbookMarkup.TITLE_TAG

figureCaption_

public void figureCaption_()

Specified by:

figureCaption_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

figureCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.FIGURE_TAG
• SimplifiedDocbookMarkup.TITLE_TAG

table

public void table()

Specified by:

table in interface org.apache.maven.doxia.sink.Sink

Overrides:

table in class org.apache.maven.doxia.sink.impl.SinkAdapter

table_

public void table_()

Specified by:

table_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

table_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.INFORMALTABLE_TAG
• SimplifiedDocbookMarkup.FRAME_ATTRIBUTE
• SimplifiedDocbookMarkup.ROWSEP_ATTRIBUTE
• SimplifiedDocbookMarkup.COLSEP_ATTRIBUTE
• SimplifiedDocbookMarkup.TABLE_TAG

tableRows

public void tableRows(int[] justification,
 boolean grid)

Specified by:

tableRows in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableRows in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TGROUP_TAG
• SimplifiedDocbookMarkup.COLS_ATTRIBUTE
• SimplifiedDocbookMarkup.COLSPEC_TAG

tableRows_

public void tableRows_()

Specified by:

tableRows_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableRows_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TGROUP_TAG
• SimplifiedDocbookMarkup.TBODY_TAG

tableRow

public void tableRow()

Specified by:

tableRow in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableRow in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ROW_TAG

tableRow_

public void tableRow_()

Specified by:

tableRow_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableRow_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ROW_TAG

tableCell

public void tableCell()

Specified by:

tableCell in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableCell in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ENTRY_TAG

tableCell_

public void tableCell_()

Specified by:

tableCell_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ENTRY_TAG

tableHeaderCell

public void tableHeaderCell()

Specified by:

tableHeaderCell in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableHeaderCell in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ENTRY_TAG

tableHeaderCell_

public void tableHeaderCell_()

Specified by:

tableHeaderCell_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableHeaderCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ENTRY_TAG

tableCaption

public void tableCaption()

Specified by:

tableCaption in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TABLE_TAG
• SimplifiedDocbookMarkup.FRAME_ATTRIBUTE
• SimplifiedDocbookMarkup.ROWSEP_ATTRIBUTE
• SimplifiedDocbookMarkup.COLSEP_ATTRIBUTE
• SimplifiedDocbookMarkup.TITLE_TAG

tableCaption_

public void tableCaption_()

Specified by:

tableCaption_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

tableCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.TITLE_TAG

anchor

public void anchor(String name)

Specified by:

anchor in interface org.apache.maven.doxia.sink.Sink

Overrides:

anchor in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ANCHOR_TAG

anchor_

public void anchor_()

Specified by:

anchor_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

anchor_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ANCHOR_TAG

link

public void link(String name)

Specified by:

link in interface org.apache.maven.doxia.sink.Sink

Overrides:

link in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ULINK_TAG
• SimplifiedDocbookMarkup.URL_ATTRIBUTE
• SimplifiedDocbookMarkup.LINK_TAG
• SimplifiedDocbookMarkup.LINKEND_ATTRIBUTE

link_

public void link_()

Specified by:

link_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

link_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• SimplifiedDocbookMarkup.ULINK_TAG
• SimplifiedDocbookMarkup.LINK_TAG

inline

public void inline()

Specified by:

inline in interface org.apache.maven.doxia.sink.Sink

Overrides:

inline in class org.apache.maven.doxia.sink.impl.SinkAdapter

inline

public void inline(org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Specified by:

inline in interface org.apache.maven.doxia.sink.Sink

Overrides:

inline in class org.apache.maven.doxia.sink.impl.SinkAdapter

inline_

public void inline_()

Specified by:

inline_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

inline_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

italic

public void italic()

Specified by:

italic in interface org.apache.maven.doxia.sink.Sink

Overrides:

italic in class org.apache.maven.doxia.sink.impl.SinkAdapter

italic_

public void italic_()

Specified by:

italic_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

italic_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

bold

public void bold()

Specified by:

bold in interface org.apache.maven.doxia.sink.Sink

Overrides:

bold in class org.apache.maven.doxia.sink.impl.SinkAdapter

bold_

public void bold_()

Specified by:

bold_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

bold_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

monospaced

public void monospaced()

Specified by:

monospaced in interface org.apache.maven.doxia.sink.Sink

Overrides:

monospaced in class org.apache.maven.doxia.sink.impl.SinkAdapter

monospaced_

public void monospaced_()

Specified by:

monospaced_ in interface org.apache.maven.doxia.sink.Sink

Overrides:

monospaced_ in class org.apache.maven.doxia.sink.impl.SinkAdapter

lineBreak

public void lineBreak()

Specified by:

lineBreak in interface org.apache.maven.doxia.sink.Sink

Overrides:

lineBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()

Specified by:

nonBreakingSpace in interface org.apache.maven.doxia.sink.Sink

Overrides:

nonBreakingSpace in class org.apache.maven.doxia.sink.impl.SinkAdapter

text

public void text(String text)

Specified by:

text in interface org.apache.maven.doxia.sink.Sink

Overrides:

text in class org.apache.maven.doxia.sink.impl.SinkAdapter

comment

public void comment(String comment)

Specified by:

comment in interface org.apache.maven.doxia.sink.Sink

Overrides:

comment in class org.apache.maven.doxia.sink.impl.SinkAdapter

unknown

public void unknown(String name,
 Object[] requiredParams,
 org.apache.maven.doxia.sink.SinkEventAttributes attributes)

Unknown events just log a warning message but are ignored otherwise.

Specified by:

unknown in interface org.apache.maven.doxia.sink.Sink

Overrides:

unknown in class org.apache.maven.doxia.sink.impl.SinkAdapter

See Also:

• Sink.unknown(String,Object[],SinkEventAttributes)

markup

protected void markup(String text)

Write text to output, preserving white space.

Parameters:

text - The text to write.

content

protected void content(String text)

Write SGML escaped text to output, not preserving white space.

Parameters:

text - The text to write.

verbatimContent

protected void verbatimContent(String text)

Write SGML escaped text to output, preserving white space.

Parameters:

text - The text to write.

flush

public void flush()

Specified by:

flush in interface org.apache.maven.doxia.sink.Sink

Overrides:

flush in class org.apache.maven.doxia.sink.impl.SinkAdapter

close

public void close()

Specified by:

close in interface org.apache.maven.doxia.sink.Sink

Overrides:

close in class org.apache.maven.doxia.sink.impl.SinkAdapter

write

protected void write(String text)

Specified by:

write in class org.apache.maven.doxia.sink.impl.AbstractXmlSink

setSkip

public void setSkip(boolean skip)

Setter for the field skip.

Parameters:

skip - the skip to set.

Since:

1.1