1Publican::WebSite(3)  User Contributed Perl Documentation Publican::WebSite(3)
2
3
4

NAME

6       Publican::WebSite - Manage a documentation website
7

VERSION

9       This document describes Publican::WebSite version 0.0.1
10

SYNOPSIS

12           use Publican::WebSite;
13
14           my $ws = Publican::WebSite::new();
15
16               $ws->add($product, $version, $name, $format);
17
18           foreach my $entry ($ws->list()) { ... }
19
20           $ws->del($product, $version, $name, $format);
21

DESCRIPTION

INTERFACE
24   new
25       Create a Publican::WebSite object...
26
27   add_entry
28       Add an entry to the current Publican::WebSite DB...
29
30       Returns number of rows added. Should be 1 for success, 0 for failure.
31
32   update_entry
33       Update an existing entry in the current Publican::WebSite DB...
34
35       Returns number of rows added. Should be 1 for success, 0 for failure.
36
37   update_or_add_entry
38       Update an existing entry if it esists, else create a new entry.
39
40   del_entry
41       Delete an entry from the current Publican::WebSite DB...
42
43       Returns number of rows deleted. Should be 1 for success, 0 for failure.
44
45   get_entry_id
46       Get the ID of a book from the Publican::WebSite DB.
47
48       Returns the ID or NULL.
49
50   get_hash_ref
51       Returns a reference to a has of all books for the selected language.
52
53   get_lang_list
54       Returns an array ref of distinct, osrted, languages.
55
56   regen_all_toc
57       Update the toc html files for every language.
58
59   report
60       Returns a string containing the current database statistics.
61
62   stats
63       Generate Site_Statistics.html containing the current database
64       statistics.
65
66   validate
67       Validate the database entries against the RPM database.
68
69       TODO should also/instead compare entires aginst web site files?
70
71   version_sort
72       Sort version strings in to correct order, handles X, X.Y, and X.Y.Z
73       formats.
74
75   toc_path
76       Return the full toc path.
77
78   xml_dump
79       Generate an XML dump, and a zip of the dump if required, of the
80       Database.
81

DIAGNOSTICS
83       "Error message here, perhaps with %s placeholders"
84           [Description of error here]
85
86       "Another error message here"
87           [Description of error here]
88
89           [Et cetera, et cetera]
90

CONFIGURATION AND ENVIRONMENT
92       Publican::WebSite requires no configuration files or environment
93       variables.
94

DEPENDENCIES
96       None.
97

INCOMPATIBILITIES
99       None reported.
100

BUGS AND LIMITATIONS
102       No bugs have been reported.
103
104       Please report any bugs or feature requests to
105       "bug-documentation-website@rt.cpan.org", or through the web interface
106       at <http://rt.cpan.org>.
107

AUTHOR
109       Jeff Fearn  "<jfearn@redhat.com>"
110

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

DISCLAIMER OF WARRANTY
119       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
120       FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
121       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
122       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
123       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
124       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
125       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
126       YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
127       NECESSARY SERVICING, REPAIR, OR CORRECTION.
128
129       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
130       WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
131       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
132       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
133       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
134       SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
135       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
136       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
137       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
138       DAMAGES.
139
140
141
142perl v5.12.4                      2011-09-22              Publican::WebSite(3)



        

    


            
        

        

            Impressum