.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Text::Greeking 3pm"
.TH Text::Greeking 3pm "2009-08-28" "perl v5.10.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Text::Greeking \- a module for generating meaningless text
that creates the illusion of the finished document.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& #!/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
.Ve
.SH "DESCRIPTION"
.IX Header "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.
.PP
This is a module is for quickly generating varying
meaningless text from any source to create this illusion of
the content in systems.
.PP
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.
.SH "METHODS"
.IX Header "METHODS"
.IP "Text::Greeking\->new" 4
.IX Item "Text::Greeking->new"
Constructor method. Returns a new instance of the class.
.ie n .IP "$g\->init" 4
.el .IP "\f(CW$g\fR\->init" 4
.IX Item "$g->init"
Initializes object with defaults. Called by the constructor.
Broken out for easy overloading to enable customized
defaults and other behaviour.
.ie n .IP "$g\->sources([\e@ARRAY])" 4
.el .IP "\f(CW$g\fR\->sources([\e@ARRAY])" 4
.IX Item "$g->sources([@ARRAY])"
Gets/sets the table of source word collections current in
memory as an \s-1ARRAY\s0 reference
.ie n .IP "$g\->add_source($text)" 4
.el .IP "\f(CW$g\fR\->add_source($text)" 4
.IX Item "$g->add_source($text)"
The class takes a body of text passed as a \s-1SCALAR\s0 and
processes it into a list of word tokens for use in
generating random filler text later.
.ie n .IP "$g\->generate" 4
.el .IP "\f(CW$g\fR\->generate" 4
.IX Item "$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.
.ie n .IP "$g\->paragraphs($min,$max)" 4
.el .IP "\f(CW$g\fR\->paragraphs($min,$max)" 4
.IX Item "$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.
.ie n .IP "$g\->sentences($min,$max)" 4
.el .IP "\f(CW$g\fR\->sentences($min,$max)" 4
.IX Item "$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.
.ie n .IP "$g\->words($min,$max)" 4
.el .IP "\f(CW$g\fR\->words($min,$max)" 4
.IX Item "$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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
http://en.wikipedia.org/wiki/Greeking
.SH "TO DO"
.IX Header "TO DO"
.IP "\s-1HTML\s0 output mode including random hyperlinked phrases." 4
.IX Item "HTML output mode including random hyperlinked phrases."
.PD 0
.IP "Configurable punctuation controls." 4
.IX Item "Configurable punctuation controls."
.PD
.SH "PARTICIPATION"
.IX Header "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 \*(L"pull
request\*(R" button on the github site.
.SH "LICENSE"
.IX Header "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>.
.SH "AUTHOR & COPYRIGHT"
.IX Header "AUTHOR & COPYRIGHT"
Except where otherwise noted, Text::Greeking is Copyright
2005\-2009, Timothy Appnel, tima@cpan.org. All rights
reserved.