Altium NEXUS Documentation

HelpLink

Modified by Susan Riege on Aug 1, 2018

Parent page: Schematic Commands

The following pre-packaged resources, derived from this base command, are available:


Applied Parameters: Source=Default

Summary

This command is used to open the reference document specified through a defined HelpURL parameter for the component under the cursor (Schematic document) or the active component (Schematic Library document). Using this parameter you can reference a PDF or text file or an HTML page.

Access

With a HelpURL parameter for the required component already defined, this command can be accessed from the Schematic Editor and Schematic Library Editor:

  • Schematic Editor - by right-clicking over the placed component in the workspace then choosing the References » Help command from the context menu.
  • Schematic Library Editor - by right-clicking anywhere in the workspace for the active component then choosing the References » Help command from the context menu.
In the Schematic Editor, the command can also be accessed by pressing F1 while the cursor is hovering over the required component (selected or not).

Use

To use the feature, first ensure that the HelpURL parameter has been added to the required component, and that the value for the parameter has been set to the document you wish to open. When specifying the value for the parameter, you can either include an absolute path or just enter the document name. The following examples are valid entries for the value of the parameter:

  • C:\Design_Projects\Schematics\Modifications.txt
  • C:\Design_Projects\Schematics\MyDataSheet.pdf
  • http://www.altium.com
  • www.altium.com/documentation

After launching the command, the target document will be opened. A web-based URL target page will open directly (if available). For a PDF or text document, a search for the document is conducted as follows:

  • If a path to it is specified, this location is searched first,
  • If the document cannot be found at this location, or if no path is specified, the \Help folder of the Altium NEXUS installation is searched.

Tips

  1. A web-based URL will be open either in an external browser, or as a tabbed document within Altium NEXUS, as determined by the Open internet links in external Web browser option, on the System - View page of the Preferences dialog. Bear in mind that to open in an external browser, the value for the HelpURL parameter must include the http:// prefix.
  2. The defined target document can also be accessed for the required component from the Libraries panel. Simply select the component and either press F1, or right-click and choose the References » Show Help command, from the context menu.


Applied Parameters: Source=HelpLink|Index=n (where n is in the range 0 to 9)

Summary

This command is used to open the indicated reference document - specified through a defined named link - for the component under the cursor (Schematic document), or the active component (Schematic Library document). Using this feature, you can define and present named links to PDFs or text files, or HTML pages.

Access

With a named link for the required component already defined, the command can be accessed from the Schematic Editor and Schematic Library Editor:

  • Schematic Editor - by right-clicking over the placed component in the workspace and choosing the applicable command from the References sub-menu.
  • Schematic Library Editor - by right-clicking anywhere in the workspace for the active component and choosing the applicable command from the References sub-menu.

Use

To use this feature, first ensure that the required named link has been added to the required component - in the Links section, on the General tab of the Properties panel (when viewing the properties for the selected component) - and configured as follows:

  • Name - used to define the entry that appears in the menu:
  • Url - used to define the target document. The following examples are valid entries:
    • C:\Design_Projects\Schematics\Modifications.txt
    • C:\Design_Projects\Schematics\MyDataSheet.pdf
    • http://www.altium.com
    • www.altium.com/documentation

While any number of named links can be defined, only the first 10 will be available in the Schematic editor's right-click References context menu. Additional named links will not appear in the Schematic editor's Reference menu but will be included in a generated PDF, and will function as live links from the PDF when the component is clicked on in Acrobat (if the Include Component Parameters option was enabled in the Publish to PDF Settings dialog when the PDF was generated).

After launching the command, the indicated target document will be opened. A web-based URL target page will open directly (if available). For a PDF or text document, a search for the document is conducted as follows:

  • If a path to it is specified, this location is searched first,
  • If the document cannot be found at this location, or if no path is specified, the \Help folder of the Altium NEXUS installation is searched.

Tips

  1. A web-based URL will be open either in an external browser, or as a tabbed document within Altium NEXUS, as determined by the Open internet links in external Web browser option, on the System - View page of the Preferences dialog. Bear in mind that to open in an external browser, the value for the ComponentLinknURL parameter must include the http:// prefix.
  2. The indicated target document can also be accessed for the required component from the Libraries panel. Simply select the component, right-click, and choose the applicable command from the References sub-menu.


Applied Parameters: Source=HelpVaultLink|Index=n (where n is in the range 0 to 9)

Summary

This command is used to open the indicated datasheet that is linked to a server component under the cursor. The datasheet itself is stored within a server in an underlying Datasheet Item.

Access

With a managed datasheet already linked to the required server component, the command can be accessed from the Schematic Editor by right-clicking over the placed instance of that component in the workspace then choosing the applicable command from the References sub-menu.

Use

To use this feature, first ensure that the datasheet has been attached/linked to the required server component within a managed content server.

After launching the command, the indicated target document will be opened, either within Altium NEXUS (for example a .txt document) or in the applicable external application

Tips

  1. A file of any format can be attached as a datasheet to a server component.

 

Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

You are reporting an issue with the following selected text
and/or image within the active document:
ALTIUM DESIGNER FREE TRIAL
Altium Designer Free Trial
Let’s get started. First off, are you or your organization already using Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

In that case, why do you need an evaluation license?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You actually don’t need an evaluation license for that.

Click the button below to download the latest Altium Designer installer.

Download Altium Designer Installer

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Please fill out the form below to get a quote for a new seat of Altium Designer.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

If you are on Altium Subscription, you don’t need an evaluation license.

If you are not an active Altium Subscription member, please fill out the form below to get your free trial.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Why are you looking to evaluate Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

You came to the right place! Please fill out the form below to get your free trial started.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Great News!

Valid students can get their very own 6-month Altium Designer Student License for FREE! Just fill out the form below to request your Student License today.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

That’s great! Making things is awesome. We have the perfect program for you.

Upverter is a free community-driven platform designed specifically to meet the needs of makers like you.

Click here to give it a try!

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.