view release on metacpan or  search on metacpan

html/about.pod  view on Meta::CPAN

A note is identified by the distribution, module, and paragraph number. But
what happens when a new version of the module comes out? The notes will also
have to take the version number of the distribution into account. But, is it
viable to show old notes with the POD of the new version? And where? Paragraph 
numbers can change.

In most cases, the documentation for the new version of a module is very
similar to the last one. If it is a bugfix release, there might not be any
changes at all; otherwise functions are typically added but not removed. In
cases such as this, it would be a good idea to transfer the old notes to the
new version. The paragraph to which the note was originally attached can be
compared to the paragraphs in the new version and, if one is similar enough
(preferably identical), the note is transferred.

If the system can't figure out where to put the old note, the author or a
moderator can move it to a place in the new version if the note still applies.
Hopefully some of the good notes will become obsolete once the author of the
module decides to update the documentation to address the issues mentioned in
the note.

Users are able to edit, move, and delete their own notes. Moderators are be

lib/AnnoCPAN/DBI.pm  view on Meta::CPAN

    # delete cached html
    $podver->flush_cache;

    # XXX version check might go here
    my $ref_section = $self->section or return;
    my $orig_cont = $ref_section->content;

    my $max_sim   = AnnoCPAN::Config->option('min_similarity') || 0;
    my $best_sect;
    for my $sect ($podver->raw_sections) {
        next if $sect->{type} & COMMAND; # can't attach notes to commands
        my $sim = similarity($orig_cont, $sect->{content}, $max_sim);
        if ($sim > $max_sim) {
            $max_sim   = $sim;
            $best_sect = $sect;
        }
    }
    if ($best_sect) {
        AnnoCPAN::DBI::NotePos->create({ note => $self, 
            section => $best_sect->{id}, score => int($max_sim * SCALE),
            status => CALCULATED });

tt/motd.html  view on Meta::CPAN

C<> (code),
etc, and verbatim paragraphs (lines that start with a space). What you can't 
use are the pod commands, such as =item, =head1, etc. For more information
about the POD format, see [% link_perldoc_name('perlpod') %].
</div>
</div>

<div class="motd"><h3>Are you a module author?</h3> 
<div class="motd_body">
You can
get an RSS feed of all the notes attached to your modules at
<code>http://annocpan.org/~<em>YOUR_PAUSE_ID</em>/recent.rss</code> !
</div>
</div>


[% PROCESS footer.html %]