text::mediawikiformat::blocks(3pm) [debian man page]
Text::MediawikiFormat::Blocks(3pm) User Contributed Perl Documentation Text::MediawikiFormat::Blocks(3pm) NAME
Text::MediawikiFormat::Blocks - blocktypes for Text::MediawikiFormat SYNOPSIS
None. Use Text::MediawikiFormat as the public interface, unless you want to create your own block type. DESCRIPTION
This module merely creates subclasses of Text::MediawikiFormat::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 "Text::MediawikiFormat::Block". METHODS
The following methods exist: o "new( %args )" Creates and returns a new block. The valid arguments are: o "text" The text of the line found in the block. o "args" The arguments captured by the block-identifying regular expression. o "level" The level of indentation for the block (usually only useful for list blocks). o "tags" The tags in effect for the current type of wiki formatting. o "opts" 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. o "add_text( @lines_of_text )" 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 o "add_args( @arguments )" Adds further arguments to the block; useful when merging blocks. o "formatted_text()" Returns text formatted appropriately for this block. Blocks don't have to have formatters, but they may. o "formatter( $line_of_text )" Formats the $line using "Text::MediawikiFormat::format_line()". You can add your own formatter here; this is worth overriding. o "merge( $next_block )" 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. o "nests()" Returns true if this block should nest (as in lists and unordered lists) for the active wiki formatting. o "nest( $next_block )" 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. AUTHOR
chromatic, "chromatic at wgz dot org" BUGS
No known bugs. COPYRIGHT
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. perl v5.10.1 2008-06-19 Text::MediawikiFormat::Blocks(3pm)
Check Out this Related Man Page
MicroMason::TextTemplate(3pm) User Contributed Perl Documentation MicroMason::TextTemplate(3pm) NAME
Text::MicroMason::TextTemplate - Alternate Syntax like Text::Template SYNOPSIS
Instead of using this class directly, pass its name to be mixed in: use Text::MicroMason; my $mason = Text::MicroMason::Base->new( -TextTemplate ); Use the standard compile and execute methods to parse and evalute templates: print $mason->compile( text=>$template )->( @%args ); print $mason->execute( text=>$template, @args ); Text::Template provides a syntax to mix Perl into a text template: { my $hour = (localtime)[2]; my $daypart = ( $hour > 11 ) ? 'afternoon' : 'morning'; '' } Good { $daypart }, { $name }! DESCRIPTION
This mixin class overrides several methods to allow MicroMason to emulate the template syntax and some of the other features of Text::Template. Compatibility with Text::Template This is not a drop-in replacement for Text::Template, as the Perl calling interface is quite different, but it should be able to process most existing templates without major changes. This should allow current Text::Template users to take advantage of MicroMason's one-time compilation feature, which in theory could be faster than Text::Template's repeated evals for each expression. (No benchmarking yet.) Contributed patches to more closely support the syntax of Text::Template documents would be welcomed by the author. Template Syntax The following elements are recognized by the TextTemplate lexer: o literal_text Anything not specifically parsed by the below rule is interpreted as literal text. o { perl_expr } A Perl expression to be interpolated into the result. Good { (localtime)[2]>11 ? 'afternoon' : 'morning' }. The block may span multiple lines and is scoped inside a "do" block, so it may contain multiple Perl statements and it need not end with a semicolon. Good { my $h = (localtime)[2]; $h > 11 ? 'afternoon' : 'morning' }. To make a block silent, use an empty string as the final expression in the block. { warn "Interpreting template"; '' } Hello there. Although the blocks are not in the same a lexical scope, you can use local variables defined in one block in another: { $phase = (localtime)[2]>11 ? 'afternoon' : 'morning'; '' } Good { $phrase }. Argument Passing Like Text::Template, this package clobbers a target namespace to pass in template arguments as package variables. For example, if you pass in an argument list of "foo => 23", it will set the variable $foo in your package. The strict pragma is disabled to facilitate these variable references. Internally, this module inherits this functionality from the PassVariables mixin. If you are using the TextTemplate mixin, do not also specify the PassVariables mixin or it will be included twice. For more information, see Text::MicroMason::PassVariables. Supported Attributes package Target package namespace. Private Methods prepare() If a package has not been specified, this method generates a new package namespace to use only for compilation of a single template. lex() Lexer for matched braces - produces only text and expr tokens. Uses Text::Balanced. SEE ALSO
The interface being emulated is described in Text::Template. For an overview of this templating framework, see Text::MicroMason. This is a mixin class intended for use with Text::MicroMason::Base. For distribution, installation, support, copyright and license information, see Text::MicroMason::Docs::ReadMe. perl v5.10.1 2007-01-29 MicroMason::TextTemplate(3pm)