Text::Greeking(3pm) User Contributed Perl Documentation Text::Greeking(3pm)NAME
Text::Greeking - a module for generating meaningless text that creates the illusion of the finished document.
SYNOPSIS
#!/usr/bin/perl -w
use strict;
use Text::Greeking;
my $g = Text::Greeking->new;
$g->paragraphs(1,2) # min of 1 paragraph and a max of 2
$g->sentences(2,5) # min of 2 sentences per paragraph and a max of 5
$g->words(8,16) # min of 8 words per sentence and a max of 16
print $g->generate; # use default Lorem Ipsum source
DESCRIPTION
Greeking is the use of random letters or marks to show the overall appearance of a printed page without showing the actual text. Greeking
is used to make it easy to judge the overall appearance of a document without being distracted by the meaning of the text.
This is a module is for quickly generating varying meaningless text from any source to create this illusion of the content in systems.
This module was created to quickly give developers simulated content to fill systems with simulated content. Instead of static Lorem Ipsum
text, by using randomly generated text and optionally varying word sources, repetitive and monotonous patterns that do not represent real
system usage is avoided.
METHODS
Text::Greeking->new
Constructor method. Returns a new instance of the class.
$g->init
Initializes object with defaults. Called by the constructor. Broken out for easy overloading to enable customized defaults and other
behaviour.
$g->sources([@ARRAY])
Gets/sets the table of source word collections current in memory as an ARRAY reference
$g->add_source($text)
The class takes a body of text passed as a SCALAR and processes it into a list of word tokens for use in generating random filler text
later.
$g->generate
Returns a body of random text generated from a randomly selected source using the minimum and maximum values set by paragraphs,
sentences, and words minimum and maximum values. If generate is called without any sources a standard Lorem Ipsum block is used added
to the sources and then used for processing the random text.
$g->paragraphs($min,$max)
Sets the minimum and maximum number of paragraphs to generate. Default is a minimum of 2 and a maximum of 8.
$g->sentences($min,$max)
Sets the minimum and maximum number of sentences to generate per paragraph. Default is a minimum of 2 and a maximum of 8.
$g->words($min,$max)
Sets the minimum and maximum number of words to generate per sentence. Default is a minimum of 5 and a maximum of 15.
SEE ALSO
http://en.wikipedia.org/wiki/Greeking
TO DO
HTML output mode including random hyperlinked phrases.
Configurable punctuation controls.
PARTICIPATION
I welcome and accept patches in diff format. If you wish to hack on this code, please fork the git repository found at:
<http://github.com/tima/perl-text-greeking/>. If you have something to push back to my repository, just use the "pull request" button on
the github site.
LICENSE
The software is released under the Artistic License. The terms of the Artistic License are described at
<http://www.perl.com/language/misc/Artistic.html>.
AUTHOR &; COPYRIGHT
Except where otherwise noted, Text::Greeking is Copyright 2005-2009, Timothy Appnel, tima@cpan.org. All rights reserved.
perl v5.10.0 2009-08-28 Text::Greeking(3pm)
Check Out this Related Man Page
Text::Context::EitherSide(3pm) User Contributed Perl Documentation Text::Context::EitherSide(3pm)NAME
Text::Context::EitherSide - Get n words either side of search keywords
SYNOPSIS
use Text::Context::EitherSide;
my $text = "The quick brown fox jumped over the lazy dog";
my $context = Text::Context::EitherSide->new($text);
$context->as_string("fox") # "... quick brown fox jumped over ..."
$context->as_string("fox", "jumped")
# "... quick brown fox jumped over the ..."
my $context = Text::Context::EitherSide->new($text, context => 1);
# 1 word on either side
$context->as_string("fox", "jumped", "dog");
# "... brown fox jumped over ... lazy dog",
Or, if you don't believe in all this OO rubbish:
use Text::Context::EitherSide qw(get_context);
get_context(1, $text, "fox", "jumped", "dog")
# "... brown fox jumped over ... lazy dog"
DESCRIPTION
Suppose you have a large piece of text - typically, say, a web page or a mail message. And now suppose you've done some kind of full-text
search on that text for a bunch of keywords, and you want to display the context in which you found the keywords inside the body of the
text.
A simple-minded way to do that would be just to get the two words either side of each keyword. But hey, don't be too simple minded, because
you've got to make sure that the list doesn't overlap. If you have
the quick brown fox jumped over the lazy dog
and you extract two words either side of "fox", "jumped" and "dog", you really don't want to end up with
quick brown fox jumped over brown fox jumped over the the lazy dog
so you need a small amount of smarts. This module has a small amount of smarts.
EXPORTABLE
get_context
This is primarily an object-oriented module. If you don't care about that, just import the "get_context" subroutine, and call it like so:
get_context($num_of_words, $text, @words_to_find)
and you'll get back a string with ellipses as in the synopsis. That's all that most people need to know. But if you want to do clever
stuff...
METHODS
new
my $c = Text::Context::EitherSite->new($text [, context=> $n]);
Create a new object storing some text to be searched, plus optionally some information about how many words on either side you want. (If
you don't like the default of 2.)
context
$c->context(5);
Allows you to get and set the number of the words on either side.
as_sparse_list
$c->as_sparse_list(@keywords)
Returns the keywords, plus n words on either side, as a sparse list; the original text is split into an array of words, and non-contextual
elements are replaced with "undef"s. (That's not actually how it works, but conceptually, it's the same.)
as_list
$c->as_list(@keywords)
The same as "as_sparse_list", but single or multiple "undef"s are collapsed into a single ellipsis:
(undef, "foo", undef, undef, undef, "bar")
becomes
("...", "foo", "...", "bar")
as_string
$c->as_string(@keywords)
Takes the "as_list" output above and joins them all together into a string. This is what most people want from "Text::Context::EitherSide".
EXPORT
"get_context" is available as a shortcut for
Text::Context::EitherSide->new($text, context => $n)->as_string(@words);
but needs to be explicitly imported. Nothing is exported by default.
SEE ALSO
Text::Context is an even smarter way of extracting a contextual string.
AUTHOR
Current maintainer: Tony Bowden
Original author: Simon Cozens
BUGS and QUERIES
Please direct all correspondence regarding this module to:
bug-Text-Context-EitherSide@rt.cpan.org
COPYRIGHT AND LICENSE
Copyright 2002-2005 by Kasei Limited, http://www.kasei.com/
You may use and redistribute this module under the terms of the Artistic License 2.0.
http://www.perlfoundation.org/artistic_license_2_0
perl v5.10.0 2009-05-04 Text::Context::EitherSide(3pm)