LXF94:LaTeX - История изменений

Crazy Rebel: оформление

2008-12-16T05:34:38Z

оформление

Yaleks в 13:33, 9 июля 2008

2008-07-09T13:33:17Z

← Предыдущая		Версия 13:33, 9 июля 2008
Строка 66:		Строка 66:
	команды \renewenvironment.		команды \renewenvironment.

-	В разделе, посвящённом описанию презентационного класса beamer [[~~LXF85~~\|(LXF85]]), упоминалось ещё об одной возможности создавать новые именованные окружения с помощью команды \newtheorem:	+	В разделе, посвящённом описанию презентационного класса beamer [[LXF91:LaTeX\|(LXF85]]), упоминалось ещё об одной возможности создавать новые именованные окружения с помощью команды \newtheorem:

	[[Image:Latex 11 4.jpg\|right\|thumb\|300px\|Рис. 4.]]		[[Image:Latex 11 4.jpg\|right\|thumb\|300px\|Рис. 4.]]
Строка 89:		Строка 89:
	=== Счётчики и другие переменные ===		=== Счётчики и другие переменные ===

-	«Другие переменные» уже обсуждались в разделе Определённые «размеры» и переменные «длины» ([[LXF89]]). Операции с этими переменными выполнялись с помощью команд \newlength, \setlength и \addtolength. Аналогично, в LaTeX представлена и целочисленная арифметика с использованием счётчиков в качестве переменных:	+	«Другие переменные» уже обсуждались в разделе Определённые «размеры» и переменные «длины» ([[LXF89:LaTeX\|LXF89]]). Операции с этими переменными выполнялись с помощью команд \newlength, \setlength и \addtolength. Аналогично, в LaTeX представлена и целочисленная арифметика с использованием счётчиков в качестве переменных:

	[[Image:Latex 11 5.jpg\|right\|thumb\|300px\|Рис. 5.]]		[[Image:Latex 11 5.jpg\|right\|thumb\|300px\|Рис. 5.]]

Yaleks: /* Создаём свои … */

2008-07-09T13:29:30Z

Создаём свои …

← Предыдущая		Версия 13:29, 9 июля 2008
Строка 29:		Строка 29:
	\newcommand определяет новую команду. Если такая команда уже существует, то при компиляции генерируется ошибка. \renewcommand переопределяет уже существующую команду. В свою очередь, \providecommand создаёт новую команду, если на момент описания такой команды не было, и ничего не делает в противном случае.		\newcommand определяет новую команду. Если такая команда уже существует, то при компиляции генерируется ошибка. \renewcommand переопределяет уже существующую команду. В свою очередь, \providecommand создаёт новую команду, если на момент описания такой команды не было, и ничего не делает в противном случае.

-	В каждом из этих макросов есть два обязательных параметра: это имя команды и её описание. Если команде необходимо передать параметр/параметры, то первый необязательный аргумент (N) должен принять значение от одного (1) до девяти (9). В [[LXF85]] (см. прилагаемый диск) обсуждался макрос для дублирования знака в формуле при переносе её на следующую строку ($a+b\hm{=}c$):	+	В каждом из этих макросов есть два обязательных параметра: это имя команды и её описание. Если команде необходимо передать параметр/параметры, то первый необязательный аргумент (N) должен принять значение от одного (1) до девяти (9). В [[LXF85:LaTeX\|LXF85]] (см. прилагаемый диск) обсуждался макрос для дублирования знака в формуле при переносе её на следующую строку ($a+b\hm{=}c$):

	\newcommand*{\hm}[1]{#1\nobreak\discretionary{}%		\newcommand*{\hm}[1]{#1\nobreak\discretionary{}%

Yaleks: шаблон

2008-05-20T10:59:19Z

шаблон

← Предыдущая		Версия 10:59, 20 мая 2008
Строка 1:		Строка 1:
		+	{{цикл/LaTeX}}
		+
	== Начала программирования ==		== Начала программирования ==
	''ЧАСТЬ 11 Завершая этот длинный цикл статей, '''Евгений Балдин''' посмотрит на LaTeX глазами профессионального программиста.''		''ЧАСТЬ 11 Завершая этот длинный цикл статей, '''Евгений Балдин''' посмотрит на LaTeX глазами профессионального программиста.''

Yaleks: «LXF94:LaTeX Программирование» переименована в «LXF94:LaTeX»: унификация

2008-05-20T10:44:41Z

«LXF94:LaTeX Программирование» переименована в «LXF94:LaTeX»: унификация

← Предыдущая

Версия 10:44, 20 мая 2008

Lockal: восстановление кавычек в коде AWB

2008-04-27T14:19:24Z

восстановление кавычек в коде AWB

← Предыдущая		Версия 14:19, 27 апреля 2008
Строка 27:		Строка 27:
	\newcommand определяет новую команду. Если такая команда уже существует, то при компиляции генерируется ошибка. \renewcommand переопределяет уже существующую команду. В свою очередь, \providecommand создаёт новую команду, если на момент описания такой команды не было, и ничего не делает в противном случае.		\newcommand определяет новую команду. Если такая команда уже существует, то при компиляции генерируется ошибка. \renewcommand переопределяет уже существующую команду. В свою очередь, \providecommand создаёт новую команду, если на момент описания такой команды не было, и ничего не делает в противном случае.

-	В каждом из этих макросов есть два обязательных параметра: это имя команды и её описание. Если команде необходимо передать параметр/параметры, то первый необязательный аргумент (N) должен принять значение от одного (1) до девяти (9). В [[~~LXF85\|~~LXF85]] (см. прилагаемый диск) обсуждался макрос для дублирования знака в формуле при переносе её на следующую строку ($a+b\hm{=}c$):	+	В каждом из этих макросов есть два обязательных параметра: это имя команды и её описание. Если команде необходимо передать параметр/параметры, то первый необязательный аргумент (N) должен принять значение от одного (1) до девяти (9). В [[LXF85]] (см. прилагаемый диск) обсуждался макрос для дублирования знака в формуле при переносе её на следующую строку ($a+b\hm{=}c$):

	\newcommand*{\hm}[1]{#1\nobreak\discretionary{}%		\newcommand*{\hm}[1]{#1\nobreak\discretionary{}%
Строка 87:		Строка 87:
	=== Счётчики и другие переменные ===		=== Счётчики и другие переменные ===

-	«Другие переменные» уже обсуждались в разделе Определённые «размеры» и переменные «длины» ([[~~LXF89\|~~LXF89]]). Операции с этими переменными выполнялись с помощью команд \newlength, \setlength и \addtolength. Аналогично, в LaTeX представлена и целочисленная арифметика с использованием счётчиков в качестве переменных:	+	«Другие переменные» уже обсуждались в разделе Определённые «размеры» и переменные «длины» ([[LXF89]]). Операции с этими переменными выполнялись с помощью команд \newlength, \setlength и \addtolength. Аналогично, в LaTeX представлена и целочисленная арифметика с использованием счётчиков в качестве переменных:

	[[Image:Latex 11 5.jpg\|right\|thumb\|300px\|Рис. 5.]]		[[Image:Latex 11 5.jpg\|right\|thumb\|300px\|Рис. 5.]]
Строка 123:		Строка 123:
	ляет значение, выводимое командой ссылки \ref, как текст, создаваемый \the-командой:		ляет значение, выводимое командой ссылки \ref, как текст, создаваемый \the-командой:

-	% окружение ~~“Задача”~~	+	% окружение "Задача"
	\newcounter{Problem}[section]		\newcounter{Problem}[section]
	\renewcommand{\theProblem}{\thesection.\arabic{Problem}}		\renewcommand{\theProblem}{\thesection.\arabic{Problem}}

Lodger: /* Напутствие */

2008-03-16T16:12:23Z

Напутствие

← Предыдущая		Версия 16:12, 16 марта 2008
Строка 303:		Строка 303:

	LaTeX-цикл в Linux Format подошёл к концу. Честно говоря, я сам за это время узнал много нового для себя. Надеюсь, мне удалось поделиться этими знаниями с вами. В этой информации нет никакой чёрной магии – всё просто и логично, и эта информация полезна, так как позволяет автоматизировать одно из самых сложных ремёсел человеческой цивилизации – создание книг. Пишите тексты, большие и маленькие: они не пропадут.		LaTeX-цикл в Linux Format подошёл к концу. Честно говоря, я сам за это время узнал много нового для себя. Надеюсь, мне удалось поделиться этими знаниями с вами. В этой информации нет никакой чёрной магии – всё просто и логично, и эта информация полезна, так как позволяет автоматизировать одно из самых сложных ремёсел человеческой цивилизации – создание книг. Пишите тексты, большие и маленькие: они не пропадут.
		+
		+	----
		+
		+	=== Внимание! ===
		+
		+	Политика создания названий команд в TeX-подобной среде такова, что для новых пакетов необходимо придумывать новые команды. Это сделано для обеспечения абсолютной совместимости сверху вниз. К сожалению, подобная политика в случае бездумного использования слов может привести к «захватыванию» подходящих сочетаний. Примером правильного именования служит пакет listings, где вместо, казалось бы, подходящего по названию окружения listing используется lstlisting.

Lodger: /* Пакетирование */

2008-03-16T16:10:54Z

Пакетирование

← Предыдущая		Версия 16:10, 16 марта 2008
Строка 283:		Строка 283:

	==== Пакетирование ====		==== Пакетирование ====
		+
		+	Часто LaTeX-пакеты распространяются в виде одного DTX-файла. Существует способ включить установочный INS-файл в файл пакета:
		+
		+	%<*batchfile>
		+	\begingroup
		+
		+	«Содержание ins-файла»
		+
		+	\endgroup
		+	%</batchfile>
		+
		+	Следует только убрать заключительную команду \endbatchfile, чтобы LaTeX мог скомпилировать остальное.
		+
		+	Всё. Для распространения свой пакет лучше всего поместить на CTAN. Для выгрузки следует обратиться к ресурсу http://www.ctan.org/upload. Всегда необходим краткий README с описанием. Собранная документация в виде PDF-файла также является хорошим тоном.

	=== Напутствие ===		=== Напутствие ===

Lodger: /* Пакетный DTX-файл */

2008-03-16T16:09:45Z

Пакетный DTX-файл

← Предыдущая		Версия 16:09, 16 марта 2008
Строка 202:		Строка 202:

	==== Пакетный DTX-файл ====		==== Пакетный DTX-файл ====
		+
		+	Пакетный DTX-файл содержит в себе и код с комментариями, и текст описания пакета. Структура DTX-файла позволяет получить печатную документацию после прогона через LaTeX. Код с комментариями тоже может стать частью документации. Это шаг по направлению к «грамотному программированию» [literate programming].
		+
		+	Наличие комментариев в коде заставляет повторять процедуру компиляции дважды. В первый раз отрабатывается LaTeX-код, а затем комментарии. Во втором случае знак % перед комментарием игнорируется, и текст комментария передаётся на вход LaTeX, если он (комментарий) не окружён командами \iffalse-\fi.

	===== Пролог =====		===== Пролог =====
		+
		+	В начале следует, естественно, добавить информацию об авторе:
		+
		+	%\iffalse meta-comment
		+	% Этот текст не обрабатывается LaTeX’ом. Слово meta-comment
		+	%добавлено просто для удобства чтения кода человеком и
		+	%означает, что этот текст предназначен именно для него (человека).
		+	%\fi
		+
		+	В ins-файле в команде \generate использовался параметр «метка». Он говорит DocStrip, что следует выбирать строки, которые следуют за
		+	комментарием и конструкцией <метка> или между тэгами <*метка> и </метка>. Далее идёт код заголовка пакета, соответствующего метке
		+	«метка»:
		+
		+	% \iffalse
		+	%<метка> \NeedsTeXFormat{LaTeX2e}
		+	%<метка> \ProvidesPackage{«имя пакета»}
		+	%<метка> [<ГГГГ>/<ММ>/<ДД> v<версия> <краткое описание>]
		+
		+	Строчку «<ГГГГ>/<ММ>/<ДД> v<версия> <краткое описание>» нужно заменить на дату, версию и краткое описание, соответственно. Закончить пролог необходимо следующими словами, создающими основную документацию:
		+
		+	%<*driver>
		+	\documentclass{ltxdoc}
		+	\usepackage{«имя пакета»}
		+	\begin{document}
		+	\DocInput{«dtx-файл»}
		+	\end{document}
		+	%</driver>
		+	% \fi
		+
		+	Это единственная часть, относящаяся к документации, которая не начинается со знака комментария (%).
		+
		+	В прологе можно указывать ещё некоторое количество инструкций, уточняющих формат создаваемой документации.

	===== Пользовательская документация =====		===== Пользовательская документация =====
		+
		+	Прежде всего, следует учесть, что подавляющий объём описаний для пакетов LaTeX сделан на английском языке. Для этого есть довольно
		+	веские основания, связанные с размером англоязычной аудитории.
		+
		+	Написание документации для DTX-пакета ничем не отличается от написания обычного LaTeX-документа, за тем исключением, что не следует забывать о знаке комментария (%) в начале строки:
		+
		+	% \title{Пакет \textsf{«имя пакета»}}
		+	% \author{«Ваше имя» \\ \texttt{«Ваш e-mail»}}
		+	% \maketitle
		+	% текст документации
		+
		+	К стандартным LaTeX-командам секционирования уровня paragraph добавляются \DescribeMacro{макрос} и \DescribeEnv{окружение}.

	===== Код с комментариями =====		===== Код с комментариями =====
		+
		+	Даже если допустить, что лучшая документация для программиста – это сам код, то для нормального человека описательный текст все равно будет предпочтительнее. Проблема совмещения кода и описания является основной причиной возникновения «грамотного программирования».
		+
		+	Код обычно начинается сразу же за пользовательской документацией:
		+
		+	%\StopEventually{\PrintIndex}
		+	%% Описание окружения.
		+	%\begin{environment}{«имя окружения»}
		+	%% Аналогично, существует окружение macros, для описания
		+	%% новых команд.
		+	% \begin{macrocode}
		+	«Здесь идёт код, вида:»
		+	\newenvironment{«имя окружения»}{начало}{окончание}
		+	% \end{macrocode}
		+	%\end{environment}
		+	…
		+	%\Finale
		+	\endinput
		+
		+	Команда \StopEventually{} отмечает начало кода и принимает в качестве параметра команду, которую следует выполнить в конце документации – например, распечатать алфавитный указатель \PrintIndex.
		+
		+	Любой код следует обрамлять с помощью окружения macrocode. Это позволит включить его в печатную документацию. Есть две особенности для этого окружения, которые следует учитывать:
		+
		+	*Между % и \begin{macrocode} должно быть ровно четыре (4) пробела. Аналогичное правило действует и для \end{macrocode},
		+	*Внутри этого окружения не должно быть текста, начинающегося с %. Внутри окружений environment и macros может быть несколько вставок кода и текста.

	==== Пакетирование ====		==== Пакетирование ====

Lodger: /* Создаём свой пакет */

2008-03-16T16:04:59Z

Создаём свой пакет

← Предыдущая		Версия 16:04, 16 марта 2008
Строка 155:		Строка 155:

	=== Создаём свой пакет ===		=== Создаём свой пакет ===
		+
		+	Предположим, что вы уже владеете искусством программирования в среде LaTeX. Чтобы распространить свои наработки, следует организовать исходные тексты в удобном для дальнейшей поддержки, передаче и установке виде. Можно и не стараться, если вас не интересует конечный результат, но знать, как правильно устроен пакет, полезно и новичку, так как эффективное обучение программированию напрямую связано с изучением уже существующего кода.
		+
		+	В LaTeX-сообществе принято распространять свои пакеты и документацию к ним в виде автономных файлов с расширением dtx (DTX-файлы). Для автоматической установки пакетов используются инструкции, записанные в файлах с расширением ins (INS-файлы). Для более подробной информации следует обратиться к инструкции «How to Package Your LaTeX Package», созданной Скотом Пакиным [Scott Pakin]. Файл dtxtut.pdf, как обычно, можно найти в стандартной поставке LaTeX или на CTAN. Вместе с документацией идут файлы примеров [c]skeleton.dtx и [c]skeleton.ins.
		+
		+	За работу с DTX-файлами отвечает пакет doc и сопутствующая ему утилита DOCSTRIP (файл docstrip.pdf). Основная идея пакета doc состоит в совмещении кода с документацией, что облегчает поддержку и развитие пакета.

	==== Установочный INS-файл ====		==== Установочный INS-файл ====
		+
		+	Для извлечения кода и документации из DTX-пакета следует написать специальный установочный файл. Набор инструкций достаточно
		+	стереотипен:
		+
		+	%% Стандартный копирайт по выбору (рекомендуется LPPL/GPL)
		+	%%
		+	%% Первый шаг - загрузка DOCSTRIP.
		+	\input docstrip.tex
		+	%% Подробный отчёт о каждом шаге хорош только когда пакет
		+	%% отлаживается.
		+	\keepsilent
		+	%% Директория, в которую устанавливается пакет. Имя
		+	%% директории является относительным по отношению к
		+	%% базовой директории $(TEXMF).
		+	\usedir{tex/latex/{«имя пакета»}}
		+	%% Определение преамбулы, которая вставляется во все
		+	%% сгенерированные файлы. Обычно это информация об авторе
		+	%% и пожелания пользователям.
		+	\preamble
		+	Текст преамбулы
		+	\endpreamble
		+	%% Извлечение файлов пакета из dtx. Основной шаг,
		+	%% который может повторяться несколько раз.
		+	\generate{\file{«извлекаемый файл»}{\from{«dtx-файл»}{метка}}}
		+	…
		+	…
		+	%% Информация для пользователя. Всегда что-то полезно сказать
		+	%% после установки.
		+	\obeyspaces
		+	\Msg{******************************************************
		+	**}
		+	\Msg{* Здорово, что Вы поставили этот пакет. *}
		+	\Msg{* Прочитайте документацию перед использованием! *}
		+	\Msg{******************************************************
		+	**}
		+	%% Метка конца установочного файла.
		+	\endbatchfile

	==== Пакетный DTX-файл ====		==== Пакетный DTX-файл ====