Module

rendering.plugins.directives.term

Term directive for inline tooltips.

Syntax:

{term="Definition text"}Term Name{/term}
{term}Term Name{/term}

(The second form uses term as definition, or looks up in glossary - glossary lookup not implemented yet)

Renders as:

<span class="term" data-tooltip="Definition text">Term Name</span>
View source
3 Functions

Functions

parse_term
Parse term directive.
3 tuple[str, str, str] 
def parse_term(inline: Any, m: re.Match[str], state: Any) -> tuple[str, str, str]

Parse term directive.

Parameters 3

Name Type Default Description
inline Any —
m re.Match[str] —
state Any —

Returns

tuple[str, str, str]

render_term
Render term to HTML.
3 str 
def render_term(renderer: Any, text: str, definition: str) -> str

Render term to HTML.

Parameters 3

Name Type Default Description
renderer Any —
text str —
definition str —

Returns

str

term_plugin
Register term plugin with Mistune.
1 None 
def term_plugin(md: Any) -> None

Register term plugin with Mistune.

Parameters 1

Name Type Default Description
md Any —