|P is for Practical|
Perl6 Pod -- reinventing the wheel?by j3 (Friar)
|on Nov 25, 2006 at 00:02 UTC||Need Help??|
I noticed that Damian recently posted a draft of Synopsis 26 (Perl6 Pod) to perl.perl6.language. It looks like a great deal of effort has been put into making POD into a more general and complete doc format. But I'm left wondering, is a very large wheel being reinvented here?
It looks as if there are already numerous doc formatting markups available that could fairly easily be used in place of POD if a more complete doc format is wanted. The one that immediately jumps out at me is Texinfo.
I won't enumerate every feature of Texinfo here, but suffice it to say that it seems to have most every feature you'd want for this sort of job (generates multiple output formats, is indexable, searchable, and so on). Furthermore, it would be trivial to incorporate it into perl code. For example, maybe have "POTD" ("Plain Old Texinfo Docs") start with '#@' instead of '#'. For example:
Then a "potd2whatever.pl" tool could simply start off as something like:
Some more observations:
Seems like the Perl + Texinfo would go together like peanut butter and jelly. So, why is this particular wheel being reinvented?
(Edit: Fixed the above code to remove the '#@' from the beginning of each line.)
(Edit: Corrected spelling of "Damian".)