1Publican::XmlClean(3) User Contributed Perl DocumentationPublican::XmlClean(3)
2
3
4
6 Publican::XmlClean - A module to reformat XML to Publican standards
7
9 This document describes Publican::XmlClean version $VERSION
10
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
21 Publican::XmlClean tidies XML formatting and filters structure based on
22 input rules.
23
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 print_banned_tags
32 Print a list of tags that are not supported.
33
34 prune_xml($node)
35 Remove unwanted nodes.
36
37 If $lang is set then delete all nodes that have lang set and do not
38 contain $lang
39
40 If $arch is set then delete all nodes that have arch set and do not
41 contain $arch
42
43 If $condition is set then delete all nodes that have condition set and
44 do not contain $condition
45
46 Clean_ID
47 Rename ID's and update xrefs.
48
49 If this node has a title as a child set it's ID else remove the ID
50
51 print_xml
52 Print out utf8 XML files
53
54 Have to output xml/DTD header
55
56 my_as_XML
57 Traverse tree and output xml as text. Overrides traverse ... evil
58 stuff.
59
60 validate_tables
61 Ensure Tables comply to requirements not enforceable in XML validation.
62
63 1. tgroup attribute cols must match the number of entries in every row.
64
65 sort_glossaries
66 Sort glosslists
67
68 process_file
69 Create XML::TreeBuilder object and perform operations.
70
72 "unknown args %s"
73 All subs with named parameters will return this error when
74 unexpected named arguments are provided.
75
76 "%s is a required argument"
77 Any sub with a mandatory parameter will return this error if the
78 parameter is undef.
79
80 "Could not open %s for output!"
81 The named file could not be opened.
82
83 "Can't calculate image size of %s"
84 Images are automatically scaled if thy are to wide, this check
85 could not be performed due to either access permissions or file
86 weirdness.
87
89 Publican::XmlClean requires no configuration files or environment
90 variables.
91
93 Carp version XML::TreeBuilder Text::Wrap Config::Simple Publican
94 File::Path Image::Size Term::ANSIColor Cwd
95
97 None reported.
98
100 No bugs have been reported.
101
102 Please report any bugs or feature requests to
103 "publican-list@redhat.com", or through the web interface at
104 <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Fedora;amp;version=rawhide&component=publican>.
105
107 Jeff Fearn "<jfearn@redhat.com>"
108
109
110
111perl v5.10.1 2010-11-12 Publican::XmlClean(3)