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:
LogEnabled
,Markup
,XmlMarkup
,DocbookMarkup
,SimplifiedDocbookMarkup
,Sink
Docbook Sink implementation.
It uses the Docbook v4.4 DTD http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd.
It uses the Docbook v4.4 DTD http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd.
- Since:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
authorDate.private String
boldBegin.private String
boldEnd.static final String
Deprecated.static final String
Deprecated.since 1.1, useDocbookMarkup.DEFAULT_SGML_SYSTEM_ID
instead of.static final String
Deprecated.since 1.1, useDocbookMarkup.DEFAULT_XML_PUBLIC_ID
instead of.static final String
Deprecated.since 1.1, useDocbookMarkup.DEFAULT_XML_SYSTEM_ID
instead of.private String
private boolean
externalLink.private String
An image source file.private boolean
hasTitle.private String
horizontalRule.Keep track of the closing tags for inline events.private String
italicBegin.private String
italicEnd.private String
language.private String
lineBreak.private String
monospacedBegin.private String
monospacedEnd.private PrintWriter
The output writer.private String
pageBreak.private boolean
private String
publicId.private PrintWriter
Used for table rows.private boolean
private String
styleSheet.private String
systemId.private boolean
tableHasCaption.private boolean
tableHasGrid.private String
tableRows.private StringWriter
tableRows writer.private boolean
verbatim.Map of warn messages with a String as key to describe the error type and a Set as value.private boolean
xmlMode.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
ConstructorsModifierConstructorDescriptionprotected
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 TypeMethodDescriptionvoid
Starts an element which defines an anchor.void
anchor_()
Ends an anchor element.void
author()
Starts an author element.void
author_()
Ends an author element.void
body_()
Ends the body element.void
bold()
Starts a bold element.void
bold_()
Ends a bold element.void
close()
Close the writer or the stream, if needed.void
Add a comment.protected void
Write SGML escaped text to output, not preserving white space.void
date()
Starts the date element.void
date_()
Ends the date element.void
Starts a definition term element within a definition list.void
Ends a definition term element within a definition list.void
Starts a definition element within a definition list.void
Ends a definition element within a definition list.void
Starts a definition list element.void
Ends a definition list element.void
Starts a list item element within a definition list.void
Ends a list item element within a definition list.static String
escapeSGML
(String text, boolean xmlMode) Deprecated.Use HtmlTools#escapeHTML(String,boolean).void
figure()
Starts a basic image embedding element.void
figure_()
Ends a basic image embedding element.void
Starts a caption of an image element.void
Ends a caption of an image.void
figureGraphics
(String name) Adding a source of a graphic.void
flush()
Flush the writer or the stream, if needed.Returns the current boldBeginTag.Returns the encoding.Returns the current horizontalRuleElement.Returns the current italicBeginTag.Returns the current language.Returns the current lineBreakElement.Returns the current monospacedBeginTag.Returns the current pageBreakElement.Returns the current publicId.Returns the current styleSheet.Returns the current systemId.protected void
Deprecated.do not use!void
head()
Starts the head element.void
head_()
Ends the head element.void
header()
Start a new header within the section or body.void
header_()
Ends a header element.void
Adding a separator of sections from a text to each other.protected void
init()
This is called inSink.head()
or inSink.close()
, and can be used to set the sink into a clear state so it can be re-used.void
inline()
Starts an inline element.void
inline
(SinkEventAttributes attributes) Starts an inline element.void
inline_()
Ends an inline element.boolean
Deprecated.xml mode is not used.void
italic()
Starts an italic element.void
italic_()
Ends an italic element.void
Adds a line break.void
Starts an element which defines a link.void
link_()
Ends a link element.void
list()
Starts an unordered list element.void
list_()
Ends an unordered list element.void
listItem()
Starts a list item element within an unordered list.void
Ends a list item element within an unordered list.private void
logMessage
(String key, String msg) If debug mode is enabled, log themsg
as is, otherwise add unique msg inwarnMessages
.private String
makeEndTag
(String beginTag) Constructs the corresponding end tag from the given begin tag.protected void
Write text to output, preserving white space.void
Starts a monospaced element.void
Ends a monospaced element.void
Adding a non breaking space, ie a space without any special formatting operations.void
numberedList
(int numbering) Starts an ordered list element.void
Ends an ordered list element.void
Starts a list item element within an ordered list.void
Ends a list item element within an ordered list.void
Adding a new page separator.void
Starts an element which represents a paragraph.void
Ends a paragraph element.protected void
Deprecated.since 1.1.2, useinit()
instead of.void
section1()
Starts a first heading element which contains the topic of the section.void
Ends a first heading element.void
section2()
Starts a second heading element which contains the topic of the section.void
Ends a second heading element.void
section3()
Starts a third heading element which contains the topic of the section.void
Ends a third heading element.void
section4()
Starts a 4th heading element which contains the topic of the section.void
Ends a 4th heading element.void
section5()
Starts a 5th heading element which contains the topic of the section.void
Ends a 5th heading element.void
Starts a title heading element.void
Ends a title heading element.void
Starts a first title heading element.void
Ends a first title heading element.void
Starts a second title heading element.void
Ends a second title heading element.void
Starts a third title heading element.void
Ends a third title heading element.void
Starts a 4th title heading element.void
Ends a 4th title heading element.void
Starts a 5th title heading element.void
Ends a 5th title heading element.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
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 fieldskip
.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()
Starts a sidebar section within a document.void
sidebar_()
Ends the sidebar element.void
table()
Starts a table element for marking up tabular information in a document.void
table_()
Ends a table element.void
Starts a caption element of a table.void
Ends a caption element of a table.void
Starts a cell element which defines a cell that contains data.void
Ends a cell element.void
Starts a cell element which defines a cell that contains header information.void
Ends a cell header element.void
tableRow()
Starts a row element which acts as a container for a row of table cells.void
Ends a row element.void
tableRows
(int[] justification, boolean grid) Starts an element that contains rows of table data.void
Ends an element that contains rows of table data.void
Adding a text.void
title()
Starts the title element.void
title_()
Ends the title element.void
unknown
(String name, Object[] requiredParams, SinkEventAttributes attributes) Add an unknown event.void
verbatim
(boolean boxed) Starts an element which indicates that whitespace in the enclosed text has semantic relevance.void
Ends a verbatim element.protected void
verbatimContent
(String text) Write SGML escaped text to output, preserving white space.protected void
Write a text to the sink.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
-
Field Details
-
DEFAULT_SGML_PUBLIC_ID
Deprecated.since 1.1, useDocbookMarkup.DEFAULT_SGML_PUBLIC_ID
instead of.DocBook V4.4 SGML public id: "-//OASIS//DTD DocBook V4.4//EN"- See Also:
-
DEFAULT_XML_PUBLIC_ID
Deprecated.since 1.1, useDocbookMarkup.DEFAULT_XML_PUBLIC_ID
instead of.DocBook XML V4.4 XML public id: "-//OASIS//DTD DocBook XML V4.4//EN"- See Also:
-
DEFAULT_XML_SYSTEM_ID
Deprecated.since 1.1, useDocbookMarkup.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:
-
DEFAULT_SGML_SYSTEM_ID
Deprecated.since 1.1, useDocbookMarkup.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:
-
out
The output writer. -
xmlMode
private boolean xmlModexmlMode. -
styleSheet
styleSheet. -
lang
language. -
publicId
publicId. -
systemId
systemId. -
italicBeginTag
italicBegin. -
italicEndTag
italicEnd. -
boldBeginTag
boldBegin. -
boldEndTag
boldEnd. -
monospacedBeginTag
monospacedBegin. -
monospacedEndTag
monospacedEnd. -
horizontalRuleElement
horizontalRule. -
pageBreakElement
pageBreak. -
lineBreakElement
lineBreak. -
graphicsFileName
An image source file. -
hasTitle
private boolean hasTitlehasTitle. -
authorDateFlag
private boolean authorDateFlagauthorDate. -
verbatimFlag
private boolean verbatimFlagverbatim. -
externalLinkFlag
private boolean externalLinkFlagexternalLink. -
tableHasCaption
private boolean tableHasCaptiontableHasCaption. -
savedOut
Used for table rows. -
tableRows
tableRows. -
tableRowsWriter
tableRows writer. -
tableHasGrid
private boolean tableHasGridtableHasGrid. -
skip
private boolean skip -
paragraph
private boolean paragraph -
encoding
-
inlineStack
Keep track of the closing tags for inline events. -
warnMessages
Map of warn messages with a String as key to describe the error type and a Set as value. Using to reduce warn messages.
-
-
Constructor Details
-
DocBookSink
Constructor, initialize the Writer.- Parameters:
writer
- not null writer to write the result. Should be an UTF-8 Writer. You could usenewXmlWriter
methods fromWriterFactory
.
-
DocBookSink
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 notnull
.
-
DocBookSink
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 notnull
.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
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
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
Returns the encoding.- Returns:
- the encoding set (can be
null
).
-
setStyleSheet
Sets the styleSheet.- Parameters:
sheet
- the styleSheet to set.
-
getStyleSheet
Returns the current styleSheet.- Returns:
- the current styleSheet.
-
setPublicId
Sets the publicId.- Parameters:
id
- the publicId to set.
-
getPublicId
Returns the current publicId.- Returns:
- the current publicId.
-
setSystemId
Sets the systemId.- Parameters:
id
- the systemId to set.
-
getSystemId
Returns the current systemId.- Returns:
- the current systemId.
-
setLanguage
Sets the language.- Parameters:
language
- the language to set.
-
getLanguage
Returns the current language.- Returns:
- the current language.
-
setItalicElement
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.
-
makeEndTag
Constructs the corresponding end tag from the given begin tag.- Parameters:
beginTag
- the begin tag to set. If null, the empty string is returned.- Returns:
- the corresponding end tag.
-
getItalicElement
Returns the current italicBeginTag.- Returns:
- the current italicBeginTag. Defaults to
<emphasis>
.
-
setBoldElement
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
Returns the current boldBeginTag.- Returns:
- the current boldBeginTag. Defaults to
<emphasis role=\"bold\">
.
-
setMonospacedElement
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
Returns the current monospacedBeginTag.- Returns:
- the current monospacedBeginTag. Defaults to
<literal>
.
-
setHorizontalRuleElement
Sets the current horizontalRuleElement.- Parameters:
element
- the element to set.
-
getHorizontalRuleElement
Returns the current horizontalRuleElement.- Returns:
- the current horizontalRuleElement. Defaults to "".
-
setPageBreakElement
Sets the current pageBreakElement.- Parameters:
element
- the element to set.
-
getPageBreakElement
Returns the current pageBreakElement.- Returns:
- the current pageBreakElement. Defaults to "".
-
setLineBreakElement
Sets the current lineBreakElement.- Parameters:
element
- the element to set.
-
getLineBreakElement
Returns the current lineBreakElement.- Returns:
- the current lineBreakElement. Defaults to "".
-
resetState
protected void resetState()Deprecated.since 1.1.2, useinit()
instead of.Reset all variables. -
init
protected void init()This is called inSink.head()
or inSink.close()
, and can be used to set the sink into a clear state so it can be re-used.- Overrides:
init
in classAbstractSink
-
head
public void head()Starts the head element.- Specified by:
head
in interfaceSink
- Overrides:
head
in classSinkAdapter
- See Also:
-
writeXmlHeader
writeXmlHeader.- Parameters:
root
- not null.- Returns:
- an attribute set.
- Since:
- 1.1
- See Also:
-
head_
public void head_()Ends the head element.- Specified by:
head_
in interfaceSink
- Overrides:
head_
in classSinkAdapter
- See Also:
-
title
public void title()Starts the title element.- Specified by:
title
in interfaceSink
- Overrides:
title
in classSinkAdapter
- See Also:
-
title_
public void title_()Ends the title element.- Specified by:
title_
in interfaceSink
- Overrides:
title_
in classSinkAdapter
- See Also:
-
author
public void author()Starts an author element.- Specified by:
author
in interfaceSink
- Overrides:
author
in classSinkAdapter
- See Also:
-
author_
public void author_()Ends an author element.- Specified by:
author_
in interfaceSink
- Overrides:
author_
in classSinkAdapter
- See Also:
-
date
public void date()Starts the date element.- Specified by:
date
in interfaceSink
- Overrides:
date
in classSinkAdapter
- See Also:
-
date_
public void date_()Ends the date element.- Specified by:
date_
in interfaceSink
- Overrides:
date_
in classSinkAdapter
- See Also:
-
body_
public void body_()Ends the body element.- Specified by:
body_
in interfaceSink
- Overrides:
body_
in classSinkAdapter
- See Also:
-
sidebar
public void sidebar()Starts a sidebar section within a document.- Specified by:
sidebar
in interfaceSink
- Overrides:
sidebar
in classSinkAdapter
- See Also:
-
sidebar_
public void sidebar_()Ends the sidebar element.- Specified by:
sidebar_
in interfaceSink
- Overrides:
sidebar_
in classSinkAdapter
- See Also:
-
section1
public void section1()Starts a first heading element which contains the topic of the section.- Specified by:
section1
in interfaceSink
- Overrides:
section1
in classSinkAdapter
- See Also:
-
section1_
public void section1_()Ends a first heading element.- Specified by:
section1_
in interfaceSink
- Overrides:
section1_
in classSinkAdapter
- See Also:
-
section2
public void section2()Starts a second heading element which contains the topic of the section. This has to be contained within aSink.section1()
element.- Specified by:
section2
in interfaceSink
- Overrides:
section2
in classSinkAdapter
- See Also:
-
section2_
public void section2_()Ends a second heading element.- Specified by:
section2_
in interfaceSink
- Overrides:
section2_
in classSinkAdapter
- See Also:
-
section3
public void section3()Starts a third heading element which contains the topic of the section. This has to be contained within aSink.section2()
element.- Specified by:
section3
in interfaceSink
- Overrides:
section3
in classSinkAdapter
- See Also:
-
section3_
public void section3_()Ends a third heading element.- Specified by:
section3_
in interfaceSink
- Overrides:
section3_
in classSinkAdapter
- See Also:
-
section4
public void section4()Starts a 4th heading element which contains the topic of the section. This has to be contained within aSink.section3()
element.- Specified by:
section4
in interfaceSink
- Overrides:
section4
in classSinkAdapter
- See Also:
-
section4_
public void section4_()Ends a 4th heading element.- Specified by:
section4_
in interfaceSink
- Overrides:
section4_
in classSinkAdapter
- See Also:
-
section5
public void section5()Starts a 5th heading element which contains the topic of the section. This has to be contained within aSink.section4()
element.- Specified by:
section5
in interfaceSink
- Overrides:
section5
in classSinkAdapter
- See Also:
-
section5_
public void section5_()Ends a 5th heading element.- Specified by:
section5_
in interfaceSink
- Overrides:
section5_
in classSinkAdapter
- See Also:
-
sectionTitle
public void sectionTitle()Starts a title heading element.- Specified by:
sectionTitle
in interfaceSink
- Overrides:
sectionTitle
in classSinkAdapter
- See Also:
-
sectionTitle_
public void sectionTitle_()Ends a title heading element.- Specified by:
sectionTitle_
in interfaceSink
- Overrides:
sectionTitle_
in classSinkAdapter
- See Also:
-
sectionTitle1
public void sectionTitle1()Starts a first title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within aSink.section1()
element.- Specified by:
sectionTitle1
in interfaceSink
- Overrides:
sectionTitle1
in classSinkAdapter
- See Also:
-
sectionTitle1_
public void sectionTitle1_()Ends a first title heading element.- Specified by:
sectionTitle1_
in interfaceSink
- Overrides:
sectionTitle1_
in classSinkAdapter
- See Also:
-
sectionTitle2
public void sectionTitle2()Starts a second title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within aSink.section2()
element.- Specified by:
sectionTitle2
in interfaceSink
- Overrides:
sectionTitle2
in classSinkAdapter
- See Also:
-
sectionTitle2_
public void sectionTitle2_()Ends a second title heading element.- Specified by:
sectionTitle2_
in interfaceSink
- Overrides:
sectionTitle2_
in classSinkAdapter
- See Also:
-
sectionTitle3
public void sectionTitle3()Starts a third title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within aSink.section3()
element.- Specified by:
sectionTitle3
in interfaceSink
- Overrides:
sectionTitle3
in classSinkAdapter
- See Also:
-
sectionTitle3_
public void sectionTitle3_()Ends a third title heading element.- Specified by:
sectionTitle3_
in interfaceSink
- Overrides:
sectionTitle3_
in classSinkAdapter
- See Also:
-
sectionTitle4
public void sectionTitle4()Starts a 4th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within aSink.section4()
element.- Specified by:
sectionTitle4
in interfaceSink
- Overrides:
sectionTitle4
in classSinkAdapter
- See Also:
-
sectionTitle4_
public void sectionTitle4_()Ends a 4th title heading element.- Specified by:
sectionTitle4_
in interfaceSink
- Overrides:
sectionTitle4_
in classSinkAdapter
- See Also:
-
sectionTitle5
public void sectionTitle5()Starts a 5th title heading element. This element is optional, but if it exists, it has to be contained, and be the first element, within aSink.section5()
element.- Specified by:
sectionTitle5
in interfaceSink
- Overrides:
sectionTitle5
in classSinkAdapter
- See Also:
-
sectionTitle5_
public void sectionTitle5_()Ends a 5th title heading element.- Specified by:
sectionTitle5_
in interfaceSink
- Overrides:
sectionTitle5_
in classSinkAdapter
- See Also:
-
header
public void header()Start a new header within the section or body.- Specified by:
header
in interfaceSink
- Overrides:
header
in classSinkAdapter
- See Also:
-
header_
public void header_()Ends a header element.- Specified by:
header_
in interfaceSink
- Overrides:
header_
in classSinkAdapter
- See Also:
-
list
public void list()Starts an unordered list element.- Specified by:
list
in interfaceSink
- Overrides:
list
in classSinkAdapter
- See Also:
-
list_
public void list_()Ends an unordered list element.- Specified by:
list_
in interfaceSink
- Overrides:
list_
in classSinkAdapter
- See Also:
-
listItem
public void listItem()Starts a list item element within an unordered list.- Specified by:
listItem
in interfaceSink
- Overrides:
listItem
in classSinkAdapter
- See Also:
-
listItem_
public void listItem_()Ends a list item element within an unordered list.- Specified by:
listItem_
in interfaceSink
- Overrides:
listItem_
in classSinkAdapter
- See Also:
-
numberedList
public void numberedList(int numbering) Starts an ordered list element.- Specified by:
numberedList
in interfaceSink
- Overrides:
numberedList
in classSinkAdapter
- Parameters:
numbering
- the numbering style.- See Also:
-
numberedList_
public void numberedList_()Ends an ordered list element.- Specified by:
numberedList_
in interfaceSink
- Overrides:
numberedList_
in classSinkAdapter
- See Also:
-
numberedListItem
public void numberedListItem()Starts a list item element within an ordered list.- Specified by:
numberedListItem
in interfaceSink
- Overrides:
numberedListItem
in classSinkAdapter
- See Also:
-
numberedListItem_
public void numberedListItem_()Ends a list item element within an ordered list.- Specified by:
numberedListItem_
in interfaceSink
- Overrides:
numberedListItem_
in classSinkAdapter
- See Also:
-
definitionList
public void definitionList()Starts a definition list element.- Specified by:
definitionList
in interfaceSink
- Overrides:
definitionList
in classSinkAdapter
- See Also:
-
definitionList_
public void definitionList_()Ends a definition list element.- Specified by:
definitionList_
in interfaceSink
- Overrides:
definitionList_
in classSinkAdapter
- See Also:
-
definitionListItem
public void definitionListItem()Starts a list item element within a definition list.- Specified by:
definitionListItem
in interfaceSink
- Overrides:
definitionListItem
in classSinkAdapter
- See Also:
-
definitionListItem_
public void definitionListItem_()Ends a list item element within a definition list.- Specified by:
definitionListItem_
in interfaceSink
- Overrides:
definitionListItem_
in classSinkAdapter
- See Also:
-
definedTerm
public void definedTerm()Starts a definition term element within a definition list.- Specified by:
definedTerm
in interfaceSink
- Overrides:
definedTerm
in classSinkAdapter
- See Also:
-
definedTerm_
public void definedTerm_()Ends a definition term element within a definition list.- Specified by:
definedTerm_
in interfaceSink
- Overrides:
definedTerm_
in classSinkAdapter
- See Also:
-
definition
public void definition()Starts a definition element within a definition list.- Specified by:
definition
in interfaceSink
- Overrides:
definition
in classSinkAdapter
- See Also:
-
definition_
public void definition_()Ends a definition element within a definition list.- Specified by:
definition_
in interfaceSink
- Overrides:
definition_
in classSinkAdapter
- See Also:
-
paragraph
public void paragraph()Starts an element which represents a paragraph.- Specified by:
paragraph
in interfaceSink
- Overrides:
paragraph
in classSinkAdapter
- See Also:
-
paragraph_
public void paragraph_()Ends a paragraph element.- Specified by:
paragraph_
in interfaceSink
- Overrides:
paragraph_
in classSinkAdapter
- See Also:
-
verbatim
public void verbatim(boolean boxed) Starts an element which indicates that whitespace in the enclosed text has semantic relevance.- Specified by:
verbatim
in interfaceSink
- Overrides:
verbatim
in classSinkAdapter
- Parameters:
boxed
- true to add a box, false otherwise- See Also:
-
verbatim_
public void verbatim_()Ends a verbatim element.- Specified by:
verbatim_
in interfaceSink
- Overrides:
verbatim_
in classSinkAdapter
- See Also:
-
horizontalRule
public void horizontalRule()Adding a separator of sections from a text to each other.- Specified by:
horizontalRule
in interfaceSink
- Overrides:
horizontalRule
in classSinkAdapter
- See Also:
-
pageBreak
public void pageBreak()Adding a new page separator.- Specified by:
pageBreak
in interfaceSink
- Overrides:
pageBreak
in classSinkAdapter
-
figure
public void figure()Starts a basic image embedding element.- Specified by:
figure
in interfaceSink
- Overrides:
figure
in classSinkAdapter
- See Also:
-
figure_
public void figure_()Ends a basic image embedding element.- Specified by:
figure_
in interfaceSink
- Overrides:
figure_
in classSinkAdapter
-
graphicElement
protected void graphicElement()Deprecated.do not use!graphicElement
-
figureGraphics
Adding a source of a graphic.- Specified by:
figureGraphics
in interfaceSink
- Overrides:
figureGraphics
in classSinkAdapter
- Parameters:
name
- the source
-
figureCaption
public void figureCaption()Starts a caption of an image element.- Specified by:
figureCaption
in interfaceSink
- Overrides:
figureCaption
in classSinkAdapter
- See Also:
-
figureCaption_
public void figureCaption_()Ends a caption of an image.- Specified by:
figureCaption_
in interfaceSink
- Overrides:
figureCaption_
in classSinkAdapter
- See Also:
-
table
public void table()Starts a table element for marking up tabular information in a document.- Specified by:
table
in interfaceSink
- Overrides:
table
in classSinkAdapter
- See Also:
-
table_
public void table_()Ends a table element.- Specified by:
table_
in interfaceSink
- Overrides:
table_
in classSinkAdapter
- See Also:
-
tableRows
public void tableRows(int[] justification, boolean grid) Starts an element that contains rows of table data.- Specified by:
tableRows
in interfaceSink
- Overrides:
tableRows
in classSinkAdapter
- Parameters:
justification
- the default justification of columns. This can be overridden by individual table rows or table cells. If null a left alignment is assumed by default. If this array has less elements than there are columns in the table then the value of the last array element will be taken as default for the remaining table cells.grid
- true to provide a grid, false otherwise.- See Also:
-
tableRows_
public void tableRows_()Ends an element that contains rows of table data.- Specified by:
tableRows_
in interfaceSink
- Overrides:
tableRows_
in classSinkAdapter
- See Also:
-
tableRow
public void tableRow()Starts a row element which acts as a container for a row of table cells.- Specified by:
tableRow
in interfaceSink
- Overrides:
tableRow
in classSinkAdapter
- See Also:
-
tableRow_
public void tableRow_()Ends a row element.- Specified by:
tableRow_
in interfaceSink
- Overrides:
tableRow_
in classSinkAdapter
- See Also:
-
tableCell
public void tableCell()Starts a cell element which defines a cell that contains data.- Specified by:
tableCell
in interfaceSink
- Overrides:
tableCell
in classSinkAdapter
- See Also:
-
tableCell_
public void tableCell_()Ends a cell element.- Specified by:
tableCell_
in interfaceSink
- Overrides:
tableCell_
in classSinkAdapter
- See Also:
-
tableHeaderCell
public void tableHeaderCell()Starts a cell element which defines a cell that contains header information.- Specified by:
tableHeaderCell
in interfaceSink
- Overrides:
tableHeaderCell
in classSinkAdapter
- See Also:
-
tableHeaderCell_
public void tableHeaderCell_()Ends a cell header element.- Specified by:
tableHeaderCell_
in interfaceSink
- Overrides:
tableHeaderCell_
in classSinkAdapter
- See Also:
-
tableCaption
public void tableCaption()Starts a caption element of a table.- Specified by:
tableCaption
in interfaceSink
- Overrides:
tableCaption
in classSinkAdapter
- See Also:
-
tableCaption_
public void tableCaption_()Ends a caption element of a table.- Specified by:
tableCaption_
in interfaceSink
- Overrides:
tableCaption_
in classSinkAdapter
- See Also:
-
anchor
Starts an element which defines an anchor.- Specified by:
anchor
in interfaceSink
- Overrides:
anchor
in classSinkAdapter
- Parameters:
name
- the name of the anchor.- See Also:
-
anchor_
public void anchor_()Ends an anchor element.- Specified by:
anchor_
in interfaceSink
- Overrides:
anchor_
in classSinkAdapter
- See Also:
-
link
Starts an element which defines a link.- Specified by:
link
in interfaceSink
- Overrides:
link
in classSinkAdapter
- Parameters:
name
- the name of the link.- See Also:
-
link_
public void link_()Ends a link element.- Specified by:
link_
in interfaceSink
- Overrides:
link_
in classSinkAdapter
- See Also:
-
inline
public void inline()Starts an inline element.- Specified by:
inline
in interfaceSink
- Overrides:
inline
in classSinkAdapter
- See Also:
-
inline
Starts an inline element.The inline method is similar to
Sink.text(String,SinkEventAttributes)
, but allows you to wrap arbitrary elements in addition to text.Supported attributes are the
base attributes
plusSEMANTICS
(values "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete").- Specified by:
inline
in interfaceSink
- Overrides:
inline
in classSinkAdapter
- Parameters:
attributes
- A set ofSinkEventAttributes
, may benull
.
-
inline_
public void inline_()Ends an inline element.- Specified by:
inline_
in interfaceSink
- Overrides:
inline_
in classSinkAdapter
-
italic
public void italic()Starts an italic element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
italic
in interfaceSink
- Overrides:
italic
in classSinkAdapter
-
italic_
public void italic_()Ends an italic element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
italic_
in interfaceSink
- Overrides:
italic_
in classSinkAdapter
-
bold
public void bold()Starts a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
bold
in interfaceSink
- Overrides:
bold
in classSinkAdapter
-
bold_
public void bold_()Ends a bold element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
bold_
in interfaceSink
- Overrides:
bold_
in classSinkAdapter
-
monospaced
public void monospaced()Starts a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
monospaced
in interfaceSink
- Overrides:
monospaced
in classSinkAdapter
-
monospaced_
public void monospaced_()Ends a monospaced element. Alternatively one may useSink.text(String,SinkEventAttributes)
withSTYLE
instead.- Specified by:
monospaced_
in interfaceSink
- Overrides:
monospaced_
in classSinkAdapter
-
lineBreak
public void lineBreak()Adds a line break.- Specified by:
lineBreak
in interfaceSink
- Overrides:
lineBreak
in classSinkAdapter
- See Also:
-
nonBreakingSpace
public void nonBreakingSpace()Adding a non breaking space, ie a space without any special formatting operations.- Specified by:
nonBreakingSpace
in interfaceSink
- Overrides:
nonBreakingSpace
in classSinkAdapter
-
text
Adding a text.- Specified by:
text
in interfaceSink
- Overrides:
text
in classSinkAdapter
- Parameters:
text
- The text to write.- See Also:
-
comment
Add a comment.- Specified by:
comment
in interfaceSink
- Overrides:
comment
in classSinkAdapter
- Parameters:
comment
- The comment to write.
-
unknown
Add an unknown event. This may be used by parsers to notify a general Sink about an event that doesn't fit into any event defined by the Sink API. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc. Unknown events just log a warning message but are ignored otherwise.- Specified by:
unknown
in interfaceSink
- Overrides:
unknown
in classSinkAdapter
- Parameters:
name
- The name of the event.requiredParams
- An optional array of required parameters to the event. May benull
.attributes
- A set ofSinkEventAttributes
, may benull
.- See Also:
-
markup
Write text to output, preserving white space.- Parameters:
text
- The text to write.
-
content
Write SGML escaped text to output, not preserving white space.- Parameters:
text
- The text to write.
-
verbatimContent
Write SGML escaped text to output, preserving white space.- Parameters:
text
- The text to write.
-
flush
public void flush()Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.- Specified by:
flush
in interfaceSink
- Overrides:
flush
in classSinkAdapter
-
close
public void close()Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.- Specified by:
close
in interfaceSink
- Overrides:
close
in classSinkAdapter
-
write
Write a text to the sink.- Specified by:
write
in classAbstractXmlSink
- Parameters:
text
- the given text to write
-
setSkip
public void setSkip(boolean skip) Setter for the field
skip
.- Parameters:
skip
- the skip to set.- Since:
- 1.1
-
logMessage
If debug mode is enabled, log themsg
as is, otherwise add unique msg inwarnMessages
.- Parameters:
key
- not nullmsg
- not null- Since:
- 1.1.1
- See Also:
-
DocbookMarkup.DEFAULT_SGML_PUBLIC_ID
instead of.