Source

p5-rdf-prefixes / rp.man

.\" 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 "RDF::Prefixes 3"
.TH RDF::Prefixes 3 "2010-09-05" "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"
RDF::Prefixes \- simple way to turn URIs into QNames.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\& my $context = RDF::Prefixes\->new;
\& say $context\->qname(\*(Aqhttp://purl.org/dc/terms/title\*(Aq);  # dc:title
\& say $context\->qname(\*(Aqhttp://example.net/rdf/dc#title\*(Aq); # dc2:title
\& say $context\->turtle;  # @prefix dc: <http://purl.org/dc/terms/> .
\&                        # @prefix dc2: <http://example.net/rdf/dc#> .
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SS "Constructor"
.IX Subsection "Constructor"
.ie n .IP """new(\e%suggestions)""" 4
.el .IP "\f(CWnew(\e%suggestions)\fR" 4
.IX Item "new(%suggestions)"
Creates a new \s-1RDF\s0 prefix context.
.Sp
Suggestions for prefix mappings may be given, but there's no guarantee
that they'll be used.
.SS "Methods"
.IX Subsection "Methods"
.ie n .IP """get_prefix($uri)""" 4
.el .IP "\f(CWget_prefix($uri)\fR" 4
.IX Item "get_prefix($uri)"
Gets the prefix associated with a \s-1URI\s0. e.g.
\&\f(CW\*(C`get_prefix(\*(Aqhttp://purl.org/dc/terms/\*(Aq)\*(C'\fR might return 'dc'.
.ie n .IP """get_qname($uri)""" 4
.el .IP "\f(CWget_qname($uri)\fR" 4
.IX Item "get_qname($uri)"
Gets a QName for a \s-1URI\s0. e.g.
\&\f(CW\*(C`get_prefix(\*(Aqhttp://purl.org/dc/terms/title\*(Aq)\*(C'\fR might return 'dc:title'.
.Sp
Some URIs cannot be converted to QNames. In these cases, undef is returned.
.ie n .IP """get_curie($uri)""" 4
.el .IP "\f(CWget_curie($uri)\fR" 4
.IX Item "get_curie($uri)"
As per \f(CW\*(C`get_qname\*(C'\fR, but allows for more relaxed return values, suitable
for RDFa, Turtle or Notation 3, but not \s-1RDF/XML\s0. Should never need to
return undef.
.ie n .IP """preview_prefix($uri)"", ""preview_qname($uri)"", ""preview_curie($uri)""" 4
.el .IP "\f(CWpreview_prefix($uri)\fR, \f(CWpreview_qname($uri)\fR, \f(CWpreview_curie($uri)\fR" 4
.IX Item "preview_prefix($uri), preview_qname($uri), preview_curie($uri)"
As per the \*(L"get\*(R" versions of these methods, but doesn't change the
context.
.ie n .IP """hashref""" 4
.el .IP "\f(CWhashref\fR" 4
.IX Item "hashref"
Returns a hashref of prefix mappings used so far.
.ie n .IP """rdfa""" 4
.el .IP "\f(CWrdfa\fR" 4
.IX Item "rdfa"
Return the same data as \f(CW\*(C`hashref\*(C'\fR, but as a string suitable for
placing in an RDFa 1.1 prefix attribute.
.ie n .IP """sparql""" 4
.el .IP "\f(CWsparql\fR" 4
.IX Item "sparql"
Return the same data as \f(CW\*(C`hashref\*(C'\fR, but as a string suitable for
prefixing a \s-1SPARQL\s0 query.
.ie n .IP """turtle""" 4
.el .IP "\f(CWturtle\fR" 4
.IX Item "turtle"
Return the same data as \f(CW\*(C`hashref\*(C'\fR, but as a string suitable for
prefixing a Turtle or Notation 3 file.
.ie n .IP """xmlns""" 4
.el .IP "\f(CWxmlns\fR" 4
.IX Item "xmlns"
Return the same data as \f(CW\*(C`hashref\*(C'\fR, but as a string of xmlns
attributes, suitable for use with \s-1RDF/XML\s0 or RDFa.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs to <http://rt.cpan.org/>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Toby Inkster <tobyink@cpan.org>.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2010 Toby Inkster
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.