Luke Closs > Socialtext-Resting-Utils > Socialtext::EditPage

Download:
Socialtext-Resting-Utils-0.21.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.04   Source  

NAME ^

Socialtext::EditPage - Edit a wiki page using your favourite EDITOR.

SYNOPSIS ^

Fetch a page, edit it, and then post it.

    use Socialtext::EditPage;

    # The rester is set with the server and workspace
    my $rester = Socialtext::Resting->new(%opts);

    my $s = Socialtext::EditPage->new(rester => $rester);
    $s->edit_page('Snakes on a Plane');

FUNCTIONS ^

new( %opts )

Arguments:

rester

Users must provide a Socialtext::Resting object setup to use the desired workspace and server.

pull_includes

If true, include wafls will be inlined into the page as extraclude blocks.

edit_page( %opts )

This method will fetch the page content, and then run $EDITOR on the file. After the file has been edited, it will be put back on the wiki server.

Arguments:

page

The name of the page you wish to edit.

callback

If supplied, callback will be called after the page has been edited. This function will be passed the edited content, and should return the content to be put onto the server.

summary_callback

If supplied, callback will be called after the page has been edit. This function should return the edit summary text for this edit, if desired.

tags

If supplied, these tags will be applied to the page after it is updated.

output

If supplied, the page will be saved to the given file instead of edited. The page will not be uploaded to the server.

template

If specified, this page will be used as the template for a new page.

edit_last_page( %opts )

This method will retrieve a last of all pages tagged with the supplied tag, and then open the latest one for edit.

Arguments are passed through to edit_page(), accept for:

tag

The name of the tag you wish to edit.

AUTHOR ^

Luke Closs, <luke.closs at socialtext.com>

BUGS ^

Please report any bugs or feature requests to bug-socialtext-editpage at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Socialtext-Resting-Utils. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Socialtext::EditPage

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2006 Luke Closs, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: