|Keep It Simple, Stupid|
How do I link to the Perl documentation?by SiteDocClan
|on Jun 30, 2004 at 21:03 UTC||Need Help??|
How do I link to the Perl POD?
There is a great website which maintains an HTML version of the Perl documentation: perldoc.perl.org.
There are two mechanisms (URL pseudo-schemas) for linking to the documentation contained on that site: perldoc and doc. The former is used for searching the documentation; the latter is for linking directly to documents.
There's also a couple ways to link to module documentation at cpan.org: mod:// and dist://. The former actually does a search of module names, using the given name components as search terms. The latter links directly to the record for the current version of the specificied distribution. If you want to link to a certain module but the search would be too ambiguous (have too many results), you can use the latter form, because it's deterministic. Neither of these forms links directly to a module's man page; the user will have to click through either a page of search results, or a distribution's main record.
(Do note that distribution names have hyphens, where module names have double-colons.)
Especially, read and heed these important shortcut usage tips!
Back to PerlMonks FAQ