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

NAME

6       Publican - Used to control settings for sub modules.
7

VERSION

9       This document describes Publican version $VERSION
10

SYNOPSIS

12           use Publican;
13
14           my $publican = Publican->new({DEBUG => 1});
15

DESCRIPTION

17       Handles general configuration of all sub modules.
18

INTERFACE

20   _load_config
21       Private method for loading a config file
22
23   _validate_config
24       Private method for validating configuration
25
26   new
27       Create a Publican object.
28
29       my $publican = Publican->new({debug => 1});
30
31       Parameters:
32
33          configfile       Override Configuration file to use.
34          debug            Use debug mode for messages.
35          common_config    Override path to coomo configuration files.
36          common_content   Override path to common content files.
37
38   debug_msg
39       Print out debugging information.
40
41   param
42       Return the current value of a configuration parameter
43
44       $publican->param('debug');
45
46   help_config
47       Display a list of config file parameters and a short description of
48       them.
49
50   dir_list
51       list all the files in a directory, and its sub-directories, matching
52       the supplied regex.
53
54   get_all_langs
55       Get all valid language directories.
56
57   logger
58       Log something, currently emits to STDOUT
59
60       TODO: consider using Log::Dispatch or similar
61
62   valid_lang
63       Is the requested language valid according to I18N::LangTags::List
64
65   maketext
66       Get localised strings
67
68   run_xslt
69       Apply the supplied xslt file to the supplied XML and return a string of
70       the output.
71
72   new_tree
73       Create a new XML::TreeBuilder object with the required attributes for
74       DocBook.
75
76       TODO: Make XmlClean use this.
77
78   dtd_string
79       Returns a valid DTD for the DocBook tag supplied.
80
81       Parameters:      tag   The root tag for this file      dtdver     The
82       DTD version      ent_file An entity file to include (optional)
83
84       ## BUGBUG this should be moved to the DocBook sub classes
85
86   print_banned_tags
87       Print a list of tags that are not supported.
88
89   add_revision
90       Add a full entry in to the revision history.
91
92       ## BUGBUG this should be moved to the DocBook sub classes
93
94   get_ed_rev
95       Get the current edition (version) and release from the Revision History
96       file.
97
98       Parameters: language, bump.
99
100       If bump is set the returned revision will increment before it's
101       returned.
102
103       ## BUGBUG this should be moved to the DocBook sub classes
104
105   fcopy
106       UTF8 escape calls to File::Copy::Recursive
107
108   fmove
109       UTF8 escape calls to File::Copy::Recursive
110
111   rcopy
112       UTF8 escape calls to File::Copy::Recursive
113
114   rcopy_glob
115       UTF8 escape calls to File::Copy::Recursive
116
117   dircopy
118       UTF8 escape calls to File::Copy::Recursive
119
120   dirmove
121       UTF8 escape calls to File::Copy::Recursive
122
123   params_as_docbook
124       Returns DocBook chunks describing all the configuration options. Used
125       to generate autodocs.
126

DIAGNOSTICS

128       "unknown args %s"
129           All subs with named parameters will return this error when
130           unexpected named arguments are provided.
131
132       "%s is a required argument"
133           Any sub with a mandatory parameter will return this error if the
134           parameter is undef.
135
136       "Config file not found: %s"
137           publican can not find the named configuration file.
138
139       "Failed to load config file: %s"
140           The named configuration file could not be loaded.
141
142       "Can't locate required file: %s"
143           A file required for processing could not be found.
144
145       "title not found in Info file"
146           The <type>_Info.xml file does not contain a title tag.
147
148       "productname not found in Info file"
149           The <type>_Info.xml file does not contain a productname tag.
150
151       "productnumber not found in Info file"
152           The <type>_Info.xml file does not contain a productnumber tag.
153
154       "pubsnumber not found in Info file"
155           The <type>_Info.xml file does not contain a pubsnumber tag.
156
157       "Failed to load brand default config file"
158           A detected defaults.cfg for the current brand could not be loaded.
159
160       "Failed to load brand overrides config file"
161           A detected overrides.cfg for the current brand could not be loaded.
162
163       "Could not create a Publican::Localise object"
164           Could not create a Publican::Localise object
165
166       "Can't open directory"
167

CONFIGURATION AND ENVIRONMENT

169       Publican requires no configuration files or environment variables.
170

DEPENDENCIES

172       Carp version Config::Simple XML::TreeBuilder I18N::LangTags::List
173       Term::ANSIColor File::Find::Rule; Publican::Localise;
174

INCOMPATIBILITIES

176       None reported.
177

BUGS AND LIMITATIONS

179       No bugs have been reported.
180
181       Please report any bugs or feature requests to
182       "publican-list@redhat.com", or through the web interface at
183       <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&amp;component=publican>.
184

AUTHOR

186       Jeff Fearn  "<jfearn@redhat.com>"
187
188
189
190perl v5.32.1                      2021-01-27                       Publican(3)