.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "GraphViz::XML 3"
.TH GraphViz::XML 3 2025-12-14 "perl v5.42.0" "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
GraphViz::XML \- Visualise XML as a tree
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use GraphViz::XML;
\&
\&  my $graph = GraphViz::XML\->new($xml);
\&  print $g\->as_png;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module makes it easy to visualise XML as a tree. XML is hard for
humans to grasp, especially if the XML is computer\-generated. This
modules aims to visualise the XML as a graph in order to make the
structure of the XML clear and to aid in understanding the XML.
.PP
XML elements are represented as diamond nodes, with links to elements
within them. Character data is represented in round nodes.
.PP
Note that the XML::Twig module should be installed.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
This is the constructor. It takes one mandatory argument, which is the
XML to be visualised. A GraphViz object is returned.
.PP
.Vb 1
\&  my $graph = GraphViz::XML\->new($xml);
.Ve
.SS as_*
.IX Subsection "as_*"
The XML can be visualised in a number of different graphical
formats. Methods include as_ps, as_hpgl, as_pcl, as_mif, as_pic,
as_gd, as_gd2, as_gif, as_jpeg, as_png, as_wbmp, as_ismap, as_imap,
as_vrml, as_vtx, as_mp, as_fig, as_svg. See the GraphViz documentation
for more information. The two most common methods are:
.PP
.Vb 2
\&  # Print out a PNG\-format file
\&  print $g\->as_png;
\&
\&  # Print out a PostScript\-format file
\&  print $g\->as_ps;
.Ve
.SH BUGS
.IX Header "BUGS"
GraphViz tends to reorder the nodes. I hope to find a work around soon
(possibly with ports).
.SH AUTHOR
.IX Header "AUTHOR"
Leon Brocard <\fIacme@astray.com\fR>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2001, Leon Brocard
.PP
This module is free software; you can redistribute it or modify it under the Perl License,
a copy of which is available at <http://dev.perl.org/licenses/>.