Templates in default-text-templates
Auto generated from lib/RakuDoc/Render.rakumod
| Name | Description |
|---|---|
| _name | special key to name template set |
| code | renders =code blocks |
| comment | renders =comment block |
| custom | renders =custom block |
| defn | renders =defn block |
| defn-list | renders =numdefn block |
special template to render a defn list data structure | |
| delta | rendering the content from the :delta option |
see inline variant markup-Δ | |
| final | special template to encapsulate all the output to save to a file |
| footnotes | special template to render the footnotes data structure |
| formula | renders =formula block |
| head | renders =head block |
| implicit-code | renders implicit code from an indented paragraph |
| index | special template to render the index data structure |
| index-item | renders a single item in the index |
| input | renders =input block |
| item | renders =item block |
| item-list | special template to render an item list data structure |
| markup-A | A< DISPLAY-TEXT | METADATA = ALIAS-NAME > |
Alias to be replaced by contents of specified V<=alias> directive | |
| markup-B | B< DISPLAY-TEXT > |
Basis/focus of sentence (typically rendered bold) | |
| markup-C | C< DISPLAY-TEXT > |
Code (typically rendered fixed-width) | |
| markup-D | D< DISPLAY-TEXT | METADATA = SYNONYMS > |
Definition inline ( D<term being defined|synonym1; synonym2> ) | |
| markup-E | E< DISPLAY-TEXT | METADATA = HTML/UNICODE-ENTITIES > |
Entity (HTML or Unicode) description ( E<entity1;entity2; multi,glyph;...> ) | |
| markup-F | F< DISPLAY-TEXT | METADATA = LATEX-FORM > |
Formula inline content ( F<ALT|LaTex notation> ) | |
| markup-H | H< DISPLAY-TEXT > |
High text (typically rendered superscript) | |
| markup-I | I< DISPLAY-TEXT > |
Important (typically rendered in italics) | |
| markup-J | J< DISPLAY-TEXT > |
Junior text (typically rendered subscript) | |
| markup-K | K< DISPLAY-TEXT > |
Keyboard input (typically rendered fixed-width) | |
| markup-L | L< DISPLAY-TEXT | METADATA = TARGET-URI > |
Link ( L<display text|destination URI> ) | |
| markup-M | M< DISPLAY-TEXT | METADATA = WHATEVER > |
Markup extra ( M<display text|functionality;param,sub-type;...>) | |
| markup-N | N< DISPLAY-TEXT > |
Note (text not rendered inline, but visible in some way: footnote, sidenote, pop-up, etc.)) | |
| markup-O | O< DISPLAY-TEXT > |
Overstrike or strikethrough | |
| markup-P | P< DISPLAY-TEXT | METADATA = REPLACEMENT-URI > |
Placement link | |
| markup-R | R< DISPLAY-TEXT > |
Replaceable component or metasyntax | |
| markup-S | S< DISPLAY-TEXT > |
Space characters to be preserved | |
| markup-T | T< DISPLAY-TEXT > |
Terminal output (typically rendered fixed-width) | |
| markup-U | U< DISPLAY-TEXT > |
Unusual (typically rendered with underlining) | |
| markup-V | V< DISPLAY-TEXT > |
Verbatim (internal markup instructions ignored) | |
| markup-X | X< DISPLAY-TEXT | METADATA = INDEX-ENTRY > |
Index entry ( X<display text|entry,subentry;...>) | |
| markup-bad | Unknown markup, render minimally |
| markup-Δ | Δ< DISPLAY-TEXT | METADATA = VERSION-ETC > |
Delta note ( Δ<visible text|version; Notification text> ) | |
| nested | renders =nested block |
| numdefn | special template to render a numbered defn list data structure |
| numdefn-list | special template to render a numbered item list data structure |
| numhead | renders =numhead block |
| numitem | renders =numitem block |
| numitem-list | special template to render a numbered item list data structure |
| output | renders =output block |
| para | renders =para block |
| place | renders =place block |
| pod | renders =pod block |
| rakudoc | renders =rakudoc block |
| section | renders =section block |
| semantic | renders =SEMANTIC block, if not otherwise given |
| table | renders =table block |
| toc | special template to render the toc list |
| toc-item | renders a single item in the toc |
| toc-numeration | renders the numeration part for a toc |
| unknown | renders any unknown block minimally |
| warnings | special template to render the warnings data structure |