.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" 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 "Module::Install::DOAPChangeSets::Format 3pm" .TH Module::Install::DOAPChangeSets::Format 3pm "2011-11-24" "perl v5.14.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" \&\s-1DOAP\s0 Changesets are written in \s-1RDF\s0 \- 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 \s-1RDF\s0 and Turtle. .PP You would normally describe your project in a file called \*(L"meta/changes.ttl\*(R" from which a changelog called \*(L"Changes\*(R" 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 \s-1DOAP\s0 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 \s-1DOAP\s0 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 \s-1DOAP\s0 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 \s-1FOAF\s0. At the very least, include a name. A \s-1CPAN\s0 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 \*(L"changefile\*(R" vocab, but this is not thoroughly tested. Changelogs written in this vocab tend to use \s-1DOAP\s0 incorrectly, so I discourage using this vocab. .SH "SEE ALSO" .IX Header "SEE ALSO" Module::Install, Module::Install::DOAPChangeSets . .PP , http://purl.org/NET/cpan\-uri/ . .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.