James Muir wrote:
Hi,
I managed to get my modules uploaded to CPAN last night. Yay! :-)
I have few questions:
The program I've been working on displays a mind map on a Gnome2 canvas.
I'm wondering if I can include a small picture (30 Kbytes) on the main
page, or replace the synopsis which didn't get formatted very nicely
with the picture. Are either of these possible?
You can do something along the lines of:
=head1 NAME
test - testing...
=head1 DESCRIPTION
Below is a diagram to illustrate smething:
=begin html
<img src="diagram.jpg">
=end html
L<http://somewhere.com/images/diagram.jpg>
=cut
This should work for users of your module that have the docs installed
locally. I do not know if it is appropriate behavior to stuff a distro
with html media for viewing on CPAN.
The '=begin html' section only outputs its text when creating html
documents. It uses a relative url, so the image can be in any directory
relative to the pod file.
Since it's only rendered for html output, you need something for other
formatters, so a L<> link follows it. L<> links must contain an absolute
url, so you'll have to host the image somewhere.
I noticed that all of the modules (even those internal to the program)
are indexed. Is this normal? Is there some way in the future to show
only the main module?
You can add a 'no_index' section to your META.yml:
<http://module-build.sourceforge.net/META-spec-v1.2.html#no_index>
Randy.
