On Jul 23, 2006, at 9:55 AM, Joe Rizza wrote:


--

Post:
    <mailto:dadadev@PROTECTED>

Unsubscribe:
     <http://mojo.skazat.com/cgi-bin/dada/mail.cgi/u/dadadev/ >

List Information:
     <http://mojo.skazat.com/cgi-bin/dada/mail.cgi/list/dadadev>

Archive:
         < http://mojo.skazat.com/cgi-bin/dada/mail.cgi/archive/dadadev>

>  I have mixed feelings. It's great to have some comments in the
> code, but because it is somewhat distracting to have the "pod" tags
> in the file, I typically have the generated HTML sitting on the
> side when I am editing the file. I can see the advantage to putting
> the "pod" tags in the file, but when you generate a separate
> document, it should be written differently from the comments in the
> code. Would be nice if there was a way to have the best of both
> worlds, without the extra work.

Well, if I did remove the pod, I would keep some basic comments, so
instead of seeing:

[snip]
     =pod

     =head2 $SUBSCRIBER_DB_TYPE

     B<$SUBSCRIBER_DB_TYPE> specifies the database you'd like to be
using. The
     plain-as-grain one to use is 'PlainText', although others may be
     available and you may be so inclined to make your own. B<MySQL> and
     B<PostgreSQL> should be included in the standard distribution.
To be
     able to use any SQL backend requires that you have access to an SQL
     database and that you have the B<DBI> perl modules installed.

     Set $SUBSCRIBER_DB_TYPE to B<MySQL> for MySQL, B<PostgreSQL> for
Postgres.

     If you do use a SQL database, you most likely have to tweak
     the B<%SQL_PARAMS> hash.

     =cut

     $SUBSCRIBER_DB_TYPE         ||= 'PlainText';
[/snip]

You'd see:

[snip]

        # Can be set to, PlainText, MySQL or Postgres
        $SUBSCRIBER_DB_TYPE         ||= 'PlainText';

[/snip]


I think a config file with *just* the variables present to be edited
would be just as worthless as one too heavily pod-ified.


--
Justin Simoni

.: Dada Mail "Write Once - Distribute Everywhere" Email Communication
Software

url:   http://mojo.skazat.com
aolim: leaddadaist



On Jul 23, 2006, at 9:55 AM, Joe Rizza wrote:

>  I have mixed feelings. It's great to have some comments in the
> code, but because it is somewhat distracting to have the "pod" tags
> in the file, I typically have the generated HTML sitting on the
> side when I am editing the file. I can see the advantage to putting
> the "pod" tags in the file, but when you generate a separate
> document, it should be written differently from the comments in the
> code. Would be nice if there was a way to have the best of both
> worlds, without the extra work.
>
> On 23 Jul 2006 00:36:01 -0000, Dada Mail (Justin Simoni)
> < dada@PROTECTED> wrote:
> Hey guys/gals, I have an idea, I thought I'd first ask you all for an
> opinion about:
>
> Currently, the Config.pm file has embedded documentation, that gets
> run through a translator, to make pretty HTML files like this:
>
>         http://mojo.skazat.com/support/documentation/Config.pm.html
>
> Here's more information on how/what the embedded docs are/work:
>
>         http://www.ayni.com/perldoc/perl5.8.0/pod/perlpod.html
>
> Some people have voiced that the embedded documentation actually
> makes reading the Config.pm file *harder*, since it's difficult to
> pick out sometimes, what variable it is you need to change, and what
> is just the *example* of how you change the variable.
>
> It may be worth while to, before I distribute Dada Mail, strip out
> this embedded documentation, to make the Config.pm file a little less
> busy. I could leave small comments here and there to keep some sort
> of organization in the file itself, but scrubbing everything else,
> except the actual variables, could lead to a easier-to-configure
> program.
>
>
> Any comments on this idea? If it's a horrible idea, please let me
> know :)
>
> Cheers, and thanks for all the comments on the boards and bugs file
> recently,
>
> --
> Justin Simoni
>
> .: Dada Mail "Write Once - Distribute Everywhere" Email Communication
> Software
>
> url:   http://mojo.skazat.com
> aolim: leaddadaist
>
>
>
>
>
>
> --
>
> Post:
>     <mailto:dadadev@PROTECTED>
>
> Unsubscribe:
>      < http://mojo.skazat.com/cgi-bin/dada/mail.cgi/u/dadadev/>
>
> List Information:
>      < http://mojo.skazat.com/cgi-bin/dada/mail.cgi/list/dadadev >
>
> Archive:
>          <http://mojo.skazat.com/cgi-bin/dada/mail.cgi/archive/
> dadadev>
>
>
>
> --
> -Joe
>
> joe.rizza@PROTECTED
> joe.rizza@PROTECTED
> joe@PROTECTED
> http://www.scubajoe.net/
> Post:
> mailto:dadadev@PROTECTED
>
> Unsubscribe:
> http://mojo.skazat.com/cgi-bin/dada/mail.cgi/u/dadadev/
>
> List Information:
> http://mojo.skazat.com/cgi-bin/dada/mail.cgi/list/dadadev
>
> Archive:
> http://mojo.skazat.com/cgi-bin/dada/mail.cgi/archive/dadadev



--

Post:
    <mailto:dadadev@PROTECTED>

Unsubscribe:
     <http://mojo.skazat.com/cgi-bin/dada/mail.cgi/u/dadadev/ >

List Information:
     <http://mojo.skazat.com/cgi-bin/dada/mail.cgi/list/dadadev>

Archive:
         < http://mojo.skazat.com/cgi-bin/dada/mail.cgi/archive/dadadev>