PDA

View Full Version : Mxs standards, a library and a doc complier for a production environment?


legie
04-16-2009, 09:08 AM
Hey there!
I was wondering whether some of you might have some advice or opinions about how to setup up a global library and some maxscript coding standards in an production environment? This is a very general question, I know, but maybe something you consider very important comes to your mind?

I am aware of the section about this on scriptspot http://www.scriptspot.com/3ds-max/tutorials/maxscript-coding-standards and what is on http://tech-artists.org/wiki/Main_Page.

Another more specific question: Did anything happen about a Maxscript Doc Compiler? Is there anything like this by know http://forums.cgsociety.org/showthread.php?f=98&t=556859 ?
I have some experience with Doxygen and C++ but no clue about how to make Doxygen work with Maxscript?

legie
04-16-2009, 09:40 AM
OK, just saw Lone Robots posting New Article on LoneRobot.com - Creating PDF documents with MXS and DotNet

I will look into that for our documentations...

LoneRobot
04-16-2009, 09:59 AM
Hi Lena,

The example posted was certainly something I thought could generate help files dynamically. The source library for PDFsharp is really good - not only do you get the PDFsharp assembly, but another called MigraDocLite. This assembly has more advanced formatting options than PDFSharp. But if it's a simple document with a bit of text formatting and image placement, PDFsharp should be enough. Let me know if you want anything added to it, or feel free to extend the struct!

RobGalanakis
04-16-2009, 01:57 PM
Hey there!
I was wondering whether some of you might have some advice or opinions about how to setup up a global library and some maxscript coding standards in an production environment? This is a very general question, I know, but maybe something you consider very important comes to your mind?

A couple TAO areas may be of use:
http://tech-artists.org/forum/showthread.php?t=124
We discuss how we deploy scripts. I should mention that the first script that loads, declares as global any struct defintions and globals in the rest of the library, to make sure they are always in the proper scope.

http://tech-artists.org/wiki/TAO:Code_Conventions
We have some community-developed coding conventions as well.

We've also written an auto-documenter based on those coding conventions:
http://tech-artists.org/hg/tao_official/documenters/file/tip/doc_mxs.py#l1
http://tech-artists.org/hg/tao_official/documenters/raw-file/tip/doc_mxs.py

Kramsurfer
04-21-2009, 11:14 PM
I've been using WinCHM for 2 years. Simply construct a tree of HTML documents as a starting point and you can then edit and enhance in WinCHM, add search keywords and hyperlinks to related pages...
Simply add a .html page when you've a new script, compile to a single sweet .CHM file and publish to your user base.

Using doscommand and HH.exe, you can have help buttons on UI's that launch the help file and open to the approprate topic.

I like it because everything is in one file. Process info for different products, scripts, back end info, ect...

CGTalk Moderation
04-21-2009, 11:14 PM
This thread has been automatically closed as it remained inactive for 12 months. If you wish to continue the discussion, please create a new thread in the appropriate forum.