Templates in default-text-templates

Auto generated from lib/RakuDoc/Render.rakumod

=begin rakudoc

:header

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

=column

Documentation of default templates

Name

Description

_name

special key to name template set

code

renders =code blocks

comment

renders =comment block

defn

renders =defn block

defn-list =column

renders =numdefn block

special template to render a defn list data structure

delta =column

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

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 =column

A< DISPLAY-TEXT &#124; METADATA = ALIAS-NAME >

Alias to be replaced by contents of specified V<=alias> directive

markup-B =column

B< DISPLAY-TEXT >

Basis/focus of sentence (typically rendered bold)

markup-C =column

C< DISPLAY-TEXT >

Code (typically rendered fixed-width)

markup-D =column

D< DISPLAY-TEXT &#124; METADATA = SYNONYMS >

Definition inline ( D<term being defined&#124;synonym1; synonym2> )

markup-E =column

E< DISPLAY-TEXT &#124; METADATA = HTML/UNICODE-ENTITIES >

Entity (HTML or Unicode) description ( E<entity1;entity2; multi,glyph;...> )

markup-F =column

F< DISPLAY-TEXT &#124; METADATA = LATEX-FORM >

Formula inline content ( F<ALT&#124;LaTex notation> )

markup-H =column

H< DISPLAY-TEXT >

High text (typically rendered superscript)

markup-I =column

I< DISPLAY-TEXT >

Important (typically rendered in italics)

markup-J =column

J< DISPLAY-TEXT >

Junior text (typically rendered subscript)

markup-K =column

K< DISPLAY-TEXT >

Keyboard input (typically rendered fixed-width)

markup-L =column

L< DISPLAY-TEXT &#124; METADATA = TARGET-URI >

Link ( L<display text&#124;destination URI> )

markup-M =column

M< DISPLAY-TEXT &#124; METADATA = WHATEVER >

Markup extra ( M<display text&#124;functionality;param,sub-type;...>)

markup-N =column

N< DISPLAY-TEXT >

Note (text not rendered inline, but visible in some way: footnote, sidenote, pop-up, etc.))

markup-O =column

O< DISPLAY-TEXT >

Overstrike or strikethrough

markup-P =column

P< DISPLAY-TEXT &#124; METADATA = REPLACEMENT-URI >

Placement link

markup-R =column

R< DISPLAY-TEXT >

Replaceable component or metasyntax

markup-S =column

S< DISPLAY-TEXT >

Space characters to be preserved

markup-T =column

T< DISPLAY-TEXT >

Terminal output (typically rendered fixed-width)

markup-U =column

U< DISPLAY-TEXT >

Unusual (typically rendered with underlining)

markup-V =column

V< DISPLAY-TEXT >

Verbatim (internal markup instructions ignored)

markup-X =column

X< DISPLAY-TEXT &#124; METADATA = INDEX-ENTRY >

Index entry ( X<display text&#124;entry,subentry;...>)

markup-bad

Unknown markup, render minimally

markup-Δ =column

Δ< DISPLAY-TEXT &#124; METADATA = VERSION-ETC >

Delta note ( Δ<visible text&#124;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

=end rakudoc

Rakuast::RakuDoc::Render v1.0.14

Renders RakuDoc v2 to text, HTML, HTML-Extra, Markdown

Authors

  • Richard Hainsworth

License

Artistic-2.0

Dependencies

Test::Deeply::RelaxedPrettyDumpTest::OutputLibCurlURIDigest::SHA1::NativeText::MiscUtilsMethod::ProtectedTest::RunRakuAST::Deparse::HighlightRainbow:ver<0.3.0+>File::Directory::TreeJSON::FastYAMLishXML

Test Dependencies

Provides

  • RakuDoc::Citations
  • RakuDoc::MarkupMeta
  • RakuDoc::Numeration
  • RakuDoc::Plugin::HTML::Bulma
  • RakuDoc::Plugin::HTML::FontAwesome
  • RakuDoc::Plugin::HTML::Graphviz
  • RakuDoc::Plugin::HTML::Hilite
  • RakuDoc::Plugin::HTML::Latex
  • RakuDoc::Plugin::HTML::LeafletMaps
  • RakuDoc::Plugin::HTML::ListFiles
  • RakuDoc::Plugin::HTML::SCSS
  • RakuDoc::Plugin::Markdown::Graphviz
  • RakuDoc::Processed
  • RakuDoc::PromiseStrings
  • RakuDoc::Render
  • RakuDoc::ScopedData
  • RakuDoc::Templates
  • RakuDoc::To::Generic
  • RakuDoc::To::HTML
  • RakuDoc::To::HTML-Extra
  • RakuDoc::To::Markdown
  • RenderDocs

The Camelia image is copyright 2009 by Larry Wall. "Raku" is trademark of the Yet Another Society. All rights reserved.