Is there any point to write new TDN articles?
by Max Kielland · in Torque Game Builder · 01/31/2013 (2:03 pm) · 51 replies
Hi,
I have been Torque Scripting for about 2 and a half week now and with my background as a C/C++ developer I think I have picked up this scripting quite fast now. I as many other has been searching high and low both in forums, TDN, source code and google to figure out how things work.
I think we all can agree that the documentation... well, needs a bit updating to make an understatement.
It seems like GG are counting on the community to do the documentation for them (I can't blame them, it is after all the most cost effective).
I would like to share some of my findings with the rest of the community but with the new MIT releases, is it any point at all to write new TDN articles?
The TDN search engine is very sensitive and it is very hard to find what you search for unless you write out the words in full and exactly the right name or spelling. What is the best way to share knowledge? TDN, Blogs or forum posts?
I have been Torque Scripting for about 2 and a half week now and with my background as a C/C++ developer I think I have picked up this scripting quite fast now. I as many other has been searching high and low both in forums, TDN, source code and google to figure out how things work.
I think we all can agree that the documentation... well, needs a bit updating to make an understatement.
It seems like GG are counting on the community to do the documentation for them (I can't blame them, it is after all the most cost effective).
I would like to share some of my findings with the rest of the community but with the new MIT releases, is it any point at all to write new TDN articles?
The TDN search engine is very sensitive and it is very hard to find what you search for unless you write out the words in full and exactly the right name or spelling. What is the best way to share knowledge? TDN, Blogs or forum posts?
About the author
Owner of MK Development www.mkdevelopment.se
#42
A pure script reference (if that's actually needed) would have it all in one, with engine tags. An FPS tutorial goes in its own section.
02/07/2013 (9:20 am)
I think ordering tutorials by the engine they are for is sort of necessary ;)A pure script reference (if that's actually needed) would have it all in one, with engine tags. An FPS tutorial goes in its own section.
#43
I have fiddled a bit with the wiki and I think the styles have to be adjusted.
The code syntax highlight needs to be fixed, it doesn't accept // remarks (makes it italic instead).
Is it possible to add tags?
02/07/2013 (9:21 am)
Yea, tutorials should be per engine.I have fiddled a bit with the wiki and I think the styles have to be adjusted.
The code syntax highlight needs to be fixed, it doesn't accept // remarks (makes it italic instead).
Is it possible to add tags?
#44
02/07/2013 (10:11 am)
Added a page on tags, added tags to some pages, and changed the syntax highlighter.
#45
Where do I add tags to the page?
02/07/2013 (10:41 am)
Are you working on some sort of template?Where do I add tags to the page?
#47
Do a search for setPos and it will find nothing. a search for Position or setPosition will show you the Wiki formattings in the result.
setPositionY(%y)==== ===Description=== Sets the position of the object. ===Syntax=== * %x - Float, The position on the x-axis to place the object. * %y - Float, The position on the y-axis to place the ... vector. A two element vector representing the x y position to place the object.// ===Returns=== This functi... les=== <sxh cpp> new t2dSceneObject(MyObject) { Position = "10 5"; }; %old = MyObject.getPosition(); MyOb
Is it possible to constrain a search to a specific section or tag? If I want the reference for a command I'm not interesting in tutorials or articles.
02/08/2013 (6:53 am)
I tried to use the search function, but it shares some of the old TDN problems.Do a search for setPos and it will find nothing. a search for Position or setPosition will show you the Wiki formattings in the result.
setPositionY(%y)==== ===Description=== Sets the position of the object. ===Syntax=== * %x - Float, The position on the x-axis to place the object. * %y - Float, The position on the y-axis to place the ... vector. A two element vector representing the x y position to place the object.// ===Returns=== This functi... les=== <sxh cpp> new t2dSceneObject(MyObject) { Position = "10 5"; }; %old = MyObject.getPosition(); MyOb
Is it possible to constrain a search to a specific section or tag? If I want the reference for a command I'm not interesting in tutorials or articles.
#48
(My post got moved to the Site Feedback section (aka Death Valley).)
Here's the post.
In short, how about GROU.PS to start a community? If you want to reply to this, the current thread may be better than the "site feedback" copy. Heh.
02/12/2013 (7:32 am)
Hi, I'm a little late to this thread, but I had recently written about upgrading the docs (and everything community) on the T2D board. My hope was to get an updated wiki and forums and stuff while we were at it.(My post got moved to the Site Feedback section (aka Death Valley).)
Here's the post.
In short, how about GROU.PS to start a community? If you want to reply to this, the current thread may be better than the "site feedback" copy. Heh.
#49
I don't think there is any point in including the new MIT versions because GG will maintain a system for them.
Ronny put up a Wiki very quick, but I don't get the right feeling of that Wiki system. Since so few ppl seemed to be interested, I spent a few hours to setup a TikiWiki. That system looks promising with a lot of plugins like forms to fill in, WYSIWYG editors, articles, blogs, chat, conference system etc...
I'm quite new to using Wiki systems and I'm still trying to figure out how to build this Wiki in the best way.
TikiWiki
02/12/2013 (6:05 pm)
Yes, my intention was to save what we can of the Torque2D, Torque3D and TGB as we can.I don't think there is any point in including the new MIT versions because GG will maintain a system for them.
Ronny put up a Wiki very quick, but I don't get the right feeling of that Wiki system. Since so few ppl seemed to be interested, I spent a few hours to setup a TikiWiki. That system looks promising with a lot of plugins like forms to fill in, WYSIWYG editors, articles, blogs, chat, conference system etc...
I'm quite new to using Wiki systems and I'm still trying to figure out how to build this Wiki in the best way.
TikiWiki
#50
The theme is set to something TDN-ish, with jQuery and other fancy crap. Search looks a lot better. I've enabled a collection of modules. Your challenge, should you accept it, is to figure out which. Register and have at it. Registered users can create and edit pages with images (if I got the permissions right).
The point of having a wiki is to put up snippets of code, cool behaviours and general HOWTO-type tips which you discover, but which may not be obvious to all. Some of this could be useful to documentation writers. It would also be a nice place to maintain a FAQ, which again could help form documentation.
If you want to run something for the old, dead, mouldy, stinky engines, make a different site. I want a modern TDN for the MIT versions, with new versions of old tutorials and components :)
02/12/2013 (8:21 pm)
Fuck this. The search is shit. Setting up TikiWiki in the same location. Not that anybody cares anymore, judging from statistics. Most visits are from MSNBot and Bing!The theme is set to something TDN-ish, with jQuery and other fancy crap. Search looks a lot better. I've enabled a collection of modules. Your challenge, should you accept it, is to figure out which. Register and have at it. Registered users can create and edit pages with images (if I got the permissions right).
The point of having a wiki is to put up snippets of code, cool behaviours and general HOWTO-type tips which you discover, but which may not be obvious to all. Some of this could be useful to documentation writers. It would also be a nice place to maintain a FAQ, which again could help form documentation.
If you want to run something for the old, dead, mouldy, stinky engines, make a different site. I want a modern TDN for the MIT versions, with new versions of old tutorials and components :)
#51
02/13/2013 (12:17 am)
Quote:Exactly my thoughts. But I also have no desire to go stumbling around the web to some other community maintained site that is not prominently connected to either here or the github locations. So long as Github doesn't yank the wiki pages like they did for the download pages it is our intention in the Steering Community (T3D) to eventually maintain relevant pages dedicated specifically to the current engine(s), cutting lose all of the cruft from past ages. Community interaction in my opinion should be focused there so as not to make the interested parties have to go looking for it. Anything legacy or backwards compatible I could less about.
If you want to run something for the old, dead, mouldy, stinky engines, make a different site. I want a modern TDN for the MIT versions, with new versions of old tutorials and components :)
Torque Owner Max Kielland
MK Development
Since T2D and T3D are using the same torque script, I think it is best to just think of it as a Torque Script Wiki. If there are differences in a script command, it should be stated in the description, or be two sections on the same page.
There could just be a line like "Applies to: T2D,T3D"