InlineParsers

laika.rst.InlineParsers$
object InlineParsers

Provides all inline parsers for reStructuredText.

Inline parsers deal with markup within a block of text, such as a link or emphasized text. They are used in the second phase of parsing, after the block parsers have cut the document into a (potentially nested) block structure.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def interpretedTextWithRoleSuffix(defaultTextRole: String): SpanParserBuilder

Parses an interpreted text element with the role name as a suffix.

Parses an interpreted text element with the role name as a suffix.

See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#interpreted-text

Attributes

def markupEnd(end: String): PrefixedParser[String]

Parses the end of an inline element according to reStructuredText markup recognition rules.

Parses the end of an inline element according to reStructuredText markup recognition rules.

See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.

Value parameters

end

the literal string expected as the delimiter at the end of an inline element

Attributes

Returns

a parser that produces the same result as the parser passed as an argument

def markupEnd(end: PrefixedParser[String]): PrefixedParser[String]

Parses the end of an inline element according to reStructuredText markup recognition rules.

Parses the end of an inline element according to reStructuredText markup recognition rules.

See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.

Value parameters

end

the parser that recognizes the markup at the end of an inline element

Attributes

Returns

a parser that produces the same result as the parser passed as an argument

def markupStart(start: String, end: String): PrefixedParser[Any]

Parses the markup at the start of an inline element according to reStructuredText markup recognition rules.

Parses the markup at the start of an inline element according to reStructuredText markup recognition rules.

See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.

Value parameters

end

the literal string at the end of an inline element, needed to verify the start sequence is not immediately followed by an end sequence as empty elements are not allowed.

start

the literal string at the start of an inline element

Attributes

Returns

a parser without a useful result, as it is only needed to verify it succeeds

def markupStart(start: PrefixedParser[String], end: Parser[String]): PrefixedParser[Any]

Parses the markup at the start of an inline element according to reStructuredText markup recognition rules.

Parses the markup at the start of an inline element according to reStructuredText markup recognition rules.

See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#inline-markup-recognition-rules.

Value parameters

end

the parser that recognizes the markup at the end of an inline element, needed to verify the start sequence is not immediately followed by an end sequence as empty elements are not allowed.

start

the parser that recognizes the markup at the start of an inline element

Attributes

Returns

a parser without a useful result, as it is only needed to verify it succeeds

Concrete fields

Parses a citation reference.

lazy val em: SpanParserBuilder

Parses a span of emphasized text.

Attributes

Parses a standalone email address (with no surrounding markup).

Parses a standalone email address (with no surrounding markup).

See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#standalone-hyperlinks

Attributes

val escapedChar: Parser[String]

Parses an escaped character. For most characters it produces the character itself as the result with the only exception being an escaped space character which is removed from the output in reStructuredText.

Parses an escaped character. For most characters it produces the character itself as the result with the only exception being an escaped space character which is removed from the output in reStructuredText.

See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#escaping-mechanism.

Attributes

Parses a footnote reference.

Parses an inline literal element.

Parses an inline internal link target.

Parses an interpreted text element with the role name as a prefix.

Parses an interpreted text element with the role name as a prefix.

See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#interpreted-text

Attributes

Parses a phrase link reference (enclosed in back ticks).

Parses a phrase link reference (enclosed in back ticks).

See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#hyperlink-references

Attributes

Parses a simple link reference.

Parses a span of text with strong emphasis.

Attributes

Parses a substitution reference.

Parses a standalone HTTP or HTTPS hyperlink (with no surrounding markup).

Parses a standalone HTTP or HTTPS hyperlink (with no surrounding markup).

See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#standalone-hyperlinks

Attributes