5.2.2 Перекрестная ссылка: тег link

На верх  Назад  Вперёд

Чтобы сослаться на другой пункт документации (связанные функции, класса или что-то еще), существует тег link. Тег link принимает в качестве единственного атрибута целевой атрибут id. Обычно тег link содержит фрагмент текста. В HTML-версии документации этот фрагмент текста будет действовать как гиперссылка. В версии latex будет напечатана ссылка на номер страницы.

Атрибут id содержит имя элемента, к которому относится ссылка. Имя (name) не чувствительно к регистру, но оно должно быть полностью квалифицированным (подходящим).

Пример ссылки:

<link id="MyEnum">MyEnum</link> - это ссылка.

Атрибут link также имеет короткую форму:

<link id="MyEnum"/> - это короткая ссылка.

В короткой форме значение атрибута id будет использоваться как текст, который и будет гиперссылкой. Это особенно полезно в теге seealso.

Чтобы ссылаться на тип в другом модуле, к атрибуту id должно быть добавлено имя элемента:

<link id="myunit.myenum"/>

будет ссылаться на тип myenum в подразделе myunit.

Чтобы сослаться на узел в документации другого пакета, имя этого пакета с символом хеша (#) должно быть добавлено к атрибуту id:

<link id="#fcl.classes.sofrombeginning"/>

будет ссылаться на константу sofrombeginning в модуле classes справочной документации FCL. Обратите внимание, что для корректной работы необходимо правильно импортировать файл contents (содержимого), сгенерированный при создании документации данного типа (см. опцию import (3.2.18 import)).