| T O P I C R E V I E W |
| Davio |
Posted - 18 July 2003 : 12:29:43
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.< |
| 15 L A T E S T R E P L I E S (Newest First) |
| Etymon |
Posted - 21 June 2007 : 10:13:43
quote:
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.< |
| AnonJr |
Posted - 21 June 2007 : 06:34:29
Check the link in Davio's post 6 posts up.  < |
| lcamara |
Posted - 21 June 2007 : 03:52:09
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).< |
| garyrobar |
Posted - 15 June 2007 : 00:05:57
how perfect would a wiki be for the documentation project?< |
| gary b |
Posted - 12 May 2007 : 18:40:25
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
< |
| AnonJr |
Posted - 31 October 2006 : 13:49:51
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...< |
| muzishun |
Posted - 31 October 2006 : 02:04:15
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.< |
| OneWayMule |
Posted - 31 October 2006 : 01:45:08
I'm willing to complete it, Davio.
As I've already put some work into it I'd like to see this done. < |
| Davio |
Posted - 30 October 2006 : 21:11:11
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.< |
| muzishun |
Posted - 30 October 2006 : 13:17:34
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?< |
| AnonJr |
Posted - 23 July 2005 : 16:00:52
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.
< |
| Shaggy |
Posted - 04 July 2005 : 06:47:25
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.
< |
| meiyee |
Posted - 04 July 2005 : 03:40:29
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
quote:
Originally posted by Raavin
quote:
...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.
strSql = "SELECT Max(REPLY_ID) as NewReplyID "
strSql = strSql & " FROM " & strActivePrefix & "REPLY "
strSql = strSql & " WHERE FORUM_ID = " & Forum_ID
strSql = strSql & " and R_AUTHOR = " & rs("MEMBER_ID")
set rs9 = my_Conn.Execute (strSql)
NewReplyID = rs9("NewReplyID")
rs9.close
set rs9 = nothing
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
strSql = "SELECT Max(REPLY_ID) as 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"
strSql = strSql & " FROM " & strActivePrefix & "REPLY "
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.
strSql = strSql & " WHERE FORUM_ID = " & Forum_ID
strSql = strSql & " and R_AUTHOR = " & rs("MEMBER_ID")
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.
set rs9 = my_Conn.Execute (strSql)
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.
NewReplyID = rs9("NewReplyID")
This bit cleans things up by closing the connection to the database then setting the value of rs9 back to zero
rs9.close
set rs9 = nothing
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 |
Posted - 04 July 2005 : 03:23:22
very sorry, I need to testing, thank you
quote:
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.
< |
| Etymon |
Posted - 02 June 2005 : 11:29:37
An email has been sent. < |
