Top Description Fields Constructors Methods
de.undercouch.citeproc.csl.internal.format

public Class MarkdownPureFormat

extends BaseFormat
Class Inheritance
Known Direct Subclasses
de.undercouch.citeproc.csl.internal.format.MarkdownFormat
Imports
de.undercouch.citeproc.csl.internal.RenderContext, .SBibliography, .TokenBuffer, de.undercouch.citeproc.csl.internal.token.DisplayGroupToken, de.undercouch.citeproc.output.Bibliography, .SecondFieldAlign

The pure Markdown output format.

Outputs pure Markdown markup without HTML tags. Use MarkdownFormat for improved output.

Author
Michel Kraemer

Field Summary

Inherited from de.undercouch.citeproc.csl.internal.format.BaseFormat:
convertLinks

Constructor Summary

AccessConstructor and Description
public
MarkdownPureFormat()

Method Summary

Modifier and TypeMethod and Description
protected String
closeFontStyle(int fontStyle)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontStyle.

Generate text that disables the given font style in the output format

protected String
closeFontWeight(int fontWeight)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontWeight.

Generate text that disables the given font weight in the output format

protected String
doFormatBibliographyEntry(TokenBuffer buffer, RenderContext ctx, int index)

Implements abstract de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatBibliographyEntry.

Convert a bibliography entry from a post-processed buffer to a string

protected String
doFormatCitation(TokenBuffer buffer, RenderContext ctx)

Implements abstract de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatCitation.

Convert a citation from a post-processed buffer to a string

protected String
escape(String str)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.escape.

Escape any formatting instructions specific to the output format

protected String
formatDOI(String str)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.formatDOI.

Convert a DOI to a link

protected String
formatURL(String str)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.formatURL.

Convert a URL to a link

public String
getName()

Implements de.undercouch.citeproc.csl.internal.format.Format.getName.

Get the format's name

public Bibliography
makeBibliography(String[] entries, SBibliography bibliographyElement)

Implements de.undercouch.citeproc.csl.internal.format.Format.makeBibliography.

Create a Bibliography object with the given entries and default parameters specified by this format

protected String
openDisplayGroup(DisplayGroupToken.Type type)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openDisplayGroup.

Generate text that opens a display group

protected String
openFontStyle(int fontStyle)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontStyle.

Generate text that enables the given font style in the output format

protected String
openFontWeight(int fontWeight)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontWeight.

Generate text that enables the given font weight in the output format

Inherited from de.undercouch.citeproc.csl.internal.format.BaseFormat:
addDOIPrefixcloseDisplayGroupcloseFontVariantcloseTextDecorationcloseVerticalAlignformatformatBibliographyEntryformatCitationopenFontVariantopenTextDecorationopenVerticalAlignpostProcesssetConvertLinks

Constructor Detail

MarkdownPureFormatback to summary
public MarkdownPureFormat()

Method Detail

closeFontStyleback to summary
protected String closeFontStyle(int fontStyle)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontStyle.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontStyle.

Generate text that disables the given font style in the output format

Annotations
@Override
closeFontWeightback to summary
protected String closeFontWeight(int fontWeight)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontWeight.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.closeFontWeight.

Generate text that disables the given font weight in the output format

Annotations
@Override
doFormatBibliographyEntryback to summary
protected String doFormatBibliographyEntry(TokenBuffer buffer, RenderContext ctx, int index)

Implements abstract de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatBibliographyEntry.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatBibliographyEntry.

Convert a bibliography entry from a post-processed buffer to a string

Annotations
@Override
doFormatCitationback to summary
protected String doFormatCitation(TokenBuffer buffer, RenderContext ctx)

Implements abstract de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatCitation.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatCitation.

Convert a citation from a post-processed buffer to a string

Annotations
@Override
doFormatLinkback to summary
protected String doFormatLink(String text, String uri)

Implements abstract de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatLink.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.doFormatLink.

Convert the given string to a link

Annotations
@Override
escapeback to summary
protected String escape(String str)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.escape.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.escape.

Escape any formatting instructions specific to the output format

Annotations
@Override
formatDOIback to summary
protected String formatDOI(String str)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.formatDOI.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.formatDOI.

Convert a DOI to a link

Annotations
@Override
formatURLback to summary
protected String formatURL(String str)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.formatURL.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.formatURL.

Convert a URL to a link

Annotations
@Override
getNameback to summary
public String getName()

Implements de.undercouch.citeproc.csl.internal.format.Format.getName.

Doc from de.undercouch.citeproc.csl.internal.format.Format.getName.

Get the format's name

Annotations
@Override
makeBibliographyback to summary
public Bibliography makeBibliography(String[] entries, SBibliography bibliographyElement)

Implements de.undercouch.citeproc.csl.internal.format.Format.makeBibliography.

Doc from de.undercouch.citeproc.csl.internal.format.Format.makeBibliography.

Create a Bibliography object with the given entries and default parameters specified by this format

Annotations
@Override
openDisplayGroupback to summary
protected String openDisplayGroup(DisplayGroupToken.Type type)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openDisplayGroup.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.openDisplayGroup.

Generate text that opens a display group

Annotations
@Override
openFontStyleback to summary
protected String openFontStyle(int fontStyle)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontStyle.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontStyle.

Generate text that enables the given font style in the output format

Annotations
@Override
openFontWeightback to summary
protected String openFontWeight(int fontWeight)

Overrides de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontWeight.

Doc from de.undercouch.citeproc.csl.internal.format.BaseFormat.openFontWeight.

Generate text that enables the given font weight in the output format

Annotations
@Override