Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change
 
PerlMonks  

Re^2: Perl6 Pod -- reinventing the wheel?

by j3 (Friar)
on Nov 25, 2006 at 05:28 UTC ( #585970=note: print w/replies, xml ) Need Help??


in reply to Re: Perl6 Pod -- reinventing the wheel?
in thread Perl6 Pod -- reinventing the wheel?

The Texinfo licensing is compatible with Perl.
Actually, it's not. As far as I could determine in a few searches, it's released only under the GPL, which means it cannot be included in the core Perl distro. Everything in the Perl core has to be released under the dual-license (GPL + Artistic).

If Perl6 were to use an existing doc standard from which to base it's Pod, it would make sense to me that an implementation of this existing standard would simply be listed as a prerequisite, rather than actually being distributed along with Perl6 proper. That's part of the price for choosing to use an outside implementation of an existing doc standard for one's software project. Maybe that's not acceptable here though. I don't know what the Perl project policy is on that.

Which means, we'd need to rewrite the entire Texinfo application. Are you volunteering?

Not as such, but thank you for the offer. :) BTW, I don't mean to be making any requests here. I hope my posts don't come off sounding that way. Incidentally, if the Perl6 team specifically wanted to use an existing (non-POD) standard specification and then write their own implementation, I bet we'd be able to scratch up some usable pod62man and pod62html scripts very quickly.

From what I can tell, a main reason for not reinventing the wheel here is to allow many users to write their docs using markup and tools with which they are already familiar. Their existing tools may have features they can't live without (like having TeX draw their mathematics, or easily being able to include screenshots in their docs).

Now, if Perl6's Pod is general enough that folks can use it for documenting things that have nothing whatsoever to do with Perl, and if it's nifty enough that they'll actually *want* to document those things in Pod instead of their current favorite, then maybe it's worth taking the time to reinvent Perl5's POD. I think it would be great if it turns out to be both.

  • Comment on Re^2: Perl6 Pod -- reinventing the wheel?

Replies are listed 'Best First'.
Re^3: Perl6 Pod -- reinventing the wheel?
by merlyn (Sage) on Nov 25, 2006 at 23:37 UTC
    If Perl6 were to use an existing doc standard from which to base it's Pod, it would make sense to me that an implementation of this existing standard would simply be listed as a prerequisite, rather than actually being distributed along with Perl6 proper.
    Well, the distro has to include internaldoc-to-man at a minimum, or Unix admins around the world will scream. And I don't even think a texinfo-to-man exists, because texinfo is too rich to fit into manpages. In fact, that's the problem with your proposal as well. According to texinfo:
    Notable is the lack of man as an output format. Texinfo is used to write the documentation of GNU software, which typically is used in Unix-like environments such as Linux, where the traditional format for documentation is man. Man pages have a strict conventional format, whereas typical Texinfo applications are for tutorials and reference manuals. As such there is no benefit in using Texinfo for man pages, which are traditionally quick reference guides. However, many GNU projects eschew man pages nearly altogether, referring the reader of the provided, and often self-describedly seldomly maintained, man page to the Info document
    Ugh.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://585970]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others musing on the Monastery: (3)
As of 2020-11-26 21:47 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?