[libcatmandu-rdf-perl] 01/01: documentation
Jonas Smedegaard
dr at jones.dk
Sun May 18 02:13:09 UTC 2014
This is an automated email from the git hooks/post-receive script.
js pushed a commit to tag 0.02
in repository libcatmandu-rdf-perl.
commit 662eed3063ea62849041af9d2aa82baa849ecd62
Author: Jakob Voss <voss at gbv.de>
Date: Fri Sep 6 11:14:51 2013 +0200
documentation
---
.perlcriticrc | 2 +-
README.md | 9 ++++++---
dist.ini | 4 ++--
lib/Catmandu/Exporter/RDF.pm | 26 +++++++++++++------------
lib/Catmandu/RDF.pm | 45 ++++++++++++++++++++++++++++++++++++++++----
5 files changed, 64 insertions(+), 22 deletions(-)
diff --git a/.perlcriticrc b/.perlcriticrc
index c2f6df1..1154892 100644
--- a/.perlcriticrc
+++ b/.perlcriticrc
@@ -1,2 +1,2 @@
-[TestingAndDebugging::RequireUseStrict]
+[-TestingAndDebugging::RequireUseStrict]
equivalent_modules = Catmandu::Sane
diff --git a/README.md b/README.md
index 8e5fe7e..87015a9 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,10 @@ Catmandu::RDF - Modules for handling RDF data within the [Catmandu](http://libre
This [CPAN distribution](https://metacpan.org/release/Catmandu-RDF) is in an
early state of development. Feedback and contributions are very welcome at
-<https://github.com/nichtich/Catmandu-RDF>!
+<https://github.com/gbv/Catmandu-RDF>!
-[](https://travis-ci.org/nichtich/Catmandu-RDF)
-[](https://coveralls.io/r/nichtich/Catmandu-RDF?branch=master)
+# Status
+
+[](https://travis-ci.org/gbv/Catmandu-RDF)
+[](https://coveralls.io/r/gbv/Catmandu-RDF?branch=devel)
+[
diff --git a/dist.ini b/dist.ini
index 3c0571f..68db59f 100644
--- a/dist.ini
+++ b/dist.ini
@@ -1,6 +1,6 @@
name = Catmandu-RDF
license = Perl_5
-version = 0.01
+version = 0.02
copyright_year = 2013
author = Jakob Voß
copyright_holder = Jakob Voß
@@ -24,7 +24,7 @@ filename = .perlcriticrc
issues=1
[ChangelogFromGit::CPAN::Changes]
-tag_regexp = ^v(\d+\.\d+)$
+tag_regexp = ^(\d+\.\d+)$
[Git::Check]
[Git::Tag]
diff --git a/lib/Catmandu/Exporter/RDF.pm b/lib/Catmandu/Exporter/RDF.pm
index 0a97018..7e872ce 100644
--- a/lib/Catmandu/Exporter/RDF.pm
+++ b/lib/Catmandu/Exporter/RDF.pm
@@ -1,6 +1,6 @@
package Catmandu::Exporter::RDF;
-#ABSTRACT: serialize RDF data
-#VERSION
+# ABSTRACT: serialize RDF data
+# VERSION
use namespace::clean;
use Catmandu::Sane;
@@ -157,9 +157,9 @@ sub _expand_rdf {
Create a new Catmandu RDF exporter which serializes into a file or to STDOUT.
-A serialization form can be set with option C<type>. The type must be a
-subclass name of L<RDF::Trine::Serializer>, for instance C<Turtle> for
-RDF/Turtle with L<RDF::Trine::Serializer::Turtle>. The first letter is
+A serialization form can be set with option C<type>. The option C<type> must
+refer to a subclass name of L<RDF::Trine::Serializer>, for instance C<Turtle>
+for RDF/Turtle with L<RDF::Trine::Serializer::Turtle>. The first letter is
transformed uppercase, so C<< format => 'turtle' >> will work as well. In
addition there are aliases C<ttl> for C<Turtle>, C<n3> for C<Notation3>, C<xml>
and C<XML> for C<RDFXML>, C<json> for C<RDFJSON>.
@@ -168,22 +168,22 @@ The option C<fix> is supported as derived from L<Catmandu::Fixable>. For every
C<add> or for every item in C<add_many> the given fixes will be applied first.
The option C<ns> can refer to an instance of or to a constructor argument of
-L<RDF::NS>. Use a fixed date, such as '20130816' to make sure your URI
+L<RDF::NS>. Use a fixed date, such as "C<20130816>" to make sure your URI
namespace prefixes are stable.
-=head2 add
+=head2 add( ... )
RDF data can be added as used by L<RDF::Trine::Model/as_hashref> in form of
-hash references. A simplified form of JSON-LD will be supported as well.
+hash references. A simplified form of JSON-LD is be supported as well.
=head2 count
-Always returns 1 because there is always one RDF graph in a RDF document.
+Always returns 1 or 0 (there is only one RDF graph in a RDF document).
-=head2 uri
+=head2 uri( $uri )
-Used to expands an URI with L<RDF::NS>: for instance C<dc:title> is expanded to
-<http://purl.org/dc/elements/1.1/title>.
+Expand and abbreviated with L<RDF::NS>. For instance "C<dc:title>" is expanded
+to "C<http://purl.org/dc/elements/1.1/title>".
=cut
@@ -191,6 +191,8 @@ Used to expands an URI with L<RDF::NS>: for instance C<dc:title> is expanded to
L<Catmandu::Exporter>, L<RDF::Trine::Serializer>
+=encoding utf8
+
=cut
1;
diff --git a/lib/Catmandu/RDF.pm b/lib/Catmandu/RDF.pm
index 8665992..c6e4914 100644
--- a/lib/Catmandu/RDF.pm
+++ b/lib/Catmandu/RDF.pm
@@ -1,17 +1,54 @@
package Catmandu::RDF;
-#ABSTRACT: Modules for handling RDF data within the Catmandu framework
-#VERSION
+# ABSTRACT: Modules for handling RDF data within the Catmandu framework
+# VERSION
=head1 DESCRIPTION
Catmandu::RDF contains modules for handling RDF data within the L<Catmandu>
framework. This release is in an early state of development. Feedback and
-contributions are very welcome at <https://github.com/nichtich/Catmandu-RDF>!
+contributions are very welcome at L<https://github.com/nichtich/Catmandu-RDF>!
-=head1 MODULES
+=head1 AVAILABLE MODULES
+
+=over 4
=item L<Catmandu::Exporter::RDF>
+Serialize RDF data (as RDF/XML, RDF/JSON, Turtle, NTriples, RDFa...).
+
+=back
+
+=head1 SUGGESTED MODULES
+
+The following modules have not been implemented yet. Please contribute or
+comment if you miss them!
+
+=over 4
+
+=item C<Catmandu::Importer::RDF>
+
+Import serialized RDF data (RDF/XML, RDF/JSON, Turtle, NTriples, RDFa...).
+
+=item C<Catmandu::Importer::SPARQL>
+
+Import RDF data from a SPARQL endpoint.
+
+=item C<Catmandu::Exporter::SPARUL> or C<Catmandu::Exporter::SPARQL>
+
+Export RDF data with SPARQL/Update.
+
+=item C<Catmandu::Exporter::RDFPatch>
+
+Export RDF with HTTP PATCH.
+
+=back
+
+=encoding utf8
+
+=head1 SEE ALSO
+
+L<Catmandu>, L<RDF::Trine>, L<RDF::NS>
+
=cut
1;
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libcatmandu-rdf-perl.git
More information about the Pkg-perl-cvs-commits
mailing list