.\" -*- 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 "Module::Install::DOAPChangeSets::Format 3pm" .TH Module::Install::DOAPChangeSets::Format 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 Module::Install::DOAPChangeSets::Format \- vocabulary guide .SH "DOAP CHANGESETS FORMAT" .IX Header "DOAP CHANGESETS FORMAT" DOAP Changesets are written in RDF \- normally serialised as Turtle, though other serialisations are fine. (The Module::Install::DOAPChangeSets module supports any input format recognised by RDF::Trine.) .PP This document assumes a good working knowledge of RDF and Turtle. .PP You would normally describe your project in a file called "meta/changes.ttl" from which a changelog called "Changes" will be automatically built at packaging time. .SS Namespaces .IX Subsection "Namespaces" You will want to define at least the following namespaces: .PP .Vb 6 \& @prefix : . \& @prefix dc: . \& @prefix dcs: . \& @prefix foaf: . \& @prefix rdfs: . \& @prefix xsd: . .Ve .PP And you should define a namespace specific for your distribution: .PP .Vb 1 \& @prefix my: . .Ve .SS "Describing the Changeset Document" .IX Subsection "Describing the Changeset Document" You should now give the Changeset document itself a description. At a minimum, you must set the dc:subject. .PP .Vb 4 \& <> \& dc:title "Changes for Example\-Example" ; \& dc:subject my:project ; \& dc:creator my:developer . .Ve .SS "Describing the First Release of the Distribution" .IX Subsection "Describing the First Release of the Distribution" Use DOAP to describe the first version of the distribution. At the very least you need to include its revision (version number): .PP .Vb 4 \& my:v_0\-01 \& a :Version ; \& dc:issued "2007\-12\-20"^^xsd:date ; \& :revision "0.01"^^xsd:string . .Ve .PP You would not normally list any changes against the first release, as nothing has been changed. .SS "Describing Subsequent Releases" .IX Subsection "Describing Subsequent Releases" For subsequent releases, you add a changeset to a release description: .PP .Vb 12 \& my:v_0\-02 \& a :Version ; \& dc:issued "2007\-12\-29"^^xsd:date ; \& :revision "0.02"^^xsd:string ; \& rdfs:label "The 0.02nd Coming" ; ## a "title" for the release \& dcs:changeset [ \& dcs:item \& [ rdfs:label "Example change." ] , \& [ rdfs:label "Example bugfix." ; a dcs:Bugfix ] , \& [ rdfs:label "Example new feature." ; a dcs:Addition ] , \& [ rdfs:label "Example removal." ; a dcs:Removal ] \& ] . .Ve .SS "Describing the Distribution" .IX Subsection "Describing the Distribution" Use DOAP to describe the distribution. At the very least you need to assert that the project is a Project and provide a name for it. You must also list all the releases you wish to appear in the human-readable Changes file generated by the Module::Install::DOAPChangeSets module. There are plenty of other properties in DOAP which you can also use. .PP .Vb 10 \& my:project \& a :Project ; \& :name "Example\-Example" ; \& :shortdesc "Just an example!" ; \& :programming\-language "Perl" ; \& :created "2007\-12\-18"^^xsd:date ; \& :maintainer my:developer ; \& :homepage ; \& :bug\-database ; \& :release my:v_0\-01 , my:v_0\-02 . .Ve .SS "Describing a Developer" .IX Subsection "Describing a Developer" Developers should be described using FOAF. At the very least, include a name. A CPAN e\-mail address is also a good idea. .PP .Vb 5 \& my:developer \& a foaf:Person ; \& foaf:name "Joe Bloggs" ; \& foaf:mbox ; \& foaf:page . .Ve .SS "Legacy Support" .IX Subsection "Legacy Support" The module has legacy support for Aaron Cope's "changefile" vocab, but this is not thoroughly tested. Changelogs written in this vocab tend to use DOAP incorrectly, so I discourage using this vocab. .SH "SEE ALSO" .IX Header "SEE ALSO" Module::Install, Module::Install::DOAPChangeSets . .PP , . .SH AUTHOR .IX Header "AUTHOR" Toby Inkster . .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2010\-2011 by Toby Inkster .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.