1Publican::XmlClean(3) User Contributed Perl DocumentationPublican::XmlClean(3)
2
3
4

NAME

6       Publican::XmlClean - A module to reformat XML to Publican standards
7

SYNOPSIS

9           use Publican::XmlClean;
10
11           my $cleaner = Publican::XmlClean->new( { clean_id => 1 } );
12
13           foreach my $xml_file ( sort(@xml_files) ) {
14               $cleaner->process_file( { file => $xml_file, out_file => $xml_file } );
15           }
16

DESCRIPTION

18       Publican::XmlClean tidies XML formatting and filters structure based on
19       input rules.
20

INTERFACE

22   new
23       Create a new Publican::XmlClean object.
24
25   print_known_tags
26       Print a list of tags that have had their output QA'd.
27
28   prune_xml($node)
29       Remove unwanted nodes. i.e. 'profile' in DocBook speak.
30
31   Clean_ID
32       Rename ID's and update xrefs.
33
34       If this node has a title as a child set it's ID else remove the ID
35
36   print_xml
37       Print out utf8 XML files
38
39       Have to output xml/DTD header
40
41   my_as_XML
42       Traverse tree and output xml as text. Overrides traverse ... evil
43       stuff.
44
45   validate_tables
46       Ensure Tables comply to requirements not enforceable in XML validation.
47
48       1. tgroup attribute cols must match the number of entries in every row.
49
50   process_file
51       Create XML::TreeBuilder object and perform operations.
52
53   set_unique_ids
54       Set unique ids for every nodes which have id
55
56   create_db
57       Create a database to track the max unique id
58

DIAGNOSTICS

60       "unknown args %s"
61           All subs with named parameters will return this error when
62           unexpected named arguments are provided.
63
64       "%s is a required argument"
65           Any sub with a mandatory parameter will return this error if the
66           parameter is undef.
67
68       "Could not open %s for output!"
69           The named file could not be opened.
70
71       "Can't calculate image size of %s"
72           Images are automatically scaled if thy are to wide, this check
73           could not be performed due to either access permissions or file
74           weirdness.
75

CONFIGURATION AND ENVIRONMENT

77       Publican::XmlClean requires no configuration files or environment
78       variables.
79

DEPENDENCIES

81       Carp version XML::TreeBuilder Text::Wrap Config::Simple Publican
82       File::Path Term::ANSIColor Cwd
83

INCOMPATIBILITIES

85       None reported.
86

BUGS AND LIMITATIONS

88       No bugs have been reported.
89
90       Please report any bugs or feature requests to
91       "publican-list@redhat.com", or through the web interface at
92       <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican>.
93

AUTHOR

95       Jeff Fearn  "<jfearn@redhat.com>"
96
97
98
99perl v5.28.0                      2018-07-15             Publican::XmlClean(3)
Impressum