.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07) .\" .\" 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" '' '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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" 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 "MKDoc::XML::Stripper 3pm" .TH MKDoc::XML::Stripper 3pm "2004-10-06" "perl v5.10.1" "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" MKDoc::XML::Stripper \- Remove unwanted XML / XHTML tags and attributes .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use MKDoc::XML::Stripper; \& \& my $stripper = new MKDoc::XML::Stripper; \& $stripper\->allow (qw /p class id/); \& \& my $ugly = \*(Aq

Hello, World!

\*(Aq; \& my $neat = $stripper\->process_data ($ugly); \& print $neat; .Ve .PP Should print: .PP .Vb 1 \&

Hello, World!

.Ve .SH "SUMMARY" .IX Header "SUMMARY" MKDoc::XML::Stripper is a class which lets you specify a set of tags and attributes which you want to allow, and then cheekily strip any \s-1XML\s0 of unwanted tags and attributes. .PP In MKDoc, this is used so that editors use structural \s-1XHTML\s0 rather than presentational tags, i.e. strip anything which looks like a tag, a 'style' attribute or other tags which would break separation of structure from content. .SH "DISCLAIMER" .IX Header "DISCLAIMER" \&\fBThis module does low level \s-1XML\s0 manipulation. It will somehow parse even broken \s-1XML\s0 and try to do something with it. Do not use it unless you know what you're doing.\fR .SH "API" .IX Header "API" .ie n .SS "my $stripper = MKDoc::XML::Stripper\->\fInew()\fP" .el .SS "my \f(CW$stripper\fP = MKDoc::XML::Stripper\->\fInew()\fP" .IX Subsection "my $stripper = MKDoc::XML::Stripper->new()" Instantiates a new MKDoc::XML::Stripper object. .ie n .SS "$stripper\->load_def ($def_name);" .el .SS "\f(CW$stripper\fP\->load_def ($def_name);" .IX Subsection "$stripper->load_def ($def_name);" Loads a definition located somewhere in \f(CW@INC\fR under MKDoc/XML/Stripper. .PP Available definitions are: .IP "xhtml10frameset" 4 .IX Item "xhtml10frameset" .PD 0 .IP "xhtml10strict" 4 .IX Item "xhtml10strict" .IP "xhtml10transitional" 4 .IX Item "xhtml10transitional" .IP "mkdoc16 \- MKDoc 1.6. \s-1XHTML\s0 structural markup" 4 .IX Item "mkdoc16 - MKDoc 1.6. XHTML structural markup" .PD .PP You can also load your own definition file, for instance: .PP .Vb 1 \& $stripper\->load_def (\*(Aqmy_def.txt\*(Aq); .Ve .PP Definitions are simple text files as follows: .PP .Vb 3 \& # allow p with \*(Aqclass\*(Aq and id \& p class \& p id \& \& # allow more stuff \& td class \& td id \& td style \& \& # etc... .Ve .ie n .SS "$stripper\->allow ($tag, @attributes)" .el .SS "\f(CW$stripper\fP\->allow ($tag, \f(CW@attributes\fP)" .IX Subsection "$stripper->allow ($tag, @attributes)" Allows \*(L"<$tag>\*(R" to appear in the stripped \s-1XML\s0. Additionally, allows \&\f(CW@attributes\fR to appear as attributes of <$tag>, so for instance: .PP .Vb 1 \& $stripper\->allow (\*(Aqp\*(Aq, \*(Aqclass\*(Aq, \*(Aqid\*(Aq); .Ve .PP Will allow the following: .PP .Vb 4 \&

\&

\&

\&

.Ve .PP However any extra attributes will be stripped, i.e. .PP .Vb 1 \&

.Ve .PP Will be rewritten as .PP .Vb 1 \&

.Ve .ie n .SS "$stripper\->disallow ($tag)" .el .SS "\f(CW$stripper\fP\->disallow ($tag)" .IX Subsection "$stripper->disallow ($tag)" Explicitly disallows a tag and all its associated attributes. By default everything is disallowed. .ie n .SS "$stripper\->process_data ($some_xml);" .el .SS "\f(CW$stripper\fP\->process_data ($some_xml);" .IX Subsection "$stripper->process_data ($some_xml);" Strips \f(CW$some_xml\fR according to the rules that were given with the \&\fIallow()\fR and \fIdisallow()\fR methods and returns the result. Does not modify \f(CW$some_xml\fR in place. .ie n .SS "$stripper\->process_file ('/an/xml/file.xml');" .el .SS "\f(CW$stripper\fP\->process_file ('/an/xml/file.xml');" .IX Subsection "$stripper->process_file ('/an/xml/file.xml');" Strips '/an/xml/file.xml' according to the rules that were given with the \&\fIallow()\fR and \fIdisallow()\fR methods and returns the result. Does not modify '/an/xml/file.xml' in place. .SH "NOTES" .IX Header "NOTES" MKDoc::XML::Stripper does not really parse the \s-1XML\s0 file you're giving to it nor does it care if the \s-1XML\s0 is well-formed or not. It uses MKDoc::XML::Tokenizer to turn the \s-1XML\s0 / \s-1XHTML\s0 file into a series of MKDoc::XML::Token objects and strictly operates on a list of tokens. .PP For this same reason MKDoc::XML::Stripper does not support namespaces. .SH "AUTHOR" .IX Header "AUTHOR" Copyright 2003 \- MKDoc Holdings Ltd. .PP Author: Jean-Michel Hiver .PP This module is free software and is distributed under the same license as Perl itself. Use it at your own risk. .SH "SEE ALSO" .IX Header "SEE ALSO" MKDoc::XML::Tokenizer MKDoc::XML::Token