OT: a metacomment on feedback comments

[Aaron Watters]

I just noticed this on my documentation
page.

http://aaron.oirt.rutgers.edu/myapp/docs/W.intro
"""
This is quite possible the most confusing
web framework ever. It really deserves
some kind of award in a special category.
"""

This was posted just after someone on the same
computer (somewhere in Texas)
tried and failed to inject some javascript
into the page using a comment.

I don't see how this comment is helpful to
me or anyone reading the page. How the
framework confusing? Why should other readers dismiss
the project? Can the documentation
or implementation be
improved, or is the whole thing beyond repair
and if so how or why? Why do people bother
to write comments like this one?

Is there a link somewhere I can point to
to help people write useful or constructive
comments?

BTW: I just added support for several
Mootools javascript widgets and the
FCK wisiwig editor, checked in
to the repository and demoed in the
documentation, but not tarred up
in a release yet.

At least I'm having fun with it!

-- Aaron Watters
http://aaron.oirt.rutgers.edu/myapp/docs/W1500.whyIsWhiffCool

===
ban dhmo!
http://www.dhmo.org/

 

[Paul Boddie]

This was posted just after someone on the same
computer (somewhere in Texas)
tried and failed to inject some javascript
into the page using a comment.

This just means that you may have reached the Reddit crowd. Don't
worry, though: ten seconds after writing their comment (having Googled
and copy-pasted the JavaScript "attack" moments before that), someone
dangled a shiny object outside their window and they ran outside to
take a look. They won't remember your framework now.

Paul

 

[Johannes Bauer]

This was posted just after someone on the same
computer (somewhere in Texas)
tried and failed to inject some javascript
into the page using a comment.

Script-kid moron. Delete and enjoy your life.

I don't see how this comment is helpful to
me or anyone reading the page. How the
framework confusing? Why should other readers dismiss
the project? Can the documentation
or implementation be
improved, or is the whole thing beyond repair
and if so how or why? Why do people bother
to write comments like this one?

Humm... I just checked your framework out and must say that I, too,
found it a little confusing. Especially the meaning of "use-url" seems
awkward since obviously this means more like "use-middleware or
"use-plugin" or "use-module" or even just plain "use" (which would be
IMHO clearer).

When you say "use-url" I first though "Ok, this part of the document
will be shown when the user surfs at the supplied URL". Which is not
what it does.

I also do not understand what the difference between a section and a
use-url ist. It seems "section" just creates a new paragraph and
"use-url" invokes some plugin behaviour - but I'm not sure.

I'm not sure why you chose to use the {{ }} syntax, but I'm guessing
that when you'd have used XML it would be a pain to include manual HTML
formatting - again I am unsure.

To sum it up, I think it's a neat idea, but it's not really intuitive.
After being quite startled at first it got better after I read the "why
it's cool" page.

Kind regards,
Johannes

 

[Aaron Watters]

....To sum it up, I think it's a neat idea, but it's not really intuitive..
After being quite startled at first it got better after I read the "why
it's cool" page.

Thanks for taking the time to check it out and comment, Johannes.
I think you bring up a very good point --
some of directive names are confusing. I will think on renaming
them and I'd love suggestions. For those who may be interested
please see the comments at the bottom of

http://aaron.oirt.rutgers.edu/myapp/docs/W1200_1200.config_template

for my initial thoughts inspired by J.B's comments.

[BTW: I had to back out a handful of mootools coolnesses
because they broke in horrible ways under IE8 -- I
apologize if you saw a blank page or any other weirdness.]

Thanks again! -- Aaron Watters
http://aaron.oirt.rutgers.edu/myapp/docs/W1500.whyIsWhiffCool

===
How do you get to Carnegie Hall?
Practice! Practice!

 

[Aaron Watters]

Regarding feedback about
WHIFF -- WSGI/HTTP Integrated Filesystems Frames

Thanks for taking the time to check it out and comment, Johannes.
I think you bring up a very good point --
some of directive names are confusing.  

In retrospect the names were more than confusing. They were
simply awful. Thanks to Johannes, Drew and others I decided
to rename the directives:

"use-url" becomes "include",
"use-section" becomes "use",
"bind-section" becomes "reuse",
"bind-url" becomes "use-include",
"section" becomes "using",
"parameter" becomes "require"

These names are much less stupid (except for
use-include, but I couldn't come up with anything
better...).

Thanks Johannes and Drew! There is a new release
with the new directive names linked from

http://whiff.sourceforge.net

(What was I thinking?)

-- Aaron Watters

===
KIDS MAKE NUTRITIOUS SNACKS
(A real life newspaper headline)