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   get_abstract
69       Return the abstract for the supplied language with all white space
70       truncated.
71
72   get_subtitle
73       Return the subtitle for the supplied language with white space
74       truncated.
75
76   get_author_list
77       Return the author list for the supplied language.
78
79   get_contributors
80       Return the contributor hash for the supplied language.
81
82   get_keywords
83       Return the contributor hash for the supplied language.
84
85   get_legalnotice
86       Return the legal notice for the supplied language.
87
88   get_draft
89       Is the book in draft mode?.
90
91   run_xslt
92       Apply the supplied xslt file to the supplied XML and return a string of
93       the output.
94
95   new_tree
96       Create a new XML::TreeBuilder object with the required attributes for
97       DocBook.
98
99       TODO: Make XmlClean use this.
100
101   dtd_string
102       Returns a valid DTD for the DocBook tag supplied.
103
104       Parameters:      tag   The root tag for this file      dtdver     The
105       DTD version      ent_file An entity file to include (optional)
106
107   print_banned_tags
108       Print a list of tags that are not supported.
109
110   add_revision
111       Add a full entry in to the revision history.
112
113   get_ed_rev
114       Get the current edition (version) and release from the Revision History
115       file.
116
117       Parameters: language, bump.
118
119       If bump is set the returned revision will increment before it's
120       returned.
121
122   fcopy
123       UTF8 escape calls to File::Copy::Recursive
124
125   fmove
126       UTF8 escape calls to File::Copy::Recursive
127
128   rcopy
129       UTF8 escape calls to File::Copy::Recursive
130
131   rcopy_glob
132       UTF8 escape calls to File::Copy::Recursive
133
134   dircopy
135       UTF8 escape calls to File::Copy::Recursive
136

DIAGNOSTICS

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

CONFIGURATION AND ENVIRONMENT

179       Publican requires no configuration files or environment variables.
180

DEPENDENCIES

182       Carp version Config::Simple XML::TreeBuilder I18N::LangTags::List
183       Term::ANSIColor File::Find::Rule; Publican::Localise;
184

INCOMPATIBILITIES

186       None reported.
187

BUGS AND LIMITATIONS

189       No bugs have been reported.
190
191       Please report any bugs or feature requests to
192       "publican-list@redhat.com", or through the web interface at
193       <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&amp;component=publican>.
194

AUTHOR

196       Jeff Fearn  "<jfearn@redhat.com>"
197
198
199
200perl v5.16.3                      2014-12-15                       Publican(3)