3.2.18 import

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

Импортируйте файл оглавления, сгенерированный FPDoc для другого пакета с опцией content (содержимого) (раздел 3.2.5, стр. 38). Эта опция может использоваться для ссылки на узлы документации в наборах документации для других пакетов. Аргумент состоит из двух частей: имени файла и префикса ссылки.

Имя файла - это имя файла, который будет импортирован. Префикс ссылки - это префикс, который будет использоваться для каждой ссылки HTML; это необходимо сделать, чтобы разместить файлы в разных каталогах.

Пример:

--import=../fcl.cnt,../fcl

Это будет читать файл fcl.cnt в родительском каталоге. Для документации HTML, всех ссылок на элементы в файле fcl.cnt, ссылка будет добавлена ​​с помощью ./fcl.

Это позволяет настроить, где все пакеты имеют собственный подкаталог общего каталога документации, а все файлы содержимого находятся в основном каталоге документации, например, в следующем дереве каталогов:

/docs/fcl
    /fpdoc
    /fpgui
    /fpgfx
    /fpimg

Файл fcl.cnt будет находиться в каталоге docs . Аналогично, для каждого пакета файл содержимого xxx.cnt может быть местом в этом каталоге. Внутри подкаталога команды, как указано выше, могут использоваться для предоставления ссылок на другие пакеты документации.

Пример:

--import=../fcl.cnt,ms-its:fcl.chm::/

Как и в предыдущем примере, это будет читать файл fcl.cnt в родительском каталоге. Но все ссылки на элементы в файле fcl.cnt будут добавлены в ms-its: fcl.chm::/. Вот как chm сшиты.

Обратите внимание, что для документации Latex эта опция игнорируется.