NAME
Meta::Revision::Revision - an object representing full revision history.
COPYRIGHT
Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.
LICENSE
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
DETAILS
MANIFEST: Revision.pm
PROJECT: meta
VERSION: 0.20
SYNOPSIS
package foo;
use Meta::Revision::Revision qw();
my($object)=Meta::Revision::Revision->new();
my($result)=$object->printd($xml);
DESCRIPTION
This object represents a full revision history of a module. The object is able to print itself in DocBook xml format.
FUNCTIONS
new($)
print($$)
perl_pod($)
perl_current($)
docbook_revhistory_print($$)
docbook_revhistory($)
docbook_edition_print($$)
docbook_edition($)
docbook_date_print($$)
docbook_date($)
docbook_copyright_print($$$)
docbook_copyright($$)
html_last_print($$)
html_last($)
dtd_copyright($$)
dtd_history($)
TEST($)
FUNCTION DOCUMENTATION
- print($$)
-
This method prints the object to a regular file. The format is debug.
- perl_pod($)
-
This method will create a string representing the current revision information. The format is perl revision.
- perl_current($)
-
This method will return a the current perl module version of the X.YY form.
- docbook_revhistory_print($$)
-
This method prints the Revision history to an XML file writer. This format is XML docbook.
- docbook_revhistory($)
-
This method will create an XML string representing the current revision information.
- docbook_edition_print($$)
-
This will print the edition information to a XML::Writer type object.
- docbook_edition($)
-
This method will create an XML string representing the current edition information.
- docbook_date_print($$)
-
This will print the date information to a XML::Writer type object.
- docbook_date($)
-
This method will create an XML string representing the current date information.
- docbook_copyright_print($$$)
-
This will print the copyright information to a XML::Writer type object.
- docbook_copyright($$)
-
This method will create an XML string representing the current copyright information.
- html_last_print($$)
-
This will print a "page last modified at" html notice.
- html_last($)
-
This method will create an XML string representing the last modified information.
- dtd_copyright($$)
-
This method will produce a text suitable to be placed as copyright notice inside a DTD.
- dtd_history($)
-
This method will produce a text suitable to be placed as history revision inside a DTD.
- TEST($)
-
Test suite for this module.
SUPER CLASSES
Meta::Ds::Array(3)
BUGS
None.
AUTHOR
Name: Mark Veltzer
Email: mailto:veltzer@cpan.org
WWW: http://www.veltzer.org
CPAN id: VELTZER
HISTORY
0.00 MV more perl code quality
0.01 MV revision change
0.02 MV languages.pl test online
0.03 MV Revision in DocBook files stuff
0.04 MV PDMT stuff
0.05 MV C++ and temp stuff
0.06 MV perl packaging
0.07 MV md5 project
0.08 MV database
0.09 MV perl module versions in files
0.10 MV movies and small fixes
0.11 MV md5 progress
0.12 MV thumbnail user interface
0.13 MV more thumbnail issues
0.14 MV website construction
0.15 MV web site automation
0.16 MV SEE ALSO section fix
0.17 MV bring movie data
0.18 MV weblog issues
0.19 MV teachers project
0.20 MV md5 issues
SEE ALSO
IO::String(3), Meta::Baseline::Aegis(3), Meta::Ds::Array(3), Meta::Math::Pad(3), XML::Writer(3), strict(3)
TODO
-do we really need the print method here ? (doesnt the array have one like that ?)
-the date method here returns the data of the first edition. Is that right ?