2. EL 7
  3. publican
  4. Publican::WebSite(3pm)

Scroll to navigation

Publican::WebSite(3) User Contributed Perl Documentation Publican::WebSite(3)

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, sorted, languages.

regen_all_toc

Update the toc html files for every language.

report

Returns a string containing the current database statistics.

validate

Validate the database entries against the RPM database.

TODO should also/instead compare entires aginst web site files?

v_sort

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

i_sort

Sort strings case insensitvly.

toc_path

Return the full toc path.

xml_dump

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

search_string

Returns a string for the web page search box.

lang_name

Returns a string of the localise name for a language. e.g. fr-FR => Francais

splash_pages

Main function for generating splash pages for web 2 style.

write_books_index

Writes an index page for a book for web 2 style.

write_language_index

Writes an index page for a language for web 2 style.

write_product_index

Writes an index page for a product for web 2 style.

write_product_menu

Writes a menu page for a product for web 2 style.

write_version_index

Writes an index page for a for web 2 style.

write_language_labels

Writes a javascript file with an associative array of labels.

MigrateDB

Migrate a website DataBase from Publican < 3 to Publican 3.

insensitive_sort

Sort strings in a case insensitive order.

version_sort

Sort version strings in correct order. Handles X Vs X.Y Vs X.Y.Z.

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.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Non-ASCII character seen before =encoding in 'Francais'. Assuming UTF-8
2014-12-15 perl v5.16.3