Download Shareware and Freeware Software for Windows, Linux, Macintosh, PDA

line Home  |  About Us  |  Link To Us  |  FAQ  |  Contact

Serving Software Downloads in 976 Categories, Downloaded 29.895.584 Times

Pod::Template 0.02

  Date Added: February 09, 2010  |  Visits: 585


Report Broken Link
Printer Friendly Version

Product Homepage
Download (74 downloads)

Pod::Template is a Perl module for building pod documentation from templates. SYNOPSIS ### As a module ### use Pod::Template; my $parser = new Pod::Template; $parser->parse( template => documentation.ptmpl ); print $parser->as_string ### As a script ### $ podtmpl -I dir1 -I dir2 documentation.ptmpl ### A simple module prepared to use Pod::Template ### package My::Module; =Template print_me =head2 print_me( $string ) Prints out its argument. =cut sub print_me { print shift; return 1 } ### A simple pod file named Extra/Additional.pod ### =pod =Template return_vals This subroutine returns 1 for success and undef for failure. =cut ### A simple Pod::Template template ### =Include My::Module =Include Extra/Additional.pod as Extra =pod =head1 SYNOPSIS use My::Module My::Module::print_me(some text); =head2 Functions =Insert My::Module->print_me =Insert Extra->return_vals =cut Writing documentation on a project maintained by several people which spans more than one module is a tricky matter. There are many things to consider: Location Should pod be inline (above every function), at the bottom of the module, or in a distinct file? The first is easier for the developers, but the latter two are better for the pod maintainers. Order What order should the documentation be in? Does it belong in the order in which the functions are written, or ordered by another principle, such as frequency of use or function type? Again, the first option is better for the developers, while the second two are better for the user. References How should a function in another file be mentioned? Should the documentation simply say see Other::Module, or should it include the relevant section? Duplication means that the documentation is more likely to be outdated, but its bad for a user to have to read numerous documents to simply find out what an inherited method does. Headers & Footers What should be done with standard headers and footers? Should they be pasted in to every file, or can the main file be assumed to cover the entire project? Pod::Template offers a solution to these problems: documentation is built up from templates..

Requirements: No special requirements
Platforms: Linux
Keyword: Documentation File Libraries Module Perl Module Pod Podtemplate Print Programming Template
Users rating: 0/10

License: Freeware Size: 8.19 KB
More Reviews or Write Review

Libraries  -  Config::File 1.4
Config::File is a Perl module to parse a simple configuration file. SYNOPSIS use Config::File; my $config_hash = Config::File::read_config_file($configuration_file); read_config_file parses a simple configuration file and stores its values...
4.1 KB  
Libraries  -  App::Conf::File 0.965
App::Conf::File is a Perl module to load and access configuration data. SYNOPSIS use App::Conf; $config = App::Conf->new(); $config = App::Conf->new(configFile => $file); print $config->dump(), "n"; # use Data::Dumper to spit out the Perl...
122.88 KB  
Libraries  -  MP3::Tag::File 0.9708
MP3::Tag::File is a Perl module for reading / writing files. SYNOPSIS my $mp3 = MP3::Tag->new($filename); ($title, $artist, $no, $album, $year) = $mp3->parse_filename(); see MP3::Tag MP3::Tag::File is designed to be called from the...
174.08 KB  
Libraries  -  Alien Perl module 0.91
Alien Perl module package contains external libraries wrapped up for your viewing pleasure! SYNOPSIS perldoc Alien; Alien is a package that exists just to hold together an idea, the idea of Alien:: packages, so there is no code here, just...
10.24 KB  
Libraries  -  Pod::PlainText 1.34
Pod::PlainText is a Perl module that can convert POD data to formatted ASCII text. SYNOPSIS use Pod::PlainText; my $parser = Pod::PlainText->new (sentence => 0, width => 78); # Read POD from STDIN and write to STDOUT....
96.26 KB  
Libraries  -  Pod::XML 0.96
Pod::XML is a Perl module to convert POD to XML. SYNOPSIS use Pod::XML; my $parser = Pod::XML->new(); $parser->parse_from_file("foo.pod"); This module uses Pod::Parser to parse POD and generates XML from the resulting parse stream. It uses...
7.17 KB  
Libraries  -  File::Maker 0.05
File::Maker is a Perl module that mimics a make by loading a database and calling targets methods. SYNOPSIS ##### # Subroutine interface # use File::Maker qw(load_db); %data = load_db($pm); ###### # Object interface # require...
77.82 KB  
Libraries  -  File::Where 0.05
File::Where is a Perl module to find the absolute file for a program module; absolute dir for a repository. SYNOPSIS ####### # Subroutine interface # use File::Where qw(pm2require where where_dir where_file where_pm where_repository);...
83.97 KB  
Libraries  -  ExtUtils::Manifest 1.51
ExtUtils::Manifest is a Perl module that contains utilities to write and check a MANIFEST file. SYNOPSIS use ExtUtils::Manifest qw(...funcs to import...); mkmanifest(); my @missing_files = manicheck; my @skipped = skipcheck; my...
17.41 KB  
Libraries  -  Test::Manifest 1.17
Test::Manifest is a Perl module created to interact with a t/test_manifest file. SYNOPSIS # in Makefile.PL eval "use Test::Manifest"; # in the file t/test_manifest, list the tests you want # to run Test::Harness assumes that you want to...
7.17 KB  
Programming  -  FLEX-db Digital Asset Manager 3.0.9
FLEX-db - an enterprise Digital Asset Manager (DAM). It ingests and links metadata with files, creates thumbnails, and processes files using business rules. FLEX-db has a JSP client, Java app server for file input and output and an EJB metadata...
21.57 MB  
Programming  -  Libicom 0.9.0
The libicom library is a character based dynamicly linked library for Linux. It is used to remotely control the Icom IC-R8500 wide band receiver via an RS232 link. All call and return parameters to the control functions are character string based....
20.48 KB  
Programming  -  dotdesktop 0.3
Dotdesktop library provides ability to parse desktop entry file and access the information in a convenient way. Desktop entry file format is defined by, it is used to describe information about an application such as the name and...
327.68 KB  
Programming  -  Cedalion for Linux 0.2.6
Cedalion is a programming language that allows its users to add new abstractions and define (and use) internal DSLs. Its innovation is in the fact that it uses projectional editing to allow the new abstractions to have no syntactic limitations.
471.04 KB  
Programming  -  libyasl 0.2
Libyasl is a C++ class library to easily realize TCP/UDP/Multicast clientsand servers in IPv4 and IPv6 environments under GNU/Linux systems.
143.36 KB  
Libraries  -  wolfSSL 3.11.0
The wolfSSL embedded SSL/TLS library is a lightweight SSL library written in ANSI standard C and targeted for embedded and RTOS environments - primarily because of its small size, speed, and feature set. It is commonly used in standard operating...
2.73 MB  
Libraries  -  EuGTK 4.8.9
Makes it easy to develop good- looking, fast, cross-platform programs that run on Linux, OS X, and Windows. Euphoria is a very fast interpreted/compiled language with straight-forward syntax. EuGTK allows programming in a clean, object-oriented...
10.68 MB  
Libraries  -  Linux User Group Library Manager 1.0
The LUG Library Manager is a project to help Linux User Groups start their own library. A LUG library is helpful to the community at large because it increases access to information, and gives everyone the opportunity to become more knowledgeable.
5.35 KB  
Libraries  -  Module::MakefilePL::Parse 0.12
Module::MakefilePL::Parse is a Perl module to parse required modules from Makefile.PL. SYNOPSIS use Module::MakefilePL::Parse; open $fh, Makefile.PL; $parser = Module::MakefilePL::Parse->new( join("", ) ); $info = $parser->required;...
8.19 KB  
Libraries  -  sqlpp 0.06
sqlpp Perl package is a SQL preprocessor. sqlpp is a conventional cpp-alike preprocessor taught to understand SQL ( PgSQL, in particular) syntax specificities. In addition to the standard #define/#ifdef/#else/#endif cohort, provides also...
10.24 KB