Packages

c

laika.rst.std

StandardTextRoles

class StandardTextRoles extends AnyRef

Defines all supported standard text roles of the reStructuredText reference parser.

The following text roles are fully supported:

  • emphasis
  • strong
  • literal
  • subscript (and sub alias)
  • superscript (and sup alias)
  • title-reference (and title alias) - the default role
  • raw (+ format option) (needs to be enabled explicitly through ReStructuredText.withRawElements)

The following text role is supported with some limitation:

  • code does currently not support syntax highlighting (it allows to set the language so client-side highlighters can be integrated if required)

The following text roles are not supported:

  • math
  • pep-reference
  • rfc-reference

In contrast to the reference parser the default-role directive cannot be supported in Laika as the parser is not stateful. Therefore it is not possible to change the default role half-way through a parsing process. However the default role can be specified through the API when creating a parser instance:

object RstExtensions extends RstExtensionRegistry {
  val blockDirectives = Nil
  val spanDirectives = Nil
  val textRoles = Nil
  override val defaultTextRole = "my-role-name"
}

val transformer = Transformer.from(ReStructuredText).to(HTML).using(RstExtensions)

See http://docutils.sourceforge.net/docs/ref/rst/roles.html for details.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandardTextRoles
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StandardTextRoles()

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. lazy val allRoles: List[TextRole]

    All standard text roles currently supported by Laika, except for the raw text role which needs to be enabled explicitly.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. lazy val codeSpan: TextRole

    The standard code text role.

    The standard code text role. The current implementation does not support syntax highlighting.

  8. lazy val emphasis: TextRole

    The standard emphasis text role.

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. lazy val literal: TextRole

    The standard literal text role.

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. lazy val rawTextRole: TextRole

    The raw text role, which is not enabled by default, see http://docutils.sourceforge.net/docs/ref/rst/roles.html#raw for details.

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

  20. lazy val strong: TextRole

    The standard strong text role.

  21. lazy val sub: TextRole

    The sub text role, an alias for the subscript role.

  22. lazy val subscript: TextRole

    The standard subscript text role.

  23. lazy val sup: TextRole

    The sup text role, an alias for the superscript role.

  24. lazy val superscript: TextRole

    The standard superscript text role.

  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. lazy val title: TextRole

    The title text role, an alias for the title-reference role.

  27. lazy val titleRef: TextRole

    The standard title-reference text role, the default text role in reStructuredText unless overridden with RstExtensionRegistry.defaultTextRole.

  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped