lib/Parrot/Docs/Section/Docs.pm

   1 # Copyright (C) 2004, The Perl Foundation.
   2 # $Id$
   3
   4 =head1 NAME
   5
   6 Parrot::Docs::Section::Docs - Docs documentation section
   7
   8 =head1 SYNOPSIS
   9
  10         use Parrot::Docs::Section::Docs;
  11
  12 =head1 DESCRIPTION
  13
  14 A documentation section describing all the POD documentation in F<docs>.
  15
  16 =head2 Class Methods
  17
  18 =over
  19
  20 =cut
  21
  22 package Parrot::Docs::Section::Docs;
  23
  24 use strict;
  25 use warnings;
  26
  27 use base qw( Parrot::Docs::Section );
  28
  29 =item C<new()>
  30
  31 Returns a new section.
  32
  33 =cut
  34
  35 sub new {
  36     my $self = shift;
  37
  38     return $self->SUPER::new(
  39         'Documentation',
  40         'docs.html',
  41         '',
  42         $self->new_group(
  43             'General Documentation',
  44             '',
  45             $self->new_item( '', 'docs/overview.pod' ),
  46             $self->new_item( '', 'docs/intro.pod' ),
  47             $self->new_item( '', 'docs/gettingstarted.pod' ),
  48             $self->new_item( '', 'docs/submissions.pod' ),
  49             $self->new_item( '', 'docs/glossary.pod' ),
  50             $self->new_item( '', 'docs/faq.pod' ),
  51             $self->new_item( '', 'docs/parrot.pod' ),
  52         ),
  53         $self->new_group(
  54             'Specific Documentation',
  55             '',
  56             $self->new_item( '', 'docs/configuration.pod' ),
  57             $self->new_item( '', 'docs/vtables.pod' ),
  58             $self->new_item( '', 'docs/mmd.pod' ),
  59             $self->new_item( '', 'docs/memory_internals.pod' ),
  60             $self->new_item( '', 'docs/parrotbyte.pod' ),
  61             $self->new_item( '', 'docs/jit.pod' ),
  62             $self->new_item( '', 'docs/native_exec.pod' ),
  63             $self->new_item( '', 'docs/running.pod' ),
  64             $self->new_item( '', 'docs/porting_intro.pod' ),
  65             $self->new_item( '', 'docs/debug.pod' ),
  66             $self->new_item( '', 'docs/debugger.pod' ),
  67             $self->new_item( '', 'docs/tests.pod' ),
  68             $self->new_item( '', 'docs/embed.pod' ),
  69         ),
  70         $self->new_group( 'Development Documentation',     '', 'docs/dev' ),
  71         $self->new_group( 'PMC Documentation',             '', 'docs/pmc' ),
  72         $self->new_group( 'Parrot Design Documents (PDD)', '', 'docs/pdds' ),
  73         $self->new_group( 'Articles',                      '', 'docs/art' ),
  74     );
  75 }
  76
  77 =back
  78
  79 =cut
  80
  81 1;
  82
  83 # Local Variables:
  84 #   mode: cperl
  85 #   cperl-indent-level: 4
  86 #   fill-column: 100
  87 # End:
  88 # vim: expandtab shiftwidth=4: