Как я могу получить оглавление страницы markdown для рендеринга в latex с использованием doxygen?

#latex #markdown #doxygen #pdflatex

#Латекс #markdown #doxygen #pdflatex

Вопрос:

Я использую doxygen для разработки. Я дополняю некоторую информацию о требованиях файлами markdown, которые doxygen будет использовать одновременно с исходным кодом. Каждый файл требований markdown должен иметь свой собственный оглавление. использование команд [TOC] или tableofcontents doxygen отлично подходит для этого, если вы используете вывод HTML. Однако конечный документ должен быть в формате PDF и будет сгенерирован с помощью вывода latex.

После сегодняшнего тестирования вывода latex я заметил, что [TOC] то, что отображается в HTML для каждой страницы, не помещается в вывод latex.

Как бы мне добавить отдельного [TOC] пользователя на каждую страницу требований markdown в выводе latex?

Зная, что latex генерирует оглавления при втором запуске компилятора, я бы предположил, что нет способа сгенерировать его только для этих конкретных страниц. Вместо этого мне пришлось бы генерировать файлы markdown как их собственные документы, а затем каким-то образом включать их в основной документ? Как мне это сделать?

Я надеюсь, что есть что-то попроще.

ОТВЕТ: Из документации doxygen указано, что необходимо указать latex в команде, чтобы она отображалась в latex.

 tableofcontents{latex,html}
 

Это приведет к отображению оглавления как в html, так и в latex.

  • Спасибо тебе, Альберт

Комментарии:

1. Какая версия doxygen?

Ответ №1:

Из документации версии 1.8.20:

24.112 tableofcontents[‘{‘[option[:level]][,option[:level]]*’}’]

Создает оглавление в верхней части страницы со списком всех разделов и подразделов на странице. Это может быть HTML, LaTeX, XML или DocBook. Когда указан уровень, это означает максимальный отображаемый уровень вложенности. Значение уровня должно находиться в диапазоне 1..5, значения за пределами этого диапазона считаются равными 5. В случае, если уровень не указан, уровень устанавливается равным 5 (показать все). В случае, если нет выбора. указано tableofcontents действует так, как если бы была указана только опция HTML и XML. В случае нескольких команд tableofcontents на странице параметр (ы) будет использоваться дополнительно к уже указанным параметрам, но допустим только последний уровень параметра.

Предупреждение

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

См. также: https://www.doxygen.nl/manual/commands.html#cmdtableofcontents

Комментарии:

1. Цитируемая документация, безусловно, создает впечатление, что для каждой страницы markdown, на которую я ввел эту команду, должно быть оглавление . В цитате также указано, что она должна работать с выводом latex … тогда почему мой HTML имеет оглавление, как и ожидалось, а latex — нет? Latex выполняет оглавление. один единственный оглавление в верхней части всего вывода latex; но он не предоставляет отдельного оглавления для каждой страницы markdown по желанию.

2. Я только что заметил, что конкретная строка> В случае, если параметр не указанtableofcontents действует так, как если бы были указаны только HTML и XML. Я добавлю latex туда и посмотрю, изменит ли это что-нибудь