pod::index::entry(3pm) [debian man page]

Pod::Index::Entry(3pm)					User Contributed Perl Documentation				    Pod::Index::Entry(3pm)

NAME

       Pod::Index::Entry - Represents Pod search result

SYNOPSIS

	   use Pod::Index::Entry;

	   my $entry =	Pod::Index::Entry->new(
	       keyword	=> 'constructors',
	       podname	=> 'perlobj',
	       line	=> 42,
	       filename => '/usr/lib/perl5/5.8.7/pod/perlobj.pod',
	       context	=> 'Using POD',
	   );

	   # trivial accessors
	   my $podname	= $entry->podname;
	   my $filename = $entry->filename;
	   my $line	= $entry->line;
	   my $context	= $entry->context;
	   my $keyword	= $entry->keyword;

	   # extract the POD for this entry
	   my $pod	= $entry->pod;

DESCRIPTION

       This class represents a POD index entry. An entry is defined by the podname/filename, line number, and context. The entry object also has
       the ability to extract the POD "scope" from the filename.

METHODS

       new
	       my $q = Pod::Index::Entry->new(%args);

	   Create a new search object. Possible arguments are:

	   podname
	       The name of the pod, such as .

	   filename
	       The filename for the pod, such as Data/Dumper.pm.

	   line
	       The line number where the scope of this entry begins.

	   context
	       The title of the section that contains this entry.

       podname
       filename
       line
       context
	   These are just simple accessors that return the value of these properties, as given to the constructor.

       pod Extracts the POD for the scope of the entry from $self->filename, beginning at $self->line. For a definition of scope, see Pod::Index.
	   The POD extraction is delegated to the Pod::Index::Extract module.

VERSION

       0.14

SEE ALSO

       Pod::Index, Pod::Index::Search, Pod::Index::Extract

AUTHOR

       Ivan Tubert-Brohman <itub@cpan.org>

COPYRIGHT

       Copyright (c) 2005 Ivan Tubert-Brohman. All rights reserved. This program is free software; you can redistribute it and/or modify it under
       the same terms as Perl itself.

perl v5.10.0							    2005-10-16						    Pod::Index::Entry(3pm)

Pod::Tree::Pod(3pm)					User Contributed Perl Documentation				       Pod::Tree::Pod(3pm)

NAME

       Pod::Tree::Pod - Convert a Pod::Tree back to a POD

SYNOPSIS

	 use Pod::Tree::Pod;

	 $tree =  new Pod::Tree;

	 $dest =  new IO::File;
	 $dest = "file.pod";

	 $pod  =  new Pod::Tree::Pod $tree, $dest;

	 $pod->translate;

DESCRIPTION

       "Pod::Tree::Pod" converts a Pod::Tree back to a POD.  The destination is fixed when the object is created.  The "translate" method does the
       actual translation.

       For convenience, Pod::Tree::Pod can write the POD to a variety of destinations.	The "new" method resolves the $dest argument.

   Destination resolution
       "Pod::Tree::Pod" can write HTML to either of 2 destinations.  "new" resolves $dest by checking these things, in order:

       1.  If $dest is a reference, then it is taken to be an "IO::File" object that is already open on the file where the POD will be written.

       2.  If $dest is not a reference, then it is taken to be the name of the file where the POD will be written.

METHODS

       $pod = "new" "Pod::Tree::Pod" $tree, $dest
	   Creates a new "Pod::Tree::Pod" object.

	   $tree is a "Pod::Tree" object that represents a POD.  $pod writes the POD to $dest.	See "Destination resolution" for details.

       $pod->"translate"
	   Writes the text of the POD.	This method should only be called once.

DIAGNOSTICS

       "Pod::Tree::Pod::new: not enough arguments"
	   (F) "new" called with fewer than 2 arguments.

       "Pod::Tree::HTML::new: Can't open $dest: $!"
	   (F) The destination file couldn't be opened.

NOTES

       o   The destination doesn't actually have to be an "IO::File" object.  It may be any object that has a "print" method.

SEE ALSO

       perl(1), "Pod::Tree", "Pod::Tree::Node"

AUTHOR

       Steven McDougall, swmcd@world.std.com

COPYRIGHT

       Copyright (c) 2000-2003 by Steven McDougall. This module is free software; you can redistribute it and/or modify it under the same terms as
       Perl itself.

perl v5.10.1							    2004-10-11						       Pod::Tree::Pod(3pm)