taint has asked for the wisdom of the Perl Monks concerning the following question:

Yes, NodeReaper, I know this question is highly subjective, may be Troll Bait, initiate Bike Shed competitions. So know also, I too will be watching.

OK now that we've established that. Let's get on to it, shall we?

I'm not in need, or desire of a (web)blog, as is usually associated with "commenting system". But more along the lines of a WIKI, or FAQ type commenting system. Where I post a very large document (documentation) and others can comment (augment) complain/express "nit's" (revise) the document -- sort of a living document, or maybe a Review, Debug, test-cycle sort of thing.

Am I making any sense?

I have a "pet project" I've been wanting to takle for some time, but had intended to write the commenting system myself. I fear that, with all I already have on my plate, I'll not get to it in a reasonable enough time. So I'd like to solicit the thoughts/experiences of the Monks, whom I've come to trust, for such information.

Thank you for all your consideration.

--Chris

P.S. It's a Perl related project, and I'll post all the dirty details in Meditations, shortly. Done. See: Why not a "living" PerlDoc? Others have it, why not Perl?, if interested.

#!/usr/bin/perl -Tw
use Perl::Always or die;
my $perl_version = (5.12.5);
print $perl_version;
  • Comment on Can anyone suggest a Commenting system?

Replies are listed 'Best First'.
Re: Can anyone suggest a Commenting system?
by kcott (Archbishop) on Nov 19, 2013 at 04:42 UTC

    G'day Chris,

    If you look at documentation on CPAN, you'll see an "Annotate this POD" link. I think all modules have this (although there may be some exceptions). In my browser, it's near the top, right-hand corner where you'll also find the "Download", "View/Report Bugs" and other links. (For a couple of examples I checked out, see DBI and List::MoreUtils.)

    These links go to an AnnoCPAN page for the module in question. This seems to be more or less what you're after.

    If your project is not something you were planning to upload to CPAN, you can probably set up your own standalone version. That's a complete guess on my part — I haven't tried it and don't know what would be involved; however, take a look at the AnnoCPAN FAQ and, in particular, "Can I get the code?".

    -- Ken

[reply]
[d/l]
[select]
      kcott, You read my mind -- I'm speechless.

      I gotta say; you really hit the nail on the head, with this one.

      Thanks kcott. +'s to you. The moment I get some to pass out! :)
      Exactly what I was looking for.
      Thanks!

      --Chris

      #!/usr/bin/perl -Tw
use Perl::Always or die;
my $perl_version = (5.12.5);
print $perl_version;
[reply]
Re: Can anyone suggest a Commenting system? (annocpan)
by Anonymous Monk on Nov 19, 2013 at 03:02 UTC

    Yes, NodeReaper, I know this question is highly subjective, may be Troll Bait, initiate Bike Shed competitions. So know also, I too will be watching.

    OK now that we've established that. Let's get on to it, shall we?

    No. Perlmonks isn't stackoverflow, none of those things are against the posting guidelines, so read Where should I post X?

    see http://www.annocpan.org/dist/AnnoCPAN?latest=1

[reply]

Back to Seekers of Perl Wisdom