Comments on the Function DB

[Oldiesmann]

I am going to be doing some more work on the function DB soon, and want to see if anyone has any comments or suggestions (besides the fact that it doesn't match the rest of the site - we're working on that )

Here are a few things I'm considering:

Changing descriptions for the variable types to match those from the PHP manual
Adding links to the PHP manual for variable types (for example, clicking on "string" would take you to http://www.php.net/language.types.string)
Clickable file names - clicking on a file name would show only the functions from that file

I know some of you probably don't use the function database, but for those who do, what do you think of it?

[SleePy]

While viewing a Function it would be nice to know what File I am in
I always have to go back to the index and search for it.

As well while viewing it would be nice to display what SMF versions it works for.

[Joshua Dickerson]

Good ideas OM. I think it should be a part of the documentation though. So, maybe move it to there or move it to the customization site?

[Oldiesmann]

While viewing a Function it would be nice to know what File I am in
I always have to go back to the index and search for it.

As well while viewing it would be nice to display what SMF versions it works for.

Good ideas

Good ideas OM. I think it should be a part of the documentation though. So, maybe move it to there or move it to the customization site?

That's actually given me an interesting idea...
We could add another page to the customization site with links to resources for developers - the function DB, package SDK, documentation on creating mods and themes, etc. We could move the function DB there as well, or just keep it where it's been for a long time - doesn't really matter.

[metallica48423]

I think it might be useful to give an example snippet of the function in use, even just a short little script.

You can see syntax, of course, as it is right now, but some people I don't feel understand how to really use a function if they see it and i think that may help to an extent.

thats just my thoughts

[Joshua Dickerson]

OM: I thought we were already working on that?

[Oldiesmann]

I think it might be useful to give an example snippet of the function in use, even just a short little script.

You can see syntax, of course, as it is right now, but some people I don't feel understand how to really use a function if they see it and i think that may help to an extent.

thats just my thoughts

Good idea. I'll see what I can do.

OM: I thought we were already working on that?

I don't know what you guys are working on

[motumbo]

While viewing a Function it would be nice to know what File I am in
I always have to go back to the index and search for it.

Exactly.  One of the hardest parts of working with SMF is trying to find out where the functions are located--very time consuming.  Since the functions are documented in the function database, the location of the function in the source code should definitely be provided.

Also, I'd like to see on the main Function DB page a "How Do I Do This" with answers to questions that are likely to be asked frequently.  For example:

How do I automate posts through a script?
How do I modify the Captcha text?

There are more that I'm sure I can come up with in the future.

One more thing I'd like to mention is that I don't think the SMF code is explained in the comments as well as it should be.  There is an old saying that you should have x number of lines of comments for y number lines of code. 

I don't know if comments slow down the parsing of PHP code.  But, it would be nice if everything in the SMF sourcecode were explicitly explained.  As it stands, there is a good deal of guesswork in trying to figure out what does what.

One more thing I'd like to see:  A guide to all the variables used in SMF and where they originate and where they are used.  Many times I've seen a variable and I don't know where it comes from or where it is used.  I know that is a tall order.