This topic discusses the changes made to the MAXScript Reference for the 2012 release of 3ds Max. See also What is New in MAXScript in 3ds Max 2012.
New Authoring System - New Reference Format
If you are an existing customer, you have surely noticed that this version of the MAXScript Reference is significantly different.
The complete documentation of all Autodesk products has been moved to a unified piblishing system based on XML source which
should provide significant improvements to both the end users and the documentation developers in the long run.
Here are some of the benefits it brings:
- The new system supports multiple output targets including HTML, CHM and Wiki pages, allowing for faster and more often updates
of the online version, as well as new approaches to documentation management via Wiki entries.
- The source is formatted using XML tags, allowing the easy redefinition of the complete publication via quick changes to the
style sheets.
- The source is managed on centralized servers, allowing for better collaboration between authors including version control,
offline output compiling etc.
- Thanks to the centralized version control and access, the localization of the documentation can be performed faster.
- Each page of the MAXScript Reference now features the same feeback links as the regular 3ds Max User Manual.
- Cross-reference links are now based on unique resource identifies (GUIDs) and are less likely to break.
- The Look-and-Feel of the MAXScript Reference is now the same as the 3ds Max User Manual and features the same navigation links in the header including breadcrubms and next/previous/parent page links.
- It would be technically possible to easily cross-reference pages between the various online help documents, for example between
the 3ds Max User Manual and the MAXScript Reference.
Currently, there are also a number of limitations compared to the previous CHM format of the MAXScript Reference:
- The Index tab provides approximately the same links as the old build of the MAXScript Reference, but the index links do not jump to the exact position of the relevant term but to the top of the topic containing the term.
- The current format does not support clickable images or image maps. This is not a limitation of the system itself but of the current implementation of the building scripts and will be hopefully
addressed in the future. For that reason, the Quick Navigation and Back To Topic Navigation icons (blur and green "wind roses")
are not clickable anymore and are accompanied by text links for the actual navigation.
- There is no support for popup pages used in the old MAXScript Reference for Quick Navigation indices or terminology explanations. For that reason the Quick Navigation
links navigate away from the current page to the relevant index topic. This is a minor difference and most of the Quick Navigation
indices have been recreated from scratch since they were not translated automatically in the source conversion process.
- There is no example color coding except for the
What To Expect
The source conversion process preserved the majority of the content including text paragraphs, examples and images, but nearly
all formatting was lost or damaged and required laborious re-editing by hand or using custom scripts (written in MAXScript,
of course!).
Despite the significant effort which went into restoring the look and usability of the document, it is likely that not all
of the over 4200 topics have been completely fixed. In particular, there have been significant glitches in the location of
space characters within the text. In some cases, words in text paragraphs or keywords in code examples could be written together
as one word, or the space could be shifted, eventually affecting the meaning of the text, or breaking the example code.
While the majority of these problems have been fixed, this could not be done automatically so there still can be glitches
hiding within the documentation. If you discover a misformatted sentence or a code example, please submit a report to Autodesk
using the Feedback link at the bottom of the topic. Thank you in advance!
Removed Sections and Topics
The following parts of the MAXScript Reference have been removed from the 2012 build:
- The section on using the HTML Help system had to be removed since the MAXScript Reference can now exist in various forms and
those topics only covered the CHM Help Viewer.