Packages

c

laika.rst.std

StandardSpanDirectives

class StandardSpanDirectives extends AnyRef

Defines all supported standard span directives of the reStructuredText reference parser. A span directive can be used in substitution definitions.

The replace directive is fully supported. The other directives have the following adjustments or limitations compared to their counterparts in the reference parser:

  • unicode: does not support the various trim options, as that would require modifying adjacent elements (and no other directive has this requirement, therefore API/impl changes did not seem justified)
  • date: Uses the patterns of java.text.SimpleDateFormat instead of Python's time.strftime function.
  • image: Does not support the various layout options (width, height, scale, align), as no other tree nodes in Laika carry concrete layout information. It is recommended to use styles instead.
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandardSpanDirectives
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StandardSpanDirectives()

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()
  6. lazy val date: DirectivePartBuilder[Span]

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

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

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

  17. lazy val spanDirectives: List[Directive[Span]]

    All standard reStructuredText span directives, to be used in substitution references.

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. lazy val unicode: DirectivePartBuilder[Span]

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

  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped