GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Pod::WikiDoc::Cookbook(3) User Contributed Perl Documentation Pod::WikiDoc::Cookbook(3)

Pod::WikiDoc::Cookbook - Examples of Pod::WikiDoc usage

version 0.21

This file contains some examples of ways to use Pod::WikiDoc or to integrate Pod::WikiDoc with other tools.

(Seeking equivalent settings for other editors or alternatives for vim.)

Vim

In vim, use the "comments" and "formatoptions" settings in ".vimrc" to have vim automatically insert the wikidoc comment leader when pressing return from a wikidoc comment line. For example, the following lines in a ".vimrc" file will activate this option whenever a perl-ish file is loaded.

     autocmd BufNewFile,BufRead *.p? set comments=b:###
     autocmd BufNewFile,BufRead *.p? set formatoptions+=r

With a little extra work in the Build.PL file, Pod::WikiDoc can work easily with Module::Build to extract wikidoc into .pod files automatically during the distribution process

The Build.PL file below subclasses Module::Build with three functions:

  • ACTION_wikidoc -- adds a new "Build wikidoc" action that extracts Pod and wikidoc from all .pm files in the "lib" directory and adds them to the MANIFEST
  • ACTION_testpod -- adds a dependency on the "wikidoc" action to regenerate .pod files before testing them
  • ACTION_distdir -- adds a dependency on the "wikidoc" action to regenerate .pod files before bundling up a distribution

As an extra feature, ACTION_wikidoc also sets a VERSION keyword that can be used to insert the current version number into the generated Pod.

     = VERSION
     This documentation refers to version %%VERSION%%.

By making wikidoc extraction part of the "distdir" action, users installing the distribution will receive it with .pod files already created, and will not need to have Pod::WikiDoc installed themselves.

     # Build.PL
     use Module::Build;
 
     my $class = Module::Build->subclass(
         class => "Module::Build::WikiDoc",
         code => <<'SUBCLASS' );
 
         sub ACTION_wikidoc {
             my $self = shift;
             eval "use Pod::WikiDoc";
             if ( $@ eq '' ) {
                 my $parser = Pod::WikiDoc->new( {
                     comment_blocks => 1}
                     keywords => { VERSION => $self->dist_version },
                 });
                 for my $src ( keys %{ $self->find_pm_files() } ) {
                     (my $tgt = $src) =~ s{\.pm$}{.pod};
                     $parser->filter( {
                         input   => $src,
                         output  => $tgt,
                     });
                     print "Creating $tgt\n";
                     $tgt =~ s{\\}{/}g; # for win32
                     $self->_add_to_manifest( 'MANIFEST', $tgt );
                 }
             }
             else {
                 warn "Pod::WikiDoc not available. Skipping wikidoc.\n";
             }
         }
 
         sub ACTION_testpod {
             my $self = shift;
             $self->depends_on('wikidoc');
             $self->SUPER::ACTION_testpod;
         }
 
         sub ACTION_distdir {
             my $self = shift;
             $self->depends_on('wikidoc');
             $self->SUPER::ACTION_distdir;
         }
 
     SUBCLASS
 
     $class->new(
         # regular Module::Build options
     )->create_build_script;

To add extra documentation files to a distribution, create them as .pm files and let Pod::WikiDoc convert them as normal. To prevent the .pm files from being indexed (e.g. by search.cpan.org), list them as "no_index" in the META.yml file of the distribution.

Example of a simple .pm documentation file:

     package Some::Module::About;
     use strict; # make CPANTS happy
     1;
     __END__
 
     =begin wikidoc
 
     Your wikidoc goes here.
 
     =end wikidoc

Adding "no_index" to META.yml via Build.PL (requires Module::Build 0.28):

     my $builder = $class->new(
         # regular Module::Build options
         meta_add            => {
             no_index => {
                 file => [ qw{
                     lib/Some/Module/About.pm
                 } ]
             }
         },
     );

David A Golden <dagolden@cpan.org>

This software is Copyright (c) 2017 by David A Golden.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
2017-05-08 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.