Packages

c

laika.rst.std

StandardBlockDirectives

class StandardBlockDirectives extends AnyRef

Defines all supported standard block directives of the reStructuredText reference parser.

The following directives are fully supported:

  • compound
  • container
  • admonition
  • attention
  • caution
  • danger
  • error
  • hint
  • important
  • note
  • tip
  • warning
  • topic
  • sidebar
  • rubric
  • epigraph
  • highlights
  • pull-quote
  • parsed-literal
  • table
  • contents
  • sectnum
  • figure
  • image
  • header
  • footer
  • title
  • meta

The following directives are supported with some limitations:

  • code does currently not support syntax highlighting (it allows to set the language so client-side highlighters can be integrated if required)
  • sectnum does currently not support the prefix, suffix and start options.
  • raw does not support the file or url options.
  • include does not support any of the options apart from the filename. See the API entry for this directive for details.

Finally, for some directives there is currently no support planned:

  • math (would require external tools)
  • csv-table, list-table (would just require some work, contributions are welcome)
  • target-notes, class (these would require processing beyond the directive itself, therefore would require new API)
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandardBlockDirectives
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StandardBlockDirectives()

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. def admonition(style: String, title: String): DirectivePartBuilder[Block]

    The attention, caution, danger, error, hint, important, note, tip and warning directives, which are all identical apart from their title which can be specified with the style parameter.

    The attention, caution, danger, error, hint, important, note, tip and warning directives, which are all identical apart from their title which can be specified with the style parameter. See http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions for details.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. lazy val blockDirectives: List[Directive[Block]]

    All standard block directives currently supported by Laika, except for the raw directive which needs to be enabled explicitly.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def code(p: RecursiveParsers): DirectivePartBuilder[Block]

    The code directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#code for details.

    The code directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#code for details. The current implementation does not support syntax highlighting.

  9. lazy val compound: DirectivePartBuilder[Block]

    The compound directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#compound-paragraph for details.

  10. lazy val container: DirectivePartBuilder[Block]

    The container directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#container for details.

  11. lazy val contents: DirectivePartBuilder[Block]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def figure(p: RecursiveParsers): DirectivePartBuilder[Block]

    The figure directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#figure for details.

  15. lazy val footer: DirectivePartBuilder[Block]

    The footer directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#document-header-footer for details.

  16. lazy val genericAdmonition: DirectivePartBuilder[Block]

    The admonition directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#generic-admonition for details.

  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. lazy val header: DirectivePartBuilder[Block]

    The header directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#document-header-footer for details.

  20. def imageBlock(p: RecursiveParsers): DirectivePartBuilder[Block]

    The image directive for block elements, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#image for details.

  21. lazy val include: DirectivePartBuilder[Block]

    The include directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment for details.

    The include directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#including-an-external-document-fragment for details.

    Note that the only argument supported in Laika is the default argument specifying the path of the file to include. The other options supported by reStructuredText original parser do not make sense in the execution context of Laika. They assume that the file is parsed everytime an include directive is used, whereas in Laika all files of the source tree get parsed in one go and then the include step simply references the previously parsed node tree. This is both simpler and more efficient when the same file gets included in multiple places.

  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. lazy val meta: DirectivePartBuilder[Block]

    The meta directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#meta for details.

    The meta directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#meta for details.

    In Laika there is no special document tree element for metadata. Therefore the result will be accessible through the generic config property in the Document class.

  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. lazy val parsedLiteral: DirectivePartBuilder[Block]

    The parsed-literal directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#parsed-literal-block for details.

  28. def quotedBlock(style: String): DirectivePartBuilder[Block]

    The epitaph, highlights and pull-quote directives, which are all identical apart from the style parameter, see epigraph, highlights and pull-quote for details.

  29. lazy val rawDirective: Directive[Block]

    The raw directive, which is not enabled by default, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#raw-data-pass-through for details.

    The raw directive, which is not enabled by default, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#raw-data-pass-through for details. It can be enabled with Transformer.from(ReStructuredText).to(HTML).withRawContent.

  30. lazy val rubric: DirectivePartBuilder[Block]

    The rubric directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#rubric for details.

  31. lazy val sectnum: DirectivePartBuilder[Block]
  32. def sidebar(p: RecursiveParsers): DirectivePartBuilder[Block]

    The sidebar directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#sidebar for details.

  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def table(p: RecursiveParsers): DirectivePartBuilder[Block]

    The table directive, adding a title to standard reStructuredText tables, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#table for details.

  35. lazy val titleDirective: DirectivePartBuilder[EmbeddedConfigValue]

    The title directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#metadata-document-title for details.

  36. def toString(): String
    Definition Classes
    AnyRef → Any
  37. lazy val topic: DirectivePartBuilder[Block]

    The topic directive, see http://docutils.sourceforge.net/docs/ref/rst/directives.html#topic for details.

  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  40. 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 AnyRef

Inherited from Any

Ungrouped