API:EPrints/Test/Pod2Wiki

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki

NAME[edit]

EPrints::Test::Pod2Wiki - convert EPrints pod to MediaWiki

User Comments

Editing Pod2Wiki Pages[edit]

Pages generated by this module have Pod2Wiki markers inserted. These markers are HTML comments that start and end every Plain Old Documentation (POD) section. For example a POD synopsis section will look like this:

 <!-- Pod2Wiki=head_synopsis -->
 ==SYNOPSIS==
 use EPrints::Test::Pod2Wiki;
 my $p = EPrints::Test::Pod2Wiki-&gt;new(
   wiki_api =&gt; "http://wiki.foo.org/api.php",
   username =&gt; "johnd",
   password =&gt; "xiPi00",
 );
 $p-&gt;update_page( "EPrints::Utils" );
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->

When the Wiki page is updated each Pod2Wiki section is replaced with the equivalent section content from the POD.

Comments can be made by adding them to the comment sections:

 ...
 <!-- Pod2Wiki=head_methods -->
 ==METHODS==
 Any changes here will be lost
 <!-- Edit below this comment -->
 This Wiki comment will be kept.
 <!-- Pod2Wiki= -->
 ...

Note: if a POD section is removed any Wiki content associated with that section will also be removed.

The rest of this page concerns the EPrints::Test::Pod2Wiki module.

User Comments

SYNOPSIS[edit]

 use EPrints::Test::Pod2Wiki;
 
 my $p = EPrints::Test::Pod2Wiki->new(
   wiki_api => "http://wiki.foo.org/api.php",
   username => "johnd",
   password => "xiPi00",
   );
 
 $p->update_page( "EPrints::Utils" );

User Comments

DESCRIPTION[edit]

This module enables the integration of EPrints POD (documentation) and MediaWiki pages.

User Comments

METHODS[edit]

User Comments

new[edit]

EPrints::Test::Pod2Wiki->new( $class, %opts )

Create a new Pod2Wiki parser. Required options:

 wiki_api - URL of the MediaWiki "api.php" page
 username - MediaWiki username
 password - MediaWiki password

User Comments

update_page[edit]

$ok = $pod->update_page( $package_name, $selfcat )

Update the MediaWiki page for $package_name. If $selfcat then add to its own category.

User Comments

command[edit]

$parser->command( $cmd, $text, $line_num, $pod_para )

Pod::Parser callback.

User Comments

verbatim[edit]

$parser->verbatim( $text, $line_num, $pod_para )

Pod::Parser callback.

User Comments

textblock[edit]

$parser->textblock( $text, $line_num, $pod_para )

Pod::Parser callback.

User Comments

interpolate[edit]

$parser->interpolate( $text, $line_num )

Pod::Parser callback. Overloaded to also escape HTML entities.

User Comments

interior_sequence[edit]

$parser->interior_sequence( $seq_cmd, $seq_arg, $pod_seq )

Pod::Parser callback.

User Comments

COPYRIGHT[edit]

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE[edit]

This file is part of EPrints 3.4 http://www.eprints.org/.

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.

User Comments