Altium Designer Documentation

HelpLink

Последнее изменение: Susan Riege; 01.08.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
  • 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.

 

Обнаружили проблему в этом документе? Выделите область и нажмите Ctrl+Enter, чтобы оповестить нас.

Связаться с нами

Связаться с нашими Представительствами напрямую

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
Вы сообщаете о проблеме, связанной со следующим выделенным текстом
и/или изображением в активном документе:
Бесплатная пробная версия Altium Designer
Бесплатная пробная версия Altium Designer
Давайте приступим. Для начала, Вы или Ваше предприятие уже используете Altium Designer?

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

В таком случае, для чего Вам необходима пробная лицензия?

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Вам для этого не нужна пробная лицензия.

Нажмите кнопку ниже, чтобы загрузить установщик самой новой версии Altium Designer

Загрузить установщик Altium Designer

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Пожалуйста, заполните форму ниже, чтобы получить ценовое предложение.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Если Ваша подписка Altium активна, у Вас нет необходимости в пробной лицензии.

Если у Вас нет активной подписки Altium, пожалуйста, заполните форму ниже, чтобы получить пробную версию.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Для чего Вы хотите попробовать Altium Designer?

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Вы нашли нужное место! Пожалуйста, заполните форму ниже, чтобы начать использование пробной версии.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

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.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Вы можете загрузить бесплатную лицензию средства просмотра Altium Designer Viewer сроком действия 6 месяцев.

Пожалуйста, заполните форму ниже, чтобы запросить эту лицензию.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Замечательно! Создавать новое - отличное занятие. У нас есть превосходная программа для Вас.

Upverter - бесплатная платформа, разработанная специально для любителей проектирования.

Нажмите здесь, чтобы попробовать!

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Вы можете загрузить бесплатную лицензию средства просмотра Altium Designer Viewer сроком действия 6 месяцев.

Пожалуйста, заполните форму ниже, чтобы запросить эту лицензию.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.