From EPrints Documentation
Revision as of 09:56, 22 January 2013 by Tdb01r (talk | contribs)
Jump to: navigation, search

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


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


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

Editing Pod2Wiki Pages

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 -->
  use EPrints::Test::Pod2Wiki;
  my $p = EPrints::Test::Pod2Wiki-&gt;new(
    wiki_index =&gt; "http://wiki.foo.org/index.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 -->
  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.


use EPrints::Test::Pod2Wiki;

my $p = EPrints::Test::Pod2Wiki->new(
	wiki_index => "http://wiki.foo.org/index.php",
	username => "johnd",
	password => "xiPi00",

$p->update_page( "EPrints::Utils" );


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



EPrints::Test::Pod2Wiki->new( ... )

Create a new Pod2Wiki parser. Required options:

  wiki_index - URL of the MediaWiki "index.php" page
  username - MediaWiki username
  password - MediaWiki password
  comments - "section", "none"


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

Update the MediaWiki page for $package_name.


$parser->command( ... )

Pod::Parser callback.


$parser->verbatim( ... )

Pod::Parser callback.


$parser->textblock( ... )

Pod::Parser callback.


$parser->interpolate( ... )

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


$parser->interior_sequence( ... )

Pod::Parser callback.


Copyright 2000-2011 University of Southampton.

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

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints 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. If not, see http://www.gnu.org/licenses/.