text::flow::wrap(3pm) [debian man page]
Text::Flow::Wrap(3pm) User Contributed Perl Documentation Text::Flow::Wrap(3pm) NAME
Text::Flow::Wrap - Flexible word wrapping for not just ASCII output. SYNOPSIS
use Text::Flow::Wrap; # for regular ASCII usage ... my $wrapper = Text::Flow::Wrap->new( check_width => sub { length($_[0]) < 70 }, ); # for non-ASCII usage ... my $wrapper = Text::Flow::Wrap->new( check_width => sub { $pdf->get_text_width($_[0]) < 500 }, ); my $text = $wrapper->wrap($text); DESCRIPTION
The main purpose of this module is to provide text wrapping features without being tied down to ASCII based output and fixed-width fonts. My needs were for sophisticated test control in PDF and GIF output formats in particular. METHODS
new (%params) This constructs a new Text::Flow::Wrap module whose %params set the values of the attributes listed below. wrap ($text) This method will accept a bunch of text, it will then return a new string which is wrapped to the expected width. Attribute Accessors check_width (&code) This attribute is required, and must be a CODE reference. This will be used to determine if the width of the text is appropriate. It will get as an argument, a string which is should check the width of. It should return a Boolean value, true if the string is not exceeded the max width and false if it has. line_break ($str) This is the line break character used when assembling and disassembling the text, it defaults to the newline character " ". paragraph_boundry ($str) This is the paragraph boundry marker used when disassembling the text, it defaults to the string " ". paragraph_break ($str) This is the paragraph breaker used when re-assembling the text, it defaults to the string " ". word_boundry ($str) This is the word boundry marker used when disassembling the text, it defaults to a single space character. word_break ($str) This is the paragraph breaker used when re-assembling the text, it defaults to a single space character. Paragraph Disassembling These methods deal with breaking up the paragraphs into its parts, which can then be processed through the re-assembling methods. These methods are mostly used internally, but more sophisticated tools might need to access them as well (see Text::Flow). disassemble_paragraph disassemble_paragraphs Paragraph Reassembling These methods deal with putting the paragraph parts back together after the disassembling methods have done thier work. These methods are mostly used internally, but more sophisticated tools might need to access them as well (see Text::Flow) reassemble_paragraph reassemble_paragraphs Introspection meta Returns the Moose meta object associated with this class. BUGS
All complex software has bugs lurking in it, and this module is no exception. If you find a bug please either email me, or add the bug to cpan-RT. AUTHOR
Stevan Little <stevan@iinteractive.com> COPYRIGHT AND LICENSE
Copyright 2007 by Infinity Interactive, Inc. <http://www.iinteractive.com> This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.10.1 2007-05-21 Text::Flow::Wrap(3pm)
Check Out this Related Man Page
Text::Wrap(3pm) Perl Programmers Reference Guide Text::Wrap(3pm) NAME
Text::Wrap - line wrapping to form simple paragraphs SYNOPSIS
Example 1 use Text::Wrap $initial_tab = " "; # Tab before first line $subsequent_tab = ""; # All other lines flush left print wrap($initial_tab, $subsequent_tab, @text); print fill($initial_tab, $subsequent_tab, @text); @lines = wrap($initial_tab, $subsequent_tab, @text); @paragraphs = fill($initial_tab, $subsequent_tab, @text); Example 2 use Text::Wrap qw(wrap $columns $huge); $columns = 132; # Wrap at 132 characters $huge = 'die'; $huge = 'wrap'; $huge = 'overflow'; Example 3 use Text::Wrap $Text::Wrap::columns = 72; print wrap('', '', @text); DESCRIPTION
"Text::Wrap::wrap()" is a very simple paragraph formatter. It formats a single paragraph at a time by breaking lines at word boundries. Indentation is controlled for the first line ($initial_tab) and all subsequent lines ($subsequent_tab) independently. Please note: $ini- tial_tab and $subsequent_tab are the literal strings that will be used: it is unlikley you would want to pass in a number. Text::Wrap::fill() is a simple multi-paragraph formatter. It formats each paragraph separately and then joins them together when it's done. It will destory any whitespace in the original text. It breaks text into paragraphs by looking for whitespace after a newline. In other respects it acts like wrap(). OVERRIDES
"Text::Wrap::wrap()" has a number of variables that control its behavior. Because other modules might be using "Text::Wrap::wrap()" it is suggested that you leave these variables alone! If you can't do that, then use "local($Text::Wrap::VARIABLE) = YOURVALUE" when you change the values so that the original value is restored. This "local()" trick will not work if you import the variable into your own namespace. Lines are wrapped at $Text::Wrap::columns columns. $Text::Wrap::columns should be set to the full width of your output device. In fact, every resulting line will have length of no more than "$columns - 1". It is possible to control which characters terminate words by modifying $Text::Wrap::break. Set this to a string such as '[s:]' (to break before spaces or colons) or a pre-compiled regexp such as "qr/[s']/" (to break before spaces or apostrophes). The default is simply 's'; that is, words are terminated by spaces. (This means, among other things, that trailing punctuation such as full stops or commas stay with the word they are "attached" to.) Beginner note: In example 2, above $columns is imported into the local namespace, and set locally. In example 3, $Text::Wrap::columns is set in its own namespace without importing it. "Text::Wrap::wrap()" starts its work by expanding all the tabs in its input into spaces. The last thing it does it to turn spaces back into tabs. If you do not want tabs in your results, set $Text::Wrap::unexapand to a false value. Likewise if you do not want to use 8-character tabstops, set $Text::Wrap::tabstop to the number of characters you do want for your tabstops. If you want to separate your lines with something other than " " then set $Text::Wrap::seporator to your preference. When words that are longer than $columns are encountered, they are broken up. "wrap()" adds a " " at column $columns. This behavior can be overridden by setting $huge to 'die' or to 'overflow'. When set to 'die', large words will cause "die()" to be called. When set to 'overflow', large words will be left intact. Historical notes: 'die' used to be the default value of $huge. Now, 'wrap' is the default value. EXAMPLE
print wrap(" ","","This is a bit of text that forms a normal book-style paragraph"); AUTHOR
David Muir Sharnoff <muir@idiom.com> with help from Tim Pierce and many many others. perl v5.8.0 2002-06-01 Text::Wrap(3pm)