NAME¶

Publican::WebSite - Manage a documentation website

VERSION¶

This document describes Publican::WebSite version 0.0.1

SYNOPSIS¶

    use Publican::WebSite;

    my $ws = Publican::WebSite::new();
        $ws->add($product, $version, $name, $format);
    foreach my $entry ($ws->list()) { ... }
    $ws->del($product, $version, $name, $format);

DESCRIPTION¶

INTERFACE¶

new¶

Create a Publican::WebSite object...

add_entry¶

Add an entry to the current Publican::WebSite DB... Returns number of rows added. Should be 1 for success, 0 for failure.

update_entry¶

Update an existing entry in the current Publican::WebSite DB... Returns number of rows added. Should be 1 for success, 0 for failure.

update_or_add_entry¶

Update an existing entry if it esists, else create a new entry.

del_entry¶

Delete an entry from the current Publican::WebSite DB... Returns number of rows deleted. Should be 1 for success, 0 for failure.

get_entry_id¶

Get the ID of a book from the Publican::WebSite DB. Returns the ID or NULL.

get_hash_ref¶

Returns a reference to a has of all books for the selected language.

get_lang_list¶

Returns an array ref of distinct, osrted, languages.

regen_all_toc¶

Update the toc html files for every language.

report¶

Returns a string containing the current database statistics.

stats¶

Generate Site_Statistics.html containing the current database statistics.

validate¶

Validate the database entries against the RPM database. TODO should also/instead compare entires aginst web site files?

version_sort¶

Sort version strings in to correct order, handles X, X.Y, and X.Y.Z formats.

toc_path¶

Return the full toc path.

xml_dump¶

Generate an XML dump, and a zip of the dump if required, of the Database.

DIAGNOSTICS¶

"Error message here, perhaps with %s placeholders"

[Description of error here]

"Another error message here"

[Description of error here]

 

[Et cetera, et cetera]

CONFIGURATION AND ENVIRONMENT¶

Publican::WebSite requires no configuration files or environment variables.

DEPENDENCIES¶

None.

INCOMPATIBILITIES¶

None reported.

BUGS AND LIMITATIONS¶

No bugs have been reported. Please report any bugs or feature requests to "bug-documentation-website@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.

AUTHOR¶

Jeff Fearn "<jfearn@redhat.com>"

LICENCE AND COPYRIGHT¶

Copyright (c) 2007, Jeff Fearn "<jfearn@redhat.com>". All rights reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY¶

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.