API:EPrints/Test/Pod2Wiki: Difference between revisions
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
<!-- Pod2Wiki=_preamble_ | <!-- Pod2Wiki=_preamble_ | ||
This page has been automatically generated from the EPrints 3. | This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost. | ||
-->{{API}}{{Pod2Wiki}}{{API:Source|file= | -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Test/Pod2Wiki.pm|package_name=EPrints::Test::Pod2Wiki}}[[Category:API|POD2WIKI]][[Category:API:EPrints/Test|POD2WIKI]]<div><!-- Edit below this comment --> | ||
| Line 8: | Line 8: | ||
EPrints::Test::Pod2Wiki - convert EPrints pod to MediaWiki | EPrints::Test::Pod2Wiki - convert EPrints pod to MediaWiki | ||
<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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | |||
<!-- Pod2Wiki=head_editing_pod2wiki_pages --> | <!-- Pod2Wiki=head_editing_pod2wiki_pages --> | ||
==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: | 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: | ||
<!-- Pod2Wiki=head_synopsis --> | |||
==SYNOPSIS== | ==SYNOPSIS== | ||
use EPrints::Test::Pod2Wiki; | use EPrints::Test::Pod2Wiki; | ||
my $p = EPrints::Test::Pod2Wiki-&gt;new( | my $p = EPrints::Test::Pod2Wiki-&gt;new( | ||
wiki_api =&gt; "http://wiki.foo.org/api.php", | |||
username =&gt; "johnd", | username =&gt; "johnd", | ||
password =&gt; "xiPi00", | password =&gt; "xiPi00", | ||
| Line 26: | Line 29: | ||
$p-&gt;update_page( "EPrints::Utils" ); | $p-&gt;update_page( "EPrints::Utils" ); | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
When the Wiki page is updated each Pod2Wiki section is replaced with the equivalent section content from the POD. | 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: | Comments can be made by adding them to the comment sections: | ||
... | |||
<!-- Pod2Wiki=head_methods --> | <!-- Pod2Wiki=head_methods --> | ||
==METHODS== | ==METHODS== | ||
| Line 39: | Line 42: | ||
This Wiki comment will be kept. | This Wiki comment will be kept. | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
... | ... | ||
Note: if a POD section is removed any Wiki content associated with that section will also be removed. | 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 <em>EPrints::Test::Pod2Wiki</em> module. | The rest of this page concerns the <em>EPrints::Test::Pod2Wiki</em> module. | ||
<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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | |||
<!-- Pod2Wiki=head_synopsis --> | <!-- Pod2Wiki=head_synopsis --> | ||
==SYNOPSIS== | ==SYNOPSIS== | ||
use EPrints::Test::Pod2Wiki; | |||
my $p = EPrints::Test::Pod2Wiki- | my $p = EPrints::Test::Pod2Wiki->new( | ||
wiki_api => "http://wiki.foo.org/api.php", | |||
username => "johnd", | |||
password => "xiPi00", | |||
); | |||
$p- | $p->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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | |||
<!-- Pod2Wiki=head_description --> | <!-- Pod2Wiki=head_description --> | ||
==DESCRIPTION== | ==DESCRIPTION== | ||
This module enables the integration of EPrints POD (documentation) and MediaWiki pages. | This module enables the integration of EPrints POD (documentation) and MediaWiki pages. | ||
<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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | |||
<!-- Pod2Wiki=head_methods --> | <!-- Pod2Wiki=head_methods --> | ||
==METHODS== | ==METHODS== | ||
<!-- Pod2Wiki= | <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_new --> | |||
===new=== | ===new=== | ||
EPrints::Test::Pod2Wiki->new( $class, %opts ) | |||
Create a new Pod2Wiki parser. Required options: | Create a new Pod2Wiki parser. Required options: | ||
wiki_api - URL of the MediaWiki "api.php" page | |||
username - MediaWiki username | username - MediaWiki username | ||
password - MediaWiki password | 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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
<!-- Pod2Wiki= | </div> | ||
<!-- Pod2Wiki=item_update_page --> | |||
===update_page=== | ===update_page=== | ||
$ok = $pod->update_page( $package_name, $selfcat ) | |||
Update the MediaWiki page for $package_name. If $selfcat then add to its own category. | |||
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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
<!-- Pod2Wiki= | </div> | ||
<!-- Pod2Wiki=item_command --> | |||
===command=== | ===command=== | ||
$parser->command( $cmd, $text, $line_num, $pod_para ) | |||
{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback. | {{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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
<!-- Pod2Wiki= | </div> | ||
<!-- Pod2Wiki=item_verbatim --> | |||
===verbatim=== | ===verbatim=== | ||
$parser->verbatim( $text, $line_num, $pod_para ) | |||
{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback. | {{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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
<!-- Pod2Wiki= | </div> | ||
<!-- Pod2Wiki=item_textblock --> | |||
===textblock=== | ===textblock=== | ||
$parser->textblock( $text, $line_num, $pod_para ) | |||
{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback. | {{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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
<!-- Pod2Wiki= | </div> | ||
<!-- Pod2Wiki=item_interpolate --> | |||
===interpolate=== | ===interpolate=== | ||
$parser->interpolate( $text, $line_num ) | |||
{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback. Overloaded to also escape HTML entities. | {{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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
<!-- Pod2Wiki= | </div> | ||
<!-- Pod2Wiki=item_interior_sequence --> | |||
===interior_sequence=== | ===interior_sequence=== | ||
$parser->interior_sequence( $seq_cmd, $seq_arg, $pod_seq ) | |||
{{API:PodLink|file=Pod/Parser|package_name=Pod::Parser|section=|text=Pod::Parser}} callback. | {{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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | |||
<!-- Pod2Wiki=head_copyright --> | <!-- Pod2Wiki=head_copyright --> | ||
==COPYRIGHT== | ==COPYRIGHT== | ||
Copyright | {{API:Copyright}} | ||
<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 --> | <!-- Edit below this comment --> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
<!-- Pod2Wiki=_postamble_ --> | </div> | ||
<!-- Edit below this comment --> | <!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment --> | ||
Latest revision as of 08:46, 15 December 2021
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
NAME[edit]
EPrints::Test::Pod2Wiki - convert EPrints pod to MediaWiki
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->new( wiki_api => "http://wiki.foo.org/api.php", username => "johnd", password => "xiPi00", ); $p->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.
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" );
DESCRIPTION[edit]
This module enables the integration of EPrints POD (documentation) and MediaWiki pages.
METHODS[edit]
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
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.
command[edit]
$parser->command( $cmd, $text, $line_num, $pod_para )
Pod::Parser callback.
verbatim[edit]
$parser->verbatim( $text, $line_num, $pod_para )
Pod::Parser callback.
textblock[edit]
$parser->textblock( $text, $line_num, $pod_para )
Pod::Parser callback.
interpolate[edit]
$parser->interpolate( $text, $line_num )
Pod::Parser callback. Overloaded to also escape HTML entities.
interior_sequence[edit]
$parser->interior_sequence( $seq_cmd, $seq_arg, $pod_seq )
Pod::Parser callback.
COPYRIGHT[edit]
© Copyright 2000-2024 University of Southampton.
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/.