HelpLink

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 and choosing the References » Help command, from the context menu.
• Schematic Library Editor - by right-clicking anywhere in the workspace for the active component and choosing the References » Help command, from the context menu.

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
• https://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 Designer installation is searched.

Tips

1. A web-based URL will be open either in an external browser, or as a tabbed document within Altium Designer, 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 1 to 10)

Summary

This command is used to open the indicated reference document - specified through a defined underlying ComponentLinknURL / ComponentLinknDescription parameter-pairing - 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 ComponentLinknURL / ComponentLinknDescription parameter-pairing 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 two parameters for each ComponentLink pair have been added to the required component, and configured as follows:

First parameter - used to define the target document:

• Parameter Name = ComponentLinknURL (where n is any integer value)
• Parameter Value = target document path\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
  • https://www.altium.com
  • www.altium.com/documentation

Second parameter - used to define the entry that appears in the menu:

• Parameter Name = ComponentLinknDescription (where n is the same integer value used in the first parameter)
• Parameter Value = entry to appear in the menu.

Any number of ComponentLink parameter pairs can be defined, each pair is associated by sharing the same value for n.

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 Designer installation is searched.

Tips

1. A web-based URL will be open either in an external browser, or as a tabbed document within Altium Designer, 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.