We have been working on a Snitz Project for the past couple of months.
About the Project The project is mainly to provide a documentation for users who are intrested in creating mods for thier forum. It will provide detailed information about every subroutine and function used in the forum code. Also detailed information about every database table and field used by the forum. Information on how to install mods and the security concerns a user should know about.
We believe mods shouldn't be created by just the admins or dev team members or the advanced snitz users. We believe all users should be able to mod thier forum to the way they want it. And give something back to the community.
What's Required? I'm glad you asked. A lot of persons think you got to be a asp guru to write a document like this, but that's not really true. A basic knowledge of the VBScript language is enough. Here's a few other requirements:

• Basic understanding of the Snitz Forums code
• Have installed a mod and also created a mod of your own
• Have a willingness to help
• A little free time

Just a few hours during the week is enough. We don't have a deadline (just hoping to get it done before the year ends). So you can take your time.
What's in it for me? You mean you wouldn't just do this for fun? Your name and/or username will be included as being part of the Snitz Development team when the document is published. Right along side the rest of the other developers. How cool is that?
If you're insterested just post here or you can email me via this forum.<

Hi Davio,

I'm interested. I'll email you soon.
Thank you for posting this. I apologize that it took me so long to notice it as well as reply.
Etymon
<

Oh, man, I wish I saw this sooner, I'd be glad to help =)<

Dave, I believe they need more than just one. You can do it.


<

Well, a lot has been done since I posted this announcement.
We have covered documenting the database tables and fields along with all asp functions and subs. What's left is to document the javascript functions, along with organizing the info we have about "Making your Mods Secure", "How to make a Mod" etc. We have the info, it just needs to be entered into the document in an easy and friendly to read manner.
If any of you guys, or anyone else is still intrested, please email me. I will take your email as "yes I would like to help out".
And please, don't email me if you're not serious about helping. I have had quite a few users who were excited about helping, but only showed up once to help and I didn't see them after that. Excitment alone isn't enough motivation.<

[^]<

Has this Project got anywhere further? Need anymore help? I'm in the middle of creating my first Mod and having this document to hand would probably have saved me loads of hours trawling through code to try and work things out!!
I'd be willing to lend a hand if you still need help. I'm a competant programmer, but don't know Snitz indepth, so I'd be coming at it from the angle of knowing what sort of info is helpful for a first time modder. <

I never saw this post. Do you still need help ??<

It's been a year later Gargoyle.
Well, the project is still there, just that it has gotten quite since. A lot of work, and I mean a lot has gone into it already. We are just at the final hurdle, where we need someone to write up the document. We have the info already, it just needs to be put into the document in a way newbies can understand and a format they can understand.
All of the functions and subs have been covered in the asp files. Just that we decided to include the Javascript functions as well, which put some additional work on the team.
There are a few javascript functions left that need to be descripted (is that a word). I mean, to be broken down and explained.
So if you guys are up to either challenge (document writing or javascript descripting), then let me know.<

E-mail has been sent to you.

Originally posted by Davio
So if you guys are up to either challenge (document writing or javascript descripting), then let me know.

I can give a hand if you like. <

Yeah I'll give it a shot if you don't mind. I'll send ya an e-mail er something.<

Ditto, It's still fairly fresh in my mind, the things Ir ealy needed to know to get programming as a mod newbie. I'll give documenting a go.<

I am very interested in learning this stuff so i can type stuff up with the given information. or i can sit here quietly and wait for it to be released<

That would be a great help, thanks Davio. I wish I could be more helpfull, but I am not very familiar with Java. But I can help with document writing.<

About the time that I last replied to this topic, we found out that our daughter has Autism. This makes two for us as our son also has it.
Since then, I've devoted my free time to developing a website that caters to the nutritional needs of Autistic persons. With what other free time I have, I can help in proof-reading when you all need a fresh pair of eyes.
Cheers,

Etymon
<

Etymon, as soon as the document end is near complete, I will use you as a proof-reader. The functions and subs and database descriptions will need to be looked over just to make sure they are working. That is 100's of descriptions to look at.
So you're on my list Etymon. <

You could add me to that list davio, sounds like alot to look over [^]<

You have been added Stim. <

I've never written any MODs, but I've gone through the code about a thousand times just to learn what things do, so if you need another proofreader, I'd be happy to help. I'll probably be best at finding nitpicky things like typos and stuff... I seem to find those quite often.<

You have been added to the list of proof readers Bill. Will email you when the document is ready for proofing.
Don't need any more proof readers. Thanks for the interest from everyone. If anymore positions come up, will let you know in this topic.<

Something just popped into my head davio, I dont know whether or not this has been thought of, but why not "suggest" it to be a good idea that when creating a mod, you should create some kind of configuration variable, thats loaded with the rest, to flag whether or not the mod is installed and active.
This way, people developing other mods that might need to accomodate an existing mod can do so by checking this variable.<

[Edited by Etymon - Reply should have been in another forum] <

Etymon, we can continue this discussion in the Mod Addon Forum w/o code<

What about a multilanguage documentation? I can translate in italian.<

Hey there,

I just posted a message yesterday asking if anyone wanted to start this kind of project. Better late that never I suppose. If there is anything I can do I will try. If I can get a taster of how you have approached the document then I can have a look into the Javascript bits. I'm not much at Javascript but if I understand correctly you mainly want a description of what the script does so people know where to look...is that right????
Also, does the document include things in FAQ form like "Adding a field to the post topic/reply..." or is is more of a tecnical description of the code.

Raavin ;)<

The document is at a halt right now due to a lack of interest. Although all of the database fields, javacscript functions, vbscript functions and subroutines, have been documented. An added feature we wanted to add was to give a description of each global variable that was used. We didn't start on that though.
An overview of how each function works was basically what I was aiming for. What it did, how it works and what each variable was used for.
What is left was highlighting the security concerns when making a mod, how to create a mod, how to install a mod. Things like that. The info is there, just that we needed someone to put it into a user friendly format, that is easy to read and not just some boring document. A few persons volunteered to do that but didn't hear back from them on it.

Also, does the document include things in FAQ form like "Adding a field to the post topic/reply..." or is is more of a tecnical description of the code.

I don't see how we could do that in the FAQ. That would be too technical as you would need to understand HTML and VBSCRIPT to accomplish that. Also considering line change may be different, code might be different. It wouldn't be helpful to a lot of people. Would end up with more questions that answers, if you ask me.<

I don't see how we could do that in the FAQ. That would be too technical as you would need to understand HTML and VBSCRIPT to accomplish that.

Yeah I suppose, but don't you need to know these 'reasonably' well to use the information to create a mod?? The field thing was an example I've just been tackling. I'm not a guru by any means, more of a hacker, but just finding all of the places where I needed to add code to get things to write to the database then display them on the topic page was a pain in the backside. I've spent the last week most nights up until between 1 and 2 am getting it happening. I'm still pulling my hair out at bits of it. In the end it all seemed so obvious but you are talking about HTML, VBSCRIPT, ASP and SQL. If I'd had a guide about where to look, the actual programming would have been a piece of cake...well almost.

One idea for a format might be to create a heavily commented version based on the standard Snitz code, then a readable document that you can thumb through and refer to a starting point in the code that you can follow to complete tasks.

At the risk of becoming one of those who act interested at the start then bail out, any chance you could forward me the documentation to have a look at. I might be able to put together an example of what I am talking about.
Cheers,

Raavin ;)

<

At the risk of becoming one of those who act interested at the start then bail out, any chance you could forward me the documentation to have a look at. I might be able to put together an example of what I am talking about.

An example? I would rather send it to you if you were going to help with the completion of the document. <

...But each time the instructions are different based on the mods they have already added...

You are so right. I'm developing a mod at the moment on the vanilla snitz forum but the version I have installed for someone else is the Serverhacker version. I created the mod myself and I am finding it difficult to migrate it over. That said, You have to have something as a base to work from ie the vanilla flavoured version.

Before I started playing with Snitz I didn't really know much about coding HTML, never mind VBScript, Javascript, SQL etc. I have used Snitz as a practical platform to learn the ropes. If it was a bit more clearly documented it would have made things easier.
The FAQ I was thinking about was taking concepts that were used over and over and describing them in more detail, going into a bit of a discussion about uses then providing links to occurrences. Ideally these would go both ways.

eg.

Retrieving Data from the Database Single values into a variable
The ASP below outputs SQL which is used to retrieve a value from the REPLY_ID column(field) in the FORUM_REPLY table and places the value in as the Variable NewReplyID. Let's dissect the script.

The 'Max'(refer to SQL reference for more info) keyword retrieves the highest number in the REPLY_ID column (depending on the conditions), while the 'as' keyword stores this value temporarily as the alias NewReplyID


Here we allocate which table we want to draw the data from. In Snitz, 'strActivePrefix' will insert the prefix for the name, in this case 'FORUM_', and the ampersand will concatenate the strings together giving 'FROM FORUM_REPLY'. To choose another table, replace reply with the table you are after or replace everything after the ampersand with an explicit string like "FROM FORUM_TOPIC"


This is the conditions part. WHERE allows you to refine the search to rows which contain certain criteria. In this case we only want the data from the row WHERE the data in the FORUM_ID column equals the value stored in Forum_ID AND the data in the R_AUTHOR matches the data currntly in the MEMBER_ID column. Both Forum_ID and rs("MEMBER_ID") can be replaced with other variables or explicit values like numbers or strings.

There is a deeper explanation here (see constants reference) but suffice it t say that my_Conn.Execute (strSql) takes the SQL you generated above and...well executes it, opening a connection to the database called rs9.

This bit stores the value of NewReplyID (remember the alias above) and puts the value into a 'proper' variable which can be used as normal.


This bit cleans things up by closing the connection to the database then setting the value of rs9 back to zero



While the above is only my understanding of what's going on from experimentation, so is not entirely accurate, it's the sort of thing I'm talking about.


Thoughts-

In my own case of adding a field (it was a bit more complicated than that) there was a whole list of things to think about so I'd like to put together something which outlined a plan of attack like what files you need to look at, How Snitz locates certain data related to Categories, Forums, Topics and Replies and whether or not you will have to initialise variables on certain pages, the process flow for normal posting and expanding on this to acount for more advanced updating.

At the moment, I'm looking into seeing if I can get something that will export the code with coloured highlighting etc. to HTML. Then I'll see about adding links and popups. Some content to start with would be nice though.
Regards,
Raavin<

What you're talking about there, Raavin, looks more to me like an ASP/SQL tutorial which, from my understanding is not what this project is about. Also, the example you've provided is very specific, selecting the maximum value of a specific field in a specific table, if such tutorials were included in the documentation, they would have to be a lot more general than that to be of use to everybody.
<

Well...yes, it pretty much is an ASP/SQL tutorial and it is fairly specific but there are lots of similar examples throughout the Snitz code getting single and multiple values into variables. The thing I put together was just off of the top of my head as an example. The idea would be to introduce a concept, give a broken down example, provide links to similar examples and ideally provide a way to use it to identify pieces of code in the reverse manner also. A quick search of the code for "set rs = my_Conn.Execute (strSql)" pulls up more than 60 hits (more using variations on "rs" like "rs2"), which if you absorb the details of a simple example, I believe, make more sense and are reproducable.

Because ASP texts use different examples I think that the size of the snitz code gets intimidating and it is difficult to find your way around. In my example of adding a field, you need to add code to post.asp, post_info.asp, topic.asp and pop_delete.asp if you want to enter the data and have it show with a normal post and others if you want it on other pages. Then where in the page do you look ????

Maybe this isn't what this project is about so maybe it's another project which can benefit from the material already gathered. Maybe it's impossible. Who knows, I'm willing to give it a go.
Raavin<

Hi Raavin,

I'd like to email you on this. Is the email in your Snitz profile current?
Cheers,

Etymon
<

Yes it is Etymon. Cheers for the interest. Sorry it's taken me a bit to get back, I've been flat out with my 'real' work.

Feel free to drop me an email.
Cheers,

Jason<

An email has been sent. <

very sorry, I need to testing, thank you

Originally posted by Davio
We have been working on a Snitz Project for the past couple of months.
About the Project The project is mainly to provide a documentation for users who are intrested in creating mods for thier forum. It will provide detailed information about every subroutine and function used in the forum code. Also detailed information about every database table and field used by the forum. Information on how to install mods and the security concerns a user should know about.
We believe mods shouldn't be created by just the admins or dev team members or the advanced snitz users. We believe all users should be able to mod thier forum to the way they want it. And give something back to the community.
What's Required? I'm glad you asked. A lot of persons think you got to be a asp guru to write a document like this, but that's not really true. A basic knowledge of the VBScript language is enough. Here's a few other requirements:

• Basic understanding of the Snitz Forums code
• Have installed a mod and also created a mod of your own
• Have a willingness to help
• A little free time

Just a few hours during the week is enough. We don't have a deadline (just hoping to get it done before the year ends). So you can take your time.
What's in it for me? You mean you wouldn't just do this for fun? Your name and/or username will be included as being part of the Snitz Development team when the document is published. Right along side the rest of the other developers. How cool is that?
If you're insterested just post here or you can email me via this forum.

<

I need to ask some more question, how can I work out the forum which the reply will post under the column according to the topic I reply to? Thank you

...But each time the instructions are different based on the mods they have already added...

You are so right. I'm developing a mod at the moment on the vanilla snitz forum but the version I have installed for someone else is the Serverhacker version. I created the mod myself and I am finding it difficult to migrate it over. That said, You have to have something as a base to work from ie the vanilla flavoured version.

Before I started playing with Snitz I didn't really know much about coding HTML, never mind VBScript, Javascript, SQL etc. I have used Snitz as a practical platform to learn the ropes. If it was a bit more clearly documented it would have made things easier.
The FAQ I was thinking about was taking concepts that were used over and over and describing them in more detail, going into a bit of a discussion about uses then providing links to occurrences. Ideally these would go both ways.

eg.

Retrieving Data from the Database Single values into a variable
The ASP below outputs SQL which is used to retrieve a value from the REPLY_ID column(field) in the FORUM_REPLY table and places the value in as the Variable NewReplyID. Let's dissect the script.

The 'Max'(refer to SQL reference for more info) keyword retrieves the highest number in the REPLY_ID column (depending on the conditions), while the 'as' keyword stores this value temporarily as the alias NewReplyID


Here we allocate which table we want to draw the data from. In Snitz, 'strActivePrefix' will insert the prefix for the name, in this case 'FORUM_', and the ampersand will concatenate the strings together giving 'FROM FORUM_REPLY'. To choose another table, replace reply with the table you are after or replace everything after the ampersand with an explicit string like "FROM FORUM_TOPIC"


This is the conditions part. WHERE allows you to refine the search to rows which contain certain criteria. In this case we only want the data from the row WHERE the data in the FORUM_ID column equals the value stored in Forum_ID AND the data in the R_AUTHOR matches the data currntly in the MEMBER_ID column. Both Forum_ID and rs("MEMBER_ID") can be replaced with other variables or explicit values like numbers or strings.

There is a deeper explanation here (see constants reference) but suffice it t say that my_Conn.Execute (strSql) takes the SQL you generated above and...well executes it, opening a connection to the database called rs9.

This bit stores the value of NewReplyID (remember the alias above) and puts the value into a 'proper' variable which can be used as normal.


This bit cleans things up by closing the connection to the database then setting the value of rs9 back to zero



While the above is only my understanding of what's going on from experimentation, so is not entirely accurate, it's the sort of thing I'm talking about.


Thoughts-

In my own case of adding a field (it was a bit more complicated than that) there was a whole list of things to think about so I'd like to put together something which outlined a plan of attack like what files you need to look at, How Snitz locates certain data related to Categories, Forums, Topics and Replies and whether or not you will have to initialise variables on certain pages, the process flow for normal posting and expanding on this to acount for more advanced updating.

At the moment, I'm looking into seeing if I can get something that will export the code with coloured highlighting etc. to HTML. Then I'll see about adding links and popups. Some content to start with would be nice though.
Regards,
Raavin
<

Meiyee, there is a testing forum here where you can test all the features of Snitz Forums 2000. If you have any questions, please start a new topic, rather than hijacking existing ones.
<

I had posted here yesterday and was directed back to this thread.. My questions stems from having stumbled across this thread looking for something else... and being unable to find it again when I wanted to ask.
I'm working on integrating this forum and two other programs I've developed into an Learning Management System for the hospital I work at. In order to do this in the way I would like, I need a better understanding of the inner workings of this forum.
If at all possible, I would like to find out if there has been any progress - official or otherwise. I am more than willing to give back any and all refinements on the documentation, and am more than willing to help in any way needed.
Thanks. <

So, I realize this is a massive thread resurrection, but I think this was one of those projects that really had a lot of merit. Davio, has this project been canceled or just put on hold while work continues on v4? I am still quite interested in helping where I can and where it's needed (and I'm sure others are as well).
Any news on the status of the Mod Guide?<

I haven't gotten a lot of help in regards to the Mod Guide. The main problem is me not having the time to finish it. I would like someone to take over the project and complete it. It's not too difficult to do really. Just a lot of copy and pasting code.
And on top of that, need someone who is good at formatting a document so that it is easy to read, is needed. We have a looong document done by one of our members, that needs to be put into the guide, but formatted into sections so it is easy to read.
I haven't done much since earlier this year as you can see here: http://forum.snitz.com/mod_doc/
But I'll try and put some work into it, soon.<

I'm willing to complete it, Davio. As I've already put some work into it I'd like to see this done. <

Well, I had originally offered my help as a proofreader, but over the past year or so, I've learned quite a bit about Snitz from tinkering around "under the hood", so to speak. I'd be willing to help take over the project if there was at least one other person who could help. There's still a lot for me to learn about Snitz, but I think I could contribute some knowledge and a fair amount of proofreading to the guide.<

Are you wanting to keep adding the info to the javascripts like that? (did that make any sense? time for another cup of coffee.)

I ask so I can make sure I'm using the same format. I keep saying I'm going to help, but never quite get around to writing down what I stumble across...
Oh, and for some random and utterly useless trivia, that was my second post here up above...<

Davio...
Per your suggestion, here is my post offering assistance.

Lots of posts... not much progress. As a Project Manager for some small projects, I would be hitting the booze! You have GOT to be frustrated. What can be done to get this project running again?!?
gary b
<

how perfect would a wiki be for the documentation project?<

I don't suppose this "looong document" is available somewhere? I'd like to be able to see it as-is (even if it is hard to read, it would be better than nothing). Does it include descriptions of variables used in the code?

For example, I happened to stumble across an mlev check and wondered what that variable was for (and what were the possible values and their meanings)? I started looking for general documentation, but only found this thread through AnonJr's old thread, before I realized I should just search for the variable directly. While I got my answer (after trying a few threads in the "mlev variable" search result), it was qualified by an "I think, I'm a little rusty on this part" (happened to be a post by AnonJr, too).<

Check the link in Davio's post 6 posts up. <

Originally posted by lcamara
Does it include descriptions of variables used in the code?

The mod document in this topic doesn't cover variables, but it does cover tables, fields, functions, and subroutines.<