Blocktypes for text::wikiformat
None. Use Text::WikiFormat as the public interface, unless you want to create your own block type.
This module merely creates subclasses of Text::WikiFormat::Block, which is the interesting code. A block is a collection of related lines, such as a code block (text to display verbatim in a monospaced font), a header, an unordered list, an ordered list, and a paragraph (text to display in a proportional font).
Every block extends \*(C`Text::WikiFormat::Block\*(C'.
The following methods exist:
\*(C`new( %args )\*(C' Creates and returns a new block. The valid arguments are:
\*(C`text\*(C' The text of the line found in the block.
\*(C`args\*(C' The arguments captured by the block-identifying regular expression.
\*(C`level\*(C' The level of indentation for the block (usually only useful for list blocks).
\*(C`tags\*(C' The tags in effect for the current type of wiki formatting.
\*(C`opts\*(C' The options in effect for the current type of wiki formatting.
Use the accessors of the same names to retrieve the values of the attributes.
\*(C`add_text( @lines_of_text )\*(C' Adds a list of lines of text to the current text for the block. This is very useful when you encounter a block and want to merge it with the previous block of the same type
\*(C`add_args( @arguments )\*(C' Adds further arguments to the block; useful when merging blocks.
\*(C`formatted_text()\*(C' Returns text formatted appropriately for this block. Blocks don't have to have formatters, but they may.
\*(C`formatter( $line_of_text )\*(C' Formats the $line using \*(C`Text::WikiFormat::format_line()\*(C'. You can add your own formatter here; this is worth overriding.
\*(C`merge( $next_block )\*(C' Merges the current block with $next_block (the next block encountered) if they're of the same type and are at the same level. This adds the text and args of $next_block to the current block. It's your responsibility to remove $next_block from whatever your code iterates over.
\*(C`nests()\*(C' Returns true if this block should nest (as in lists and unordered lists) for the active wiki formatting.
\*(C`nest( $next_block )\*(C' Nests $next_block under this block if the both nest and if $next_block has a level greater than the current block. This actually adds $next_block as a text item within the current block. Beware.
chromatic, \*(C`chromatic at wgz dot org\*(C'
No known bugs.
Copyright (c) 2006, chromatic. Some rights reserved.
This module is free software; you can use, redistribute, and modify it under the same terms as Perl 5.8.x.