writer2latex.latex

Class NoteConverter

public class NoteConverter extends ConverterHelper

This class handles conversion of footnotes and endnotes, including references. It takes advantage of the packages endnotes.sty and perpage.sty if allowed in the configuration.

Constructor Summary
NoteConverter(OfficeReader ofr, Config config, ConverterPalette palette)
Method Summary
voidaddEndnoteName(String sName)

Add an endnote name.

voidaddFootnoteName(String sName)

Add a footnote name.

voidappendDeclarations(LaTeXDocumentPortion pack, LaTeXDocumentPortion decl)

Append declarations needed by the NoteConverter to the preamble.

voidflushFootnotes(LaTeXDocumentPortion ldp, Context oc)
Flush the queue of postponed footnotes
voidhandleEndnote(Element node, LaTeXDocumentPortion ldp, Context oc)

Process an endnote (text:endnote tag)

voidhandleEndnoteRef(Element node, LaTeXDocumentPortion ldp, Context oc)

Process an endnote reference (text:endnote-ref tag)

voidhandleFootnote(Element node, LaTeXDocumentPortion ldp, Context oc)

Process a footnote (text:footnote tag)

voidhandleFootnoteRef(Element node, LaTeXDocumentPortion ldp, Context oc)

Process a footnote reference (text:footnote-ref tag)

voidhandleNoteRef(Element node, LaTeXDocumentPortion ldp, Context oc)

Process a note reference (text:note-ref tag, oasis)

voidinsertEndnotes(LaTeXDocumentPortion ldp)

Insert the endnotes into the documents.

Constructor Detail

NoteConverter

public NoteConverter(OfficeReader ofr, Config config, ConverterPalette palette)

Method Detail

addEndnoteName

public void addEndnoteName(String sName)

Add an endnote name. The method handleEndnote includes a \label only if the endnote name is already known to the NoteConverter. Hence this method is invoked by the prepass for each endnote reference. The end result is, that only necessary labels will be included.

Parameters: sName the name (id) of the endnote

addFootnoteName

public void addFootnoteName(String sName)

Add a footnote name. The method handleFootnote includes a \label only if the footnote name is already known to the NoteConverter. Hence this method is invoked by the prepass for each footnote reference. The end result is, that only necessary labels will be included.

Parameters: sName the name (id) of the footnote

appendDeclarations

public void appendDeclarations(LaTeXDocumentPortion pack, LaTeXDocumentPortion decl)

Append declarations needed by the NoteConverter to the preamble.

Parameters: pack the LaTeXDocumentPortion to which declarations of packages should be added (\\usepackage). decl the LaTeXDocumentPortion to which other declarations should be added.

flushFootnotes

public void flushFootnotes(LaTeXDocumentPortion ldp, Context oc)
Flush the queue of postponed footnotes

handleEndnote

public void handleEndnote(Element node, LaTeXDocumentPortion ldp, Context oc)

Process an endnote (text:endnote tag)

Parameters: node The element containing the endnote ldp the LaTeXDocumentPortion to which LaTeX code should be added oc the current context

handleEndnoteRef

public void handleEndnoteRef(Element node, LaTeXDocumentPortion ldp, Context oc)

Process an endnote reference (text:endnote-ref tag)

Parameters: node The element containing the endnote reference ldp the LaTeXDocumentPortion to which LaTeX code should be added oc the current context

handleFootnote

public void handleFootnote(Element node, LaTeXDocumentPortion ldp, Context oc)

Process a footnote (text:footnote tag)

Parameters: node The element containing the footnote ldp the LaTeXDocumentPortion to which LaTeX code should be added oc the current context

handleFootnoteRef

public void handleFootnoteRef(Element node, LaTeXDocumentPortion ldp, Context oc)

Process a footnote reference (text:footnote-ref tag)

Parameters: node The element containing the footnote reference ldp the LaTeXDocumentPortion to which LaTeX code should be added oc the current context

handleNoteRef

public void handleNoteRef(Element node, LaTeXDocumentPortion ldp, Context oc)

Process a note reference (text:note-ref tag, oasis)

Parameters: node The element containing the note reference ldp the LaTeXDocumentPortion to which LaTeX code should be added oc the current context

insertEndnotes

public void insertEndnotes(LaTeXDocumentPortion ldp)

Insert the endnotes into the documents.

Parameters: ldp the LaTeXDocumentPortion to which the endnotes should be added.