org.apache.maven.doxia.module.latex
Class LatexSink

java.lang.Object
  org.apache.maven.doxia.sink.AbstractSink
      org.apache.maven.doxia.sink.SinkAdapter
          org.apache.maven.doxia.sink.AbstractTextSink
              org.apache.maven.doxia.module.latex.LatexSink

All Implemented Interfaces:

LogEnabled, Markup, TextMarkup, Sink

Direct Known Subclasses:

LatexBookSink

public class LatexSink
extends AbstractTextSink

Latex Sink implementation.
Note: The encoding used is UTF-8.

Since:

1.0

Version:

$Id: LatexSink.java 784533 2009-06-14 10:02:54Z vsiveton $

Field Summary

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

PIPE

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.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

Constructor Summary

protected	LatexSink(java.io.Writer out) Constructor, initialize the Writer and the variables.
protected	LatexSink(java.io.Writer out, java.lang.String sinkCommands, java.lang.String preamble) Constructor, initialize the Writer and the variables.
protected	LatexSink(java.io.Writer out, java.lang.String sinkCommands, java.lang.String preamble, boolean fragmentDocument) Constructor, initialize the Writer and the variables.

Method Summary

void	anchor_() Ends an anchor element.
void	anchor(java.lang.String name) Starts an element which defines an anchor.
void	author_() Ends an author element.
void	author() Starts an author element.
void	body_() Ends the body element.
void	body() Starts the body of a document.
void	bold_() Ends a bold element.
void	bold() Starts a bold element.
void	close() Close the writer or the stream, if needed.
protected void	content(java.lang.String text) Writes the text, without preserving whitespace.
void	date_() Ends the date element.
void	date() Starts the date element.
protected java.lang.String	defaultPreamble() Returns the default preamble.
protected java.lang.String	defaultSinkCommands() Returns the default sink commands.
void	definedTerm_() Starts a definition term element within a definition list.
void	definedTerm() Starts a definition term element within a definition list.
void	definitionList_() Ends a definition list element.
void	definitionList() Starts a definition list element.
static java.lang.String	escaped(java.lang.String text) Escapes special characters.
void	figure_() Ends a basic image embedding element.
void	figure() Starts a basic image embedding element.
void	figureCaption_() Ends a caption of an image.
void	figureCaption() Starts a caption of an image element.
void	figureGraphics(java.lang.String name) Adding a source of a graphic.
void	flush() Flush the writer or the stream, if needed.
protected java.lang.String	getDocumentBegin() Returns a default \begin{document} declaration.
protected java.lang.String	getDocumentEnd() Returns a default \end{document} declaration.
protected java.lang.String	getDocumentStart() Returns a default \documentclass declaration.
void	head() Starts the head element.
void	horizontalRule() Adding a separator of sections from a text to each other.
void	italic_() Ends an italic element.
void	italic() Starts an italic element.
void	lineBreak() Adds a line break.
void	link_() Ends a link element.
void	link(java.lang.String name) Starts an element which defines a link.
void	list_() Ends an unordered list element.
void	list() Starts an unordered list element.
void	listItem() Starts a list item element within an unordered list.
protected void	markup(java.lang.String text) Writes the text, preserving whitespace.
void	monospaced_() Ends a monospaced element.
void	monospaced() Starts a monospaced element.
void	nonBreakingSpace() Adding a non breaking space, ie a space without any special formatting operations.
void	numberedList_() Ends an ordered list element.
void	numberedList(int numbering) Starts an ordered list element.
void	numberedListItem() Starts a list item element within an ordered list.
void	pageBreak() Adding a new page separator.
void	paragraph_() Ends a paragraph element.
void	paragraph() Starts an element which represents a paragraph.
void	sectionTitle1_() Ends a first title heading element.
void	sectionTitle1() Starts a first title heading element.
void	sectionTitle2_() Ends a second title heading element.
void	sectionTitle2() Starts a second title heading element.
void	sectionTitle3_() Ends a third title heading element.
void	sectionTitle3() Starts a third title heading element.
void	sectionTitle4_() Ends a 4th title heading element.
void	sectionTitle4() Starts a 4th title heading element.
void	sectionTitle5_() Ends a 5th title heading element.
void	sectionTitle5() Starts a 5th title heading element.
void	table_() Ends a table element.
void	table() Starts a table element for marking up tabular information in a document.
void	tableCaption_() Ends a caption element of a table.
void	tableCaption() Starts a caption element of a table.
void	tableCell_() Ends a cell element.
void	tableCell() Starts a cell element which defines a cell that contains data.
void	tableHeaderCell_() Ends a cell header element.
void	tableHeaderCell() Starts a cell element which defines a cell that contains header information.
void	tableRow_() Ends a row element.
void	tableRow() Starts a row element which acts as a container for a row of table cells.
void	tableRows_() Ends an element that contains rows of table data.
void	tableRows(int[] justification, boolean grid) Starts an element that contains rows of table data.
void	text(java.lang.String text) Adding a text.
void	title_() Ends the title element.
void	title() Starts the title element.
void	unknown(java.lang.String name, java.lang.Object[] requiredParams, SinkEventAttributes attributes) Add an unkown event.
void	verbatim_() Ends a verbatim element.
void	verbatim(boolean boxed) Starts an element which indicates that whitespace in the enclosed text has semantic relevance.
protected void	verbatimContent(java.lang.String text) Writes the text, preserving whitespace.

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

anchor, author, body, comment, date, definedTerm, definition_, definition, definition, definitionList, definitionListItem_, definitionListItem, definitionListItem, figure, figureCaption, figureGraphics, head_, head, horizontalRule, lineBreak, link, list, listItem_, listItem, numberedList, numberedListItem_, numberedListItem, paragraph, rawText, section_, section, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, sectionTitle_, sectionTitle_, sectionTitle, sectionTitle, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, title, verbatim

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

enableLogging, getLog, unifyEOLs

Methods inherited from class java.lang.Object

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

Constructor Detail

LatexSink

protected LatexSink(java.io.Writer out)

Constructor, initialize the Writer and the variables.

Parameters:

out - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from org.codehaus.plexus.util.WriterFactory.

LatexSink

protected LatexSink(java.io.Writer out,
                    java.lang.String sinkCommands,
                    java.lang.String preamble)

Constructor, initialize the Writer and the variables.

Parameters:

out - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from org.codehaus.plexus.util.WriterFactory.

sinkCommands - A String representation of commands that go before \documentclass.

preamble - A String representation of commands that go between \documentclass and \begin{document}.

LatexSink

protected LatexSink(java.io.Writer out,
                    java.lang.String sinkCommands,
                    java.lang.String preamble,
                    boolean fragmentDocument)

Constructor, initialize the Writer and the variables.

Parameters:

out - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from org.codehaus.plexus.util.WriterFactory.

sinkCommands - A String representation of commands that go before \documentclass.

preamble - A String representation of commands that go between \documentclass and \begin{document}.

fragmentDocument - If this receives events that that are only part of a document. Typically, headers are omitted if this is true.

Method Detail

getDocumentStart

protected java.lang.String getDocumentStart()

Returns a default \documentclass declaration.

Returns:

String.

getDocumentBegin

protected java.lang.String getDocumentBegin()

Returns a default \begin{document} declaration.

Returns:

String.

getDocumentEnd

protected java.lang.String getDocumentEnd()

Returns a default \end{document} declaration.

Returns:

String.

head

public void head()

Starts the head element.

Specified by:

head in interface Sink

Overrides:

head in class SinkAdapter

See Also:

Sink.head(SinkEventAttributes)

body

public void body()

Starts the body of a document.

Specified by:

body in interface Sink

Overrides:

body in class SinkAdapter

See Also:

Sink.body(SinkEventAttributes)

body_

public void body_()

Ends the body element.

Specified by:

body_ in interface Sink

Overrides:

body_ in class SinkAdapter

title

public void title()

Starts the title element.

Specified by:

title in interface Sink

Overrides:

title in class SinkAdapter

See Also:

Sink.title(SinkEventAttributes)

title_

public void title_()

Ends the title element.

Specified by:

title_ in interface Sink

Overrides:

title_ in class SinkAdapter

author

public void author()

Starts an author element.

Specified by:

author in interface Sink

Overrides:

author in class SinkAdapter

See Also:

Sink.author(SinkEventAttributes)

author_

public void author_()

Ends an author element.

Specified by:

author_ in interface Sink

Overrides:

author_ in class SinkAdapter

date

public void date()

Starts the date element.
The date is recommended (but it is not a requirement) to be align to the ISO-8601 standard, i.e.:

 YYYY-MM-DD
 

where

• YYYY is the year in the Gregorian calendar
• MM is the month of the year between 01 (January) and 12 (December)
• and DD is the day of the month between 01 and 31

Specified by:

date in interface Sink

Overrides:

date in class SinkAdapter

See Also:

Sink.date(SinkEventAttributes)

date_

public void date_()

Ends the date element.

Specified by:

date_ in interface Sink

Overrides:

date_ in class SinkAdapter

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 a Sink.section1() element.

Specified by:

sectionTitle1 in interface Sink

Overrides:

sectionTitle1 in class SinkAdapter

See Also:

Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle1_

public void sectionTitle1_()

Ends a first title heading element.

Specified by:

sectionTitle1_ in interface Sink

Overrides:

sectionTitle1_ in class SinkAdapter

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 a Sink.section2() element.

Specified by:

sectionTitle2 in interface Sink

Overrides:

sectionTitle2 in class SinkAdapter

See Also:

Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle2_

public void sectionTitle2_()

Ends a second title heading element.

Specified by:

sectionTitle2_ in interface Sink

Overrides:

sectionTitle2_ in class SinkAdapter

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 a Sink.section3() element.

Specified by:

sectionTitle3 in interface Sink

Overrides:

sectionTitle3 in class SinkAdapter

See Also:

Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle3_

public void sectionTitle3_()

Ends a third title heading element.

Specified by:

sectionTitle3_ in interface Sink

Overrides:

sectionTitle3_ in class SinkAdapter

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 a Sink.section4() element.

Specified by:

sectionTitle4 in interface Sink

Overrides:

sectionTitle4 in class SinkAdapter

See Also:

Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle4_

public void sectionTitle4_()

Ends a 4th title heading element.

Specified by:

sectionTitle4_ in interface Sink

Overrides:

sectionTitle4_ in class SinkAdapter

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 a Sink.section5() element.

Specified by:

sectionTitle5 in interface Sink

Overrides:

sectionTitle5 in class SinkAdapter

See Also:

Sink.sectionTitle(int,SinkEventAttributes)

sectionTitle5_

public void sectionTitle5_()

Ends a 5th title heading element.

Specified by:

sectionTitle5_ in interface Sink

Overrides:

sectionTitle5_ in class SinkAdapter

list

public void list()

Starts an unordered list element.

Specified by:

list in interface Sink

Overrides:

list in class SinkAdapter

See Also:

Sink.list(SinkEventAttributes)

list_

public void list_()

Ends an unordered list element.

Specified by:

list_ in interface Sink

Overrides:

list_ in class SinkAdapter

listItem

public void listItem()

Starts a list item element within an unordered list.

Specified by:

listItem in interface Sink

Overrides:

listItem in class SinkAdapter

See Also:

Sink.listItem(SinkEventAttributes)

numberedList

public void numberedList(int numbering)

Starts an ordered list element.

Specified by:

numberedList in interface Sink

Overrides:

numberedList in class SinkAdapter

Parameters:

numbering - the numbering style.

See Also:

Sink.numberedList(int,SinkEventAttributes)

numberedList_

public void numberedList_()

Ends an ordered list element.

Specified by:

numberedList_ in interface Sink

Overrides:

numberedList_ in class SinkAdapter

numberedListItem

public void numberedListItem()

Starts a list item element within an ordered list.

Specified by:

numberedListItem in interface Sink

Overrides:

numberedListItem in class SinkAdapter

See Also:

Sink.numberedListItem(SinkEventAttributes)

definitionList

public void definitionList()

Starts a definition list element.

Specified by:

definitionList in interface Sink

Overrides:

definitionList in class SinkAdapter

See Also:

Sink.definitionList(SinkEventAttributes)

definitionList_

public void definitionList_()

Ends a definition list element.

Specified by:

definitionList_ in interface Sink

Overrides:

definitionList_ in class SinkAdapter

definedTerm

public void definedTerm()

Starts a definition term element within a definition list.

Specified by:

definedTerm in interface Sink

Overrides:

definedTerm in class SinkAdapter

See Also:

Sink.definedTerm(SinkEventAttributes)

definedTerm_

public void definedTerm_()

Starts a definition term element within a definition list.

Specified by:

definedTerm_ in interface Sink

Overrides:

definedTerm_ in class SinkAdapter

figure

public void figure()

Starts a basic image embedding element.

Specified by:

figure in interface Sink

Overrides:

figure in class SinkAdapter

See Also:

Sink.figure(SinkEventAttributes)

figure_

public void figure_()

Ends a basic image embedding element.

Specified by:

figure_ in interface Sink

Overrides:

figure_ in class SinkAdapter

figureGraphics

public void figureGraphics(java.lang.String name)

Adding a source of a graphic.

Specified by:

figureGraphics in interface Sink

Overrides:

figureGraphics in class SinkAdapter

Parameters:

name - the source

figureCaption

public void figureCaption()

Starts a caption of an image element.

Specified by:

figureCaption in interface Sink

Overrides:

figureCaption in class SinkAdapter

See Also:

Sink.figureCaption(SinkEventAttributes)

figureCaption_

public void figureCaption_()

Ends a caption of an image.

Specified by:

figureCaption_ in interface Sink

Overrides:

figureCaption_ in class SinkAdapter

table

public void table()

Starts a table element for marking up tabular information in a document.

Specified by:

table in interface Sink

Overrides:

table in class SinkAdapter

See Also:

Sink.table(SinkEventAttributes)

table_

public void table_()

Ends a table element.

Specified by:

table_ in interface Sink

Overrides:

table_ in class SinkAdapter

tableRows

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

Starts an element that contains rows of table data.

Specified by:

tableRows in interface Sink

Overrides:

tableRows in class SinkAdapter

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:

Sink.table(SinkEventAttributes), Sink.JUSTIFY_CENTER, Sink.JUSTIFY_LEFT, Sink.JUSTIFY_RIGHT

tableRows_

public void tableRows_()

Ends an element that contains rows of table data.

Specified by:

tableRows_ in interface Sink

Overrides:

tableRows_ in class SinkAdapter

tableRow

public void tableRow()

Starts a row element which acts as a container for a row of table cells.

Specified by:

tableRow in interface Sink

Overrides:

tableRow in class SinkAdapter

See Also:

Sink.tableRow(SinkEventAttributes)

tableRow_

public void tableRow_()

Ends a row element.

Specified by:

tableRow_ in interface Sink

Overrides:

tableRow_ in class SinkAdapter

tableCell

public void tableCell()

Starts a cell element which defines a cell that contains data.

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

See Also:

Sink.tableCell(SinkEventAttributes)

tableCell_

public void tableCell_()

Ends a cell element.

Specified by:

tableCell_ in interface Sink

Overrides:

tableCell_ in class SinkAdapter

tableHeaderCell

public void tableHeaderCell()

Starts a cell element which defines a cell that contains header information.

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class SinkAdapter

See Also:

Sink.tableHeaderCell(SinkEventAttributes)

tableHeaderCell_

public void tableHeaderCell_()

Ends a cell header element.

Specified by:

tableHeaderCell_ in interface Sink

Overrides:

tableHeaderCell_ in class SinkAdapter

tableCaption

public void tableCaption()

Starts a caption element of a table.

Specified by:

tableCaption in interface Sink

Overrides:

tableCaption in class SinkAdapter

See Also:

Sink.tableCaption(SinkEventAttributes)

tableCaption_

public void tableCaption_()

Ends a caption element of a table.

Specified by:

tableCaption_ in interface Sink

Overrides:

tableCaption_ in class SinkAdapter

paragraph

public void paragraph()

Starts an element which represents a paragraph.

Specified by:

paragraph in interface Sink

Overrides:

paragraph in class SinkAdapter

See Also:

Sink.paragraph(SinkEventAttributes)

paragraph_

public void paragraph_()

Ends a paragraph element.

Specified by:

paragraph_ in interface Sink

Overrides:

paragraph_ in class SinkAdapter

verbatim

public void verbatim(boolean boxed)

Starts an element which indicates that whitespace in the enclosed text has semantic relevance.

Specified by:

verbatim in interface Sink

Overrides:

verbatim in class SinkAdapter

Parameters:

boxed - true to add a box, false otherwise

verbatim_

public void verbatim_()

Ends a verbatim element.

Specified by:

verbatim_ in interface Sink

Overrides:

verbatim_ in class SinkAdapter

horizontalRule

public void horizontalRule()

Adding a separator of sections from a text to each other.

Specified by:

horizontalRule in interface Sink

Overrides:

horizontalRule in class SinkAdapter

See Also:

Sink.horizontalRule(SinkEventAttributes)

pageBreak

public void pageBreak()

Adding a new page separator.

Specified by:

pageBreak in interface Sink

Overrides:

pageBreak in class SinkAdapter

anchor

public void anchor(java.lang.String name)

Starts an element which defines an anchor.

Specified by:

anchor in interface Sink

Overrides:

anchor in class SinkAdapter

Parameters:

name - the name of the anchor.

See Also:

Sink.anchor(String,SinkEventAttributes)

anchor_

public void anchor_()

Ends an anchor element.

Specified by:

anchor_ in interface Sink

Overrides:

anchor_ in class SinkAdapter

link

public void link(java.lang.String name)

Starts an element which defines a link.

Specified by:

link in interface Sink

Overrides:

link in class SinkAdapter

Parameters:

name - the name of the link.

See Also:

Sink.link(String,SinkEventAttributes)

link_

public void link_()

Ends a link element.

Specified by:

link_ in interface Sink

Overrides:

link_ in class SinkAdapter

italic

public void italic()

Starts an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

italic in interface Sink

Overrides:

italic in class SinkAdapter

italic_

public void italic_()

Ends an italic element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

italic_ in interface Sink

Overrides:

italic_ in class SinkAdapter

bold

public void bold()

Starts a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

bold in interface Sink

Overrides:

bold in class SinkAdapter

bold_

public void bold_()

Ends a bold element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

bold_ in interface Sink

Overrides:

bold_ in class SinkAdapter

monospaced

public void monospaced()

Starts a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

monospaced in interface Sink

Overrides:

monospaced in class SinkAdapter

monospaced_

public void monospaced_()

Ends a monospaced element. Alternatively one may use Sink.text(String,SinkEventAttributes) with STYLE instead.

Specified by:

monospaced_ in interface Sink

Overrides:

monospaced_ in class SinkAdapter

lineBreak

public void lineBreak()

Adds a line break.

Specified by:

lineBreak in interface Sink

Overrides:

lineBreak in class SinkAdapter

See Also:

Sink.lineBreak(SinkEventAttributes)

nonBreakingSpace

public void nonBreakingSpace()

Adding a non breaking space, ie a space without any special formatting operations.

Specified by:

nonBreakingSpace in interface Sink

Overrides:

nonBreakingSpace in class SinkAdapter

text

public void text(java.lang.String text)

Adding a text.

Specified by:

text in interface Sink

Overrides:

text in class SinkAdapter

Parameters:

text - The text to write.

See Also:

Sink.text(String,SinkEventAttributes)

unknown

public void unknown(java.lang.String name,
                    java.lang.Object[] requiredParams,
                    SinkEventAttributes attributes)

Add an unkown 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. Unkown events just log a warning message but are ignored otherwise.

Specified by:

unknown in interface Sink

Overrides:

unknown in class SinkAdapter

Parameters:

name - The name of the event.

requiredParams - An optional array of required parameters to the event. May be null.

attributes - A set of SinkEventAttributes, may be null.

See Also:

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

markup

protected void markup(java.lang.String text)

Writes the text, preserving whitespace.

Parameters:

text - the text to write.

content

protected void content(java.lang.String text)

Writes the text, without preserving whitespace.

Parameters:

text - the text to write.

verbatimContent

protected void verbatimContent(java.lang.String text)

Writes the text, preserving whitespace.

Parameters:

text - the text to write.

escaped

public static java.lang.String escaped(java.lang.String text)

Escapes special characters.

Parameters:

text - The text to escape.

Returns:

The text with special characters replaced.

flush

public void flush()

Flush the writer or the stream, if needed. Flushing a previously-flushed Sink has no effect.

Specified by:

flush in interface Sink

Overrides:

flush in class SinkAdapter

close

public void close()

Close the writer or the stream, if needed. Closing a previously-closed Sink has no effect.

Specified by:

close in interface Sink

Overrides:

close in class SinkAdapter

defaultSinkCommands

protected java.lang.String defaultSinkCommands()

Returns the default sink commands.

Returns:

String.

defaultPreamble

protected java.lang.String defaultPreamble()

Returns the default preamble.

Returns:

String.