Scoop -- the swiss army chainsaw of content management
Front Page · Everything · News · Code · Help! · Wishlist · Project · Scoop Sites · Dev Notes · Latest CVS changes · Development Activities
Let's comment code better Feature Requests
By fsterman , Section Wishlist []
Posted on Sat Sep 13, 2003 at 12:00:00 PM PST
A suggestion to make coding scoop easier. Basically label the final code with which block it belongs to. Implement as an option for all accounts since some things are not seen by non-admins.

While the commenting in Scoop is pretty decent it would be really nice if some commenting carried over to the raw HTML along with comments indicating which block contains that code. That way I wouldn't be wasting so much damn time searching through blocks hoping to find what I want. It would be good as an option for accounts, then we wouldn't need to waste kbytes on comments most people won't see anyway.

Also a search engine for block values would be nice as the standard browser search feature does not search through text boxes.
< A Naked Poll | PoliGeeks >

Menu
· create account
· faq
· search
· report bugs
· Scoop Administrators Guide
· Scoop Box Exchange

Login
Make a new account
Username:
Password:

Related Links
· Scoop
· More on Feature Requests
· Also by fsterman

Story Views
  28 Scoop users have viewed this story.

Display: Sort:
Let's comment code better | 4 comments (4 topical, 0 hidden)
I tried that (none / 0) (#1)
by janra on Sat Sep 13, 2003 at 10:06:04 PM PST

I think the only thing you can really do is put comments in the blocks themselves indicating which block starts and ends where.

If you take a look at lib/Scoop/Interface.pm, around line 40, you'll see some commented-out code that puts an HTML comment at the beginning and end of every block. I initially put this in in the hopes that it would help admins track down what block was used where, an especially ... interesting ... task when dealing with themes.

The trouble is, some blocks, like the colours, are interpolated into the middle of an HTML tag, and putting a comment in the middle of an HTML tag breaks things horribly. The code really has no way of telling what it can and can't safely put comments around, because a block is a block and can be interpolated everywhere.

And re: the search engine for blocks - I was just thinking an hour or so ago, as I answered a "where is this block?" question on scoop-help, that having the Scoop search engine search block values and descriptions (for people with edit_blocks permission only, of course) would be nice...

--
Discuss the art and craft of writing




Good idea (none / 0) (#4)
by fsterman on Sat Sep 27, 2003 at 09:09:45 PM PST

Good idea, I will have to start using Moz, as it provides all those funtionalities.  Shitty interface, a developers browser for sure :)  It is still a pain as you said.



Let's comment code better | 4 comments (4 topical, 0 hidden)
Display: Sort:

Hosted by ScoopHost.com Powered by Scoop
All trademarks and copyrights on this page are owned by their respective companies. Comments are owned by the Poster. The Rest © 1999 The Management

create account | faq | search