Mysidia Adoptables Support Forum  

Home Community Mys-Script Creative Off-Topic
Go Back   Mysidia Adoptables Support Forum > Community Board > Feedback and Suggestions

Notices

Reply
 
Thread Tools Display Modes
  #1  
Old 01-15-2015, 01:40 AM
MikiHeart's Avatar
MikiHeart MikiHeart is offline
Premium Member
 
Join Date: Apr 2009
Posts: 187
Gender: Female
Credits: 20,326
MikiHeart
Default We should build a wiki

I'm thinking that it could be a very good idea to build a wiki, or have an addon for vbulletin that creates a Wiki.

Something that we can all edit and add to, but have moderators approve edits (So we don't have any trolls come in and take over).

Then we can add our mods, guides, tips, and it's all in one easy place for people to get to.
Reply With Quote
  #2  
Old 01-15-2015, 01:46 AM
rickasawr's Avatar
rickasawr rickasawr is offline
Member
 
Join Date: Apr 2011
Location: United States
Posts: 51
Gender: Male
Credits: 7,447
rickasawr is on a distinguished road
Default

I would like to see this happen!

As a new user of the script, a wiki would be very informative and is easier navigating than thread posts on forums for information.
__________________
Reply With Quote
  #3  
Old 01-15-2015, 02:30 AM
Kyttias's Avatar
Kyttias Kyttias is offline
Premium Member
 
Join Date: Jan 2014
Posts: 857
Gender: Unknown/Other
Credits: 86,947
Kyttias is on a distinguished road
Default

I vote no. There are many versions of the script, far less than a dozen mods for each, and users would have to sign up for the wiki to ask questions on a separate discussion page. And as a mod maker, I would have to post and answer questions in two locations and then refer people who ask questions to the opposite site where the same question may have already been asked, rather than repeat myself.

There is already a perfectly convenient category on this site for mods (which are even conveniently organized by version). I don't see bulletin board software with a wiki for mods. Or any content management system, really. Save wikis for games and tv shows.

What we need is documentation and a github repository, as these are appropriate resource outlets for code. I don't want to see a wiki until those two are 100% done.
__________________
Please do not contact me directly outside of Mysidia.
I also cannot troubleshoot code more than two years old - I legit don't remember it.
Reply With Quote
  #4  
Old 01-15-2015, 02:54 AM
MikiHeart's Avatar
MikiHeart MikiHeart is offline
Premium Member
 
Join Date: Apr 2009
Posts: 187
Gender: Female
Credits: 20,326
MikiHeart
Default

There are all kinds of mods for vbulletin, including a wiki. So doesn't have to be a separate place. I think it's better than the forums, because the forums are all over the place.

The mods section is very unorganized. There are people asking for help, there are mods that have been removed, and mods that aren't updated.

The wiki would also include the full documentation. Right now, everything is all over the place and you have to search through everything to find what is useful and what is not. Where an updated and managed wiki would be a lot better.
Reply With Quote
  #5  
Old 01-15-2015, 01:07 PM
IntoRain's Avatar
IntoRain IntoRain is offline
Moderator
 
Join Date: Jul 2013
Location: Portugal
Posts: 461
Gender: Female
Credits: 19,256
IntoRain is on a distinguished road
Default

If the code was fully documented, documentation would be automatically made with specific tools like doxygen (yes, it generates its own wiki). I think it's more useful to document the classes and functions directly, instead of using a wiki
__________________


asp.net stole my soul.
Reply With Quote
  #6  
Old 01-15-2015, 01:59 PM
Hall of Famer's Avatar
Hall of Famer Hall of Famer is offline
Administrator, Lead Coder
 
Join Date: Dec 2008
Location: South Brunswick
Posts: 4,448
Gender: Male
Credits: 327,371
Hall of Famer is on a distinguished road
Default

Well the next major version will have documentation for each class, property and method. Mys v1.3.x does not have documentation though, and I do not plan to add one in future. I think a wiki sounds good, you may research on mediawiki or wikia. Let me know which one you like better.
__________________


Mysidia Adoptables, a free and ever-improving script for aspiring adoptables/pets site.
Reply With Quote
  #7  
Old 01-15-2015, 04:04 PM
rickasawr's Avatar
rickasawr rickasawr is offline
Member
 
Join Date: Apr 2011
Location: United States
Posts: 51
Gender: Male
Credits: 7,447
rickasawr is on a distinguished road
Default

After seeing the idea for documentation, i agree that there should be a documentation instead of a wiki because im having trouble figuring out everything about the script. A documentation would be very usefull and very help, i hope to see one in the future!
__________________
Reply With Quote
  #8  
Old 01-15-2015, 07:28 PM
Kyttias's Avatar
Kyttias Kyttias is offline
Premium Member
 
Join Date: Jan 2014
Posts: 857
Gender: Unknown/Other
Credits: 86,947
Kyttias is on a distinguished road
Default

I'm trying to build some sort of documentation here, but mostly for my own reference, and it's far from done. ^^;
__________________
Please do not contact me directly outside of Mysidia.
I also cannot troubleshoot code more than two years old - I legit don't remember it.
Reply With Quote
  #9  
Old 01-15-2015, 11:11 PM
MikiHeart's Avatar
MikiHeart MikiHeart is offline
Premium Member
 
Join Date: Apr 2009
Posts: 187
Gender: Female
Credits: 20,326
MikiHeart
Default

I don't know much about documentation, I just know that most ones I've seen are just simple html pages.

Also HoF, any timeline for the next version? I know you were planning to release it last year but life always gets in the way of things (Damn life and living and stuff lol)

rickasawr: Have a look at Kyttias' documentation, it's looking really good.
Reply With Quote
  #10  
Old 01-16-2015, 12:38 PM
IntoRain's Avatar
IntoRain IntoRain is offline
Moderator
 
Join Date: Jul 2013
Location: Portugal
Posts: 461
Gender: Female
Credits: 19,256
IntoRain is on a distinguished road
Default

Basically you just need to comment the functions and classes with the appropriate comment blocks and it generates a wiki with call graphs and cross references and everything.
Quoting a post I made previously about this:

Quote:
Originally Posted by IntoRain View Post
Can I suggest doxygen-style comments for the classes and functions? Doxygen automatically generates a wiki thing (.html) with information on all classes and functions from just comments, making it easier in my opinion for us to search for stuff. I know it kinda sucks to comment everything, but since you will be changing the code a lot and since some of the older functions and core classes are already commented, I thought I'd suggest doxygen-style comments: http://www.doxygen.nl/docblocks.html

The generated .html pages look awesome:

http://i.imgur.com/xwg2V9c.png (example of a function description (detailed) - it has the call graph and the caller graph!)

http://i.imgur.com/O8nIDdC.png (example of a class list, it shows undetailed member functions with the details at the end of the page - it has a search function! it also shows class hierarchy, files, etc!)
(please ignore the fact I used both C-style and Java-style code standards for the function names lol it's messy I know)

You can customize the wiki colors and structure as well, I just didn't lose much time with it.

I say yes to creating a wiki for user guides like Kyttias' though.
__________________


asp.net stole my soul.
Reply With Quote
Reply

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
Looking for someone to help me build an alert system Infernette Staff Central 4 07-02-2014 05:23 PM
Lionisa - Build up your lion collection! Aasixx Adoptables Buzz 1 08-07-2012 05:10 PM
-Using Scratch to Build A Town- Poppy Tutorials and Tips 3 03-28-2012 07:02 PM


All times are GMT -5. The time now is 07:30 AM.

Currently Active Users: 451 (0 members and 451 guests)
Threads: 4,080, Posts: 32,024, Members: 2,016
Welcome to our newest members, jolob.
BETA





What's New?

What's Hot?

What's Popular?


Powered by vBulletin® Version 3.8.11
Copyright ©2000 - 2024, vBulletin Solutions Inc.
vBCommerce I v2.0.0 Gold ©2010, PixelFX Studios
vBCredits I v2.0.0 Gold ©2010, PixelFX Studios
Emoticons by darkmoon3636