An offical T3D wiki?
by Glenn Bermingham · in General Discussion · 11/29/2013 (11:18 pm) · 22 replies
I've seen people mentioning the want for one or the various links to other places for information. So I'm wondering if there is or going to be an official Torque 3D Wiki? At the moment I'm having to load up separate site pages for Syntax, then login to another area entirely for other bits of information.
Personally I'm still learning Torque Script let alone C++ and I wish there was a single place for information for me to learn from. To be able to search up something such as SFXProfile and find a list of capabilities, attributes and even a reference to the actual C++ side of things explaining how things are working would be invaluable. To further add to that, having a type of resource integration e.g. RTS Protype example (as well as others) to future show new options or other peoples alternatives.
My hope from this thread is to get the ball rolling.
Personally I'm still learning Torque Script let alone C++ and I wish there was a single place for information for me to learn from. To be able to search up something such as SFXProfile and find a list of capabilities, attributes and even a reference to the actual C++ side of things explaining how things are working would be invaluable. To further add to that, having a type of resource integration e.g. RTS Protype example (as well as others) to future show new options or other peoples alternatives.
My hope from this thread is to get the ball rolling.
About the author
I spend most of my time working on games.
#2
12/01/2013 (6:07 am)
I agree, there should be a wiki. The issue would be someone taking time out to set one up. Nonetheless a great idea.
#3
12/01/2013 (4:24 pm)
Like most Wiki's its community contributed and driven, so its a matter of having an official location for it than anything else really. I would be inclined to start one up but it likely wouldn't be taken seriously or be used as much as something officially announced and supported. 
#4
Torque Developor Network (Wiki) at tdn.garagegames.com/wiki/TDN_Home
12/01/2013 (6:06 pm)
You know the TDN? Torque Developor Network (Wiki) at tdn.garagegames.com/wiki/TDN_Home
#5
12/01/2013 (9:52 pm)
@Luis I have used that area before but its behind a login and not exactly in the public eye.
#6
Would have to see if the Commitee can contact people from GG to give us more control over the wiki and how to make it more visible.
Then, we must carry all documentation wiki T3D.
TDN + Doxygen is a good combination.
12/03/2013 (2:34 pm)
I think changing the TDN to read by anonymous is fairly easy.Would have to see if the Commitee can contact people from GG to give us more control over the wiki and how to make it more visible.
Then, we must carry all documentation wiki T3D.
TDN + Doxygen is a good combination.
#7
What's the problem with the GitHub wiki? The official place to get T3D is now on GitHub, so it makes sense to tie an official wiki to the exact same location.
12/03/2013 (2:43 pm)
You would be better off spinning up a new TDN using an up to date version of the base tech (MediaWiki), or just using the GitHub wiki. TDN is on life support and can't handle any major changes to its functionality.What's the problem with the GitHub wiki? The official place to get T3D is now on GitHub, so it makes sense to tie an official wiki to the exact same location.
#8
12/03/2013 (3:14 pm)
The GitHub wiki was the best place, but I think there are permission issues with it. I think we couldn't open up edit access to everyone for the wiki without doing so for the repo itself. 
#9
12/04/2013 (4:01 am)
Yeah GitHub wikis are totally unilateral. Even though they're git repos themselves, you can't pull-request them directly. I think if GitHub is the constraint (I agree, it does make sense), then making a separate repo full of Markdown files might be the way to go. Like the current docs repo but redesigned from the bottom up. 
#10
(Which btw GG.com, doesn't either. Wouldn't it only take like 5 minutes to write a syntaxhighlighter script for GG.com?)
12/04/2013 (4:04 am)
Well, I would prefer a seperate Wiki simply because GitHub's SyntaxHighlighting doesn't cover TorqueScript!(Which btw GG.com, doesn't either. Wouldn't it only take like 5 minutes to write a syntaxhighlighter script for GG.com?)
#11
12/04/2013 (7:10 am)
Nothing takes 5 minutes for GG.com. It's a decade old ground up custom site. 
#12
12/04/2013 (12:33 pm)
LOL - yeah, updating GG.com is a daunting task at best. I remember the "simplest" changes causing havoc for days....
#13
I would like to test the idea of a site with all documentation.
github.com/LuisAntonRebollo/Torque-3D-Wiki-Test/wiki
I created a new repo and have imported to the wiki, all Torque3D-Documentation (repository). The repo is used as a web server to host Torque3D engine reference and TorqueScript reference.
To make easier the community to help with a wiki, would have to assign colaborators. The rest would have to create issues to add / modify the wiki documentation.
It would be interesting to import TDN wiki articles and useful resources.
You think that something similar could be productive?
It would be useful for the community?
It is possible to obtain the necessary settings and files (cpp and torquescript) for Doxygen?
12/04/2013 (8:20 pm)
This topic is on my roadmap 2014: DI would like to test the idea of a site with all documentation.
github.com/LuisAntonRebollo/Torque-3D-Wiki-Test/wiki
I created a new repo and have imported to the wiki, all Torque3D-Documentation (repository). The repo is used as a web server to host Torque3D engine reference and TorqueScript reference.
To make easier the community to help with a wiki, would have to assign colaborators. The rest would have to create issues to add / modify the wiki documentation.
It would be interesting to import TDN wiki articles and useful resources.
You think that something similar could be productive?
It would be useful for the community?
It is possible to obtain the necessary settings and files (cpp and torquescript) for Doxygen?
#14
Luis: I would really recommend not using an actual GitHub wiki, because the pull-request process is difficult and just allowing everyone to be an admin is a bad idea. IMO we should either have a proper seperarately hosted wiki, or use a repo of markdown pages. In fact, you could simply clone the T3D wiki repo, then point it to a proper repo remote and push. I'll do that as an example tonight.
12/08/2013 (4:27 pm)
Quote:Nothing takes 5 minutes for GG.com.This is why we need something like Torque3D.net...
Luis: I would really recommend not using an actual GitHub wiki, because the pull-request process is difficult and just allowing everyone to be an admin is a bad idea. IMO we should either have a proper seperarately hosted wiki, or use a repo of markdown pages. In fact, you could simply clone the T3D wiki repo, then point it to a proper repo remote and push. I'll do that as an example tonight.
#15
Eventually I'd like to get an autogenerated torquescript reference cron setup for each project if possible. Not sure if that would be useful.
Other docs and also maybe a section that would allow us to do test reporting for each release and new feature added would probably help out.
12/08/2013 (4:28 pm)
I finally got torquewiki.com setup. I've imported as much from TDN as I can, and I'll be going through and cleaning up and moving those old docs to a separate namespace for archival purposes. Need to import the collection of files from TDN too.Eventually I'd like to get an autogenerated torquescript reference cron setup for each project if possible. Not sure if that would be useful.
Other docs and also maybe a section that would allow us to do test reporting for each release and new feature added would probably help out.
#16
I've always used mediawiki, but I wanted to try a new solution.
If I could vote, I would decide for a mediawiki site.But it does have some problems:
@Frogger, lots of work in this wiki :D
It would be nice that category Torque2D and Torque3D and were on the Main Page to access them faster.
What is your experience in php and mediawiki?
What is your opinion about what I said about domain/hosting?
12/09/2013 (8:01 am)
It is true that the workflow when using the github wiki, it is very difficult for a community.I've always used mediawiki, but I wanted to try a new solution.
If I could vote, I would decide for a mediawiki site.But it does have some problems:
- Hosting: Someone would have to donate it, understanding that the content belongs to the community. Would have to provide facilities to access/copy/backup the site when necessary.
- Domain: It would have to donate one domain to the community, and find some way to get organized so domain do not get lost or left out of the community.
@Frogger, lots of work in this wiki :D
It would be nice that category Torque2D and Torque3D and were on the Main Page to access them faster.
What is your experience in php and mediawiki?
What is your opinion about what I said about domain/hosting?
#17
Simple and free.
Otherwise Frogger's site seems to look good, the only issue is having all of the wiki on a single domain accessed by a single user, if you run out of money or for another reason shut down the wiki, and another community member isn't taking over then all that information might simply get lost.
@Frogger
It would be nice if you could provide a safety-net for that sort of things, maybe a weekly-based backup that uploads a copy of the site and database to a public place where it can be accessed by anyone?
12/09/2013 (8:40 am)
If hosting is an issue, why not use a free solution like Wikia or some other solution like that?Simple and free.
Otherwise Frogger's site seems to look good, the only issue is having all of the wiki on a single domain accessed by a single user, if you run out of money or for another reason shut down the wiki, and another community member isn't taking over then all that information might simply get lost.
@Frogger
It would be nice if you could provide a safety-net for that sort of things, maybe a weekly-based backup that uploads a copy of the site and database to a public place where it can be accessed by anyone?
#18
12/09/2013 (5:49 pm)
Sure, I'd be happy to setup backups (either downloadable or copied somewhere). Ideally we'd have more than one admin on the site. No one really knows about it yet, so I guess it would depend quite a bit on the motivations of the steering committee. Otherwise, for now I'll try to get the stuff that's there cleaned up and add some more links to useful resources, and try to get ts reference generation working for each project.
#19
I've registered the domain at name.com. Ideally if we have an organization built up to maintain records of this suff, then that would be better. I've got it sitting on a linode box. If we need to, we can move it or do whatever we need.
Linode: $20.00/m * 12 months = $240
Domain: $10.99/y
SSL Cert: Free!
Total/y: $250.99
As far as extras that are added to mediaWiki, it includes syntax highlighting, and I need to add a torquescript definition for GeSHI. I'm pretty familiar with how to work with mediawiki and PHP in general.
I was contemplating putting all of the TDN pages somewhere (maybe a different namespace) so that they can get cleaned up and brought back in. There's a lot of complete garbage (no offense) as well that can just be removed.
Proper Torque3D and Torque2D sections need to be added as well, however I haven't been doing a very good job at keeping up with the Torque2D happenings, so I'm less sure if they have any use for one?
For each section at the very least have a console reference, build guides, and testing information (test new features and releases, keep track of regressions, hardware config tests). Then maybe other things depending on how much interest there is.
12/09/2013 (8:15 pm)
Hey sorry Luis, I didnt notice your post!I've registered the domain at name.com. Ideally if we have an organization built up to maintain records of this suff, then that would be better. I've got it sitting on a linode box. If we need to, we can move it or do whatever we need.
Linode: $20.00/m * 12 months = $240
Domain: $10.99/y
SSL Cert: Free!
Total/y: $250.99
As far as extras that are added to mediaWiki, it includes syntax highlighting, and I need to add a torquescript definition for GeSHI. I'm pretty familiar with how to work with mediawiki and PHP in general.
I was contemplating putting all of the TDN pages somewhere (maybe a different namespace) so that they can get cleaned up and brought back in. There's a lot of complete garbage (no offense) as well that can just be removed.
Proper Torque3D and Torque2D sections need to be added as well, however I haven't been doing a very good job at keeping up with the Torque2D happenings, so I'm less sure if they have any use for one?
For each section at the very least have a console reference, build guides, and testing information (test new features and releases, keep track of regressions, hardware config tests). Then maybe other things depending on how much interest there is.
#20
TorqueWiki.com looks like a good place as any, just need to get now get the ball rolling on submitting information I suppose. On that note I think including Torque 2D information should be integrated but visually separated as not to confuse. I know with a few games (Specifically the Arma Series) wiki's they have separate sections on pages for their legacy/alternate versions of games/engines as to cater to all.
12/20/2013 (7:32 pm)
Glad to see something happening! I think one of the hardest things to do is elaborate on information on the Wiki, I've been doing a person one of sorts and a lot of the information is circumstantial to what you may or may not want to do.TorqueWiki.com looks like a good place as any, just need to get now get the ball rolling on submitting information I suppose. On that note I think including Torque 2D information should be integrated but visually separated as not to confuse. I know with a few games (Specifically the Arma Series) wiki's they have separate sections on pages for their legacy/alternate versions of games/engines as to cater to all.
Torque Owner Lukas Joergensen
WinterLeaf Entertainment
You can do pull requests if you want to contribute.
Edit: I know it's not exactly the same thing as a wiki, but it's the closest we get atm.