Official TGE Documentation Feedback
by Michael Perry · in Torque Game Engine · 05/14/2008 (7:28 pm) · 64 replies
=========================================================================
This Thread Is The Official Documentation Feedback Area For ALL Versions of TGE
If you want to quick search for all TGE Doc Updates, perform a keyword search in your browser for "Documentation Update:"
=========================================================================
Hey everyone. It's about time we have a central thread for TGE users to post their feedback in regard to documentation.
Now, I know there is a Documentation area in the TGE private area, but it makes sense to give non-licensed users a chance to be heard as well.
We have a similar thread going on in the TGEA private forum, and so far the feedback has been overwhelmingly positive, constructive, and very helpful to the doc writers...so let's keep that going with TGE =)
Purpose of the Thread:
- Provide a central thread for Torque Game Engine users to post their thoughts, suggestions, and criticisms about documentation.
Targets:
- Official documentation provided by GarageGames, TDN articles, and user submitted docs/tutorials.
Suggestions for Posts:
- What is the #1 thing you would like added to the official docs?
- What area of the docs do you think needs the most work?
- What do you see in other tech docs, be it for other Torque engines or non-Torque tech, that you think would be beneficial to have in the docs?
- What are your feeling on TDN vs how the current official docs are presented?
- Bring attention to resources, tutorials, articles, or community member submissions you think should be merged into the official docs
...etc, etc
So, the overall concept of this thread is pretty simple. This is your chance to talk until your face turns blue about what you want from the docs.
Be as clear, descriptive, and specific as you can!
This Thread Is The Official Documentation Feedback Area For ALL Versions of TGE
If you want to quick search for all TGE Doc Updates, perform a keyword search in your browser for "Documentation Update:"
=========================================================================
Hey everyone. It's about time we have a central thread for TGE users to post their feedback in regard to documentation.
Now, I know there is a Documentation area in the TGE private area, but it makes sense to give non-licensed users a chance to be heard as well.
We have a similar thread going on in the TGEA private forum, and so far the feedback has been overwhelmingly positive, constructive, and very helpful to the doc writers...so let's keep that going with TGE =)
Purpose of the Thread:
- Provide a central thread for Torque Game Engine users to post their thoughts, suggestions, and criticisms about documentation.
Targets:
- Official documentation provided by GarageGames, TDN articles, and user submitted docs/tutorials.
Suggestions for Posts:
- What is the #1 thing you would like added to the official docs?
- What area of the docs do you think needs the most work?
- What do you see in other tech docs, be it for other Torque engines or non-Torque tech, that you think would be beneficial to have in the docs?
- What are your feeling on TDN vs how the current official docs are presented?
- Bring attention to resources, tutorials, articles, or community member submissions you think should be merged into the official docs
...etc, etc
So, the overall concept of this thread is pretty simple. This is your chance to talk until your face turns blue about what you want from the docs.
Be as clear, descriptive, and specific as you can!
About the author
Programmer.
#42
The authoritative server/replicated client networking model is so fundamental to everything else in Torque that I feel it needs strong explanation and reinforcement right at the beginning. It affects everything, and until I started teaching it right off in the commercial and education boot camps, students did not seem to properly adapt to the principles involved, and how it affects design.
Other than that, looks pretty solid!
PS: I realize that it breaks the mold of starting off easy and getting complex, but I'd strongly suggest that it really is that important.
08/13/2008 (3:50 pm)
Serious suggestion: I would move the (currently chapter 16) "Multiplayer" section up towards the top, probably top 3-5.The authoritative server/replicated client networking model is so fundamental to everything else in Torque that I feel it needs strong explanation and reinforcement right at the beginning. It affects everything, and until I started teaching it right off in the commercial and education boot camps, students did not seem to properly adapt to the principles involved, and how it affects design.
Other than that, looks pretty solid!
PS: I realize that it breaks the mold of starting off easy and getting complex, but I'd strongly suggest that it really is that important.
#43
08/13/2008 (4:03 pm)
@Stephen - I completely agree. That aspect of Torque development is critical, and indeed difficult to learn later after all the other fundamentals are covered. As far as the whole "mold" thing goes, I've read some pretty complex stuff in starter sections of books. Even if it was difficult to grasp at my level (at the time), it was fully appreciated as I reached the end of the book.
#44
08/13/2008 (5:54 pm)
I'm not sure if it qualifies as "documentation" for the purposes of this thread, but I for one really was compelled by the slight handful of tutorial videos I've found on YouTube and Vimeo. Not only are they great for visual learners like myself, but I honestly think they're a great marketing tool since it lets people see two things: 1) Torque is easy and powerful, and 2) it is well supported and you won't feel alone and lost when using it (greatly decreases the intimidation factor).
#45
The New Documentation System is live!!!!
Read my blog HERE
Here are the new TGE Links:
Main Landing Page
TGE Landing Page
TGE Official Documentation
08/14/2008 (9:43 am)
Documentation Update:The New Documentation System is live!!!!
Read my blog HERE
Here are the new TGE Links:
Main Landing Page
TGE Landing Page
TGE Official Documentation
#46
Looks good Perry!
This is what we need, a much clearer overlook of the docs, added stuff, etc.
(One request though, in for example the tutorials, can you/someone else add a tag at the top that states what versions of the engine it works with? Not just TGE, TGEA, Tx, etc. but more like 1.5.x, and such, as some of them are as old as 2002 it feels weird to try and implement it since you don't know if it's going to work with the new engine that you have.)
Hats off to ya!
08/14/2008 (9:56 am)
After just having had a chance to glance over the new layout and docs, I have to say AWESOME.Looks good Perry!
This is what we need, a much clearer overlook of the docs, added stuff, etc.
(One request though, in for example the tutorials, can you/someone else add a tag at the top that states what versions of the engine it works with? Not just TGE, TGEA, Tx, etc. but more like 1.5.x, and such, as some of them are as old as 2002 it feels weird to try and implement it since you don't know if it's going to work with the new engine that you have.)
Hats off to ya!
#47
Adding the compatibility tags is probably a good idea. I just need to think of a way of adding it without cluttering everything up. Thanks for the suggestion and the compliments.
08/14/2008 (9:58 am)
@Marcus - Thanks! =)Adding the compatibility tags is probably a good idea. I just need to think of a way of adding it without cluttering everything up. Thanks for the suggestion and the compliments.
#48
08/14/2008 (10:15 am)
A small tag at the link and at the top of the post/tutorial perhaps? 
#49
I'll be parusing them shortly. :-)
08/14/2008 (3:14 pm)
Wow, torques docs have finally come into the 21st century. Looking great.I'll be parusing them shortly. :-)
#50
Michael, I know we are already being spoiled, but a few screen shots would work so well in the Materials and Shaders section - and I'm sure other places too. :)
08/15/2008 (12:56 pm)
TGEA Material Translucency / The Alpha Channel: the link to SuperPNG is a 404. ( http://www.fnordware.com/superpng/ ? )Michael, I know we are already being spoiled, but a few screen shots would work so well in the Materials and Shaders section - and I'm sure other places too. :)
#51
I tend to go overboard with screen shots, so I'm actually scaling it back a bit. I plan on using them in tutorials only, unless a reference doc absolutely needs a visual aid. Don't worry, though. There will be plenty of visual aids as I start generating new content.
08/15/2008 (2:50 pm)
@Konrad - Thanks for finding that dead link. Could you repost that in the TGEA thread as well?I tend to go overboard with screen shots, so I'm actually scaling it back a bit. I plan on using them in tutorials only, unless a reference doc absolutely needs a visual aid. Don't worry, though. There will be plenty of visual aids as I start generating new content.
#52
08/16/2008 (1:02 am)
Michael, sorry for posting in the wrong forum, I will repost that in the TGEA thread right away.
#53
08/16/2008 (1:14 am)
I added Stephen's request to my list.
#54
I hope so because I think it is a great suppliment to the official docs you've done. But I couldn't find a link to these on the new landing page.
08/19/2008 (1:57 pm)
Awesome work,Michael! Quick question: will the old docs still be available? (i.e. http://www.garagegames.com/docs/tge/)I hope so because I think it is a great suppliment to the official docs you've done. But I couldn't find a link to these on the new landing page.
#55
08/19/2008 (2:58 pm)
@Brady - We'll be leaving those up for a while, at least until I can figure out how to deal with them. Glad you like the new docs =) 
#56
Any plans on writing docs for these soon? Does someone volunteering push it up on the list any?
Edit: Sent an email.
09/03/2008 (5:22 pm)
I'm suprised no one has mentioned Rigid's in the thread yet. I would be willing to help write some documentation for Rigid's and RigidShapes. I've been heavily modifying them over the past few days, so I've gotten a better understanding of them. But even so with all the 1 letter variables and seemingly random functions, it's confusing as hell. It's something that will really need line-by-line documentation for anyone hoping to modify it if they don't want to print out the code and spend a while studying it.Any plans on writing docs for these soon? Does someone volunteering push it up on the list any?
Edit: Sent an email.
#57
I've updated the TGE Landing Page:
- Links to TDN and GG pages now open in same window/tab
- Links to 3rd party site open in new window/tab
- Fixed grammatical errors
- Added Gem - A - Day link to tutorials
*Note - You may not see the changes immediately. The server cache has to be flushed.
09/05/2008 (2:36 pm)
Documentation UpdateI've updated the TGE Landing Page:
- Links to TDN and GG pages now open in same window/tab
- Links to 3rd party site open in new window/tab
- Fixed grammatical errors
- Added Gem - A - Day link to tutorials
*Note - You may not see the changes immediately. The server cache has to be flushed.
#58
Hey, the docs look great so far. I do need to point this out because it has been one of my biggest pet peaves with the torque game engine, the GUI. I personally can't stand it, I hate it and I think the reason why is because I don't fully understand how to use it. There is absolutely no documentation on any of the gui controls. I need to see examples and descriptions of how gui's are used. For example how do you use the GuiFrameSetCtrl or GuiStackControl, or whatever. When it comes to the gui and trying to build what you want, searching in the forums for people who might have had similar questions is a big waste of time. Please please please can you or someone put some good effort into the gui's and explain how to use each particular one. So users like myself and get an idea of what to use and how to build it.
Thx.
09/11/2008 (8:22 am)
@ Michael PerryHey, the docs look great so far. I do need to point this out because it has been one of my biggest pet peaves with the torque game engine, the GUI. I personally can't stand it, I hate it and I think the reason why is because I don't fully understand how to use it. There is absolutely no documentation on any of the gui controls. I need to see examples and descriptions of how gui's are used. For example how do you use the GuiFrameSetCtrl or GuiStackControl, or whatever. When it comes to the gui and trying to build what you want, searching in the forums for people who might have had similar questions is a big waste of time. Please please please can you or someone put some good effort into the gui's and explain how to use each particular one. So users like myself and get an idea of what to use and how to build it.
Thx.
#59
09/11/2008 (11:01 am)
@DALO - Heard loud and clear. When it comes to TGE and TGEA, the GUI system is where I excel. That was the first Torque component I touched when I picked up the engine. There is already a lot of GUI documentation out there, but it's so scattered that it's hard to put together a good series. I'm on it! 
James Martin