File documentation? - Posted (4729 Views)
thefallen
Starting Member
thefallen
Posts: 7
7
Has anyone taken the time to document the files used in Snitz and outlining their purpose/function? I've been looking around a bit and haven't found anything about it yet.

I'm looking at setting up a snitz forum for use on a commercial website in about 2 months and I'd rather not spend a week (at 1hr / page) going through 1.3mb of ASP code to understand the purpose of each file...so uhm, help?
<
 Sort direction, for dates DESC means newest first  
 Page size 
Posted
HuwR
Forum Admin
HuwR
Posts: 20611
20611
If you look at the lsit of files, the naming of them is pretty self evident as to what they do.
<
Posted
thefallen
Starting Member
thefallen
Posts: 7
7
Thanks for replying, and somewhat yes, it shows a very high level description, but there are still a bunch of calls cross page that I need to get a grip on to see where the rdbms gets called, what portions of a page are retrieved from other pages and so on. At the moment the only way to see what pages are included where and what pages call the DB to do what etc. is to go through the files one by one and look at the code and then cross match this with other pages to see where data comes from and where it's going. I'm hoping someone has been in the same situation and has done this before.


<
Posted
HuwR
Forum Admin
HuwR
Posts: 20611
20611
I'm pretty sure you'll find everyone has been in that situation smile
There is no better way to learn than by looking yourself. Telling you what everything does might speed thinkgs up slightly, but it will not give you the understanding which is of far greater benefit.
<
Posted
thefallen
Starting Member
thefallen
Posts: 7
7
arr, yeah, I just wish I didn't have a deadline sad
Ah well, if I spend a week or two documenting the files and calls and functions I'll post it up here somewhere.
<
Posted
HuwR
Forum Admin
HuwR
Posts: 20611
20611
And then you would need to do it again when 3.4 is released, and then again when the internationalise 4 is released, which works very differently.
<
Posted
thefallen
Starting Member
thefallen
Posts: 7
7
Not really, if I start documenting and customizing this version then we'll stick to it until there's a real business-based reason to move on.
Problem is I'm starting to think the effort might be more trouble than it's worth. We're gonna need to tie it into another member database on SQL Server, and having each pageload connect straight to the DB will be a scalability nightmare without connection pooling and stored procedures. And I'll need to know just what pages call the DB and what they do to be able to even consider building that. Ah well, we shall see.
<
Posted
Gremlin
General Help Moderator
Gremlin
Posts: 7528
7528
Intergrating with another member DB is usually not to hard, many have just used a SQL VIEW to do this.
Almost every page hits the DB in one way or another !
Sounds like your forum DB is not going to be sql ? or not the same server as the one with the existing membership DB ?
www.daoc-halo.com<
Posted
thefallen
Starting Member
thefallen
Posts: 7
7
Yeah, it is an SQL Server, and the same physical box as the other DB. I can do the DB matching thing simply by adding to the script that'll add/drop a member from the Snitz one if I add/drop them from the primary one, so that's no problem.
Ah well, I'll compromise and look at a few of the Snitz pages and then try to figure something out, can't really justify spending a week or two just on writing documentation before I even consider modification at the moment. From what I've seen so far there are a *lot* of DB connections, which could be a problem.
Thanks for the replies anyway smile
<
Posted
Gremlin
General Help Moderator
Gremlin
Posts: 7528
7528
Theres only one connection used in inc_top.asp (my_conn) or are you referring to Recordsets ?
www.daoc-halo.com<
Posted
HuwR
Forum Admin
HuwR
Posts: 20611
20611
As Gremlin said, there is only one connection per page, it is opened in inc_top and closed in inc_footer

You will get much further if you jus plow in and ask specific questions as a nd when you need to. You will find most functions are in the inc_functions.asp notabley, you should look at the dateToStr and strToDate functions, as the forum does not use dateTime data types.
<
You Must enter a message