Hi Daniel,

On Mon, 2010-05-03 at 12:35 +0200, Daniel Carrera wrote:
> Hello,
> 
> Does anyone mind if I edit the wiki?

in principle, no--this is why we have it!
> 
> After logging in to SF using my Google ID I went to the wiki page and I
> got an infinite redirect loop. Does anyone know what's going on?

not without more description.  Though make sure you look at #6 from the
main page "Editing the PDL wiki" for a description of how to get editor
access.  SF restricts it to prevent spam.  Once a username attributable
to you shows up in the wiki user list, I can add you as an editor.  I
don't know how that works if you use a Google instead of a SF id.

> 
> 
> Anyway, I think I can improve the wiki.

you suggest copying several PDL docs into the wiki. I'm not sure that's
a good idea right now, mostly because those documents are present in the
PDL source code (for example, see Impatient.pod).  This makes it easy
for these documents to start diverging, making for a maintenance
nightmare.  Linking to the relevant online docs is a good idea,
however--those are updated pretty regularly.

In fact, I just updated the online docs.  Look for PDL::Guide in the
manuals section.  This may be what you are looking for .  A link to that
from the wiki might be a good place to start.

I'll think about this more in the morning, if I have time.

best,
Derek

> 
> Here is the problem: PDL has lots of good documentation, but in the
> wiki it's all buried and impossible to find. Instead, the user is
> presented with a bunch of links that are more likely to frustrate than
> to help. The mail culprit is the "Getting Started" page.
> 
> If I had wiki access I would rewrite the "Documentation Contents"
> section like this:
> 
> 
> * "Philosophy of PDL"
>   -- Copy: http://pdl.sourceforge.net/PDLdocs/Philosophy.html
> 
> * "Installation"
>   -- Link: Installing_PDL_the_quick_and_easy_way
>      NOTE: This page should link to "Manual Installation".
> 
> * "Quick overview of PDL"
>   -- Copy: http://pdl.sourceforge.net/PDLdocs/Impatient.html
> 
> * "PDL for Matlab users"
>   -- Link: PDL_for_Matlab_users
>      NOTE: Add a migration guide, like the one for IDL.
> 
> * "PDL for IDL users"
>   -- Link: PDL_for_IDL_users
> 
> * "Frequently Asked Questions"
>   -- Copy: http://pdl.sourceforge.net/PDLdocs/FAQ.html
> 
> * "Indexing"
>   -- Copy: http://pdl.sourceforge.net/PDLdocs/Indexing.html
> 
> * "Support for 'Bad Values'"
>   -- Copy: http://pdl.sourceforge.net/PDLdocs/BadValues.html
> 
> * "Object Orientation"
>   -- Copy: http://pdl.sourceforge.net/PDLdocs/Objects.html
> 
> * "Dataflow"
>   -- Copy: http://pdl.sourceforge.net/PDLdocs/Dataflow.html
> 
> * "PDL Pre-Processor"
>   -- Copy: http://pdl.sourceforge.net/PDLdocs/PP.html
> 
> * "PDL API"
>   -- Copy: http://pdl.sourceforge.net/PDLdocs/
> 
> 
> As you can see, I am just re-organizing existing documentation. This
> makes the important information easier to find, and makes the docs feel
> more organized and coherent. The topics are reasonably sequential, from
> introductory to advanced, and a new user will easily find the pages he
> needs.
> 
> The list of links could be expanded with CPAN modules related to PDL.
> So it can talk about plotting, statistics, file format support, curve
> fitting, debugging, and so on. These are all important topics for PDL
> and should be on the main documentation page.
> 
> What do you think?
> 
> Daniel.
> 
> _______________________________________________
> Perldl mailing list
> [email protected]
> http://mailman.jach.hawaii.edu/mailman/listinfo/perldl



_______________________________________________
Perldl mailing list
[email protected]
http://mailman.jach.hawaii.edu/mailman/listinfo/perldl

Reply via email to