.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Publican::Builder::DocBook 3pm" .TH Publican::Builder::DocBook 3pm "2015-08-27" "perl v5.20.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Publican::Builder::DocBook \- A module to Convert XML to various output formats .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use Publican::Builder::DocBook; \& my $builder = Publican::Builder::DocBook\->new(); \& $builder\->clean_ids(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Manipulate DocBook \s-1XML\s0 and convert to other formats. .SH "INTERFACE" .IX Header "INTERFACE" .SS "new" .IX Subsection "new" Create a new Publican::Builder::DocBook object. .SS "build" .IX Subsection "build" Transform the source in to another format. .ie n .SH " #BUGBUG fix templates print( $OUT < \et\et\et\et\et\et\et$term EOL );" .el .SH " #BUGBUG fix templates print( \f(CW$OUT\fP < \et\et\et\et\et\et\et$term EOL );" .IX Header " #BUGBUG fix templates print( $OUT < ttttttt$term EOL );" .Vb 4 \& print( $OUT <$text \&EOL \& ) if ( $text && $text ne "" ); \& \& print( $OUT < \&EOL \& ); .Ve .SS "transform" .IX Subsection "transform" Run \s-1XSLT\s0 over \s-1XML\s0 .SS "drupal_transform" .IX Subsection "drupal_transform" Write csv file for drupal node import .SS "escape_xml" .IX Subsection "escape_xml" Escapes an input string so that it can be used in an \s-1XML\s0 Element. .SS "get_nodes_order" .IX Subsection "get_nodes_order" Get all nodes with id from xml files in order .SS "get_chunk_filename" .IX Subsection "get_chunk_filename" Gets the chunked filename for an LibXML::Node in a tree. .SS "convert_num_to_alpha" .IX Subsection "convert_num_to_alpha" Converts a numeric number to an alpha list item. ie 1 \-> a, 27 \-> aa .SS "build_drupal_book" .IX Subsection "build_drupal_book" Convert each html file into csv a row for drupal. .SS "adjustColumnWidths" .IX Subsection "adjustColumnWidths" Adjust column widths for \s-1XML\s0 Tables. Converts hard coded to px and relative withs to %. .PP \&\s-1FO\s0 input: .PP \&\*(L"\en\en\en\en\en\*(R" .PP \&\s-1HTML\s0 input: .PP \&\*(L"\en\en\*(R" .PP Returns: modified input tree which is \s-1XHTML\s0 or \s-1XML:FO\s0 .SS "highlight" .IX Subsection "highlight" perl_highlight syntax highlighting .PP Edit highlight_color template in pdf.xsl and .perl_XXX in \s-1CSS\s0 to change highlight colours .PP Returns: Modified input tree, which is DocBook \s-1XML.\s0 .SS "insertCallouts" .IX Subsection "insertCallouts" \&\s-1XSLT\s0 callout function for inserting Callout markup in to verbatim text. .PP Parameters: areaspec: the DocBook areaspec node set verbatim: the \s-1XHTML/XML:FO\s0 tree to place gfx in .PP Returns: modified \f(CW$verbatim\fR .PP \&\s-1BUGBUG: BZ\s0 #561618 \&\s-1BUGBUG:\s0 The approach taken here does not work for tagged content in the verbatim. \&\s-1BUGBUG:\s0 Need to walk the node tree in childnode instead of using it as a string. \&\s-1BUGBUG:\s0 make sure class is being set .SS "numberLines" .IX Subsection "numberLines" perl_numberLines \s-1XSL\s0 function for numbering lines. .PP Returns: Modified input tree, which is DocBook \s-1XML.\s0 .SS "web_labels" .IX Subsection "web_labels" Determine if the labels use in the web navigation are different from the names used for packaging. .SS "change_log" .IX Subsection "change_log" Generate an \s-1RPM\s0 style change log from \f(CW$xml_lang\fR/Revision_History.xml .SS "get_abstract" .IX Subsection "get_abstract" Return the abstract for the supplied language with all white space truncated. .PP ## \s-1BUGBUG\s0 this should be moved to the DocBook sub classes .SS "get_subtitle" .IX Subsection "get_subtitle" Return the subtitle for the supplied language with white space truncated. .PP ## \s-1BUGBUG\s0 this should be moved to the DocBook sub classes .SS "get_author_list" .IX Subsection "get_author_list" Return the author list for the supplied language. .SS "get_contributors" .IX Subsection "get_contributors" Return the contributor hash for the supplied language. .PP ## \s-1BUGBUG\s0 this should be moved to the DocBook sub classes .SS "get_keywords" .IX Subsection "get_keywords" Return the contributor hash for the supplied language. .PP ## \s-1BUGBUG\s0 this should be moved to the DocBook sub classes .SS "get_legalnotice" .IX Subsection "get_legalnotice" Return the legal notice for the supplied language. .PP ## \s-1BUGBUG\s0 this should be moved to the DocBook sub classes .SS "get_draft" .IX Subsection "get_draft" Is the book in draft mode?. .PP ## \s-1BUGBUG\s0 this should be moved to the DocBook sub classes .SS "to_html" .IX Subsection "to_html" Convert an XML::Element node containing DocBook \s-1XML\s0 directly to \s-1HTML\s0 text. .SS "headings" .IX Subsection "headings" Create an array of all headings in DocBook \s-1XML.\s0 .SS "links" .IX Subsection "links" Convert DocBook links in to \s-1HTML5\s0 anchors. .SS "footnotes" .IX Subsection "footnotes" Convert DocBook footnotes in to \s-1HTML5\s0 footnotes. .SS "highlight2" .IX Subsection "highlight2" Highlight code blocks in \s-1HTML5.\s0 .PP \&\s-1TODO\s0 replace with highlight.js?? .SS "number_lines" .IX Subsection "number_lines" Number lines in \s-1HTML5\s0 code blocks. .SS "toc" .IX Subsection "toc" Create an \s-1HTML5 TOC.\s0 .SH "DIAGNOSTICS" .IX Header "DIAGNOSTICS" .ie n .IP """unknown args %s""" 4 .el .IP "\f(CWunknown args %s\fR" 4 .IX Item "unknown args %s" All subs with named parameters will return this error when unexpected named arguments are provided. .ie n .IP """%s is a required argument""" 4 .el .IP "\f(CW%s is a required argument\fR" 4 .IX Item "%s is a required argument" Any sub with a mandatory parameter will return this error if the parameter is undef. .SH "CONFIGURATION AND ENVIRONMENT" .IX Header "CONFIGURATION AND ENVIRONMENT" Publican requires no configuration files or environment variables. .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" Carp version Publican Publican::XmlClean Publican::Translate File::Path File::pushd File::Find XML::LibXSLT XML::LibXML Cwd Archive::Tar DateTime DateTime::Format::DateParse Syntax::Highlight::Engine::Kate HTML::TreeBuilder HTML::FormatText Term::ANSIColor \&\s-1POSIX\s0 .SH "INCOMPATIBILITIES" .IX Header "INCOMPATIBILITIES" None reported. .SH "BUGS AND LIMITATIONS" .IX Header "BUGS AND LIMITATIONS" No bugs have been reported. .PP Please report any bugs or feature requests to \&\f(CW\*(C`publican\-list@redhat.com\*(C'\fR, or through the web interface at . .SH "AUTHOR" .IX Header "AUTHOR" Jeff Fearn \f(CW\*(C`\*(C'\fR