Resource Documentation

What we really need is a function in the manager so that when you are editing (or adding) a resource, if the assets/resourcetype/resourcename/documenation.txt file exists, it will show you a link saying view documenation!

Now that would be slick!

---Ryan Approved---

Mark claims it’s only four lines of code to implement, and it was spurned by the fact that Newslisting now has about 25Kb of documentation code. Sounds like a winner to me!

It would look something like this:

In the "snippets" tag for editing documents, clicking on a snippet name producing a pop-up with at least the argument list would be nice. Actually, it would not be difficult to do something about extracting the commented head from a snippet and making a FAQ-style dropdown out of it immediately under the name. That would mean that snippet writers would have to use a standard format for the comments in the beginning of their code, or at least have a standard header delimiter.

Sounds very interesting !

Keep up the good work guys-n-gals

regards,

zi

Agree to this!

We can havea better standard, so it’s easier for users to use it. While I have my own standar, susan has her own standard, same thing with Mark and the rest of the team. So any thoght of implementing a standard commenting system will be awesome. It will be much better if we set a standard for the code itself.

I’m all for standard, so if any progress on this, please holler me.

Well, I’ve learned over the years not to become dogmatic over a standard I may prefer; the best standard is one that people will use!

Quote from: sottwell at Feb 02, 2006, 09:31 AM

Well, I’ve learned over the years not to become dogmatic over a standard I may prefer; the best standard is one that people will use!

Well, that’s true as well. But what I have in mind is a better/simpler way for people to have an auth system on their snippet for example. Instead of hard coding it like myself, I think having a more flexible API for this auth system will be awesome. So far I only found one for webuser, but i need to make my own for manager user. I think this is not related to coding standard at all, so forget about my post.