Can you download the documentation?

#1 You can re-create them using doxygen. Read the section in the docs about building the documentation. In brief, it basically involves installing doxygen and running it over your checked out copy of the source, doxygen then spits out a shiny new copy of the docs for you.

T.

#2 Thanks a lot for the reply Tom, I appreciate it!
Shane

#3 Have you tried "Save As"?

#4 You're probably going to need to change the paths in the doxygen.html.cfg file (which is inside torque/doc/doxygen/html).

It took me a while to figure out that was the problem when I tried it, as Windoze closed the console window too quickly for me to read the error message.

#5 @Shane,

No probs.

@Wysardry,

doxygen is a command line program, it's meant to be run from the Command Prompt. If you want to run it directly from windows explorer, you could create a shortcut to it in the TGE docs dir with the relevant args to build the docs, then i think you can set the shortcut properties to not close the window when it's done.

Sorry if you already knew any of that, I'm just making assumptions based on your post.

T.

#6 I was running it via Doxywizard, which is the program listed in the start menu. From there I used the File...Open dialogue to open doxygen.html.cfg and run Doxygen.

Running from the command line in Win98 has its own problems, as the filenames get truncated to the "8.3" format. That is how I found out the error though.

The main problem seems to be that Win98 doesn't seem to like paths beginning with a single dot. i.e. "./doc/doxygen/html" so adding the full path (including the drive letter) or using Doxywizard's browse feature (which does the same thing) is safest.

#7 Ah, gotcha, I forgot that doxywizard existed :) Sorry.

#8 I couldn't get the doxywizard to work. I fixed the problem by moving my torque directory to c:\ and running the command from the command line. Once it built the documentation folder, I moved everything back.

As someone who only downloaded torque 2 days ago though, I have to say that I'm totally confused. The documentation seems to me to only give a list of the variables / functions etc.
Where is the "you need to run this command before this other command" type documentation? The doxygen documentation doesn't even give usage for the commands. I can't even find how to set the screen resolution. Do I have to wade through hundreds of forum posts to learn how to use torque from the ground up?

I appologise again if I've missed something totally obvious, but I'd appreciate someone pointing me in the right direction.

#9 AFAIK Doxygen only creates the Torque Source Code Documentation (the kind of info C++ programmers want to know), not the General Torque Documentation.

You probably already know this, but following the "Make Games" link at the top of these pages displays a lot more options now that you have a license.

From there you can find all sorts of documentation, tutorials, resources etc.

If you only downloaded TGE 2 days ago, "totally confused" is a perfectly normal state of mind. ;)

#10 Thanks Wysardry!

#11 I see what Shane is after, and I have the same question:

Is the General Torque Documentation around somewhere on the GG site in downloadable form? I mean, besides, navigating to the GTD directory and saving each html page using "Save As" from the browser? Maybe as a .pdf or compiled html file?

I've built the API docs already using dOxygen...

#12 Are there any plans on "releasing" the General Torque Documentation? It looks as if it were auto-generated (maybe by doxygen).

I like to print off the useful bits I find, such as Appendix C. But the formatting is a little off from what I'd like. Ideally, I would be able to regenerate the documentation with a few changes (some css changes maybe) and send it off to the printer.

I realize that there's a lot of documentation, it's not complete, and there are lots of missing images. Just trying to see if it's worth waiting for a release, or go ahead and print some things off now (means spending some time cleaning up the html possibly).

thanks!
-ner

#13 Appendix C certainly needs formatting work. That is on the to-do list. :)

There aren't any current plans to release the source of the documentation, though a printed version will be offered for sale sometime in the near future.

#14

Quote:...a printed version will be offered for sale

Even better!

thanks,
-ner

#15 It would be very nice if the printed version included some sort of PDF that you could take the docs on your laptop when you go on vacation :)

#16 Chris, that's a good idea. We'll certainly consider it.

#17 A PDF that you could search... most excellent.

#18 I for one am very disappointed in the lack of decent documentation. I'm going to try blitz instead, it may be in basic but from what I've seen at least it has comprehensive documentation.

#19 Before you try Blitz, you should master....


"Save As"



Or maybe you could get to the advanced stages of "Make available offline" with some help from friends.

#20 The General Docs would be very very nice to have as a d/l. Hell, we got full text searching, why not beg for more?

-s