BASIS  r3148
Head1.pm
Go to the documentation of this file.
00001 #============================================================= -*-Perl-*-
00002 #
00003 # Pod::POM::Node::Head1
00004 #
00005 # DESCRIPTION
00006 #   Module implementing specific nodes in a Pod::POM, subclassed from
00007 #   Pod::POM::Node.
00008 #
00009 # AUTHOR
00010 #   Andy Wardley   <abw@kfs.org>
00011 #   Andrew Ford    <a.ford@ford-mason.co.uk>
00012 #
00013 # COPYRIGHT
00014 #   Copyright (C) 2000, 2001 Andy Wardley.  All Rights Reserved.
00015 #   Copyright (C) 2009 Andrew Ford.  All Rights Reserved.
00016 #
00017 #   This module is free software; you can redistribute it and/or
00018 #   modify it under the same terms as Perl itself.
00019 #
00020 # REVISION
00021 #   $Id: Head1.pm 76 2009-08-20 20:41:33Z ford $
00022 #
00023 #========================================================================
00024 
00025 package BASIS::Pod::POM::Node::Head1;
00026 
00027 use strict;
00028 
00029 use parent qw( BASIS::Pod::POM::Node );
00030 use vars qw( %ATTRIBS @ACCEPT $ERROR );
00031 
00032 %ATTRIBS =   ( title => undef );
00033 @ACCEPT  = qw( head2 head3 head4 over begin for text verbatim code );
00034 
00035 sub new {
00036     my ($class, $pom, $title) = @_;
00037     $title = $pom->parse_sequence($title)
00038     || return $class->error($pom->error())
00039         if length $title;
00040     return $class->SUPER::new($pom, $title);
00041 }
00042 
00043 1;
00044 
00045 =head1 NAME
00046 
00047 Pod::POM::Node::Head1 -
00048 
00049 =head1 SYNOPSIS
00050 
00051     use Pod::POM::Nodes;
00052 
00053 =head1 DESCRIPTION
00054 
00055 This module implements a specialization of the node class to represent C<=head1> elements.
00056 
00057 =head1 AUTHOR
00058 
00059 Andrew Ford E<lt>a.ford@ford-mason.co.ukE<gt>
00060 
00061 Andy Wardley E<lt>abw@kfs.orgE<gt>
00062 
00063 =head1 COPYRIGHT
00064 
00065 Copyright (C) 2000, 2001 Andy Wardley.  All Rights Reserved.
00066 
00067 Copyright (C) 2009 Andrew Ford.  All Rights Reserved.
00068 
00069 This module is free software; you can redistribute it and/or
00070 modify it under the same terms as Perl itself.
00071 
00072 =head1 SEE ALSO
00073 
00074 Consult L<Pod::POM::Node> for a discussion of nodes.