Data Dictionary for Vbulletin

[globalstrata]

Has any one built a data dictionary for Vbulletin that describes all the variables and functions used within the code? I am looking for information such as required input and ourput for all the functions, variable information such as what they are used for, expected input type, where are they used (Files, functions), etc. I am doing a lot of customization and I would like to use the same variables as much as possible to ensure that the customization that I do, still allows me to keep upgrading my version of the files (when a new version is released) and quickly troubleshoot problems. I have contacted Jelsoft, but they do not have anything yet. :ermm:

Gladys

[Scrub]

I belive Zack may be working on something like this, but I am not sure.

[Xenon]

Well, of course it would be good for coders, but not that easy to write up.

But yeah, Zak should do it :D

[globalstrata]

Why would not be easy to write? I think that it is time consuming because the code has gotten big but not hard. In addition, there is software that allows you to pickup comments from within the code and automaticaly creates an html page for easy display and search. Can you imaging how this software we grow? Every one would be able to align their code to the business processes that Jelsoft has defined which in turn would allow that hacks would continue to work or at least would easily be changed as vbulletin upgrades are released. This is just common sense. Why do you think that most software have what is called developer kits?

[globalstrata]

One of the reasons that I was concern about how things are developed is because I was starting to add quite a bit of hacks to my site. Because of this, I had the following concerns:

1. If one is installing many hacks, one can run into the problem of overwriting code that is required by another hack.

2. vBulletin does not provide paid support (phone, email) if one has hacks installed in the system. I understand their concern because some of the hacks may insert code that could cause problems. But imagine Microsoft saying that they would not support Office because Adobe Acrobat Professional is installed!

3. Upgrading to future vBulletin software becomes increasingly more difficult as more hacks are installed in the system.

If the correct standardization policies and procedures would be defined, these type of problems could be prevented and it would ensure that people can keep upgrading their system to the latest capabilities.

One system that is promoting standardization and provides a good start for fixing standardization problems is vBa CMPS (http://www.vbadvanced.com/products.php?do=productinfo&p=4), since it allows one to keep templates almost unchanged but allows the flexibility to customize the look of the pages. However, that does not takes care of the changes that are done to many of the php files in order for hacks to work.

I think this is an awesome system and it has the potential to be really powerful. It just need a way to allow people to contribute in a standardized way.

Gladys Rodriguez
http://www.hamptonroadstech.com

[Dark_Wizard]

One of the reasons that I was concern about how things are developed is because I was starting to add quite a bit of hacks to my site. Because of this, I had the following concerns:

1. If one is installing many hacks, one can run into the problem of overwriting code that is required by another hack.

2. vBulletin does not provide paid support (phone, email) if one has hacks installed in the system. I understand their concern because some of the hacks may insert code that could cause problems. But imagine Microsoft saying that they would not support Office because Adobe Acrobat Professional is installed!

3. Upgrading to future vBulletin software becomes increasingly more difficult as more hacks are installed in the system.

If the correct standardization policies and procedures would be defined, these type of problems could be prevented and it would ensure that people can keep upgrading their system to the latest capabilities.

One system that is promoting standardization and provides a good start for fixing standardization problems is vBa CMPS (http://www.vbadvanced.com/products.php?do=productinfo&p=4), since it allows one to keep templates almost unchanged but allows the flexibility to customize the look of the pages. However, that does not takes care of the changes that are done to many of the php files in order for hacks to work.

I think this is an awesome system and it has the potential to be really powerful. It just need a way to allow people to contribute in a standardized way.

Gladys Rodriguez
http://www.hamptonroadstech.com

Standardization is a touchy and is a very difficult thing to setup. Although I agree there are certain things we (coders) can do to help out.

(referencing your topics above)....
1. What I try to do here is create functions and such to use wording specific to each of my hacks.

2. This is why we have vb.org.

3. I try to create a so called modular system in that I minimize as much as possible the editing of vb files to decrease the complexity of upgrading when you have my hacks installed. I have also (my new hacks for vb 3.0) integrated into my install/upgrade system a section to reinstall templates and phrases (just run the script again) in case of overwrite from a vb upgrade, I have seen this as well with a few other scripts and one right off the top of my head is vBindex (https://vborg.vbsupport.ru/showthread.php?t=59524&page=1&pp=15) by NTLDR....

Iz Zach is doing this then more power to him as this can take quite some time to develop.

[Natch]

This issue with templates being overwritten by a vB reinstall is kinda strange to me - why can the templates not be installed into all TOP LEVEL styles instead of just installing into the MASTER style ?

If this was the case, then the templates do not vanish when you upgrade ...

(just a thought)

[heavi]

Well, of course it would be good for coders, but not that easy to write up.

But yeah, Zak should do it :D

Has Zack (or anyone) created the Data Dictionary for Vbulletin?
If not, are there any threads or links to shed some light on the subject?

[Trigunflame]

Anyone can create it easily, if you can fill 2 requirements...

1. Know a good bit of the internals of vbulletin
2. use phpDoc