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

NAME

6       Publican::Builder - A module to Convert XML to various output formats
7

SYNOPSIS

9           use Publican::Builder;
10           my $builder = Publican::Builder->new();
11           $builder->clean_ids();
12

DESCRIPTION

14       Manipulate XML and convert to other formats.
15

INTERFACE

17   new
18       Create a new Publican::Builder object.
19
20   build
21       Transform the source in to another format.
22
23       Valid formats: eclipse epub html html-single html-desktop man pdf txt
24
25   del_unwanted_dirs
26       Callback that deletes all unwanted directories from the given directory
27       tree. Used to delete CVS and SVN files from the working directories.
28
29   del_unwanted_xml
30       Callback that deletes all unwanted xml from the given directory tree.
31
32   validate_xml
33       Ensure the XML validates against the DTD.
34
35       To debug the XML catalogs
36
37       export XML_DEBUG_CATALOG=1
38
39       test...
40
41       unset XML_DEBUG_CATALOG
42
43   package_brand
44       Create the structure for the distributed files and save it as a tar.gz
45       file
46
47   package_home
48       Package a book for use as a Publican Website home page.
49
50   build_rpm
51       Build an srpm for books and brands.
52
53   package
54       Create the structure for the distributed files and save it as a tar.gz
55       file
56
57       Creates RPM Specfile and build SRPM.
58
59       TODO: Consider handling other package formats, deb etc.
60
61   web_labels
62       Determine if the labels use in the web navigation are different from
63       the names used for packaging.
64
65       This should be sub-classed.
66
67   setup_xml
68       Create the proper directory structure for the XML, including copying in
69       Brand files.
70
71       This should be sub-classed.
72
73   clean_ids
74       Travers over the source XML and update the id's to match the standard
75       format.
76
77       Updates all existing PO files with the new xref links.
78
79       This should be sub-classed.
80
81   change_log
82       Generate an RPM style change log from $xml_lang/Revision_History.xml
83
84       This should be sub-classed.
85
86   get_books
87       Fetch all the books for a set from a repo.
88
89       Supported Repos: SVN
90
91   build_set_books
92       Prepare XML from sub books for Remote Sets
93

DIAGNOSTICS

95       "unknown args %s"
96           All subs with named parameters will return this error when
97           unexpected named arguments are provided.
98
99       "%s is a required argument"
100           Any sub with a mandatory parameter will return this error if the
101           parameter is undef.
102

CONFIGURATION AND ENVIRONMENT

104       Publican requires no configuration files or environment variables.
105

DEPENDENCIES

107       Carp version Config::Simple Publican Publican::XmlClean
108       Publican::Translate File::Path File::pushd File::Find Cwd Archive::Tar
109       DateTime DateTime::Format::DateParse Syntax::Highlight::Engine::Kate
110       HTML::TreeBuilder HTML::FormatText Term::ANSIColor POSIX
111

INCOMPATIBILITIES

113       None reported.
114

BUGS AND LIMITATIONS

116       No bugs have been reported.
117
118       Please report any bugs or feature requests to
119       "publican-list@redhat.com", or through the web interface at
120       <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican>.
121

AUTHOR

123       Jeff Fearn  "<jfearn@redhat.com>"
124
125
126
127perl v5.34.0                      2021-07-23              Publican::Builder(3)