Official Torque 3D Documentation Feedback

#181 @Jacob - Yes, we had some anticipated problems with the upload of the new docs. Waiting for our web developer to come in and help me solve a few of the problems. There was no intention of uploading placeholder or blank docs for bad links, as the links should be working and pointing to existing docs. We will work on this throughout the week.

As for the CHM, you need to unblock it. On Windows, right click on the CHM and then click properties. At the bottom of the properties should be an option to unblock or unlock the file. After that, you should be able to see the CHM contents.

#182 Where is the link to the CHM ?

#183 @Giorgio - In the official docs (docs.torquepowered.com/torque-3d/official), click on the Scripting section in the TOC. It provides a link to the CHM.

TorqueScript Manual.

(honestly, at the rate it is evolving it's becoming more of a general manual, not just TorqueScript). speaks volumes for the doc team)

#184 @Jacob - Would you mind posting the exact links that go 404? I'm having a hard time locating them.

#185 - Added River Editor guide
- Added Mesh Road Editor guide
- Added Decal Road Editor guide
- Added Decal Editor guide
- Added Particle Editor guide
- Added Datablock Editor guide
- Fixed missing images for Setup guide
- Updated Shape Editor guide in World Editor/Editors section
- Improved formatting of Shape Editor guides
- Updated Introduction for T3D Documentation
- Various fixes for artist docs: odd characters, unused images, added missing files, fixed links

Documented fields, functions, classes, and callbacks for the following classes (WIP, as some of the classes need to change a little to support the docs). You can find them in the latest TorqueScript Manual CHM.

- Message
- MessageVector
- MessageForwarder
- ForestWindEmitter
- InteriorInstance (not fun)
- LightBase
- LightAnimData
- LightDescription
- HTTPObject
- LevelInfo
- ProjectileData
- PhysicalZone
- ScriptObject
- ScriptMsgListener

I just uploaded this push about 5 min ago. I'm flushing the site cache so you may not see it immediately. Some classes are using a few weird function calls, making it difficult to fully complete them for today's push. Still, just a show of progress.

#186 ALL
I just saw there are missing images from a few of the new guides, and I finally figured out what has been causing it all along. Has to do with the conversion process from Wiki to a clean HTML output. Just have to pay attention to the final output, and maybe make Dreamweaver stricter.

#187 I downloaded the torquescript manual from the link above, but all I see are "The address is not valid" errors. I must be doing something wrong.

#188 You have to unlock the CHM. For security reasons, whenever you download the CHM it will be locked:

1. Find the CHM
2. Right click
3. Properties
4. At the bottom of the properties, you should see an Unlock or Unblock section.

That should resolve the CHM issue

#189 Hrm...there must have been some help file bandits scanning hard drives for social security numbers and credit cards in the past. Shame on them preying on those in need of help ;)

#190 Thanks, I did not have the issue at home, only on the work computer.

#191 Notice a discrepancy between CHM Scripting Manual and the Online Official Documentation:

in TSShapeConstructor function descriptions:

addMesh has it's argument list in a different order than the CHM file

...It seems like a bit of work was done with TSShapeConstructor and more 'items' might need 'refreshing' across the two documents, ;)!

Scripting Manual has the 'latest' T3D scripting descriptions, and has the arguments listed as follows:

bool TSShapeConstructor::addMesh  ( string  meshName,  
  string  srcShape,  
  string  srcMesh   
 )

as compared to Official documentation, which has them in this order...

addMesh(string shape_filename, string src_mesh, string mesh_name)

#192 Rex - the TSShapeConstructor docs in the CHM are auto-generated from the source code, so these will always be the most up-to-date. The HTML version in the online docs should probably be removed.

#193 The autogen docs are really, well ok better than nothing. However it would be really nice if we had some examples. (a guy can dream can't he?)

I think TorquePowered needs to understand that not all of their users are hard core coders. They probably lose lots of people that way. Many are attracted by the shiny tools and the promise of not needing to be a systems level C++ dev to use it.

#194 Before you know it people will be wanting Official Tutorials also ;)

I must say that the new system for generating docs is quite nice: cleaner and simpler than it was before - just a matter of making use of it :D

#195 I have found the examples what ship with the engine to be full of good knowledge, better then a tutorial what would be aimed at a specific topic.

Of course, i have notice, some who do not seem to think of the 'demo' examples when pondering a technique to accomplish a goal.

#196 Pushing a new set of docs online today. Here's the breakdown:

Build Date 8/17/2010
Build Time 2:00pm
Available Time 3:00pm
Build URL http://docs.torquepowered.com/torque-3d/official/

Known Issues

Issues that are not critical enough to block release.

• TDOC-164 -> Directory Tour doc is out of date, in both text and images

Fixed Issues

Jira ID -> Issue Description

TDOC-123 -> T3D Documentation install takes user to nonexistent page

• TDOC-125 -> Creating Terrain Tutorial - Height map selection picture does not match documentation
• TDOC-126 -> "Introduction > Toolbox > Packaging Project" section contains grammar issue
• TDOC-127 -> "Engine > Rendering > Overview" page - HLSL link was changed
• TDOC-128 -> "Scripting > Syntax Guide" page contains some links with different web addresses
• TDOC-129 -> "Interface > Next" does not work
• TDOC-130 -> "Introduction > Toolbox > Next" does not work
• TDOC-131 -> "Editors > Terrain Painter > Conclusion" contains a sentence that should be a link
• TDOC-132 -> "Scripting > Syntax Guide" contains some broken links in "Bitwise Operators" section
• TDOC-133 -> "Tutorials > Adding Foliage > Previous/Next" does not work
• TDOC-134 -> "Scripting > Simple > Switch Statements > Next" > does not work as intended
• TDOC-135 -> "Adding Objects > Contents" is not fully functional
• TDOC-136 -> "Introduction > Toolbox > Adding Quick Links" section has missing images
• TDOC-137 -> "Adding Objects > Ground Plane > Next" does not work
• TDOC-138 -> "Introduction > Directory Tour > Previous/Next" link pics are missing
• TDOC-139 -> "Introduction > Setup > Supplemental Software" - Tortoise SVN Download link is broken
• TDOC-140 -> First page of the documentation contains a broken link
• TDOC-141 -> "Artist Guide > Importing Assets > Terrain > Next" does not work
• TDOC-142 -> "Introduction > What is Torque 3D" - Contents are not fully functional
• TDOC-143 -> "Scripting > Advanced > RTS Prototype" page has a broken image enlargement
• TDOC-144 -> "Tutorials > Creating a Sky > Next" does not work
• TDOC-145 -> "Scripting > Advanced > TSShapeConstructor" page contains a broken image
• TDOC-146 -> "Artist Guide > Importing Assets > Adding Objects to Level" - Contents are not fully functional
• TDOC-147 -> "Scripting > Simple > Vectors > Previous/Next" link goes to wrong page
• TDOC-148 -> "Engine > Audio > Overview" contains some broken links
• TDOC-149 -> "Introduction > Toolbox > Project Information" section contains a nonworking "Click to enlarge" picture
• TDOC-150 -> "Scripting > Intro to TorqueScript" contains broken links for Torsion and Notepad++
• TDOC-151 -> "Introduction > What is Torque 3D > Next" does not work
• TDOC-152 -> "Engine > Audio > Conclusion" page contains two broken links
• TDOC-153 -> "Introduction > Setup > Previous/Next" images are missing
• TDOC-154 -> "Scripting > Overview > Quick Reference > default" contains a broken link
• TDOC-155 -> "Tutorials > Adding Lakes > Previous/Next" does not work
• TDOC-156 -> "Engine > Rendering > Source Code Tour" contains broken links
• TDOC-157 -> "Artist Guide > Torque 3D Editors > Material Editor" issue with image enlargement
• TDOC-158 -> "Artist Guide > Torque 3D Editors > Sketch Tool > Previous/Next" links do not work
• TDOC-159 -> "Introduction > Directory Tour >SDK Tour" section contains a broken link
• TDOC-160 -> "Introduction > Toolbox > Previous" goes to the wrong page
• TDOC-161 -> "Creating Levels" link does not work
• TDOC-162 -> Documentation - Creating a Sky Tutorial - Tutorial files not provided
• TDOC-163 -> Documentation issues in Offline Documentation "Toolbox" page (list attached)
• TDOC-165 -> Broken links and images in the Official Documentation
• TDOC-166 -> Broken Offline Documentation 'Introduction' Links

Comments

• Next and Previous links/images have been removed from documentation
• Directory Overview is going to be rewritten, with no images this time
• Several tasks are duplicates, but listed for the sake of clarity

#197 There is no explanation of "RechargeRate" (it's for player - maybe vehicle too - energy level) or "energyPerDamagePoint" in the Torque API Manual. It only gets one single mention, and that's in code comments about something else.

Also you've got a typo of "enery" (do a search to find it and the others above)

#198

Quote:
There is no explanation of "RechargeRate" (it's for player - maybe vehicle too - energy level) or "energyPerDamagePoint" in the Torque API Manual.

Hehe, I had actually docommented those myself, in script, when working on the old defunct FPS Genre Kit. Too bad the majority of it got dumped.

#199 Also, is it me ... or are raycasts completely missing?

#200 "There is no explanation of "RechargeRate" (it's for player - maybe vehicle too - energy level) or "energyPerDamagePoint" in the"

Well their is still no mention of this in the doc I downloaded from the github.... Odd...