.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "RDF::DOAP::ChangeSets 3pm"
.TH RDF::DOAP::ChangeSets 3pm 2024-03-07 "perl v5.38.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
RDF::DOAP::ChangeSets \- create pretty ChangeLogs from RDF
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use RDF::DOAP::ChangeSets;
\& use URI::file;
\& 
\& my $file     = \*(Aqpath/to/changelog.rdf\*(Aq;
\& my $file_uri = URI::file\->new_abs($file);
\& 
\& my $dcs = RDF::DOAP::ChangeSets\->new(
\&             $file_uri, undef, undef, \*(AqRDFXML\*(Aq);
\& print $dcs\->to_string;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module takes software changelogs written in the RDF DOAP
Change Sets vocabulary and produces human-readable changelogs.
.ie n .IP """RDF::DOAP::ChangeSets\->new($uri, $data, $type, $fmt)""" 4
.el .IP "\f(CWRDF::DOAP::ChangeSets\->new($uri, $data, $type, $fmt)\fR" 4
.IX Item "RDF::DOAP::ChangeSets->new($uri, $data, $type, $fmt)"
Creates and initialises an object.
.Sp
\&\f(CW$uri\fR is a URL for the input data. The URL is used to query the
RDF data for the heading of the output changelog. It may be passed
as either a string, or a URI object.
.Sp
\&\f(CW$data\fR is the RDF data to use as input. It may be passed as a
string, or as an RDF::Trine::Model object. If undefined,
this module will attempt to read data from the URL using
LWP::Simple.
.Sp
\&\f(CW$type\fR gives the constructor a hint as to the RDF vocabulary you
are using. For DOAP Change Sets, use 'current'; for Aaron Cope's
Changefile vocab, use 'legacy'; to autodetect, use 'auto'. By
default, performs autodetection. This module may crash and burn
if you try to mix both vocabs!!
.Sp
\&\f(CW$fmt\fR provides a hint as to what RDF format you're using. By
default, Turtle is assumed. Valid values are whatever
RDF::Trine::Parser\->new accepts.
.ie n .IP """$changeset\->is_legacy""" 4
.el .IP \f(CW$changeset\->is_legacy\fR 4
.IX Item "$changeset->is_legacy"
Boolean, indicating if a legacy vocab is being used.
.ie n .IP """$changeset\->is_current""" 4
.el .IP \f(CW$changeset\->is_current\fR 4
.IX Item "$changeset->is_current"
Boolean, indicating if the current vocab is being used.
.ie n .IP """$changeset\->model""" 4
.el .IP \f(CW$changeset\->model\fR 4
.IX Item "$changeset->model"
RDF::Trine::Model object representing the changelog data.
.ie n .IP """$changeset\->uri""" 4
.el .IP \f(CW$changeset\->uri\fR 4
.IX Item "$changeset->uri"
String representing the changelog URI.
.ie n .IP """$changeset\->to_string""" 4
.el .IP \f(CW$changeset\->to_string\fR 4
.IX Item "$changeset->to_string"
Creates a human-readable representation of the changelog.
.ie n .IP """$changeset\->to_file($filename)""" 4
.el .IP \f(CW$changeset\->to_file($filename)\fR 4
.IX Item "$changeset->to_file($filename)"
Same as \f(CW\*(C`to_string\*(C'\fR, but outputs to a file.
.SH BUGS
.IX Header "BUGS"
Please report any bugs to <http://rt.cpan.org/>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
RDF::Trine, CPAN::Changes::Spec, Module::Install::DOAPChangeSets.
.PP
<http://www.perlrdf.org/>.
.SH AUTHOR
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2010\-2012 Toby Inkster
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.