Masterview devel - Jul 2006 - MasterView directives - proposal single file format to contain code and all necessary docs, examples, category, etc.

Deb,

I was thinking about how to approach sharing of directives and everything
that involved around that.

I want to make this as easy as possible both for users and for us.

So with that in mind, it seems like a single file format for directives
would be the easiest. In that single ruby file we would have the directive
code and all the other necessary information to add it to the master list.
For instance in the rdoc it would have information about the directive.
Inside that might be example code on how to use it which could be
automatically put on the interactive test page. We could include a category
in the directive which we can use to group directives together much like you
have done for the docs.

My thinking is that if we move all the necessary information into the
directive files themselves and read it from there then we can make our docs,
interactive test page, and catalogs all dynamic. And people can upload and
submit a single ruby file and make it part of a shared online collection.

The only thing I haven''t figured out is tests for the ruby directive.
Those
are begging to be in a separate file unless we allow those to be bundled in
as well and then maybe not loaded at runtime but have test helper that
searches out those during test runs?? Haven''t thought threw this last
item
much but it would be so nice to be able to have people only submit a single
file to have everything. Gems would work too, but they are harder for people
to build.

Let''s think through further and see what we can come up with.

Jeff
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
http://rubyforge.org/pipermail/masterview-devel/attachments/20060712/7bc2104e/attachment.html

Jeff - yes, I like the direction that you''re heading with a scheme so
that
everything needed for a directive can be easily packaged in a single source
file.
 
As soon as someone has to start going through packaging and build cycles,
the "barrier to entry" goes way, way up.
 
I could live with, say, a 2-file approach based on a naming convention for
identifying test case to go with a directive; might even be better than
trying to bundle it all in one file, I do like having some separation of
tests from deliverables.  Separate but equal - tests come alongside, but
they''re not the thing itself.
 
Sorry I haven''t made much progress this week on the directives
infrastructure I got started on; been deep in a "zope black hole" all
week
for my new client.  Seeing some light in the tunnel though, so hoping for a
break to get back to the fun rails stuff within a day or two.  It''ll be
a
masterview w/e out here on the coast.  (and hey, paying work after a rather
long slow period ain''t so bad, I''m not complaining!)
 
~ Deb
 
-------------- next part --------------
An HTML attachment was scrubbed...
URL:
http://rubyforge.org/pipermail/masterview-devel/attachments/20060712/e3cbfc9d/attachment.html