.\" -*- 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::Prefixes 3pm"
.TH RDF::Prefixes 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::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"
This module is not so much for managing namespaces/prefixes in code (see
RDF::Trine::NamespaceMap for that), but as a helper for code that
serialises data using namespaces.
.PP
It generates pretty prefixes, reducing "http://purl.org/dc/terms/"
to "dc" rather than something too generic like like "ns01", and provides
a context for keeping track of namespaces already used, so that when
"http://purl.org/dc/elements/1.1/" is encountered, it won't stomp on
the previous definition of "dc".
.SS Constructor
.IX Subsection "Constructor"
.ie n .IP """new(\e%suggestions, \e%options)""" 4
.el .IP "\f(CWnew(\e%suggestions, \e%options)\fR" 4
.IX Item "new(%suggestions, %options)"
Creates a new RDF prefix context.
.Sp
Suggestions for prefix mappings may be given, but there's no guarantee
that they'll be used.
.Sp
The only option right now is 'syntax' that is used by the to_string
method.
.Sp
Both hashrefs are optional.
.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 URI. e.g.
\&\f(CWget_prefix(\*(Aqhttp://purl.org/dc/terms/\*(Aq)\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 URI. e.g.
\&\f(CWget_qname(\*(Aqhttp://purl.org/dc/terms/title\*(Aq)\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 RDF/XML. 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 "get" versions of these methods, but doesn't modify the
context.
.ie n .IP """to_hashref""" 4
.el .IP \f(CWto_hashref\fR 4
.IX Item "to_hashref"
Returns a hashref of prefix mappings used so far. This is not especially
necessary as the object may be treated as a hashref directly:
.Sp
.Vb 4
\&  foreach my $prefix (keys %$context)
\&  {
\&    printf("%s => %s\en", $prefix, $context\->{$prefix});
\&  }
.Ve
.ie n .IP """TO_JSON""" 4
.el .IP \f(CWTO_JSON\fR 4
.IX Item "TO_JSON"
A synonym for to_hashref, provided for the benefit of the JSON package.
.ie n .IP """rdfa""" 4
.el .IP \f(CWrdfa\fR 4
.IX Item "rdfa"
Return the same data as \f(CW\*(C`to_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`to_hashref\*(C'\fR, but as a string suitable for
prefixing a SPARQL query.
.ie n .IP """turtle""" 4
.el .IP \f(CWturtle\fR 4
.IX Item "turtle"
Return the same data as \f(CW\*(C`to_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`to_hashref\*(C'\fR, but as a string of xmlns
attributes, suitable for use with RDF/XML or RDFa.
.ie n .IP """to_string""" 4
.el .IP \f(CWto_string\fR 4
.IX Item "to_string"
Calls either \f(CW\*(C`rdfa\*(C'\fR, \f(CW\*(C`sparql\*(C'\fR, \f(CW\*(C`turtle\*(C'\fR (the default) or \f(CW\*(C`xmlns\*(C'\fR, based on
the 'syntax' option passed to the constructor. This module overloads
the stringification operator, so explicitly calling to_string is rarely
necessary.
.Sp
.Vb 3
\& my $context  = RDF::Prefixes\->new({}, {syntax=>\*(Aqturtle\*(Aq});
\& my $dc_title = \*(Aqhttp://purl.org/dc/terms/title\*(Aq;
\& print "# Prefixes\en" . $context;
.Ve
.SS Internationalisation
.IX Subsection "Internationalisation"
Strings passed to and from this module are expected to be utf8 character
strings, not byte strings. This is not explicitly checked for, but will
be checked in a future version, so be warned!
.PP
URIs containing non-Latin characters should "just work".
.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\-2013 Toby Inkster
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.