debian man page for socialtext::wikiobject

Socialtext::WikiObject(3pm)				User Contributed Perl Documentation			       Socialtext::WikiObject(3pm)

NAME
       Socialtext::WikiObject - Represent wiki markup as a data structure and object

SYNOPSIS
	 use Socialtext::WikiObject;
	 my $page = Socialtext::WikiObject->new(
		       rester => $Socialtext_Rester,
		       page => $wiki_page_name,
		    );

DESCRIPTION
       Socialtext::WikiObject is a package that attempts to fetch and parse some wiki text into a perl data structure.	This makes it easier for
       tools to access information stored on the wiki.

       The goal of Socialtext::WikiObject is to create a structure that is 'good enough' for most cases.

       The wiki data is parsed into a data structure intended for easy access to the data.  Headings, lists and text are supported.  Simple tables
       without multi-line rows are parsed.

       Subclass Socialtext::WikiObject to create a custom module for your data.  You can provide accessors into the parsed wiki data.

       Subclasses can simply provide accessors into the data they wish to expose.

FUNCTIONS
   new( %opts )
       Create a new wiki object.  Options:

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

       page
	   If the page is given, it will be loaded immediately.

   load_page( $page_name )
       Load the specified page.  Will fetch the wiki page and parse it into a perl data structure.

   parse_wikitext( $wikitext )
       Parse the wikitext into a data structure.

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:

       o   AnnoCPAN: Annotated CPAN documentation

	   <http://annocpan.org/dist/Socialtext-Resting-Utils>

       o   CPAN Ratings

	   <http://cpanratings.perl.org/d/Socialtext-Resting-Utils>

       o   RT: CPAN's request tracker

	   <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Socialtext-Resting-Utils>

       o   Search CPAN

	   <http://search.cpan.org/dist/Socialtext-Resting-Utils>

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.

perl v5.10.1							    2009-12-22					       Socialtext::WikiObject(3pm)