Q100466: Accessing Nuke, Nuke Studio and Hiero documentation offline

Warning:  This article contains links to external websites

SUMMARY

This article will explain how you can view the documentation for Nuke, Nuke Studio and Hiero offline.

MORE INFORMATION

Locating the documentation

The Hiero User Guide is available to download as a PDF file from our website or can also be found in the following directories by default:

Windows:

C:\Program Files\Nuke11.3v1\Documentation\Hiero11.3v1UserGuide.pdf

macOS:

/Applications/Nuke11.3v1/Documentation/Hiero11.3v1UserGuide.pdf

Linux:

/usr/local/Nuke11.3v1/Documentation/Hiero11.3v1UserGuide.pdf

The Nuke and Nuke Studio documentation can also be found in Nuke’s install directory and is available as html files. If you open getting_started.html, you can navigate around the documentation in the same way as you would online.

The getting_started.html file can be found in the following locations for each OS by default:

Windows:

C:\Program Files\Nuke11.3v1\Documentation\html\content\getting_started.html

macOS:

/Applications/Nuke11.3v1/Documentation/html/content/getting_started.html

Linux:

/usr/local/Nuke11.3v1/Documentation/html/content/getting_started.html

You can also create a shortcut to make the documentation easier to find for future use.

Loading product documentation from offline version

To use the offline documentation version from within the product, you need to go to Preferences > Documentation and change the ‘documentation source’ dropdown from ‘foundry’ to ‘local’.

When you click the question mark (?) icon in the Properties panel of any node, you will be directed to the relevant offline page of the documentation.

FURTHER READING

There is currently a feature request logged to make the Nuke/Nuke Studio documentation available in PDF format again, and the reference number for this is the following:

TP 358221 - Nuke/Nuke Studio documentation to be available in PDF format

There is also a feature request to allow users to customise the question mark knob on custom nodes so that third party plugins can have links to their own help documentation. The reference number for this feature request is the following:

TP 310332 - Let users customise the '?' question mark knob website link for custom nodes

You can reference these numbers in the release notes of upcoming Nuke versions once it has been addressed.