Peter Lavender > Padre-0.98 > Padre::Browser

Download:
Padre-0.98.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.98   Source   Latest Release: Padre-1.00

NAME ^

Padre::Browser -- documentation browser for Padre

DESCRIPTION ^

Provide an interface for retrieving / generating documentation, resolving terms to documentation (search?) and formatting documentation.

Allow new packages to be loaded and interrogated for the MIME types they can generate documentation for. Provide similar mechanism for registering new documentation viewers and URI schemes accepted for resolving.

NOTE: I think all the method names are wrong. Blast it.

SYNOPSIS ^

  # Does perlish things by default via 'Padre::Browser::POD'
  my $browser = Padre::Browser->new;
  my $source = Padre::Document->new( filename=>'source/Package.pm' );

  my $docs = $browser->docs( $source );
  # $docs provided by Browser::POD->generate
  #  should be Padre::Browser::Document , application/x-pod

  my $output = $browser->browse( $docs );
  # $output provided by Browser::POD->render
  #  should be Padre::Document , text/x-html

  $browser->load_viewer( 'Padre::Browser::PodAdvanced' );
  # PodAdvanced->render might add an html TOC in addition to
  #  just pod2html

  my $new_output = $browser->browse( $docs );
  # $new_output now with a table of contents

METHODS ^

new

Boring constructor, pass nothing. Yet.

load_provider

Accepts a single class name, will attempt to auto-use the class and interrogate its provider_for method. Any MIME types returned will be associated with the class for dispatch to generate.

Additionally, interrogate class for accept_schemes and associate the class with URI schemes for dispatch to resolve.

load_viewer

Accepts a single class name, will attempt to auto-use the class and interrogate its viewer_for method. Any MIME types returned will be associated with the class for dispatch to render.

resolve

Accepts a URI or scalar

browse

accept

EXTENDING ^

  package My::Browser::Doxygen;

  # URI of doxygen:$string or doxygen://path?query
  sub accept_schemes {
      'doxygen',
  }

  sub provider_for {
      'text/x-c++src'
  }

  sub viewer_for {
      'text/x-doxygen',
  }

  sub generate {
      my ($self,$doc) = @_;
      # $doc will be Padre::Document of any type specified
      # by ->provider_for

      # push $doc through doxygen
      # ...
      # that was easy :)

      # You know your own output type, be explicit
      my $response = Padre::Document->new;
      $response->{original_content} = $doxygen->output;
      $response->set_mimetype( 'text/x-doxygen' );
      return $response;
  }

  sub render {
      my ($self,$docs) = @_;
      # $docs will be of any type specified
      # by ->viewer_for;

      ## turn $docs into doxygen(y) html document
      #  ...
      #

      my $response = Padre::Document->new;
      $response->{original_content} = $doxy2html->output;
      $response->set_mimetype( 'text/x-html' );
      return $response;

  }
syntax highlighting: