Re: Roll Call

[email protected] (Luke Palmer)
Newsgroups perl.perl6.documentation
Message-ID <[email protected]>
> Date: Fri, 08 Nov 2002 19:07:47 +0000
> From: Richard Nuttall <[email protected]>
>
> Useful List. I presonally use a combination of documentation for 
> programming, and
> find the Perl documentation more difficult to use than many. Generally, 
> I'd like
> an online 'database' of documentation.

That'd be nice.  I personally like Wolfram's mathworld
(mathworld.wolfram.com) (Weisstein) setup.  It's heavily
cross-referenced, and indexed by topic.  It has a good search tool as
well.

It might not be so great for a single documentation project.  It works
well for hugantic sums of information, possibly not specialized.

> perlfunc, et al. are OK for a "what parameters do I use for this 
> function", but for
> example code, updates, etc, it has to be online.

It's extremely nice to have a local copy though.  Maybe something that
can easily be synced?  Or a, um, perl script to look it up quickly
online.  Both?

> I expect to be mostly a lurker on this list, but am prepared to put some 
> effort into any online documentation effort. Presumably this would be 
> written in Perl6 ? Actually I mostly use PHP
> currently (again, this has an excellent online reference manual, with 
> places for people to add
> sample code snippets), since I find it lighter weight and more 
> integrated for dynamic webpage
> generation when linked to a database.

You know it would be sacreligious to do it in PHP though...

Perl 5, until Perl 6 is stable and fast enough.  Then switch over.

Of course, we do it all in POD.  Then use various types of docs.  The
online part, perhaps a TexInfo (has anybody written a pod2texi?).
L<...> would have to be able to refer to more than manual pages.  Just
a different interpretation of the "...".

Yeah.  I like that the best.  Have a big bunch of small to medium
sized POD pages, cross-reference them together, and convert them to
web, texinfo, man, and all of that.

Extensions?  Caveats?

Luke
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.