Re: minivend documentation (WAS: Re: [mv] IF tag: [if session login]doesn't work?)

[Birgitt Funk <birgitt@booktraders.com>]

******    message to minivend-users from Birgitt Funk <birgitt@booktraders.com>     ******



On Fri, 24 Mar 2000, Bill Randle wrote:

> I'm sure there are a lot of you out there that can read Perl - even if
> you don't consider yourself a strong programmer in it.
> 
> Just to follow up on Mike's earlier suggestion, how about this challenge:
> for those of you that feel capable, the next time you come across a
> minivend tag that you're not quite sure about, take a look at the source.
> Write down the list of options (things referenced by $opt->{somename})
> and a brief synopsis of what it looks like it does. Post your summary
> to the mailing list.

[snip]

> P.S. If you do decide to take up my challenge, you'll find most of the
> tags are handled in <minivend-root>/lib/Vend/Interpolate.pm. The
> functions are typically named "tag_xxx" where the xxx part is the
> tag name. E.g. tag_error, tag_data. If you don't find it there, look
> in Parse.pm. There's a giant table in there that has the tag name
> and a reference the module/function that handles that tag

May be we could pick up Mike's suggestion this way:

All people who feel their Perl competence is strong enough to pitch in
sign up in a list. (I am not in there) Someone posts a _complete_ list of
tags (again).

Each person takes one to several tags and looks through the existing
documentation to see how it was described and where. Then writes up a
replacement text possibly with suggestion where to replace and posts it 
to the list under [mv-tag-document].

Then it is up to Mike to decide if and how to integrate it in the existing
docs. 

If that helps. 

How many people out of the 897 feel their Perl knowledge is strong enough
to document the source code ? 

It would help to identify the number of people capable (even if not
wanting to participate), just to get an idea at where the users stand with
regards to their Perl knowledge and ability to handle documentation tasks. 

May be we find then a more realistic approach and a much fairer (and
more appreciative) view about the existing docs as well.

Birgitt 


-
To unsubscribe from the list, DO NOT REPLY to this message.  Instead, send
email with 'UNSUBSCRIBE minivend-users' in the body to Majordomo@minivend.com.
Archive of past messages: http://www.minivend.com/minivend/minivend-list