On Tue, May 4, 2010 at 6:55 PM, Daniel Carrera <[email protected]> wrote:
> Hello, > > Ok, I'm ready to show you my documentation ideas. For this, I'll need you > to use your imagination a little and pretend that what ou are looking at is > actually a man page, or a POD-generated page: > > http://sourceforge.net/apps/mediawiki/pdl/index.php?title=Demo_PDL > > This is what you would see if you type "man PDL" or if you click on the > "Documentation" link on the website. The idea is that the documentation > would be all developed in one place (e.g. POD) and then converted as needed > (HTML, man, etc). > This looks great! > This page merges content from PDL::Guide and the wiki. I also borrow one > idea from the Perl man page: If you look at the Perl man page, you'll see > that it is a just a guide that helps you find the docs you need ("Overview", > "Tutorials", "Reference", etc.). This is a good idea and PDL should do the > same. > Agreed. The page I wrote is also meant to work well as the front page for web based > documentation. The idea is that when you convert POD to HTML you obtain a > good quality, well organized user manual for PDL. > > > Please do read the page. I tried to keep the length reasonable. Some > highlights: > > * I rename PDL::Impatient to PDL::QuickStart. > * I merge PDL::Tips with the PDL Cookbook. > * I merge wiki pages (installation & migration) with POD pages. > These renames and additons seem reasonable to me as long as somebody (you? :) is willing to update any links pointing to them. Let me know what you think. > > Cheers, > Daniel. > Daniel - This looks great. The only thing I would add is that a document should be created somewhere that explains what 'use PDL' actually does, and a link to this page should be placed near the top of the doc. Said page, explaining what 'use PDL' does, should probably also compare (preferably in tabular format) 'use PDL', 'use PDL::Lite', and 'use PDL::LiteF'. David
_______________________________________________ Perldl mailing list [email protected] http://mailman.jach.hawaii.edu/mailman/listinfo/perldl
