1Publican(3) User Contributed Perl Documentation Publican(3)
2
6 Publican - Used to control settings for sub modules.
7
9 This document describes Publican version $VERSION
10
12 use Publican;
13 my $publican = Publican->new({DEBUG => 1});
15
17 Handles general configuration of all sub modules.
18
20 _load_config
21 Private method for loading a config file
22 _validate_config
24 Private method for validating configuration
25 new
27 Create a Publican object.
28 my $publican = Publican->new({debug => 1});
30 Parameters:
32 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 debug_msg
39 Print out debugging information.
40 param
42 Return the current value of a configuration parameter
43 $publican->param('debug');
45 help_config
47 Display a list of config file parameters and a short description of
48 them.
49 dir_list
51 list all the files in a directory, and its sub-directories, matching
52 the supplied regex.
53 get_all_langs
55 Get all valid language directories.
56 logger
58 Log something, currently emits to STDOUT
59 TODO: consider using Log::Dispatch or similar
61 valid_lang
63 Is the requested language valid according to I18N::LangTags::List
64 maketext
66 Get localised strings
67 old2new
69 Parse a publican 0.x Makefile and create a publican 1.x config file.
70 get_abstract
72 Return the abstract for the supplied langauge with all white space
73 truncted.
74 get_subtitle
76 Return the subtitle for the supplied langauge with white space
77 truncted.
78 run_xslt
80 Apply the supplied xslt file to teh supplied XML and return a string of
81 the output.
82 new_tree
84 Create a new XML::TreeBuilder object with the required attributes for
85 DocBook.
86 TODO: Make XmlClean use this.
88
90 "unknown args %s"
91 All subs with named parameters will return this error when
92 unexpected named arguments are provided.
93 "%s is a required argument"
95 Any sub with a mandatory parameter will return this error if the
96 parameter is undef.
97 "Config file not found: %s"
99 publican can not find the named configuration file.
100 "Failed to load config file: %s"
102 The named configuration file could not be loaded.
103 "Can't locate required file: %s"
105 A file required for processing could not be found.
106 "title not found in Info file"
108 The <type>_Info.xml file does not contain a title tag.
109 "productname not found in Info file"
111 The <type>_Info.xml file does not contain a productname tag.
112 "productnumber not found in Info file"
114 The <type>_Info.xml file does not contain a productnumber tag.
115 "edition not found in Info file"
117 The <type>_Info.xml file does not contain a edition tag.
118 "pubsnumber not found in Info file"
120 The <type>_Info.xml file does not contain a pubsnumber tag.
121 "Failed to load brand default config file"
123 A detected defaults.cfg for the current brand could not be loaded.
124 "Failed to load brand overrides config file"
126 A detected overrides.cfg for the current brand could not be loaded.
127 "Could not create a Publican::Localise object"
129 Could not create a Publican::Localise object
130 "Can't open directory"
132
134 Publican requires no configuration files or environment variables.
135
137 Carp version Config::Simple XML::TreeBuilder I18N::LangTags::List
138 Term::ANSIColor File::Find::Rule; Publican::Localise;
139
141 None reported.
142
144 No bugs have been reported.
145 Please report any bugs or feature requests to
147 "publican-list@redhat.com", or through the web interface at
148 <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican>.
149
151 Jeff Fearn "<jfearn@redhat.com>"
152perl v5.12.4 2011-09-22 Publican(3)