publican::xmlclean(3) [centos man page]
Publican::XmlClean(3) User Contributed Perl Documentation Publican::XmlClean(3) NAME
Publican::XmlClean - A module to reformat XML to Publican standards VERSION
This document describes Publican::XmlClean version $VERSION SYNOPSIS
use Publican::XmlClean; my $cleaner = Publican::XmlClean->new( { clean_id => 1 } ); foreach my $xml_file ( sort(@xml_files) ) { $cleaner->process_file( { file => $xml_file, out_file => $xml_file } ); } DESCRIPTION
Publican::XmlClean tidies XML formatting and filters structure based on input rules. INTERFACE
new Create a new Publican::XmlClean object. print_known_tags Print a list of tags that have had their output QA'd. prune_xml($node) Remove unwanted nodes. i.e. 'profile' in DocBook speak. Clean_ID Rename ID's and update xrefs. If this node has a title as a child set it's ID else remove the ID print_xml Print out utf8 XML files Have to output xml/DTD header my_as_XML Traverse tree and output xml as text. Overrides traverse ... evil stuff. validate_tables Ensure Tables comply to requirements not enforceable in XML validation. 1. tgroup attribute cols must match the number of entries in every row. sort_glossaries Sort glosslists process_file Create XML::TreeBuilder object and perform operations. set_unique_ids Set unique ids for every nodes which have id create_db Create a database to track the max unique id DIAGNOSTICS
"unknown args %s" All subs with named parameters will return this error when unexpected named arguments are provided. "%s is a required argument" Any sub with a mandatory parameter will return this error if the parameter is undef. "Could not open %s for output!" The named file could not be opened. "Can't calculate image size of %s" Images are automatically scaled if thy are to wide, this check could not be performed due to either access permissions or file weirdness. CONFIGURATION AND ENVIRONMENT
Publican::XmlClean requires no configuration files or environment variables. DEPENDENCIES
Carp version XML::TreeBuilder Text::Wrap Config::Simple Publican File::Path Term::ANSIColor Cwd INCOMPATIBILITIES
None reported. BUGS AND LIMITATIONS
No bugs have been reported. Please report any bugs or feature requests to "publican-list@redhat.com", or through the web interface at <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican>. AUTHOR
Jeff Fearn "<jfearn@redhat.com>" perl v5.16.3 2014-06-10 Publican::XmlClean(3)
Check Out this Related Man Page
Publican(3) User Contributed Perl Documentation Publican(3) NAME
Publican - Used to control settings for sub modules. VERSION
This document describes Publican version $VERSION SYNOPSIS
use Publican; my $publican = Publican->new({DEBUG => 1}); DESCRIPTION
Handles general configuration of all sub modules. INTERFACE
_load_config Private method for loading a config file _validate_config Private method for validating configuration new Create a Publican object. my $publican = Publican->new({debug => 1}); Parameters: configfile Override Configuration file to use. debug Use debug mode for messages. common_config Override path to coomo configuration files. common_content Override path to common content files. debug_msg Print out debugging information. param Return the current value of a configuration parameter $publican->param('debug'); help_config Display a list of config file parameters and a short description of them. dir_list list all the files in a directory, and its sub-directories, matching the supplied regex. get_all_langs Get all valid language directories. logger Log something, currently emits to STDOUT TODO: consider using Log::Dispatch or similar valid_lang Is the requested language valid according to I18N::LangTags::List maketext Get localised strings get_abstract Return the abstract for the supplied language with all white space truncated. get_subtitle Return the subtitle for the supplied language with white space truncated. get_author_list Return the author list for the supplied language. get_contributors Return the contributor hash for the supplied language. get_keywords Return the contributor hash for the supplied language. get_legalnotice Return the legal notice for the supplied language. get_draft Is the book in draft mode?. run_xslt Apply the supplied xslt file to the supplied XML and return a string of the output. new_tree Create a new XML::TreeBuilder object with the required attributes for DocBook. TODO: Make XmlClean use this. dtd_string Returns a valid DTD for the DocBook tag supplied. Parameters: tag The root tag for this file dtdver The DTD version ent_file An entity file to include (optional) print_banned_tags Print a list of tags that are not supported. add_revision Add a full entry in to the revision history. get_ed_rev Get the current edition (version) and release from the Revision History file. Parameters: language, bump. If bump is set the returned revision will increment before it's returned. fcopy UTF8 escape calls to File::Copy::Recursive fmove UTF8 escape calls to File::Copy::Recursive rcopy UTF8 escape calls to File::Copy::Recursive rcopy_glob UTF8 escape calls to File::Copy::Recursive dircopy UTF8 escape calls to File::Copy::Recursive DIAGNOSTICS
"unknown args %s" All subs with named parameters will return this error when unexpected named arguments are provided. "%s is a required argument" Any sub with a mandatory parameter will return this error if the parameter is undef. "Config file not found: %s" publican can not find the named configuration file. "Failed to load config file: %s" The named configuration file could not be loaded. "Can't locate required file: %s" A file required for processing could not be found. "title not found in Info file" The <type>_Info.xml file does not contain a title tag. "productname not found in Info file" The <type>_Info.xml file does not contain a productname tag. "productnumber not found in Info file" The <type>_Info.xml file does not contain a productnumber tag. "pubsnumber not found in Info file" The <type>_Info.xml file does not contain a pubsnumber tag. "Failed to load brand default config file" A detected defaults.cfg for the current brand could not be loaded. "Failed to load brand overrides config file" A detected overrides.cfg for the current brand could not be loaded. "Could not create a Publican::Localise object" Could not create a Publican::Localise object "Can't open directory" CONFIGURATION AND ENVIRONMENT
Publican requires no configuration files or environment variables. DEPENDENCIES
Carp version Config::Simple XML::TreeBuilder I18N::LangTags::List Term::ANSIColor File::Find::Rule; Publican::Localise; INCOMPATIBILITIES
None reported. BUGS AND LIMITATIONS
No bugs have been reported. Please report any bugs or feature requests to "publican-list@redhat.com", or through the web interface at <https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&component=publican>. AUTHOR
Jeff Fearn "<jfearn@redhat.com>" perl v5.16.3 2014-06-10 Publican(3)