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

public Class MarkdownFormat

extends MarkdownPureFormat
Class Inheritance
Imports
de.undercouch.citeproc.csl.internal.RenderContext, .TokenBuffer, de.undercouch.citeproc.csl.internal.token.DisplayGroupToken

The Markdown output format.

Adheres to the CommonMark specification. Use MarkdownPureFormat for output that does not contain HTML tags.

Author
Michel Kraemer

Constructor Summary

AccessConstructor and Description
public
MarkdownFormat()

Method Summary

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

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

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

protected String
closeFontVariant(int fontVariant)

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

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

protected String
closeFontWeight(int fontWeight)

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

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

protected String
closeTextDecoration(int textDecoration)

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

Generate text that disables the given text decoration in the output format

protected String
closeVerticalAlign(int verticalAlign)

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

Generate text that disables the given vertical alignment in the output format

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

Overrides de.undercouch.citeproc.csl.internal.format.MarkdownPureFormat.doFormatBibliographyEntry.

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

public String
getName()

Overrides de.undercouch.citeproc.csl.internal.format.MarkdownPureFormat.getName.

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

Get the format's name

protected String
openDisplayGroup(DisplayGroupToken.Type type)

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

Generate text that opens a display group

protected String
openFontStyle(int fontStyle)

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

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

protected String
openFontVariant(int fontVariant)

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

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

protected String
openFontWeight(int fontWeight)

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

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

protected String
openTextDecoration(int textDecoration)

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

Generate text that enables the given text decoration in the output format

protected String
openVerticalAlign(int verticalAlign)

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

Generate text that enables the given vertical alignment in the output format

Inherited from de.undercouch.citeproc.csl.internal.format.MarkdownPureFormat:
doFormatCitationdoFormatLinkescapeformatDOIformatURLmakeBibliography

Constructor Detail

MarkdownFormatback to summary
public MarkdownFormat()

Method Detail

closeFontStyleback to summary
protected String closeFontStyle(int fontStyle)

Overrides de.undercouch.citeproc.csl.internal.format.MarkdownPureFormat.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
closeFontVariantback to summary
protected String closeFontVariant(int fontVariant)

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

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

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

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

Overrides de.undercouch.citeproc.csl.internal.format.MarkdownPureFormat.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
closeTextDecorationback to summary
protected String closeTextDecoration(int textDecoration)

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

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

Generate text that disables the given text decoration in the output format

Annotations
@Override
closeVerticalAlignback to summary
protected String closeVerticalAlign(int verticalAlign)

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

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

Generate text that disables the given vertical alignment in the output format

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

Overrides de.undercouch.citeproc.csl.internal.format.MarkdownPureFormat.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
getNameback to summary
public String getName()

Overrides de.undercouch.citeproc.csl.internal.format.MarkdownPureFormat.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
openDisplayGroupback to summary
protected String openDisplayGroup(DisplayGroupToken.Type type)

Overrides de.undercouch.citeproc.csl.internal.format.MarkdownPureFormat.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.MarkdownPureFormat.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
openFontVariantback to summary
protected String openFontVariant(int fontVariant)

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

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

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

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

Overrides de.undercouch.citeproc.csl.internal.format.MarkdownPureFormat.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
openTextDecorationback to summary
protected String openTextDecoration(int textDecoration)

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

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

Generate text that enables the given text decoration in the output format

Annotations
@Override
openVerticalAlignback to summary
protected String openVerticalAlign(int verticalAlign)

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

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

Generate text that enables the given vertical alignment in the output format

Annotations
@Override