Linuxformat - Вклад участника [ru]

LXF87-88:LaTeX

2009-10-28T23:17:31Z

GArik: /* listings */

[[Категория:Учебники]]

: '''Компьютерные TeXнологии''' Учимся использовать культовую систему вёрстки

=Документация и программный код=

{{Цикл/LaTeX}}

: '''ЧАСТЬ 4:''' ''TeX'', как известно, был создан для представления кода и алгоритмов. Так постигайте же замысел создателя и его последователей вместе с '''Евгением Балдиным'''!

::::''+++ Ошибка Деления На Огурец.''
::::''Переустановите Вселенную И Перезагрузитесь +++''
::::''Так зависает Гекс.''
::::::::''Источник: «Санта-Хрякус» от Терри Пратчетта''

Программирование под Linux – вполне естественное занятие.
Написание документации – неотъемлемая часть этого процесса. ''LaTeX'' достоин быть включённым в технологическую
цепочку по выпуску программного продукта.

Если вспомнить историю, то Д.Э. Кнут создал ''TeX'' именно для целей
представления кода и алгоритмов в своём глобальном пятитомнике
«Искусство программирования».

==Спецсредства==

Чтобы украсить инструкцию, надо добавлять в неё «пятна».
Злоупотреблять этим не стоит, но пару мыслей выделить вполне реально. Упомянутые ниже приёмы – далеко не всё, что может предложить ''LaTeX'': это просто демонстрация возможностей.

===keystroke===

Иногда в тексте необходимы фразы вида: «Для выхода из программы
нужно нажать клавишу Esc.» Макрос '''\keystroke''', определённый в одноимённом пакете '''keystroke''', позволяет выделить название клавиши, примерно следующим образом:

[[Изображение:LXF88_latex01.png|LXF88_latex01.png]]

В пакете определены многие клавиши, имеющиеся на стандартной
клавиатуре. Пакет очень прост и имеет зачатки интернационализации –
его легко адаптировать под свои нужды.

[[Изображение:LXF88_latex02.png|Клавиши, определенные в keystroke]]

===LCD-дисплей===

LCD-дисплеи сейчас встроены даже в кофемолки. Они легко узнаваемы, поэтому нет необходимости копировать их вид в документацию
с помощью фотографий – достаточно нарисовать что-то похожее.
Изобразить вид дисплея можно с помощью пакета '''lcd'''.

[[Изображение:LXF88_latex03.png|LXF88_latex03.png]]

Для определения цветов используется макрос '''\definecolor''' из пакета '''color'''. Команда '''\LCDcolors''' формирует цвет букв и фона, а макрос '''\textLCD''' выводит LCD-подобный текст на экран. '''\textLCD''' понимает
стандартные команды изменения размера шрифта, поэтому его можно
использовать совместно с обычным текстом внутри абзаца.

По умолчанию определены только латинские буквы, цифры и некоторые из стандартных символов. Для определения других символов
можно воспользоваться макросом '''\DefineLCDchar'''. Макросу передаётся
имя символа и битовая маска, определяющая картинку 5x7 точек. Имя
символа может быть однобуквенным, тогда соответствующая буква
замещается новым рисунком, или многобуквенным, тогда созданный
рисунок кодируется указанным словом в фигурных скобках. Другие
размеры матрицы в пакете отсутствуют, но при желании его вполне
можно доработать.

[[Изображение:LXF88_latex04.png|Определяем Ё для LCD]]

Для эмуляции дисплея используется команда '''\LCD'''. В качестве обязательных параметров ей передаётся число строк и число столбцов, за которыми следует содержание строк, разделённых каким-то разделителем. В приведённом примере в качестве разделителя используется
вертикальная черта, но на её месте мог бы быть любой символ:

[[Изображение:LXF88_latex05.png|LXF88_latex05.png]]

===Битовые поля===

Для описания сетевых протоколов, а так же для бинарных форматов
данных удобнее всего представить последовательность битов графически, то есть в виде таблицы. Это специализация пакета '''bytefield'''. В пакете определено одноимённое окружение '''bytefield''', в качестве обязательного аргумента которому передаётся ширина таблицы в битах:

<source lang=latex>
\begin{bytefield}{«битовая ширина поля»}
«битовые поля»
\end{bytefield}
</source>

В окружении '''bytefield''' работают команды '''\wordbox''' и '''\bitbox''', которые формируют поля, занимающие всю ширину таблицы или только часть её, соответственно:

<source lang=latex>
\wordbox[«рамка»]{«число строк»}{«текст»}
\bitbox[«рамка»]{«число занимаемых битов»}{«текст»}
</source>

Необязательный параметр «рамка» позволяет сформировать обрамление для текущего битового поля. Значение по умолчанию ['''lrtb'''] означает, что рамка рисуется со всех сторон поля: '''l''' – слева, '''r''' – справа, '''t''' – сверху и '''b''' – снизу. Строки разделяются двойной обратной чертой '''\\'''.

Формат пакета сетевого протокола UDP можно описать примерно
следующим образом:

<source lang=latex>
\begin{bytefield}{32}
\bitheader{0,15,16,31}\\
\wordgroupr{Заголовок}
\bitbox{16}{Порт отправителя}\bitbox{16}{Порт получателя}\\
\bitbox{16}{Размер}\bitbox{16}{Контрольная сумма}
\endwordgroupr\\
\wordbox[lrt]{1}{Данные}\\
\skippedwords\\
\wordbox[lrb]{1}{до 65{.}527 байт}
\end{bytefield}
</source>

[[Изображение:LXF88_latex06.png|Формат пакета UDP]]

Кроме уже упомянутых команд создания полей при описании формата UDP использовалась команда нумерации столбцов '''\bitheader''',
конструкция для создания группы '''\wordgroupr''' и макрос '''\skippedwords'''
для формирования «разрыва».

В качестве обязательного аргумента команде '''\bitheader''' передаётся список нумеруемых битов, при этом можно передавать диапазоны чисел, например, {0-31}. В пакете определены два окружения для
группировки битовых полей, '''\wordgroupr''' и '''\wordgroupl''' – отличие этих
команд в том, что для первой заголовок группы вводится справа, а для
второй – слева. Для более подробной информации следует обратиться
к документации пакета.

==Форматирование кода==

''LaTeX'' может использоваться не только для набора математики. Хотя
набор математики, безусловно, вершина типографского искусства,
существует масса задач со сравнимой сложностью форматирования.
Представление исходных текстов программ – это весьма непростое
занятие, особенно если хочется сделать код читаемым.

===verbatim===

Самый простой способ включить код в текст – это заключить его в
стандартное окружение '''verbatim''', которое просто выводит данный текст
на печать с отступами пользователя. При этом исчезает возможность
делать акценты в избранных местах.

Небольшие вставки можно делать с помощью команды '''\verb!текст!'''.
Сразу после '''\verb''' должен идти группирующий символ (в данном случае, «'''!'''»), который указывает окончание действия команды. Группирующий символ может быть любым, кроме пробела или звёздочки «'''*'''».

Пакет '''verbatim''' из коллекции '''tools''' переопределяет стандартную команду так, что внутри окружения можно вставлять тексты неограниченного размера. Кроме этого, пакет предоставляет команду
'''\verbatiminput''', которой в качестве основного аргумента можно передать имя внешнего файла.

Кроме упомянутых окружения и макросов определены такие же, но
со звёздочкой в конце имени, то есть окружение '''verbatim*''' и команды
'''\verb*''' и '''\verbatiminput*'''. '''*'''-форма отличается от базовой тем, что все
пробелы визуализируются.

[[Изображение:LXF88_latex07.png|LXF88_latex07.png]]

Стандартный пакет '''alltt''' – это почти то же самое, что и '''verbatim''',
но с возможностью использовать внутри окружения команды ''LaTeX''.
Правда, шрифт в любом случае остаётся фиксированной ширины, как
для печатной машинки.

[[Изображение:LXF88_latex08.png|LXF88_latex08.png]]

Гораздо более разнообразные средства управления выводом
неформатированного текста предоставляет пакет ''fancyvrb''. За подробной информацией следует обратиться к документации пакета.

===listings===

Пакет '''listings''' специализируется на оформлении программного кода. К
пакету прилагается подробнейшая документация (''Следует поискать файл listings.pdf.''). С помощью команд
пакета можно включить как небольшие кусочки кода, так и целые его
сегменты, ну и, естественно, файлы.

Для загрузки пакета '''listings''' необходимо добавить в заголовок следующие инструкции:

[[Изображение:LXF88_latex09.png|LXF88_latex09.png]]

{{Врезка
|Заголовок=Языки программирования
|Содержание=Текущая версия пакета 1.3c поддерживает следующие языки (в скобках указаны диалекты):
ABAP, ACSL, Ada (83, 95), Algol (60, 68), Ant, Assembler (x86masm), Awk (gnu, POSIX), bash, Basic
(Visual), C (ANSI, Handel, Objective, Sharp), C++ (ANSI, GNU, ISO, Visual), Caml (light, Objective),
Clean, Cobol (1974, 1985, ibm) Comal 80, csh, Delphi, Eiffel, Elan, erlang, Euphoria, Fortran (77, 90,
95), GCL, Gnuplot, Haskell, HTML, IDL (empty, CORBA), inform, Java (empty, AspectJ), JVMIS, ksh,
Lisp (empty, Auto), Logo, make (empty, gnu), Mathematica (1.0, 3.0), Matlab, Mercury, MetaPost,
Miranda, Mizar, ML, Modula-2, MuPAD, NASTRAN, Oberon-2, OCL (decorative, OMG), Octave, Oz,
Pascal (Borland6, Standard, XSC), Perl, PHP, PL/I, Plasm, POV, Prolog, Promela, Python, R, Reduce,
Rexx, RSL, Ruby, S (empty, PLUS), SAS, Scilab, sh, SHELXL, Simula (67, CII, DEC, IBM), SQL, tcl
(empty, tk), TeX (AlLaTeX, common, LaTeX, plain, primitive), VBScript, Verilog, VHDL (empty, AMS),
VRML (97), XML, XSLT.
|Ширина=300px
}}

Сразу после загрузки пакета рекомендуется «подгрузить» используемые в тексте языки программирования (см. врезку) с помощью макроса
'''\lstloadlanguages'''. В квадратных скобочках перед названием языка
можно указать желательный диалект.

Команда '''\lstset''' позволяет устанавливать значения по умолчанию.
Некоторые из полезных умолчаний перечислены ниже:
* Для того, чтобы можно было печатать кириллицу, например в комментариях, следует определить переменную '''extendedchars=true''' (''Если это не сработает, то необходимо обновить пакет до последней версии или сменить дистрибутив LaTeX на более подходящий'').
* Опция '''escapechar''' позволяет при наборе кода пользоваться услугами ''LaTeX'' напрямую. Всё, что находится между выбранными символами, обрабатывается средствами '''LaTeX'''. Естественно, если выбранный символ (в данном случае «'''|'''») используется в отображаемом языке, то могут возникнуть проблемы при компиляции. Для того, чтобы обнулить '''escapechar''', достаточно ничего не писать за знаком равно при следующем переопределении.
* Инструкция '''frame=<POSITION>''' позволяет рисовать рамку вокруг сегмента кода. На вход принимаются буквы '''t''' – обрамление сверху, '''b''' – снизу, '''l''' и '''r''' – слева и справа, соответственно. В случае '''frame=trbl''' будет
нарисована простейшая одинарная рамка. Опция '''frame=''' эквивалентна отказу от обрамления. Если вместо прописных букв указать заглавные '''frame=TRBL''', то рамка будет двойная. В пакете есть возможность сделать рамки посложнее.

Все команды, определённые в пакете '''listings''', начинаются с префикса '''lst'''. Команда для включения небольших кусочков кода '''\lstinline!код!''' аналогична по действию команде '''\verb!текст!'''.

Сегмент кода оформляется с помощью окружения '''lstlisting''':

[[Изображение:LXF88_latex10.png|LXF88_latex10.png]]

Необязательный параметр может принимать опции, специфичные
для оформления этого куска кода. Например, опция '''language''' позволяет установить язык программирования отличный от выбранного по умолчанию, а '''caption''' создаёт подпись к фрагменту кода.

Файлы можно включать с помощью команды '''\lstinputlisting''':

<source lang=latex>
%установка значений по умолчанию
\lstset{numbers=left, language=MetaPost,
backgroundcolor=\color{yellow},
frame=shadowbox, rulesepcolor=\color{black}}
%вставка файла
\lstinputlisting[firstline=16, lastline=24,
emph={forsuffixes,text,bpath},emphstyle={\color{red}},
emph={[2]fill,unfill},emphstyle={[2]\bfseries\underbar},
]{intro.mp}
</source>

[[Изображение:LXF88_latex11.png|LXF88_latex11.png]]

С помощью опций '''firstline''' и '''secondline''' можно указать диапазон
строк, который следует вывести. В зависимости от выбора языка форматирование существенно меняется. Инструкция '''numbers=left''' нумерует
строки слева.

Для работы с цветами лучше загрузить уже упоминавшийся
ранее пакет '''color'''. Цвета хороши для выделения каких-то ключевых слов и подложки, за которую отвечает опция '''backgroundcolor'''.
Возможности для определения своих «словариков» предоставляет
опции '''emph=<список ключевых слов>'''. В начале списка может идти
его метка в квадратных скобках, таким образом, можно поддерживать
несколько списков одновременно. С помощью опции '''emphstyle''' можно
определить способ выделения ключевых слов.

Обычно код располагается прямо по месту основного текста, так как
обсуждение «исходников» можно производить в самом коде, благо есть
комментарии. При желании можно воспользоваться опцией '''float''', чтобы
из фрагмента кода получился полноценный «плавающий» объект.

Пакет поддерживает свыше сотни распространённых языков программирования и разметки (с учётом диалектов), так что вам, скорее всего, не придётся определять свой язык с помощью инструкции
'''\lstdefinelanguage'''. Но если очень хочется, то и это возможно.

==Представление алгоритмов==

Собственно говоря, это именно то, ради чего Д.Э. Кнут и создал ''TeX''.
Поэтому пакеты для облегчения записи алгоритмов в ''LaTeX'' существовали с самого его рождения. На текущий момент, даже число стандартных пакетов, подпадающих под эту тематику, больше десятка. Здесь
рассмотрена только малая часть из них.

===algorithm===

Пакет '''algorithm''' ориентирован на описание алгоритмов, а не на представление кода. Это позволяет отрешиться от форматирования и сосредоточиться на основной задаче. Пакет определяет окружение '''algorithmic'''. Для
использования в преамбуле следует загрузить одноимённый стиль.

[[Изображение:LXF88_latex12.png|Пример использования пакета ''algorithm'']]

Если необязательный аргумент определён, то осуществляется
нумерация строк. Если аргумент равен 1, то нумеруются все строки,
если 2 – то каждая вторая, а далее по индукции.

Команда '''\STATE''' определяет простое утверждение. Условный оператор представлен командами '''\IF{<условие>}''', '''\ELSIF{<условие>}''',''' \ELSE''' и '''\ENDIF'''. Циклы представлены операторами '''\FOR''' и '''\FORALL''', которые закрываются командой '''\ENDFOR'''. Аналогично присутствуют пары
'''\WHILE{<условие>}''' – '''\ENDWHILE''', '''\REPEAT''' – '''\UNTILL{<условие>}''' и бесконечный цикл '''\LOOP''' – '''\ENDLOOP'''. Кроме уже перечисленных конструкций определены предварительное условие для корректного выполнение алгоритма '''\REQUIRE''', постусловие, которое должно выполняться
при корректной работе алгоритма, '''\ENSURE''', возвращение результата
'''\RETURN''', промежуточная печать '''\PRINT''' и комментарий '''\COMMENT'''.

Собственно говоря, всё. Псевдокод автоматически разбивается на
строки и форматируется в соответствии с общепринятыми представлениями. Очевидно также, что навыки набора математики будут здесь очень кстати. Подробности по настройке пакета следует выяснять в
документации к нему: '''algorithms.pdf'''.

Для того, чтобы сделать из объекта '''algorithmic''' «плавающий объект» можно воспользоваться окружением '''algorithm''', для его использования следует загрузить одноимённый стиль в преамбуле. Внутри
'''algorithm''' можно использовать команды '''\caption''' и '''\label'''.

===Клоны algorithms===

С использованием имеющихся наработок пакета '''algorithms''' был создан
'''algorithmicx'''. Этот пакет предоставляет более расширенный набор
команд. Кроме того, пользователю предоставляются команды, с помощью которых можно формировать свои алгоритмические конструкции.

Автор также предоставил вариант форматирования отступов, принятый в ''Pascal'', что позволяет относительно легко приводить программы на этом языке к виду, годному для красивой распечатки. Пакет работает с теми же окружениями, что используюся в пакете '''algorithms'''. Это
приводит к их несовместимости.

Решение схожей функциональности предоставляет пакет '''algorithm2e'''.
Форматирование ''C''-подобно. Предоставлен избыточный набор конструкций и возможность самому создавать новые структуры. Есть зачатки локализации. Пакет использует окружение '''algorithm''', Это приводит к
несовместимости как с пакетом '''algorithms''', так и с пакетом '''algorithimcx'''.

===clrscode===

Пакет '''clrscode''' представляет возможность набирать псевдокод, как
это делали авторы книги «Алгоритмы: построение и анализ» Томас Х.
Кормен, Чарльз И. Лейзерсон, Рональд Л. Ривест и Клиффорд Штайн (''Introduction to algorithms, Second Edition. Thomas H. Cormen, Charles E. Leiserson, Ronald L. Rivest, Clifford Stein.'').
Для работы с пакетом необходимо загрузить одноимённый стиль. Это
прекрасный пример того, как можно адаптировать ''LaTeX'' для создания
книг по программированию.

[[Изображение:LXF88_latex13.png|Пример использования пакета ''clrscode''.]]

===pseudocode===

Профессора Дональд Л. Крехер [Donald L. Kreher] и Дуглас Р. Стинсон
[Douglas R. Stinson] написали книгу «''Combinatorial Algorithms: Generation, Enumeration and Search''». Специально для представления псевдокода в этой книге они создали пакет, который так и назвали:
'''pseudocode'''. Дональд Л. Крехер использовал одноимённое окружение и
в своей следующей книге по алгоритмам, выпущенной уже в 2005 году.
Пакет поддерживается до сих пор.

[[Изображение:LXF88_latex13.png|Пример использования пакета ''pseudocode''.]]

К сожалению, в книгах по ''LaTeX'' редко рассматриваются структуры,
полезные для представления программных текстов или псевдокода.
Здесь я попытался восполнить этот зияющий пробел. Тема настолько
обширна, что разрабатывать её можно почти бесконечно. ''LaTeX'' сам по
себе код, поэтому программистам, по идее, должно быть уютно в его
окружении. '''LXF'''

==LaTeX и контроль версий==

Исходный текст ''LaTeX'' тоже представляет
собой код. И как всякий код, он достоин жить
в системе контроля версий. Часто бывает
любопытно узнать текущую версию документа
и время его последнего обновления. Если в
качестве системы контроля версий используется ''Subversion'', то для начала следует загрузить пакет '''svn'''.

\usepackage{svn}
\SVN $Date$
\SVN $Rev$

При этом в текст следует добавить метки,
предваряемые командой '''\SVN'''. Для интерполяции меток в системе ''Subversion'' при обновлении файла следует выполнить команды вида:

> svn propset svn:keywords “Date Rev” «имя файла»
> svn commit -m “интерполяция меток”

При этом '''svn''' передаётся информация о том,
какие именно метки требуется обновлять при
выполнении '''commit'''. В данном случае, это метки '''Date''' и '''Rev''' — дата и номер ревизии, соответственно. Более подробную информацию можно получить с помощью команды

> svn help propset

Команда '''\SVN $Date$''' определяет команды
'''\SVNDate''' и '''\SVNTime''', ответственные за календарную дату и время. Все остальные команды
вида '''\SVN $Keyword$''', где '''Keyword''' — одна из
интерполируемых меток '''svn''', определяют
команды '''\SVNKeyword'''.

После интерполяции метки будут выглядеть
примерно следующим образом (см. рисунок).

Схожую функциональность предоставляет
пакет '''svninfo'''.

[[Изображение:LXF88_latex15.png|LXF88_latex15.png]]

LXF87-88:LaTeX

2009-10-28T23:12:03Z

GArik: Косметическая правка

[[Категория:Учебники]]

: '''Компьютерные TeXнологии''' Учимся использовать культовую систему вёрстки

=Документация и программный код=

{{Цикл/LaTeX}}

: '''ЧАСТЬ 4:''' ''TeX'', как известно, был создан для представления кода и алгоритмов. Так постигайте же замысел создателя и его последователей вместе с '''Евгением Балдиным'''!

::::''+++ Ошибка Деления На Огурец.''
::::''Переустановите Вселенную И Перезагрузитесь +++''
::::''Так зависает Гекс.''
::::::::''Источник: «Санта-Хрякус» от Терри Пратчетта''

Программирование под Linux – вполне естественное занятие.
Написание документации – неотъемлемая часть этого процесса. ''LaTeX'' достоин быть включённым в технологическую
цепочку по выпуску программного продукта.

Если вспомнить историю, то Д.Э. Кнут создал ''TeX'' именно для целей
представления кода и алгоритмов в своём глобальном пятитомнике
«Искусство программирования».

==Спецсредства==

Чтобы украсить инструкцию, надо добавлять в неё «пятна».
Злоупотреблять этим не стоит, но пару мыслей выделить вполне реально. Упомянутые ниже приёмы – далеко не всё, что может предложить ''LaTeX'': это просто демонстрация возможностей.

===keystroke===

Иногда в тексте необходимы фразы вида: «Для выхода из программы
нужно нажать клавишу Esc.» Макрос '''\keystroke''', определённый в одноимённом пакете '''keystroke''', позволяет выделить название клавиши, примерно следующим образом:

[[Изображение:LXF88_latex01.png|LXF88_latex01.png]]

В пакете определены многие клавиши, имеющиеся на стандартной
клавиатуре. Пакет очень прост и имеет зачатки интернационализации –
его легко адаптировать под свои нужды.

[[Изображение:LXF88_latex02.png|Клавиши, определенные в keystroke]]

===LCD-дисплей===

LCD-дисплеи сейчас встроены даже в кофемолки. Они легко узнаваемы, поэтому нет необходимости копировать их вид в документацию
с помощью фотографий – достаточно нарисовать что-то похожее.
Изобразить вид дисплея можно с помощью пакета '''lcd'''.

[[Изображение:LXF88_latex03.png|LXF88_latex03.png]]

Для определения цветов используется макрос '''\definecolor''' из пакета '''color'''. Команда '''\LCDcolors''' формирует цвет букв и фона, а макрос '''\textLCD''' выводит LCD-подобный текст на экран. '''\textLCD''' понимает
стандартные команды изменения размера шрифта, поэтому его можно
использовать совместно с обычным текстом внутри абзаца.

По умолчанию определены только латинские буквы, цифры и некоторые из стандартных символов. Для определения других символов
можно воспользоваться макросом '''\DefineLCDchar'''. Макросу передаётся
имя символа и битовая маска, определяющая картинку 5x7 точек. Имя
символа может быть однобуквенным, тогда соответствующая буква
замещается новым рисунком, или многобуквенным, тогда созданный
рисунок кодируется указанным словом в фигурных скобках. Другие
размеры матрицы в пакете отсутствуют, но при желании его вполне
можно доработать.

[[Изображение:LXF88_latex04.png|Определяем Ё для LCD]]

Для эмуляции дисплея используется команда '''\LCD'''. В качестве обязательных параметров ей передаётся число строк и число столбцов, за которыми следует содержание строк, разделённых каким-то разделителем. В приведённом примере в качестве разделителя используется
вертикальная черта, но на её месте мог бы быть любой символ:

[[Изображение:LXF88_latex05.png|LXF88_latex05.png]]

===Битовые поля===

Для описания сетевых протоколов, а так же для бинарных форматов
данных удобнее всего представить последовательность битов графически, то есть в виде таблицы. Это специализация пакета '''bytefield'''. В пакете определено одноимённое окружение '''bytefield''', в качестве обязательного аргумента которому передаётся ширина таблицы в битах:

<source lang=latex>
\begin{bytefield}{«битовая ширина поля»}
«битовые поля»
\end{bytefield}
</source>

В окружении '''bytefield''' работают команды '''\wordbox''' и '''\bitbox''', которые формируют поля, занимающие всю ширину таблицы или только часть её, соответственно:

<source lang=latex>
\wordbox[«рамка»]{«число строк»}{«текст»}
\bitbox[«рамка»]{«число занимаемых битов»}{«текст»}
</source>

Необязательный параметр «рамка» позволяет сформировать обрамление для текущего битового поля. Значение по умолчанию ['''lrtb'''] означает, что рамка рисуется со всех сторон поля: '''l''' – слева, '''r''' – справа, '''t''' – сверху и '''b''' – снизу. Строки разделяются двойной обратной чертой '''\\'''.

Формат пакета сетевого протокола UDP можно описать примерно
следующим образом:

<source lang=latex>
\begin{bytefield}{32}
\bitheader{0,15,16,31}\\
\wordgroupr{Заголовок}
\bitbox{16}{Порт отправителя}\bitbox{16}{Порт получателя}\\
\bitbox{16}{Размер}\bitbox{16}{Контрольная сумма}
\endwordgroupr\\
\wordbox[lrt]{1}{Данные}\\
\skippedwords\\
\wordbox[lrb]{1}{до 65{.}527 байт}
\end{bytefield}
</source>

[[Изображение:LXF88_latex06.png|Формат пакета UDP]]

Кроме уже упомянутых команд создания полей при описании формата UDP использовалась команда нумерации столбцов '''\bitheader''',
конструкция для создания группы '''\wordgroupr''' и макрос '''\skippedwords'''
для формирования «разрыва».

В качестве обязательного аргумента команде '''\bitheader''' передаётся список нумеруемых битов, при этом можно передавать диапазоны чисел, например, {0-31}. В пакете определены два окружения для
группировки битовых полей, '''\wordgroupr''' и '''\wordgroupl''' – отличие этих
команд в том, что для первой заголовок группы вводится справа, а для
второй – слева. Для более подробной информации следует обратиться
к документации пакета.

==Форматирование кода==

''LaTeX'' может использоваться не только для набора математики. Хотя
набор математики, безусловно, вершина типографского искусства,
существует масса задач со сравнимой сложностью форматирования.
Представление исходных текстов программ – это весьма непростое
занятие, особенно если хочется сделать код читаемым.

===verbatim===

Самый простой способ включить код в текст – это заключить его в
стандартное окружение '''verbatim''', которое просто выводит данный текст
на печать с отступами пользователя. При этом исчезает возможность
делать акценты в избранных местах.

Небольшие вставки можно делать с помощью команды '''\verb!текст!'''.
Сразу после '''\verb''' должен идти группирующий символ (в данном случае, «'''!'''»), который указывает окончание действия команды. Группирующий символ может быть любым, кроме пробела или звёздочки «'''*'''».

Пакет '''verbatim''' из коллекции '''tools''' переопределяет стандартную команду так, что внутри окружения можно вставлять тексты неограниченного размера. Кроме этого, пакет предоставляет команду
'''\verbatiminput''', которой в качестве основного аргумента можно передать имя внешнего файла.

Кроме упомянутых окружения и макросов определены такие же, но
со звёздочкой в конце имени, то есть окружение '''verbatim*''' и команды
'''\verb*''' и '''\verbatiminput*'''. '''*'''-форма отличается от базовой тем, что все
пробелы визуализируются.

[[Изображение:LXF88_latex07.png|LXF88_latex07.png]]

Стандартный пакет '''alltt''' – это почти то же самое, что и '''verbatim''',
но с возможностью использовать внутри окружения команды ''LaTeX''.
Правда, шрифт в любом случае остаётся фиксированной ширины, как
для печатной машинки.

[[Изображение:LXF88_latex08.png|LXF88_latex08.png]]

Гораздо более разнообразные средства управления выводом
неформатированного текста предоставляет пакет ''fancyvrb''. За подробной информацией следует обратиться к документации пакета.

===listings===

Пакет '''listings''' специализируется на оформлении программного кода. К
пакету прилагается подробнейшая документация (''Следует поискать файл listings.pdf.''). С помощью команд
пакета можно включить как небольшие кусочки кода, так и целые его
сегменты, ну и, естественно, файлы.

Для загрузки пакета '''listings''' необходимо добавить в заголовок следующие инструкции:

[[Изображение:LXF88_latex09.png|LXF88_latex09.png]]

{{Врезка
|Заголовок=Языки программирования
|Содержание=Текущая версия пакета 1.3c поддерживает следующие языки (в скобках указаны диалекты):
ABAP, ACSL, Ada (83, 95), Algol (60, 68), Ant, Assembler (x86masm), Awk (gnu, POSIX), bash, Basic
(Visual), C (ANSI, Handel, Objective, Sharp), C++ (ANSI, GNU, ISO, Visual), Caml (light, Objective),
Clean, Cobol (1974, 1985, ibm) Comal 80, csh, Delphi, Eiffel, Elan, erlang, Euphoria, Fortran (77, 90,
95), GCL, Gnuplot, Haskell, HTML, IDL (empty, CORBA), inform, Java (empty, AspectJ), JVMIS, ksh,
Lisp (empty, Auto), Logo, make (empty, gnu), Mathematica (1.0, 3.0), Matlab, Mercury, MetaPost,
Miranda, Mizar, ML, Modula-2, MuPAD, NASTRAN, Oberon-2, OCL (decorative, OMG), Octave, Oz,
Pascal (Borland6, Standard, XSC), Perl, PHP, PL/I, Plasm, POV, Prolog, Promela, Python, R, Reduce,
Rexx, RSL, Ruby, S (empty, PLUS), SAS, Scilab, sh, SHELXL, Simula (67, CII, DEC, IBM), SQL, tcl
(empty, tk), TeX (AlLaTeX, common, LaTeX, plain, primitive), VBScript, Verilog, VHDL (empty, AMS),
VRML (97), XML, XSLT.
|Ширина=300px
}}

Сразу после загрузки пакета рекомендуется «подгрузить» используемые в тексте языки программирования (см. врезку) с помощью макроса
'''\lstloadlanguages'''. В квадратных скобочках перед названием языка
можно указать желательный диалект.

Команда '''\lstset''' позволяет устанавливать значения по умолчанию.
Некоторые из полезных умолчаний перечислены ниже:
* Для того, чтобы можно было печатать кириллицу, например в комментариях, следует определить переменную '''extendedchars=true''' (''Если это не сработает, то необходимо обновить пакет до последней версии или сменить дис-
трибутив LaTeX на более подходящий'').
* Опция '''escapechar''' позволяет при наборе кода пользоваться услугами ''LaTeX'' напрямую. Всё, что находится между выбранными символами, обрабатывается средствами '''LaTeX'''. Естественно, если выбранный символ (в данном случае «'''|'''») используется в отображаемом языке, то могут возникнуть проблемы при компиляции. Для того, чтобы обнулить '''escapechar''', достаточно ничего не писать за знаком равно при следующем переопределении.
* Инструкция '''frame=<POSITION>''' позволяет рисовать рамку вокруг сегмента кода. На вход принимаются буквы '''t''' – обрамление сверху, '''b''' – снизу, '''l''' и '''r''' – слева и справа, соответственно. В случае '''frame=trbl''' будет
нарисована простейшая одинарная рамка. Опция '''frame=''' эквивалентна отказу от обрамления. Если вместо прописных букв указать заглавные '''frame=TRBL''', то рамка будет двойная. В пакете есть возможность сделать рамки посложнее.

Все команды, определённые в пакете '''listings''', начинаются с префикса '''lst'''. Команда для включения небольших кусочков кода '''\lstinline!код!''' аналогична по действию команде '''\verb!текст!'''.

Сегмент кода оформляется с помощью окружения '''lstlisting''':

[[Изображение:LXF88_latex10.png|LXF88_latex10.png]]

Необязательный параметр может принимать опции, специфичные
для оформления этого куска кода. Например, опция '''language''' позволяет установить язык программирования отличный от выбранного по умолчанию, а '''caption''' создаёт подпись к фрагменту кода.

Файлы можно включать с помощью команды '''\lstinputlisting''':

<source lang=latex>
%установка значений по умолчанию
\lstset{numbers=left, language=MetaPost,
backgroundcolor=\color{yellow},
frame=shadowbox, rulesepcolor=\color{black}}
%вставка файла
\lstinputlisting[firstline=16, lastline=24,
emph={forsuffixes,text,bpath},emphstyle={\color{red}},
emph={[2]fill,unfill},emphstyle={[2]\bfseries\underbar},
]{intro.mp}
</source>

[[Изображение:LXF88_latex11.png|LXF88_latex11.png]]

С помощью опций '''firstline''' и '''secondline''' можно указать диапазон
строк, который следует вывести. В зависимости от выбора языка форматирование существенно меняется. Инструкция '''numbers=left''' нумерует
строки слева.

Для работы с цветами лучше загрузить уже упоминавшийся
ранее пакет '''color'''. Цвета хороши для выделения каких-то ключевых слов и подложки, за которую отвечает опция '''backgroundcolor'''.
Возможности для определения своих «словариков» предоставляет
опции '''emph=<список ключевых слов>'''. В начале списка может идти
его метка в квадратных скобках, таким образом, можно поддерживать
несколько списков одновременно. С помощью опции '''emphstyle''' можно
определить способ выделения ключевых слов.

Обычно код располагается прямо по месту основного текста, так как
обсуждение «исходников» можно производить в самом коде, благо есть
комментарии. При желании можно воспользоваться опцией '''float''', чтобы
из фрагмента кода получился полноценный «плавающий» объект.

Пакет поддерживает свыше сотни распространённых языков программирования и разметки (с учётом диалектов), так что вам, скорее всего, не придётся определять свой язык с помощью инструкции
'''\lstdefinelanguage'''. Но если очень хочется, то и это возможно.

==Представление алгоритмов==

Собственно говоря, это именно то, ради чего Д.Э. Кнут и создал ''TeX''.
Поэтому пакеты для облегчения записи алгоритмов в ''LaTeX'' существовали с самого его рождения. На текущий момент, даже число стандартных пакетов, подпадающих под эту тематику, больше десятка. Здесь
рассмотрена только малая часть из них.

===algorithm===

Пакет '''algorithm''' ориентирован на описание алгоритмов, а не на представление кода. Это позволяет отрешиться от форматирования и сосредоточиться на основной задаче. Пакет определяет окружение '''algorithmic'''. Для
использования в преамбуле следует загрузить одноимённый стиль.

[[Изображение:LXF88_latex12.png|Пример использования пакета ''algorithm'']]

Если необязательный аргумент определён, то осуществляется
нумерация строк. Если аргумент равен 1, то нумеруются все строки,
если 2 – то каждая вторая, а далее по индукции.

Команда '''\STATE''' определяет простое утверждение. Условный оператор представлен командами '''\IF{<условие>}''', '''\ELSIF{<условие>}''',''' \ELSE''' и '''\ENDIF'''. Циклы представлены операторами '''\FOR''' и '''\FORALL''', которые закрываются командой '''\ENDFOR'''. Аналогично присутствуют пары
'''\WHILE{<условие>}''' – '''\ENDWHILE''', '''\REPEAT''' – '''\UNTILL{<условие>}''' и бесконечный цикл '''\LOOP''' – '''\ENDLOOP'''. Кроме уже перечисленных конструкций определены предварительное условие для корректного выполнение алгоритма '''\REQUIRE''', постусловие, которое должно выполняться
при корректной работе алгоритма, '''\ENSURE''', возвращение результата
'''\RETURN''', промежуточная печать '''\PRINT''' и комментарий '''\COMMENT'''.

Собственно говоря, всё. Псевдокод автоматически разбивается на
строки и форматируется в соответствии с общепринятыми представлениями. Очевидно также, что навыки набора математики будут здесь очень кстати. Подробности по настройке пакета следует выяснять в
документации к нему: '''algorithms.pdf'''.

Для того, чтобы сделать из объекта '''algorithmic''' «плавающий объект» можно воспользоваться окружением '''algorithm''', для его использования следует загрузить одноимённый стиль в преамбуле. Внутри
'''algorithm''' можно использовать команды '''\caption''' и '''\label'''.

===Клоны algorithms===

С использованием имеющихся наработок пакета '''algorithms''' был создан
'''algorithmicx'''. Этот пакет предоставляет более расширенный набор
команд. Кроме того, пользователю предоставляются команды, с помощью которых можно формировать свои алгоритмические конструкции.

Автор также предоставил вариант форматирования отступов, принятый в ''Pascal'', что позволяет относительно легко приводить программы на этом языке к виду, годному для красивой распечатки. Пакет работает с теми же окружениями, что используюся в пакете '''algorithms'''. Это
приводит к их несовместимости.

Решение схожей функциональности предоставляет пакет '''algorithm2e'''.
Форматирование ''C''-подобно. Предоставлен избыточный набор конструкций и возможность самому создавать новые структуры. Есть зачатки локализации. Пакет использует окружение '''algorithm''', Это приводит к
несовместимости как с пакетом '''algorithms''', так и с пакетом '''algorithimcx'''.

===clrscode===

Пакет '''clrscode''' представляет возможность набирать псевдокод, как
это делали авторы книги «Алгоритмы: построение и анализ» Томас Х.
Кормен, Чарльз И. Лейзерсон, Рональд Л. Ривест и Клиффорд Штайн (''Introduction to algorithms, Second Edition. Thomas H. Cormen, Charles E. Leiserson, Ronald L. Rivest, Clifford Stein.'').
Для работы с пакетом необходимо загрузить одноимённый стиль. Это
прекрасный пример того, как можно адаптировать ''LaTeX'' для создания
книг по программированию.

[[Изображение:LXF88_latex13.png|Пример использования пакета ''clrscode''.]]

===pseudocode===

Профессора Дональд Л. Крехер [Donald L. Kreher] и Дуглас Р. Стинсон
[Douglas R. Stinson] написали книгу «''Combinatorial Algorithms: Generation, Enumeration and Search''». Специально для представления псевдокода в этой книге они создали пакет, который так и назвали:
'''pseudocode'''. Дональд Л. Крехер использовал одноимённое окружение и
в своей следующей книге по алгоритмам, выпущенной уже в 2005 году.
Пакет поддерживается до сих пор.

[[Изображение:LXF88_latex13.png|Пример использования пакета ''pseudocode''.]]

К сожалению, в книгах по ''LaTeX'' редко рассматриваются структуры,
полезные для представления программных текстов или псевдокода.
Здесь я попытался восполнить этот зияющий пробел. Тема настолько
обширна, что разрабатывать её можно почти бесконечно. ''LaTeX'' сам по
себе код, поэтому программистам, по идее, должно быть уютно в его
окружении. '''LXF'''

==LaTeX и контроль версий==

Исходный текст ''LaTeX'' тоже представляет
собой код. И как всякий код, он достоин жить
в системе контроля версий. Часто бывает
любопытно узнать текущую версию документа
и время его последнего обновления. Если в
качестве системы контроля версий используется ''Subversion'', то для начала следует загрузить пакет '''svn'''.

\usepackage{svn}
\SVN $Date$
\SVN $Rev$

При этом в текст следует добавить метки,
предваряемые командой '''\SVN'''. Для интерполяции меток в системе ''Subversion'' при обновлении файла следует выполнить команды вида:

> svn propset svn:keywords “Date Rev” «имя файла»
> svn commit -m “интерполяция меток”

При этом '''svn''' передаётся информация о том,
какие именно метки требуется обновлять при
выполнении '''commit'''. В данном случае, это метки '''Date''' и '''Rev''' — дата и номер ревизии, соответственно. Более подробную информацию можно получить с помощью команды

> svn help propset

Команда '''\SVN $Date$''' определяет команды
'''\SVNDate''' и '''\SVNTime''', ответственные за календарную дату и время. Все остальные команды
вида '''\SVN $Keyword$''', где '''Keyword''' — одна из
интерполируемых меток '''svn''', определяют
команды '''\SVNKeyword'''.

После интерполяции метки будут выглядеть
примерно следующим образом (см. рисунок).

Схожую функциональность предоставляет
пакет '''svninfo'''.

[[Изображение:LXF88_latex15.png|LXF88_latex15.png]]

LXF92:LaTeX

2009-10-28T23:06:27Z

GArik: Косметическая правка

[[Категория:Учебники]]
: '''Компьютерные TeXнологии''' Учимся использовать культовую систему вёрстки

{{Цикл/LaTeX}}

==Справочно-поисковый аппарат издания==

: '''ЧАСТЬ 9''' ''TeX'' создавался для верстки книг и сегодня '''Евгений Балдин''' рассмотрит всё то, без чего немыслимо серьезное произведение – оглавление, предметный указатель, сноски и т.д..

::::''На этом же этаже располагалось книгохранилище. По поводу''
::::''его размеров рассказывали, что в глубине, в полукилометре''
::::''от входа, идёт вдоль стеллажей неплохое шоссе, оснащённое''
::::''верстовые столбами.''
:::::::''«Понедельник начинается в субботу»''
:::::::::''Аркадий и Борис Стругацкие.''

Книги делятся на те, что читаются один раз и те, что многократно перечитываются. Наличие информации о структуре книги
повышает ценность любого текста. Отсутствие этой информации – прямой намёк, что после прочтения произведение следует забыть
и выбросить.

Справочно-поисковый аппарат издания позволяет читателю облегчить и ускорить поиск имеющихся в книге объектов. В качестве элементов, из которых складывается справочного-поисковая система, можно
упомянуть рубрикацию, оглавление, колонтитулы, ссылки, подстрочные примечания, алфавитный указатель и библиографию.

Этот аппарат существует исключительно для читателя, и он достаточно трудоёмок при создании, но сложности не должны пугать истинных энтузиастов в деле создания текстов, так как их преодоление значительно повышают ценность серьёзного произведения.

===Рубрикация и оглавление===

:::''Нужны ли книге оглавление или содержание? Любой скажет: что за вопрос, конечно, нужны. И не только в книге научной и деловой. В любой.''
''А.Э. Мильчин. «Культура издания»''

Для оформления разделов в основном используются команды секционирования: '''\section, \subsection, \subsubsection, \paragraph ''' и '''\subparagraph.'''

Команды перечислены в порядке убывания значимости при рубрикации. Обычно любой сколько-нибудь сложный текст следует начинать
с планирования структуры, то есть создать шаблон, примерно следующего вида:

<source lang=latex>
\documentclass[a4paper,12pt]{ncc}
\usepackage[warn]{mathtext}
\usepackage[T2A]{fontenc}
\usepackage[koi8-r]{inputenc}
\usepackage[english,russian]{babel}
\usepackage{indentfirst}
\title{Пример рубрикации}
\author{А.\,В.~Тор}
\begin{document}
\maketitle{}
\tableofcontents{}
\section{Раздел}
\label{sec:section}
Основной элемент рубрикации.
\subsection{Подраздел}
\label{sec:subsection}
Вспомогательный элемент рубрикации.
\subsubsection[Подподраздел]{Что-то более мелкое чем подраздел}
\label{sec:subsubsection}
Вспомогательный для вспомогательного. В содержании выводится
краткая версия заголовка.
\paragraph{Параграф}
\label{sec:paragraph}
Важный параграф.
\subparagraph{Подпараграф}
\label{sec:subparagraph}
Параграф чуть менее важный.
\section*{Раздел, отсутствующий в содержании}
Всяко бывает. Иногда и такое нужно.
\section*{Заключение}
\label{sec:afterwords}
\addcontentsline{toc}{section}{Заключение}
Заключение, в отличие от, скажем, раздела~\ref{sec:subsection}
на странице~\pageref{sec:subsection}, нумеровать не надо, но в
содержании отразить необходимо.
\appendix
\section{Приложение}
\label{appendix}
\end{document}
</source>

[[Изображение:LXF92_latex01.jpg|Пример рубрикации]]

'''Пример рубрикации и оглавления.'''

Результат компиляции кода представлен на иллюстрации. Кроме
самих заголовков разделов, созданных с помощью команд секционирования, в начале документа создаётся оглавление. За это отвечает команда '''\tableofcontents'''. При каждой компиляции информация о разделах собирается в файле с тем же именем, что и у tex-файла, но с расширением '''toc'''. При следующей компиляции обновлённая информация
о разделах используется для создания оглавления.

Уровень, до которого информация отображается в оглавлении, можно поменять, изменив значение переменной '''tocdepth''', например, так:

\setcounter{tocdepth}{2}

В этом случае будет показана информация о разделах вплоть до
второго уровня. Раздел типа '''\section''' соответствует первому уровню
секционирования, '''\subsection''' – второму, и так далее.

Кроме оглавления, можно вывести список иллюстраций '''\listoffigures'''
и таблиц '''\listoftables'''. Информация об иллюстрациях и таблицах автоматически собирается в файлах с расширениями '''.lof''' и '''.lot'''.

Для добавления какой-то информации в оглавление в обход
команд секционирования можно воспользоваться командой

\addcontentsline{toc}{«уровень раздела»}{«строка в оглавлении»}

У этой команды три аргумента. Первый аргумент соответствует
расширению файла ('''.toc, .lof''' или '''.lot'''), в который добавляется «строка
в оглавлении». Уровень раздела определяется именами команд секционирования, то есть '''section, subsection''' и так далее. Команды ''LaTeX'' при передаче в файлы списков следует защищать командой '''\protect''', дабы
избежать проблемы с «хрупкими» инструкциями.

Команда '''\appendix''' отделяет приложение от основного текста. После
её вызова правила нумерация разделов изменяется. '''\appendix''' тоже
является командой секционирования.

===Ссылки и примечания===

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

====Механизм ссылок====

В примере, демонстрирующем работу команд секционирования, вслед
за каждой такой командой ставилась метка с помощью инструкции
'''\label'''. Метка представляет собой последовательность ASCII-символов.
Префикс '''sec:''' автоматически добавляется AUCTeX во время вставки
метки при редактировании tex-файла в ''Emacs''. Этот префикс существует исключительно для удобства автора, так что можно обойтись без
него. При компиляции документа информация о имеющихся метках
добавляется в файл с расширением '''.aux'''. Для того, чтобы извлечь эту
информацию, то есть номер раздела (команда '''\ref''') или номер страницы ('''\pageref'''), необходимо пропустить текст через ''LaTeX'' ещё раз.

Для того, чтобы можно было сослаться на внешний документ, следует воспользоваться пакетом ''xr''. В этом случае в преамбуле необходимо добавить примерно такие инструкции:

<source lang=latex>
\usepackage{xr}
\externaldocument[EXT-]{externaldoc}
</source>

Это позволяет получить доступ к меткам файла '''externaldoc.tex'''.
Обращение к меткам, как и обычно, осуществляется помощью команд
'''\ref/\pageref''', только перед именем метки добавляется префикс '''EXT-'''.
Можно обойтись и без префикса, так как этот параметр является опциональным, но в этом случае повышается вероятность конфликта из-за существования одинаковых меток.

Ссылаться можно не только на разделы. Метки внутри нумерованных окружений, типа '''equation''' (выключенные математические формулы1) или '''theorem''' (теоремы), принимают их номер. Это так же касается
рисунков (окружение '''figure''') и таблиц (окружение '''tabular'''). В этом случае '''\label''' должна следовать сразу за командой '''\caption''', формирующей
подпись к плавающему объекту.

Общего рецепта создания ссылок на электронные ресурсы нет.
Проще всего использовать команду '''\url''' из одноимённого пакета:

[[Изображение:LXF92_latex02.png|LXF92_latex02.png]]

В адресной строке должны отсутствовать символы '''%, #, ^,''' и она не
должна заканчиваться символом '''\'''. Если есть желание уйти и от этих
ограничений, то аналогично команде '''\verb''' инструкцию можно использовать и так: <code>\url!http://www.адрес.ru!</code>.

В плане создания и управления гиперссылками также интересен
пакет ''hyperref'', который предоставляет схожую функциональность и
позволяет создавать гиперссылки в pdf-документах, но это уже совсем
другая история:

<source lang=latex>
%загрузка пакет hyperref
\usepackage[unicode=true]{hyperref}
</source>

====Подстрочные примечания====

Подстрочное примечание формируется с помощью команды '''\footnote'''.
Правила оформления примечаний прописываются в определении
класса, и без особых на то причин менять их не стоит. Примечание,
если позволяет место, печатается на той же странице, где помещена
ссылка, и отделяется от текста разделительной линией.

[[Изображение:LXF92_latex03.png|LXF92_latex03.png]]

Примечание можно добавлять и внутри окружения '''minipage''', но тогда оно печатается внутри окружения:

[[Изображение:LXF92_latex04.png|LXF92_latex04.png]]

Необязательный параметр '''\footnote''' позволяет присвоить примеча
нию значение по выбору пользователя.

Для того чтобы можно было сделать сноску внутри заголовка раз
дела, необходимо защитить инструкцию '''\footnote''' командой '''\protect'''
команда создания подстрочного примечания является «хрупкой»:

\section{Заголовок\protect\footnote{Подстрочное примечание.}}

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

\footnotemark[num]
\footnotetext[num]{«сноска»}

Необязательный параметр '''num''', как и в случае '''\footnote''', позволяет
формировать свою нумерацию. Для хранения текущего номера ссылки
используется счётчик '''footnote'''.

===Колонтитулы===

Правила формирования колонтитулов целиком зависит от выбранного
класса документа. Если же хочется изменить значения по умолчанию
то проще всего выбрать стиль страницы '''myheadings''' и сформировать
колонтитулы:

\pagestyle{myheadings}
\markboth{«левый колонтитул»}{«правый колонтитул»}

Если печать односторонняя, то достаточно воспользоваться коман
дой '''\markright''', которая имеет только один аргумент.

Для полного управления содержимым колонтитулов лучше всего
подходит пакет '''fancyhdr'''. Подробно об этом пакеты было рассказано
ранее в статье «Вёрстка», раздел «Стили страницы» ([[LXF89:LaTeX|LXF89]]).

===Библиография===

:::''Книги создаются не в безвоздушном или бескнижном пространстве.''

''А.Э. Мильчин. «Культура издания»''

Хорошая книга представляет из себя ценность, но даже самая лучшая
книга не в состоянии охватить абсолютно все аспекты рассматриваемой
в ней темы. Книги существуют в книжном пространстве. Всегда
можно найти что-то, на чём книга основывалась; что-то, что развивает
основную идею; и что-то, что позволяет взглянуть на главную тему с
другой стороны. Список литературы только украшает книгу.

Для ссылок на литературу используется команда

\cite[«комментарий»]{«список меток»}

Метки либо формируются автором самостоятельно внутри окружения
'''thebibliography''':

<source lang=latex>
Полезно почитать книгу \cite[Роженко]{rozenko-2005}.
\begin{thebibliography}{9}
\bibitem{rozenko-2005}Роженко А.И. Искусство вёрстки в
\LaTeX’е. \newblock --- Новосибирск: Изд. ИВМиМГ СО~РАН,
2005. 398~с.
\end{thebibliography}
</source>

либо используется механизм ''BibTeX''. Команда '''\newblock''' позволяет
логически разделить разные по смыслу элементы.
В качестве обязательного аргумента окружения '''thebibliography''' требуется передать
текст, соответствующий самой широкой метке, для выравнивания.
То есть, если список литературы содержит меньше 10 записей,
то достаточно передать однобуквенную фразу, например, «9», а в случае
двузначного числа книг в списке уже потребуется «99», и так далее.

[[Изображение:LXF92_latex05.png|LXF92_latex05.png]]

'''Пример библиографической ссылки.'''

Как и в случае с перекрёстными ссылками, информация о списке
литературы заносится в файл с расширением '''aux''', то есть для правильного его отображения необходимо два прохода ''LaTeX''.

Для того чтобы можно было использовать кириллицу в метках для
цитирования литературы, то есть иметь возможность написать что-то
вроде:

<source lang=latex>
\cite{Котельников-2004}
…
\bibitem{Котельников-2004}
</source>

Следует воспользоваться пакетом '''citehack''':

\usepackage{citehack}

Из названия пакета очевидно, что это «хак» со всеми вытекающими
последствиями и что им не следует злоупотреблять.

====BibTeX====

[[Изображение:LXF92_latex06.jpg|Конвейер ''LaTeX+BibTeX'']]

'''Конвейер ''LaTeX+BibTeX''. tex – ''LaTeX''-исходник, bib – библиографическая база, bst – стилевой файл для библиографии, blg – log-файл ''BibTeX'', bbl – отсортированный список литературы, aux – информация о ссылках.'''

Список литературы можно оформлять вручную. Есть какой-никакой
стандарт, например, тот же ГОСТ 7.80-00 или ГОСТ 7.1-84 (ГОСТ на оформление библиографического указателя, принятый в 2000 году. Правила оформления могут нравиться или не нравиться, но это всё-таки хоть какой-то стандарт). Его можно
просто взять и следовать подробной инструкции. Но далеко не все
издательства подчиняются этому стандарту, в котором, например, нет
информации о том, как нужно оформлять www-ссылки. Да и вообще,
список сопутствующей литературы – это нечто большее, чем просто
довесок к статье или книге: это вполне самостоятельный фрагмент
информации, который очень полезно уметь представлять по-разному.

Для решения этой проблемы Орен Поташник разработал программу ''BibTeX'', которая сама формирует окружение '''thebibliography''', получая
информацию из текстовой библиографической базы. Структура библиографической базы ''BibTeX'' является довольно распространённым
форматом, который использует в том числе и Google Scholar (http://scholar.google.com/), не говоря уж о том, что основной архив электронных препринтов http://xxx.lanl.gov предоставляет библиографическую
информацию исключительно в виде записей ''BibTeX''.

Из программного обеспечения, позволяющего работать с ''BibTeX'',
следует упомянуть встроенный в ''Emacs'' пакет ''RefTeX'' и ''JabRef'' http://jabref.sourceforge.net/. Тот, кто не освоил ''Emacs'', и кому не нравится
Java, может поискать программные пакеты ''gBib'' и ''KBib'' для Gnome и
KDE соответственно. Простой конвертер ''BibTeX2html'' позволяет получить список литературы в html-виде. Естественно, и простое редактирование текстового файла вручную также никто не отменял.

Как правило, библиографическая база в формате ''BibTeX'' хранится в файле с расширением '''.bib'''. Перед тем, как с помощью команды '''\bibliography''' подключить базу к ''LaTeX''-исходнику, нужно выбрать стиль
сортировки библиографии:

<source lang=latex>
\bibliographystyle{«стиль»}
\bibliography{«имя bib-файла»}
</source>

В ''LaTeX'' есть четыре стандартных стиля для формирования списка
литературы:

* '''plain''' – открытый стиль. Библиографические записи помечаются
порядковыми номерами и сортируются в алфавитном порядке. Чтобы
правильно отсортировать библиографию на русском языке, необходимо вместо ''BibTeX'' воспользоваться командой ''BibTeX8'', указав с помощью ключа '''--csfile''' соответствующее правило сортировки (В стандартной поставке ''LaTeX'' есть правило для сортировки для кодовой страницы '''cp866 cp866rus.csf'''. На основе этого файла можно создать правило для другой кодовой страницы.)

* '''unsrt''' – несортирующий стиль. В отличии от '''plain''', порядок представления списка литературы определяется порядком цитирования библиографии в тексте.

* '''alpha''' – алфавитный стиль. Вместо нумерации библиографии используются имена меток. Литература сортируется по меткам.

* '''abbrv''' – аббревиатурный стиль. Вместо полных имён авторов, названий месяцев и журналов печатаются сокращения. Сортировка и нумерация соответствует стилю '''plain'''.

'''Максим Поляков''' разработал стили для ''BibTeX'', соответствующие
ГОСТ 7.80-00 и GOST 7.1-84: '''gost780s/gost71s''', аналогичные '''plain''' и
'''gost780u/gost71u''', аналогичные '''unsrt'''. Описание этих стилей представлено в стандартной документации в виде файлов '''gost780.pdf''' и '''gost71.pdf'''. Многие журналы, принимающие публикации в ''LaTeX'', имеют
свои собственные ''BibTeX''-стили. В стандартной поставке TeXLive 2007
идёт более 200 различных библиографических стилей – есть из чего
выбирать.

[[Изображение:LXF92_latex07.png|LXF92_latex07.png]]

'''Список литературы, оформленный с помощью ''BibTeX''. Стиль gost780u.'''

В дополнение к команде цитирования '''\cite''' в случае подключения
библиографической базы можно использовать инструкцию '''\nocite'''.
Команда '''\nocite''' не создаёт никакой ссылки в тексте, но упомянутая
запись отображается в списке литературы.

Сама по себе база состоит из записей вида:

<source lang=latex>
@book{Gussens-1999,
author = {М. Гуссенс and Ф. Миттельбах and А. Самарин},
title = {Путеводитель по пакету \LaTeX{} и его
расширению \LaTeXe: Пер. с англ.},
year = {1999},
isbn = {5-03-003325-4},
publisher = {Мир},
address = {М.},
numpages = {606},
language = {russian},
OPTnote = {}
}
</source>

После знака «коммерческое at» @ идёт тип записи. В фигурных
скобках вслед за меткой через запятую перечисляются пары ключ-значение. ''BibTeX'' поддерживает определённый набор типов записей, каждому из которых соответствуют свои обязательные и необязательные
поля (Если к названию необязательного поля добавить '''OPT''' ('''note->OPTnote'''), то такие такие поля игнорируются, даже если присутствуют в записи). Если не заполнено обязательное поле, то при компиляции ''BibTeX''
генерирует ошибку. Имеются следующие стандартные типы записей
(''BibTeX'' не чувствителен к регистру):

* '''Аritcle''' – статья в журнале. Обязательные поля: '''author, title, journal, year'''. Необязательные поля: '''volume, number, pages, month, note, annote'''.

* '''Book'''' – книга. Обязательные поля: '''author''' или '''editor, title, publisher, year'''. Необязательные поля: '''volume, number, series, address, edition, month, note, annote.'''

* '''Booklet''' – брошюра. Обязательное поле: '''title'''. Необязательные поля: '''author, howpublished, address, month, year, note, annote'''.

* '''Conference''' или '''InProceedings''' – статья, опубликованная в трудах конференции. Обязательные поля: '''author, title'''. Необязательные поля: '''crossref, booktitle, pages, year, editor, volume, number, series, address, month, organisation, publisher, note, annote'''.

* '''Proceedings''' – труды конференции. Обязательные поля: '''title, year'''. Необязательные поля: '''booktitle, editor, volume, number, series, address, month, organisation, publisher, note, annote'''.

* '''InBook''' – ссылка на часть книги, то есть на её главу, раздел или просто на определённый набор страниц. Обязательные поля: '''author''' или '''editor, title, chapter, publisher, year'''. Необязательные поля: '''volume''' или '''number, series, type, address, edition, month, pages, note, annote'''.

* '''InCollection '''– часть книги со своим заглавием. Обязательные поля: '''author, title, booktitle'''. Необязательные поля: '''crossref, pages, publisher, year, editor, volume или number, series, type, chapter, address, edition, month, note, annote'''.

* '''Manual''' – техническая документация. Обязательное поле: '''title'''. Необязательные поля: '''author, organisation, address, edition, month, year, note, annote'''.

* '''PhdThesis''' – диссертация. Обязательные поля: '''author, title, school, year'''. Необязательные поля: '''address, month, note, annote'''.

* '''MastersThesis''' – дипломная работа. Обязательные и необязательные поля такие же, как у '''PhdThesis'''.

* '''TechReport''' – отчёт. Обязательные поля: '''author, title, institution, year'''. Необязательные поля: '''type, numer, address, month, note, annote'''.

* '''Unpublished''' – неопубликованный авторский текст. Обязательные поля: '''author, title, note'''. Необязательные поля: '''month, year, annote'''.

* '''Misc''' – то, что не подходит для других типов записей. Обязательные поля отсутствуют. Необязательные поля: '''author, title, howpublished, month, year, note, annote'''.

Значение полей в большинстве случаев понятно из их названия.
Исключением, пожалуй, является поле '''crossref''', в качестве значения
которого можно передать ссылку на другую запись, откуда ''BibTeX'' при
трансляции возьмёт значения всех недостающих полей записи. Из особенностей следует упомянуть, что авторы в поле '''author''' разделяются с
помощью союза '''and'''.

Кроме перечисленных стандартных полей при использовании библиографических ГОСТ-стилей '''gost780u/gost71u''' и '''gost780s/gost71s''' можно использовать поля '''numpages''' – число страниц и '''language''' – влияет на сортировку при выборе стиля типа '''plain'''. Допустимые значения
для поля '''language – russian, ukrainian''' и '''english''' по умолчанию.

===Алфавитный указатель===

:::''Указатель значительно повышает ценность любой книги, если она из тех, что читают не только насквозь, но и выборочно.''

''А.Э. Мильчин «Культура издания»''

[[Изображение:LXF92_latex08.png|LXF92_latex08.png]]

'''Конвейер ''LaTeX+MakeIndex''. tex – LaTeX-исходник, idx – не отсортированный индекс (полуфабрикат), ist – стилевой файл для указателя, ilg – log-файл MakeIndex, ind – отсортированный указатель.'''

Для создания «полуфабриката» алфавитного указателя в преамбуле помещается инструкция

\makeindex

Cлова, которые нужно поместить в указатель, отмечаются с помощью команды '''\index'''.

Указатель\index{Предметный указатель} …

Сама по себе команда '''\index''' игнорируется, но всё, что в ней отмечается вместе с информацией о положении команды, заносится в файл с расширением '''.idx'''. Имя idx-файла по умолчанию соответствует имени
основного документа. Полуфабрикатом idx-файл является потому, что
записи хранятся в нём в неотсортированном виде. С помощью программы сортировки ''rumakeindex''' получается отформатированный правильным образом указатель в файле с расширением '''.ind'''. Этот файл
уже можно вставить в документ:

\input{«ind-файл»}

Это же делает и команда '''\printindex''' из пакета ''makeidx''. В дополнение к подключению индекса команда '''\printindex''' проверяет существование индексного файла и не даёт ''LaTeX'' генерировать ошибку в
случае его отсутствия. Пакет ''makeidx'' содержит ещё несколько полезных команд для создания индекса, поэтому его в любом случае имеет смысл загрузить.

Программа ''rumakeindex'' является простейшим скриптом, где с
помощью sed кириллические буквы из внутреннего представления
''LaTeX'' переводятся в '''koi8-r''' и правильным образом сортируются с
использованием стандартного механизма ''makeindex''. Если необходимо
отсортировать индексный файл для включения в текст, использующий
другую кодовую страницу, или вас просто не устраивают правила сортировки, этот скрипт легко переделать.

Оригинальная программа сортировки индекса ''makeindex'' (подробная документация представлена в файле '''makeindex.dvi''') была написана довольно давно и, естественно, не учитывала национальных особенностей других языков, кроме английского и немецкого. Впрочем, она
оказалась слишком гибка, чтобы полностью отказаться от неё в пользу другого механизма сортировки, уже нормально поддерживающего
интернационализацию. Наиболее вероятным претендентом на замену
уже долгое время является ''xindy'' (http://www.xindy.org/), который «из
коробки» поддерживает множество языков вплоть до клингонского, но
до сих пор отсутствует в основных ''LaTeX''-дистрибутивах.

Аргумент команды '''\index''' может содержать любые символы, кроме
'''!, “, @''' и '''|'''. Их специальное значение проявляется только внутри команды. Чтобы убрать специальное значение этих символов внутри '''\index'''
необходимо добавить перед ними символ '''“''' (двойную кавычку). На
рисунке представлен пример простейшего указателя. Ниже будут раскрыты методы его создания.

[[Изображение:LXF92_latex09.png|LXF92_latex09.png]]

'''Пример готового алфавитного указателя.'''

Для формирования многоуровневых иерархических указателей
используется разделитель в виде восклицательного знака '''!''':

% на страницах 110 и 111
\index{Указатель!rumakeindex}

Команды '''\index''' с одинаковыми аргументами группируются в одну
запись с полным списком страниц.

Символ вертикальной черты '''|''' используется для отделения видимого аргумента от управляющих знаков. Команда '''\see''' (перекрёстная ссылка на другую запись), определённая в пакете ''makeidx'', должна
идти в индексе вслед за этим разделителем:

\index{Указатель!makeindex|see{rumakeindex}}

С помощью вертикальной черты можно также сформировать указа-
тель на диапазон страниц:

<source lang=latex>
% на странице 110
\index{Указатель|(}
много текста
% на странице 111
\index{Указатель|)}
</source>

Иногда номер страницы нужно как-то выделить. Команды выделения текста также должны идти после вертикальной черты:

<source lang=latex>
% Выделяем страницу 110 жирным шрифтом
\index{MakeIndex@\textit{MakeIndex}|textbf}
</source>

Конструкция '''«ключ»@«запись»''' используется для правильной
сортировки внутри '''\index'''. По «ключу» производится сортировка, а
«запись» выводится в предметном указателе.

===Заключение===

Написать любую книгу безумно тяжело. Сделать её полезной – почти
невозможно. Справочно-поисковый аппарат издания – лишь инструмент на этом пути, но инструмент, неоднократно проверенный грамотным человечеством. Можно путь пройти и без него, но с ним будет
гораздо интереснее. '''LXF'''