CodeBlockDirektive

CodeBlockDirektive is a directive used in certain templating and documentation systems to mark and process blocks of source code within documents. The directive associates a language tag with a code block, enabling consistent rendering, syntax highlighting, and, in some implementations, execution or extraction of the enclosed code. It is designed to be language-agnostic and is supported by processors that render technical documentation and wiki pages.

Usage and syntax: A CodeBlockDirektive block begins with a header line that specifies the language and optional rendering options, for example: CodeBlockDirektive language="Python" line_numbers=true. The following lines constitute the code and are terminated by a closing line EndCodeBlock. Options may control line numbering, wrapping, export behavior, or whether the block is executable. If no options are provided, the block is rendered with defaults.

Semantics: In static rendering, the directive primarily affects presentation, such as syntax highlighting and indentation. In interactive environments, the processor may offer execution or sandboxed evaluation of the enclosed code, subject to security settings and language support.

Examples:

CodeBlockDirektive language="Python" line_numbers=true

def greet(name):

return f"Hello, {name}"

EndCodeBlock

CodeBlockDirektive language="Shell" executable=false

echo "Build started"

EndCodeBlock

Compatibility and notes: Implementations vary and the directive is not part of a formal standard. Some processors treat code blocks as exportable artifacts, while others focus on rendering. When migrating content between systems, ensure header options are mapped correctly.

See also: CodeBlockDirective, LiteralBlock, Directive.