Package writer2latex.latex

Class BibConverter

java.lang.Object

writer2latex.latex.ConverterHelper

writer2latex.latex.BibConverter

public class BibConverter
extends ConverterHelper

This class handles the bibliography. The result depends on these configuration options. The citations will be treated like this:

• use_bibtex: If true, citations will be exported as \cite commands. If false, citations will be exported as static text

The bibliography will be treated like this:

• use_index: If false, the bibliography will be omitted
• use_bibtex true and external_bibtex_files empty: The citations will be exported to a BibTeX file, which will be used for the bibliography
• use_bibtex true and external_bibtex_files non-empty: The citations will be not be exported to a BibTeX file, the files referred to by the option will be used instead
• use_bibtex false: The bibliography will be exported as static text.
• bibtex_style If BibTeX is used, this style will be applied

Field Summary

Fields inherited from class writer2latex.latex.ConverterHelper

config, ofr, palette

Constructor Summary

Constructors

Constructor	Description
BibConverter(OfficeReader ofr, LaTeXConfig config, ConverterPalette palette)	Construct a new BibConverter.

Method Summary

Modifier and Type	Method	Description
void	appendDeclarations(LaTeXDocumentPortion pack, LaTeXDocumentPortion decl)	Append declarations needed by the BibConverter to the preamble.
BibTeXDocument	getBibTeXDocument()	Get the BibTeX document, if any (the document is only created if it's specified in the configuration *and* the document contains bibliographic data *and* the configuration does not specify external BibTeX files
void	handleBibliography(Element node, LaTeXDocumentPortion ldp, Context oc)	Process a bibliography (text:bibliography tag)
void	handleBibliographyMark(Element node, LaTeXDocumentPortion ldp, Context oc)	Process a Bibliography Mark (text:bibliography-mark tag)

Methods inherited from class java.lang.Object

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

Constructor Details

BibConverter

public BibConverter(OfficeReader ofr,
 LaTeXConfig config,
 ConverterPalette palette)

Construct a new BibConverter.

Parameters:

config - the configuration to use

palette - the ConverterPalette to use

Method Details

appendDeclarations

public void appendDeclarations(LaTeXDocumentPortion pack,
 LaTeXDocumentPortion decl)

Append declarations needed by the BibConverter to the preamble.

Overrides:

appendDeclarations in class ConverterHelper

Parameters:

pack - the LaTeXDocumentPortion to which declarations of packages should be added (\\usepackage).

decl - the LaTeXDocumentPortion to which other declarations should be added.

handleBibliography

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

Process a bibliography (text:bibliography tag)

Parameters:

node - The element containing the Bibliography

ldp - the LaTeXDocumentPortion to which LaTeX code should be added

oc - the current context

handleBibliographyMark

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

Process a Bibliography Mark (text:bibliography-mark tag)

Parameters:

node - The element containing the Mark

ldp - the LaTeXDocumentPortion to which LaTeX code should be added

oc - the current context

getBibTeXDocument

public BibTeXDocument getBibTeXDocument()

Get the BibTeX document, if any (the document is only created if it's specified in the configuration *and* the document contains bibliographic data *and* the configuration does not specify external BibTeX files

Returns:

the BiBTeXDocument, or null if it does not exist).