LaTeX. Пакет FiXme
В процессе написания руководства пользователя часто бывает нужно добавить в текст документа какое-нибудь «напоминание»: дописать раздел, что-то уточнить или исправить. Обычно для этих целей в .tex файле используют комментарии, которые в итоговом документе не видны, поэтому вероятность забыть о них очень велика.
На этот случай в LaTeX предусмотрен пакет FiXme, позволяющий добавить напоминание, текст которого будет отображён в итоговом pdf-документе. Этот пакет уже содержится в используемом нами дистрибутиве LaTeX, входящем в стандартную поставку Debian GNU/Linux.
Для его использования достаточно написать \usepackage{fixme} в преамбуле документа. После этого в исходный текст можно добавлять напоминания 4-х уровней значимости: примечание (\fxnote), предупреждение (\fxwarning), ошибка (\fxerror), критическая ошибка (\fxfatal).
Например, вот текст в .tex-файле:
Тестер-анализатор \fxnote{добавить фото}{\DEVICENAME{}} предназначен для проведения анализа и диагностического тестирования оборудования в сетях, основанных на технологии Ethernet. Он поддерживает полный диапазон скоростей от 10 Мбит/с до 10 Гбит/с.
А вот, что мы увидим в pdf-документе:
С помощью необязательного параметра команды \usepackage выбирают, в каком формате напоминание будет отображено в итоговом документе: в виде списка в предметном указателе, сноски, заметки на полях или непосредственно в тексте.
Например, команда \usepackage[footnote]{fixme} позволяет отобразить напоминание в виде сноски.
Кстати, для отображения напоминаний в итоговом документе следует в преамбуле указать стандартную опцию draft: \documentclass[a5paper, …, draft]{scrbook}. После того, как все ошибки и замечания исправлены, вместо draft пишем final. В полученном после компиляции pdf-файле напоминания отображаться не будут. Однако, если в тексте присутствует неисправленная критическая ошибка, то при сборке LaTeX выдаст предупреждение и документ не будет сформирован, пока ошибку не исправят.
Выше представлено описание только основных возможностей пакета. Он имеет множество других настроек, которые подробно описаны в документации.