Sch_Cmd-HelpLinkHelpLink_AD

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.

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 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
  • https://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 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.

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 Designer (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.