Difference between revisions of "Main Page"

Revision as of 12:44, 25 February 2010

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

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

User Comments

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 -->
 ==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 -->
 ==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

 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" );

User Comments

DESCRIPTION

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

User Comments

METHODS

User Comments

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

User Comments

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

Update the MediaWiki page for $package_name.

User Comments

$parser->command( ... )

Pod::Parser callback.

User Comments

$parser->verbatim( ... )

Pod::Parser callback.

User Comments

$parser->textblock( ... )

Pod::Parser callback.

User Comments

$parser->interpolate( ... )

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

User Comments

$parser->interior_sequence( ... )

Pod::Parser callback.

User Comments

@@ Line 1: / Line 1: @@
-[[Category:Rubbish]]
+<!-- Pod2Wiki=_preamble_
-__NOTOC__
+This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
+ -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Test/Pod2Wiki.pm|package_name=EPrints::Test::Pod2Wiki}}[[Category:API|Pod2Wiki]]<div><!-- Edit below this comment -->
-'''Welcome to the EPrints Wiki'''
-This wiki contains technical and user-contributed documentation for the [[Introduction|EPrints software]].
+<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
+==NAME==
+EPrints::Test::Pod2Wiki - convert EPrints pod to MediaWiki
-[http://demoprints3.eprints.org/ Demoprints] is our live, online server that allows anyone to try EPrints without having to install it first.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
-For more information on the EPrints project and related activities visit http://eprints.org/.
-== Download EPrints ==
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=head_editing_pod2wiki_pages -->
+==Editing Pod2Wiki Pages==
+Pages generated by this module have Pod2Wiki markers inserted. These markers are HTML comments that start and end every {{API:PodLink|file=perlpod|package_name=perlpod|section=|text=Plain Old Documentation}} (POD) section. For example a POD synopsis section will look like this:
-{{Download}}
+  &lt;!-- Pod2Wiki=head_synopsis --&gt;
+  ==SYNOPSIS==
+  use EPrints::Test::Pod2Wiki;
+  my $p = EPrints::Test::Pod2Wiki-&amp;gt;new(
+    wiki_index =&amp;gt; "http://wiki.foo.org/index.php",
+    username =&amp;gt; "johnd",
+    password =&amp;gt; "xiPi00",
+  );
+  $p-&amp;gt;update_page( "EPrints::Utils" );
+  &lt;!-- Edit below this comment --&gt;
+  &lt;!-- Pod2Wiki= --&gt;
+When the Wiki page is updated each Pod2Wiki section is replaced with the equivalent section content from the POD.
-==Installation==
+Comments can be made by adding them to the comment sections:
-* [[:Category:Installation|Installing]] EPrints on various platforms
+  ...
+  &lt;!-- Pod2Wiki=head_methods --&gt;
+  ==METHODS==
+  Any changes here will be lost
+  &lt;!-- Edit below this comment --&gt;
+  This Wiki comment will be kept.
+  &lt;!-- Pod2Wiki= --&gt;
+  ...
+Note: if a POD section is removed any Wiki content associated with that section will also be removed.
-==Getting Started==
+The rest of this page concerns the <em>EPrints::Test::Pod2Wiki</em> module.
-* [[EPrints Manual|EPrints 3 Documentation]]
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
-* [http://www.eprints.org/software/training/ Training materials] provided by EPrints Services.
+<span style='display:none'>User Comments</span>
-* [[Frequently Asked Questions]]
+<!-- Edit below this comment -->
-* [[:Category:Howto|How to...]]
-==Getting Support==
-* [http://www.eprints.org/services/ EPrints Services] - premium support, training and hosting from EPrints experts
+<!-- Pod2Wiki= -->
-* [[Contact|Mailing lists]]
+</div>
-* [[IRC|IRC chat channel]]
+<!-- Pod2Wiki=head_synopsis -->
+==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" );
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
-==Add-ons, patches and translations==
-* The [http://files.eprints.org/ EPrints Files Repository] contains add-on and 3rd party scripts, patches and translations. This also provides an archive of all previous EPrints releases (3.0 onwards).
+<!-- Pod2Wiki= -->
-* [[Files/]] Wiki pages about scripts and patches.
+</div>
+<!-- Pod2Wiki=head_description -->
+==DESCRIPTION==
+This module enables the integration of EPrints POD (documentation) and MediaWiki pages.
-{{Register}}
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
-==Contributing to EPrints==
-* [[Usability|EPrints usability]]
+<!-- Pod2Wiki= -->
-* [[:Category:New Features|New features in EPrints]] - released and proposed
+</div>
-* [[How to contribute|How to contribute to EPrints development]]
+<!-- Pod2Wiki=head_methods -->
-* [http://trac.eprints.org/ EPrints Trac] - access nightly builds, tickets and changes (requires free registration to view source code)
+==METHODS==
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
-== Content management ==
-* [[Digital preservation]]: managing content for longer-term access and use
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_new -->
+===EPrints::Test::Pod2Wiki-&gt;new( ... )===
-==EPrints 2 and Older Versions==
+Create a new Pod2Wiki parser. Required options:
-The manual for older versions of EPrints are available on the [http://www.eprints.org/documentation/tech/php/intro.php main EPrints site].
+  wiki_index - URL of the MediaWiki "index.php" page
+  username - MediaWiki username
+  password - MediaWiki password
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_update_page -->
+===$ok = $pod-&gt;update_page( $package_name )===
+Update the MediaWiki page for $package_name.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_command -->
+===$parser-&gt;command( ... )===
+{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_verbatim -->
+===$parser-&gt;verbatim( ... )===
+{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_textblock -->
+===$parser-&gt;textblock( ... )===
+{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_interpolate -->
+===$parser-&gt;interpolate( ... )===
+{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback. Overloaded to also escape HTML entities.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=item_interior_sequence -->
+===$parser-&gt;interior_sequence( ... )===
+{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback.
+<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+<span style='display:none'>User Comments</span>
+<!-- Edit below this comment -->
+<!-- Pod2Wiki= -->
+</div>
+<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Difference between revisions of "Main Page"

Revision as of 12:44, 25 February 2010

Contents

NAME

Editing Pod2Wiki Pages

SYNOPSIS

DESCRIPTION

METHODS

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

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

$parser->command( ... )

$parser->verbatim( ... )

$parser->textblock( ... )

$parser->interpolate( ... )

$parser->interior_sequence( ... )

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Wiki

Tools