text::wikiformat::blocks(3pm) [debian man page]
Text::WikiFormat::Blocks(3pm) User Contributed Perl Documentation Text::WikiFormat::Blocks(3pm) NAME
Text::WikiFormat::Blocks - blocktypes for Text::WikiFormat SYNOPSIS
None. Use Text::WikiFormat as the public interface, unless you want to create your own block type. DESCRIPTION
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 "Text::WikiFormat::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::WikiFormat::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 2011-02-12 Text::WikiFormat::Blocks(3pm)
Check Out this Related Man Page
SVN::Dump::Record(3pm) User Contributed Perl Documentation SVN::Dump::Record(3pm) NAME
SVN::Dump::Record - A SVN dump record SYNOPSIS
# SVN::Dump::Record objects are returned by the next_record() # method of SVN::Dump DESCRIPTION
An "SVN::Dump::Record" object represents a Subversion dump record. METHODS
"SVN::Dump" provides the following gourps of methods: Record methods new() Create a new empty "SVN::Dump::Record" object. type() Return the record type, as guessed from its headers. The method dies if the record type cannot be determined. set_header( $h, $v ) Set the header $h to the value $v. get_header( $h ) Get the value of header $h. set_property( $p, $v ) Set the property $p to the value $v. get_property( $p ) Get the value of property $p. delete_property( @k ) Delete the set_text( $t ) Set the value of the text block. get_text() Get the value of the text block. Inner blocks manipulation A "SVN::Dump::Record" is composed of several inner blocks of various kinds: "SVN::Dump::Headers", "SVN::Dump::Property" and "SVN::Dump::Text". The following methods provide access to these blocks: set_headers_block( $headers ) get_headers_block() Get or set the "SVN::Dump::Headers" object that represents the record headers. set_property_block( $property ) get_property_block() Get or set the "SVN::Dump::Property" object that represents the record property block. delete_property( @keys ) Delete the given properties. Behave like the builtin "delete()". set_text_block( $text ) get_text_block() Get or set the "SVN::Dump::Text" object that represents the record text block. set_included_record( $record ) get_included_record() Some special record are actually output recursiveley by svnadmin dump. The "record in the record" is stored within the parent record, so they are parsed as a single record with an included record. "get_record()" / "set_record()" give access to the included record. According to the Subversion sources (subversion/libsvn_repos/dump.c), this is a "delete original, then add-with-history" node. The dump looks like this: Node-path: tags/mytag/myfile Node-kind: file Node-action: delete Node-path: tags/mytag/myfile Node-kind: file Node-action: add Node-copyfrom-rev: 23 Node-copyfrom-path: trunk/myfile Note that there is a single blank line after the first header block, and four after the included one. update_headers() Update the various "...-length" headers. Used internally. You must call this method if you update the inner property or text blocks directly, or the results of "as_string()" will be inconsistent. Information methods has_prop() Return a boolean value indicating if the record has a property block. has_text() Return a boolean value indicating if the record has a text block. has_prop_only() Return a boolean value indicating if the record has only a property block (and no text block). has_prop_or_text() Return a boolean value indicating if the record has a property block or a text block. property_length() Return the length of the property block. text_length() Return the length of the text block. Output method as_string() Return a string representation of the record. Warning: dumping a record currenly gives back the information that was read from the original dump. Which means that if you modified the property or text block of a record, the headers will be inconstent. ENCAPSULATION
When using "SVN::Dump" to manipulate a SVN dump, one should not directly access the "SVN::Dump::Headers", "SVN::Dump::Property" and "SVN::Dump::Text" components of a "SVN::Dump::Record" object, but use the appropriate "set_...()" and "get_...()" methods of the record object. These methods compute the appropriate modifications of the header values, so that the "as_string()" method outputs the correct information after any modification of the record. SEE ALSO
"SVN::Dump::Headers", "SVN::Dump::Property", "SVN::Dump::Text". COPYRIGHT
Copyright 2006-2011 Philippe 'BooK' Bruhat, All Rights Reserved. LICENSE
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.10.1 2011-03-22 SVN::Dump::Record(3pm)