.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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 "Term::EditorEdit 3pm"
.TH Term::EditorEdit 3pm "2011-07-05" "perl v5.14.2" "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"
Term::EditorEdit \- Edit a document via $EDITOR
.SH "VERSION"
.IX Header "VERSION"
version 0.0016
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Term::EditorEdit;
\&    
\&    # $VISUAL or $EDITOR is invoked
\&    $document = Term::EditorEdit\->edit( document => <<_END_ );
\&    Apple
\&    Banana
\&    Cherry
\&    _END_
.Ve
.PP
With post-processing:
.PP
.Vb 10
\&    $document = Term::EditorEdit\->edit( document => $document, process => sub {
\&        my $edit = shift;
\&        my $document = $edit\->document;
\&        if ( document_is_invalid() ) {
\&            # The retry method will return out of \->process immediately (via die)
\&            $edit\->retry
\&        }
\&        # Whatever is returned from the processor will be returned via \->edit
\&        return $document;
\&    } );
.Ve
.PP
With an \*(L"out-of-band\*(R" instructional preamble:
.PP
.Vb 7
\&    $document = <<_END_
\&    # Delete everything but the fruit you like:
\&    \-\-\-
\&    Apple
\&    Banana
\&    Cherry
\&    _END_
\&
\&    # After the edit, only the text following the first \*(Aq\-\-\-\*(Aq will be returned
\&    $content = Term::EditorEdit\->edit(
\&        separator => \*(Aq\-\-\-\*(Aq,
\&        document => $document,
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Term::EditorEdit is a tool for prompting the user to edit a piece of text via \f(CW$VISUAL\fR or \f(CW$EDITOR\fR and return the result
.PP
In addition to just editing a document, this module can distinguish between a document preamble and document content, giving you a way to provide \*(L"out-of-bound\*(R" information to whoever is editing. Once an edit is complete, only the content (whatever was below the preamble) is returned
.SH "USAGE"
.IX Header "USAGE"
.ie n .SS "$result = Term::EditorEdit\->edit( ... )"
.el .SS "\f(CW$result\fP = Term::EditorEdit\->edit( ... )"
.IX Subsection "$result = Term::EditorEdit->edit( ... )"
Takes the following parameters:
.PP
.Vb 1
\&    document            The document to edit (required)
\&
\&    separator           The string to use as a line separator dividing
\&                        content from the preamble
\&
\&    process             A code reference that will be called once an edit is complete.
\&                        Within process, you can check the document, preamble, and content.
\&                        You can also have the user retry the edit. Whatever is returned
\&                        from the code will be what is returned from the \->edit call
.Ve
.PP
Returns the edited document (or content if a separator was specified) or the result of
the \f(CW\*(C`process\*(C'\fR argument (if supplied)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Term::CallEditor
.SH "AUTHOR"
.IX Header "AUTHOR"
Robert Krimen <robertkrimen@gmail.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Robert Krimen.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.