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

VERSION

9       This document describes Publican::XmlClean version $VERSION
10

SYNOPSIS

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

DESCRIPTION

21       Publican::XmlClean tidies XML formatting and filters structure based on
22       input rules.
23

INTERFACE

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

DIAGNOSTICS

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

CONFIGURATION AND ENVIRONMENT

83       Publican::XmlClean requires no configuration files or environment
84       variables.
85

DEPENDENCIES

87       Carp version XML::TreeBuilder Text::Wrap Config::Simple Publican
88       File::Path Term::ANSIColor Cwd
89

INCOMPATIBILITIES

91       None reported.
92

BUGS AND LIMITATIONS

94       No bugs have been reported.
95
96       Please report any bugs or feature requests to
97       "publican-list@redhat.com", or through the web interface at
98       <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican>.
99

AUTHOR

101       Jeff Fearn  "<jfearn@redhat.com>"
102
103
104
105perl v5.16.3                      2014-12-15             Publican::XmlClean(3)
Impressum