Q100466: Accessing Nuke, Nuke Studio and Hiero documentation offline

Follow
  1. Foundry
  2. Nuke Family
  3. FAQ

SUMMARY

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

 

MORE INFORMATION

Due to the differences between Nuke/Nuke Studio and Hiero, the documentation for each is split into two separate areas when installed with the Nuke release. This can lead to confusion when trying to find the offline documentation for the individual applications. Select a header below to list the locations for each operating system:

Nuke/Nuke Studio

The offline documentation for Nuke and Nuke Studio can be found in the following locations:

Windows: C:\Program Files\Nuke15.1v1\Documentation\html\default.html

macOS:     /Applications/Nuke15.1v1/Documentation/html/default.html

Linux:       /usr/local/Nuke15.1v1/Documentation/html/default.html

 
Hiero

The Hiero User Guide can be found as a PDF in the following locations:

Windows: C:\Program Files\Nuke15.1v1\Documentation\Hiero15.1UserGuide.pdf

macOS:     /Applications/Nuke15.1v1/Documentation/Hiero15.1UserGuide.pdf

Linux:       /usr/local/Nuke15.1v1/Documentation/Hiero15.1UserGuide.pdf

Please note that from version 12.0v1 to 12.2v3, this PDF was absent from the offline documentation included during installation. This issue was raised to the Documentation team and addressed in Nuke 12.2v4.

 

PDF User Guides

PDF versions of both the Nuke/Nuke Studio and Hiero User Guides can be located in the respective links below:

 

Loading product documentation from offline version

To use the offline documentation version from within the product, you need to go to Edit > Preferences > Documentation (hotkey Shift+S) and change the ‘documentation source’ dropdown from ‘foundry’ to ‘local’, as shown here:

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 a feature request to allow users to customize 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:

ID 310332 - Let users customize 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.

    We're sorry to hear that

    Please tell us why