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   del_entry
38       Delete an entry from the current Publican::WebSite DB...
39
40       Returns number of rows deleted. Should be 1 for success, 0 for failure.
41
42   get_entry_id
43       Get the ID of a book from the Publican::WebSite DB.
44
45       Returns the ID or NULL.
46
47   get_hash_ref
48       Returns a reference to a has of all books for the selected language.
49
50   get_lang_list
51       Returns an array ref of distinct, osrted, languages.
52
53   regen_all_toc
54       Update the toc html files for every language.
55
56   report
57       Returns a string containing the current database statistics.
58
59   stats
60       Generate Site_Statistics.html containing the current database
61       statistics.
62
63   get_settings
64       Get a reference to a hash for the settings for this site.
65
66   update_settings
67       Update the settings table in DB with supplied values.
68
69       Values:      host   The host name
70           search HTML to use for navigation search.
71
72   validate
73       Validate the database entries against the RPM database.
74
75       TODO should also/instead compare entires aginst web site files?
76
77   version_sort
78       Sort version strings in to correct order, handles X, X.Y, and X.Y.Z
79       formats.
80
81   toc_path
82       Return the full toc path.
83

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

CONFIGURATION AND ENVIRONMENT
94       Publican::WebSite requires no configuration files or environment
95       variables.
96

DEPENDENCIES
98       None.
99

INCOMPATIBILITIES
101       None reported.
102

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

AUTHOR
111       Jeff Fearn  "<jfearn@redhat.com>"
112

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

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



        

    


            
        

        

            Impressum