.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Publican::WebSite 3pm"
.TH Publican::WebSite 3pm "2015-08-27" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Publican::WebSite \- Manage a documentation website
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Publican::WebSite;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Builds the static navgation content for a Publican Web Site.
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "new"
.IX Subsection "new"
Create a Publican::WebSite object...
.SS "add_entry"
.IX Subsection "add_entry"
Add an entry to the current Publican::WebSite \s-1DB...\s0
.PP
Returns number of rows added. Should be 1 for success, 0 for failure.
.SS "update_entry"
.IX Subsection "update_entry"
Update an existing entry in the current Publican::WebSite \s-1DB...\s0
.PP
Returns number of rows added. Should be 1 for success, 0 for failure.
.SS "update_or_add_entry"
.IX Subsection "update_or_add_entry"
Update an existing entry if it esists, else create a new entry.
.SS "del_entry"
.IX Subsection "del_entry"
Delete an entry from the current Publican::WebSite \s-1DB...\s0
.PP
Returns number of rows deleted. Should be 1 for success, 0 for failure.
.SS "get_entry_id"
.IX Subsection "get_entry_id"
Get the \s-1ID\s0 of a book from the Publican::WebSite \s-1DB.\s0
.PP
Returns the \s-1ID\s0 or \s-1NULL.\s0
.SS "get_hash_ref"
.IX Subsection "get_hash_ref"
Returns a reference to a has of all books for the selected language.
.SS "get_lang_list"
.IX Subsection "get_lang_list"
Returns an array ref of distinct, sorted, languages.
.SS "regen_all_toc"
.IX Subsection "regen_all_toc"
Update the toc html files for every language.
.SS "report"
.IX Subsection "report"
Returns a string containing the current database statistics.
.SS "validate"
.IX Subsection "validate"
Validate the database entries against the \s-1RPM\s0 database.
.PP
\&\s-1TODO\s0 should also/instead compare entires aginst web site files?
.SS "v_sort"
.IX Subsection "v_sort"
Sort version strings in to correct order, handles X, X.Y, and X.Y.Z formats.
.SS "i_sort"
.IX Subsection "i_sort"
Sort strings case insensitvly.
.SS "toc_path"
.IX Subsection "toc_path"
Return the full toc path.
.SS "xml_dump"
.IX Subsection "xml_dump"
Generate an \s-1XML\s0 dump, and a zip of the dump if required, of the Database.
.SS "search_string"
.IX Subsection "search_string"
Returns a string for the web page search box.
.SS "lang_name"
.IX Subsection "lang_name"
Returns a string of the localise name for a language. e.g. fr-FR => Franc\*,ais
.SS "splash_pages"
.IX Subsection "splash_pages"
Main function for generating splash pages for web 2 style.
.SS "write_books_index"
.IX Subsection "write_books_index"
Writes an index page for a book for web 2 style.
.SS "write_language_index"
.IX Subsection "write_language_index"
Writes an index page for a language for web 2 style.
.SS "write_product_index"
.IX Subsection "write_product_index"
Writes an index page for a product for web 2 style.
.SS "write_product_menu"
.IX Subsection "write_product_menu"
Writes a menu page for a product for web 2 style.
.SS "write_version_index"
.IX Subsection "write_version_index"
Writes an index page for a  for web 2 style.
.SS "write_language_labels"
.IX Subsection "write_language_labels"
Writes a javascript file with an associative array of labels.
.SS "MigrateDB"
.IX Subsection "MigrateDB"
Migrate a website DataBase from Publican < 3 to Publican 3.
.SS "insensitive_sort"
.IX Subsection "insensitive_sort"
Sort strings in a case insensitive order.
.SS "version_sort"
.IX Subsection "version_sort"
Sort version strings in correct order. Handles X Vs X.Y Vs X.Y.Z.
.SS "get_splash"
.IX Subsection "get_splash"
Returns the splash page header as a \s-1HTML\s0 chunk.
.SS "site_params_as_docbook"
.IX Subsection "site_params_as_docbook"
Returns the site paramaters as a docbook chunk, used for documeting options.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jeff Fearn  \f(CW\*(C`<jfearn@redhat.com>\*(C'\fR
.SH "LICENCE AND COPYRIGHT"
.IX Header "LICENCE AND COPYRIGHT"
Copyright (c) 2007, Jeff Fearn \f(CW\*(C`<jfearn@redhat.com>\*(C'\fR. All rights reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself. See perlartistic.
.SH "DISCLAIMER OF WARRANTY"
.IX Header "DISCLAIMER OF WARRANTY"
\&\s-1BECAUSE 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 \*(L"AS IS\*(R" 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.\s0
.PP
\&\s-1IN 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 \s0(\s-1INCLUDING 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\s0), \s-1EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.\s0