You are on page 1of 3

NX DOCUMENTATION HELP

The NX online Help is delivered in standard HTML format. A few modules are
delivered in PDF format. On Windows the Open for .NET Reference Guide is deliver
ed in
compiled help .chm format.

You can view NX Help using a web browser. The web browser must support Java (MS
JVM or
Sun JVM version 1.5 or higher. The JVM is available in the Java Runtime Environm
ent (JRE) 6.0.) for the
search to work.
We certify and support the following browsers:
Windows browser support:
* Internet Explorer 7.0 or higher
If you have problems displaying the pages in Internet Explorer,
you may need to set your browser options
to allow active content to be displayed. This is usually an issu
e when using
Windows XP Service Pack 2 (SP2).
To allow active content to be displayed in Internet Explorer, fo
llow these steps:
*Select Tools/Internet Options
*Select the Advanced tab
*In the Settings field, scroll down to the Security cate
gory and turn on Allow active
content to run in files on My Computer.
* Mozilla Firefox 3.0.5 or higher
* Firefox, for Linux or Windows, has a default security setting
that prevents the help from
launching correctly from a UNC path (file:///). If you intent
to launch the NX Help using an
http:// protocol, you must set the value of the security.fileu
ri.strict_origin_policy preference
to false. To do so:
o In the browser URL address bar, type about:config.
o In the Filter field, typed security.fileuri.
o Change the value of the security.fileuri.strict_orig
in_policy preference to false.
o Restart the browser.

UNIX & Linux


* Mozilla Firefox 3.0.5 or higher
If you have other Mozilla web browsers installed on your system, make
sure either your default browser
is set to the correct Firefox version, or the UGII_HTML_BROWSER enviro
nment variable in your
ugii_env.dat file is set to the supported Firefox version.

Mac OS X
* Safari 3.0 or higher
On MAC OS X, the search and index features of online help will not wor
k correctly if accessed through a
UNC path (for example, file:///ugdoc/html_files). The work-around is t
o install the help on a web server
so that it is accessed through a URL (for example, http://nx75/en_US/u
gdoc/html_files/mainlibrary.html).
Also, when accessing context sensitive help on MAC OS X, the Safari br
owser does not reuse the existing
window but displays the information in another browser window.

In addition, some portions of the help require:


* Adobe Acrobat Reader 7.0 or higher
* Flash 5 Plug-in
To view some of the animations, you need the Macromedia Flash player, Fl
ash 5 or greater.
Visit the Macromedia site for more information about the Flash player.

CAVEATS
* If you use a UNC path, some help links may not work properly. For full support
of the help system, you must use a
mapped drive or a designated web server.
* The Help may not work properly if installed to a location that contains a spac
e in the pathname.
* On UNIX, Linux and Windows-64 bit systems, when you invoke the context sensiti
ve help, the system does not reuse
the existing browser but displays another browser for each time you invoke the
context sensitive help.

ENVIRONMENT VARIABLES
The following variables set in the ugii_env file are necessary for running NX 7.
5 Help.
UGII_BASE_DIR Base location where software is installed
(example:) \\plm\cynas\iproot\ugnx75\ip30\wnt
i32\kits

UGII_UGDOC_BASE_DIR Base location where the UGDOCS are installed.


(default value) $UGII_BASE_DIR/ugdoc
UGII_HTML_UGDOC Location of the html files - start file
(default value) $UGII_UGDOC_BASE_DIR/html_fil
es/mainlibuary.html
UGII_CSHELP_DOCS Location of the html files.
(default value) $UGII_UGDOC_BASE_DIR/html_fil
es
UGII_CSHELP_HTML_DOCS Location of the html files.
(default value) $UGII_UGDOC_BASE_DIR/html_fil
es
UGII_CSHELP_MAPS Location of the UG context sensitive help tra
nslation tables
(default value) $UGII_BASE_DIR/ugii/docmaps
UGII_HTML_BROWSER Default browser used for displaying NX html files.
(UNIX/Linux ONLY) (default value) Firefox 1.5+ or 2.0

UGII_HELP_RELEASE_NOTES Location of the release notes


(default value) $UGII_BASE_DIR/rel_info/relea
se_notes/english/index.html

UGII_HELP_WHATS_NEW Location of the whatsnew


(default value) $UGII_BASE_DIR/rel_info/whats
new/english/index.html

* If the Help is being launched from a URL - the docs variables might look somet
hing like:
UGII_BASE_DIR=//plm/cynas/iproot/ugnx75/ip30/wnti32/kits
UGII_UGDOC_BASE_DIR=http://nx75/en_US/nx_tdoc_package/ugdoc
UGII_HTML_UGDOC=http://nx75/en_US/nx_tdoc_package/ugdoc/html_files/mainlibrary.h
tml
UGII_CSHELP_DOCS=http://nx75/en_US/nx_tdoc_package/ugdoc/html_files
UGII_CSHELP_MAPS=//plm/cynas/iproot/ugnx7/ip30/wnti32/kits/ugii/docmaps