Commit 70ee1f59 authored by Jonas Smedegaard's avatar Jonas Smedegaard

Add POD sections NAME SYNOPSIS DESCRIPTION ARGUMENTS.

parent 5d1365fc
......@@ -28,6 +28,27 @@ use lib "$FindBin::Bin/../lib"; # Curie is my own module, not yet on CPAN
use RDF::Prefixes::Curie;
#use Smart::Comments;
=head1 NAME
rdfpuml - convert RDF to PlantUML diagrams
=head1 SYNOPSIS
B<rdfpuml> [options] F<infile>
=head1 DESCRIPTION
B<rdfpuml> makes true diagrams directly from B<Turtle> examples
using B<PlantUML> and B<GraphViz>.
Diagram readability is of prime concern,
  • kill this para. it doesn't really tell the whole story. instead, refer to the full documentation (is there a way to make a relative link that would work on CPAN?)

  • Above POD is needed for Pod::Usage to work in (succeeding git commit).

    I am aware that it is duplicated information, but it is backwards to maintain POD data in a separate file if we want to reuse POD data not only for standalone documentation but also at runtime for --help output and error messages: The better approach is to then move the POD data entirely inside the code file.

  • Can all of it be after __END__? And where to keep the images so the HTML export has them?

  • Quoting Vladimir Alexiev (2018-12-07 11:11:09)

    Vladimir Alexiev commented on a discussion on bin/rdfpuml.pl:

    #use Smart::Comments;

    +=head1 NAME + +rdfpuml - convert RDF to PlantUML diagrams + +=head1 SYNOPSIS + +B [options] F + +=head1 DESCRIPTION + +B makes true diagrams directly from B examples +using B and B. + +Diagram readability is of prime concern,

    Can all of it be after __END__? And where to keep the images so the HTML export has them?

    Yes, it is Perl: There is more than one way to do it!

    Is the placement of the POD sections crucial to you? If not, then I recommend that you accept this as-is and we discuss later eventual reorfanizing of documentation as a whole.

    signature.asc

Please register or sign in to reply
and rdfpuml introduces various diagram control mechanisms
using triples in the B<puml:> namespace.
Special attention is paid to inlining
and visualizing various Reification mechanisms (described with PRV).
=cut
my %PREFIXES =
(
crm => 'http://www.cidoc-crm.org/cidoc-crm/',
......@@ -94,6 +115,21 @@ filter not exists {?re a puml:NoReify}}
SPARQL
## $RE_SPARQL;
=head1 ARGUMENTS
=over 16
=item B<infile>
Read from this Turtle file.
=back
PlantUML output is written to file with a name stemming from B<infile>,
existing suffix F<.ttl> removed (if it existed) and suffix F<.puml> added.
=cut
die "perl rdfpuml <file>: read <file>.ttl, write <file>.puml\n"
unless (@ARGV);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment