Искусство программирования для Unix
Шрифт:
Тем не менее, на момент написания книги man-страницы остаются единственной наиболее важной формой Unix-документации.
Пример 18.2. Разметка man-страниц .SH ПРИМЕР РАЗДЕЛА
Макрос SH начинает раздел, выделяя его заголовок жирным шрифтом.
– Р
Запрос Р начинает новый абзац. Запрос I форматирует свой
аргумент
.1 курсивом.
.IP *
Данный запрос начинает абзац с отступом, отмеченным звездочкой. Дополнительный текст для первого абзаца списка. • TP
Эта первая строка станет меткой абзаца
Данная строка будет первой строкой в абзаце, с отступом по отношению к метке.
Пустая строка выше интерпретируется
18.3.2. TeX
TeX (произносится как "teX") представляет собой очень мощную программу подготовки документов, которая, подобно редактору Emacs, возникла за пределами Unix-культуры, но теперь "прижилась" в ней. Она была создана видным компьютерным ученым Дональдом Кнуттом (Donald Knuth), когда ему надоело качество доступной в конце 70-х годов прошлого века типографской разметки текста и особенно форматирования математических выражений.
TeX, подобно утилите troff (1), является системой, ориентированной на разметку. TgX имеет гораздо более мощный язык запросов, чем troff. Среди прочего, данная программа лучше приспособлена для обработки изображений, точного позиционирования содержимого страницы и интернационализации. TgX особенно хорошо проявляет себя в форматировании математических выражений и является непревзойденным инструментом для решения базовых задач форматирования, таких как кернинг, заполнение строк и расстановка переносов. стал стандартным форматом для представления материалов в большинство математических журналов. В настоящее время TjgX курируется как программа с открытым исходным кодом рабочей группой Американского математического общества (American Mathematical Society). Программа также широко используется для создания научных документов.
Как и в случае с troff(1), пользователь обычно не пишет вручную множество чистых TfX-макросов. Вместо этого используются макро-пакеты и различные вспомогательные программы. Один особый макропакет, ЕЧ|Х является почти универсальным, и большинство пользователей, которые говорят о том, что создают документы в Т|Х, почти всегда фактически имеют в виду написание Е?Т]ЗС-макроеов. Как и макропакеты troff, множество запросов ЙГрХ являются полуструктурными.
Одно важное применение Т|Х, которое обычно скрыто от пользователя, заключается в том, что другие инструменты обработки документов часто генерируют код, преобразуемый впоследствии в PostScript, вместо того, чтобы самостоятельно пытаться выполнять гораздо более трудную работу по созданию PostScript-документа. Такой прием используется в управляющем сценарии xmlto(1), который рассматривался в главе 14 в качестве учебного примера shell-программирования. Аналогично данная проблема решается в инструментарии XML-DocBook, который описывается ниже в настоящей главе.
TgX имеет более широкий диапазон применений, чем troff (1), и в основном лучшую конструкцию. Во все более связанном с Web мире рассматриваемая программа имеет те же фундаментальные проблемы, что и troff. Ее разметка сильно привязана к уровню представления, и автоматическое создание хороших Web-страниц
Программа Т^Х никогда не используется для создания Unix-документации и только иногда используется для документирования приложений. Для таких целей достаточно использовать troff. Однако некоторые программные пакеты, которые возникли в академических учреждениях за пределами Unix-сообщества, заимствовали использование TjjX как главного формата документации; одним из примеров является язык Python. Как было сказано выше, он также интенсивно используется для создания математических и научных документов и, вероятно, будет доминировать в этой нише еще несколько лет.
18.3.3. Texinfo
Texinfo — разметка документации, разработанная Фондом свободного программного обеспечения. Она используется главным образом для документирования GNU-проектов, включая создание документации для таких важнейших инструментов, как Emacs и коллекция GNU-компиляторов.
Texinfo была первой системой разметки, специально предназначенной для поддержки вывода форматированного текста на бумагу и гипертекстового вывода для просмотра на экране. Однако используемым в ней гипертекстовым форматом был не HTML, а более примитивная разновидность, которая называется "info", первоначально предназначенная для просмотра из Emacs. Для печати документов Texinfo преобразуется в TjX-макрос, а затем из него в PostScript-представление.
Texinfo-инструменты в настоящее время способны генерировать HTML-документы. Однако качество и полнота данной операции оставляют желать лучшего, а поскольку множество Texinfo-разметки находится на уровне представления, вряд ли эта ситуация улучшится. В середине 2003 года Фонд свободного программного обеспечения еще продолжал работу над эвристическим преобразованием Texinfo в DocBook. Вероятно, формат Texinfo на какое-то время сохранится.
18.3.4. POD
POD или Plain Old Documentation (простая старая документация) представляет собой систему разметки, применяемую кураторами проекта Perl. Данная система генерирует страницы руководства и имеет все известные проблемы разметок уровня представления, включая проблемы при создании хороших HTML-документов.
18.3.5. HTML
С момента широкого распространения World Wide Web в начале 90-х годов прошлого века документация небольшой, но возрастающей части Unix-проектов пишется непосредственно на HTML. Проблема данного подхода заключается в том, что генерировать из HTML высококачественный типографский вывод трудно. Кроме того, существуют определенные проблемы с индексированием; необходимая для создания индексов информация в HTML отсутствует.
18.3.6. DocBook
DocBook представляет собой определение типов SGML- и XML-документов, предназначенное для крупных, сложных технических документов. Данный формат является единственным исключительно структурированным среди форматов разметки, используемых в Unix-сообществе. Инструмент хтко( 1), описанный в главе 14, поддерживает преобразование в HTML, XHTML, PostScript, PDF, разметку справочной системы Windows и несколько менее важных форматов.