Klaus, You are correct that you would force a web connection for documentation by hard coding a web address. And as Lars identified you may offend the MetaCPAN lovers (myself included) by forcing an older CPAN link. As an aside you may need to beef up your META.yml file and or your META.json files in the distribution before your distribution indexes on MetaCPAN.
https://metacpan.org/author/WITTROCK Some perl gurus feel that the best way to ship a script as a module is the use of Modulinos. https://github.com/shlomif/mastering-perl/blob/master/Chapters/18.modulinos.pod This would solve your linking problem with scripts. Additionally Adding the POD at the bottom of your code instead of a separate file will allow the function and the documentation to have the same package name/reference. Best Regards, Jed On Wed, Feb 5, 2014 at 3:47 AM, K. Wittrock <kwittr...@web.de> wrote: > Jed, > > I feared that I had written too much details, so no one would look at my > email. On the contrary you even consulted my source code before writing > down your reply. I appreciate this very much. > > Here is another link example, taken from file obstacle.pod: > L<Games::Sudoku::Trainer::pod::training.pod/Train the strategy> > This is a link between 2 .pod files. You wrote > > | In general the L<SudokuTrainer> form is for registered (or at least > indexed modules) ... > > When I understand this right, this means that I have to convert my .pod > files to .pm modules (with only a package and a version line and a 1; line > above the POD stuff) in order to get such links clickable in HTML doku. The > links work correct at my local installation, created from the tarball > before uploading it. That's a big surprise for me. > > Script sudokutrainer.pl <http://search.cpan.org/% > 7Ewittrock/SudokuTrainer-0.00_08/script/sudokutrainer.pl> will finally > land up in dir "bin/" or "site/bin". So I think a good package name might > be "sudokutrainer", without a path in front. <http://search.cpan.org/% > 7Ewittrock/SudokuTrainer-0.00_08/script/sudokutrainer.pl> > > I don't like to insert your suggested link to search.cpan.org < > http://search.cpan.org/%7Ewittrock/SudokuTrainer-0.00_ > 08/script/sudokutrainer.pl> into my source, since this would mean that > the user has to be online to read the docu, although it is available > locally. Instead I might e.g. replace the link in file obstacle.pod that I > quoted above by C<Games::Sudoku::Trainer::pod::training.pod/Train the > strategy>. > > Thanks again for your kind help. > > Klaus > > > Am 04.02.2014 21:30, schrieb Jed Lund: > >> Klaus, >> >> For the generic web link try >> >> L<SudokuTrainer|http://search.cpan.org/~wittrock/ >> SudokuTrainer-0.00_08/script/sudokutrainer.pl <http://search.cpan.org/% >> 7Ewittrock/SudokuTrainer-0.00_08/script/sudokutrainer.pl>> >> >> >> In general the L<SudokuTrainer> form is for registered (or at least >> indexed modules) not scripts and requires that the script have a package >> name to register. This script operates in "main". >> >> #!/usr/bin/perl >> use strict; >> use warnings; >> >> #use feature qw( say ); >> >> # basic Sudoku structures >> # don't panic - all basic Sudoku structures are constant >> package main; <--- >> >> Best Regards, >> >> Jed >> >> >> On Tue, Feb 4, 2014 at 9:40 AM, K. Wittrock <kwittr...@web.de <mailto: >> kwittr...@web.de>> wrote: >> >> My CPAN application SudokuTrainer has POD sections in files >> sudokutrainer.pl <http://sudokutrainer.pl> and enter_presets.pl >> <http://enter_presets.pl>. In addition there are 3 POD files in >> >> dir Games/Sudoku/Trainer/pod/. My module files reside in dir >> Games/Sudoku/Trainer/. I also copied (by commands in Build.PL) the >> POD sections of *.pl to separate files sudokutrainer.pod and >> enter_presets.pod, which also reside in dir >> Games/Sudoku/Trainer/pod/, hoping that this might ease the usage >> of the docu. >> >> I am able to create links from a POD file to a target in the same >> file, and also to a module in CPAN. But I cannot create a link >> from a POD file to a different one. When clicking on such a link >> at "http://search.cpan.org/search?query=sudokutrainer&mode=all"; I >> always get the CPAN window saying "not found". Here are some >> variants that I tried in enter_presets.pl <http://enter_presets.pl>: >> >> >> L<SudokuTrainer|Games::Sudoku::Trainer::pod::sudokutrainer.pod> >> (link looks good) >> L<Games::Sudoku::Trainer::pod::sudokutrainer.pod> (link looks good) >> L<Games::Sudoku::Trainer::pod/sudokutrainer.pod> (link looks good) >> L<Games/Sudoku/Trainer/pod/sudokutrainer.pod> (apparently wrong) >> L<sudokutrainer.pl <http://sudokutrainer.pl>> >> >> L<sudokutrainer> >> >> All generated HTML-links are clickable. >> >> Is it possible that all of this fails simply because I didn't yet >> upload a "stable" version of SudokuTrainer, and thus there are no >> POD files in my namespace? >> >> And before you ask: Yes, I really did try to find the correct >> syntax for the links in various sources, among others perldoc pod, >> the camel book (German edition), PerlMonks Tutorial "POD in 5 >> minutes" (http://www.perlmonks.org/?node_id=252477). >> >> >> >
