t

laika.factory

MarkupFormat

trait MarkupFormat extends Format

Responsible for creating parser instances for a specific markup format. A parser is simply a function of type Input => Document.

Linear Supertypes
Format, AnyRef, Any
Known Subclasses
Markdown, ReStructuredText
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MarkupFormat
  2. Format
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def blockParsers: Seq[BlockParserBuilder]

    All block parsers for the markup language this parser processes.

  2. abstract def extensions: Seq[ExtensionBundle]

    The parser-specific extensions that need to be installed for each transformation that involves this parser.

    The parser-specific extensions that need to be installed for each transformation that involves this parser.

    One scenario where a parser needs to provide a bundle is when it produces tree elements that are unknown to the built-in rewrite rules and renderers.

  3. abstract def fileSuffixes: Set[String]

    The file suffixes recognized by this parser.

    The file suffixes recognized by this parser. When transforming entire directories only files with names ending in one of the specified suffixes will be considered.

    It is recommended not to support txt or similarly common suffixes as this might interfere with other installed formats.

  4. abstract def spanParsers: Seq[SpanParserBuilder]

    All span parsers for the markup language this parser processes.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def createBlockListParser(parser: Parser[Block]): Parser[Seq[Block]]

    Creates the parser for a sequence of blocks based on the parser for a single block.

    Creates the parser for a sequence of blocks based on the parser for a single block.

    The parser for a single block is already the result of merging all block parsers defined within this instance with all extension parsers defined by the user.

    The default implementation simply applies this parser repeatedly while skipping blank lines between the parsed blocks. This method can get overridden for special requirements, for example when the previous result has an influence on which parser to pick for the subsequent block.

  7. def description: String

    Short string describing the markup or output format for tooling and logging.

    Short string describing the markup or output format for tooling and logging.

    Definition Classes
    Format
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def escapedChar: Parser[String]

    Parses the character after the one that started the escape sequence (usually a backslash).

    Parses the character after the one that started the escape sequence (usually a backslash).

    The default implementation parses any character as is, this can be overridden in case the host language has more specific rules for escape sequences.

  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Format

Inherited from AnyRef

Inherited from Any

Ungrouped