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

NAME

6       Publican::WebSite - Manage a documentation website
7

SYNOPSIS

9           use Publican::WebSite;
10

DESCRIPTION

12       Builds the static navgation content for a Publican Web Site.
13

INTERFACE

15   new
16       Create a Publican::WebSite object...
17
18   add_entry
19       Add an entry to the current Publican::WebSite DB...
20
21       Returns number of rows added. Should be 1 for success, 0 for failure.
22
23   update_entry
24       Update an existing entry in the current Publican::WebSite DB...
25
26       Returns number of rows added. Should be 1 for success, 0 for failure.
27
28   update_or_add_entry
29       Update an existing entry if it esists, else create a new entry.
30
31   del_entry
32       Delete an entry from the current Publican::WebSite DB...
33
34       Returns number of rows deleted. Should be 1 for success, 0 for failure.
35
36   get_entry_id
37       Get the ID of a book from the Publican::WebSite DB.
38
39       Returns the ID or NULL.
40
41   get_hash_ref
42       Returns a reference to a has of all books for the selected language.
43
44   get_lang_list
45       Returns an array ref of distinct, sorted, languages.
46
47   regen_all_toc
48       Update the toc html files for every language.
49
50   report
51       Returns a string containing the current database statistics.
52
53   validate
54       Validate the database entries against the RPM database.
55
56       TODO should also/instead compare entires aginst web site files?
57
58   v_sort
59       Sort version strings in to correct order, handles X, X.Y, and X.Y.Z
60       formats.
61
62   i_sort
63       Sort strings case insensitvly.
64
65   toc_path
66       Return the full toc path.
67
68   xml_dump
69       Generate an XML dump, and a zip of the dump if required, of the
70       Database.
71
72   search_string
73       Returns a string for the web page search box.
74
75   lang_name
76       Returns a string of the localise name for a language. e.g. fr-FR =>
77       Français
78
79   splash_pages
80       Main function for generating splash pages for web 2 style.
81
82   write_books_index
83       Writes an index page for a book for web 2 style.
84
85   write_language_index
86       Writes an index page for a language for web 2 style.
87
88   write_product_index
89       Writes an index page for a product for web 2 style.
90
91   write_product_menu
92       Writes a menu page for a product for web 2 style.
93
94   write_version_index
95       Writes an index page for a  for web 2 style.
96
97   write_language_labels
98       Writes a javascript file with an associative array of labels.
99
100   MigrateDB
101       Migrate a website DataBase from Publican < 3 to Publican 3.
102
103   insensitive_sort
104       Sort strings in a case insensitive order.
105
106   version_sort
107       Sort version strings in correct order. Handles X Vs X.Y Vs X.Y.Z.
108
109   get_splash
110       Returns the splash page header as a HTML chunk.
111
112   site_params_as_docbook
113       Returns the site paramaters as a docbook chunk, used for documeting
114       options.
115

AUTHOR

117       Jeff Fearn  "<jfearn@redhat.com>"
118

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

DISCLAIMER OF WARRANTY

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