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
(andsub
alias)superscript
(andsup
alias)title-reference
(andtitle
alias) - the default roleraw
(+ format option) (needs to be enabled explicitly throughReStructuredText.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.
- Alphabetic
- By Inheritance
- StandardTextRoles
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new StandardTextRoles()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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. -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
lazy val
codeSpan: TextRole
The standard code text role.
The standard code text role. The current implementation does not support syntax highlighting.
-
lazy val
emphasis: TextRole
The standard emphasis text role.
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
lazy val
literal: TextRole
The standard literal text role.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
. -
lazy val
strong: TextRole
The standard strong text role.
-
lazy val
sub: TextRole
The sub text role, an alias for the subscript role.
-
lazy val
subscript: TextRole
The standard subscript text role.
-
lazy val
sup: TextRole
The sup text role, an alias for the superscript role.
-
lazy val
superscript: TextRole
The standard superscript text role.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
lazy val
title: TextRole
The title text role, an alias for the title-reference role.
-
lazy val
titleRef: TextRole
The standard title-reference text role, the default text role in reStructuredText unless overridden with
RstExtensionRegistry.defaultTextRole
. -
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated