как вставить код latex в latex

Записки разработчика

Страницы

вторник, 14 января 2014 г.

minted: Оформляем исходный код в LaTeX

Помнится, ещё на студенческой скамье я встречал задачу оформления исходного кода в LaTeX. В ту пору я использовал пакет listings. И я страдал. О, как же я страдал! Русские буквы не хотели дружить с UTF-8, а глаза мои текли кровавыми слезами при взгляде на итоговое форматирование. И вот, вновь я встретился с этой тяжёлой задачей. В поисках решения я наткнулся на замечательный пост в записках дебианщика Как оформить исходный код программ в LaTeX без адских страданий. Название подсказывало мне, что развлечение это не простое. Я аккуратно перепробовал все рецепты из статьи, но ни один меня не устроил. И в самом конце поста я обнаружил ссылку на замечательный пакет minted, который должен был положить конец моим страданиям.

Пакет minted базируется на Python-овской библиотеке Pygments, которая умеет на отличненько раскрашивать код, поддерживается около 300 разных языков и форматов разметки. Для начала нам понадобится её установить (предполагаем, что Python и easy_install уже имеются):

Переходим в любимый LaTeX-редактор и начинаем писать код (опять-таки предполагаем, что версия нашего LaTeX-дистрибутива включает пакет minted и все его зависимости):

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

И возрадуемся появлению русских букв:

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

Больше информации вы найдёте на GitHub-е и в документации

Источник

Code listing

Contents

Introduction

L a T e X is widely used in science and programming has become an important aspect in several areas of science, hence the need for a tool that properly displays code. This article explains how to use the standard verbatim environment as well as the package listings, which provide more advanced code-formatting features. This separate article discusses the minted package, which performs syntax-highlighting using Python’s pygmentize library.

The verbatim environment

The code above produces the following output:

Just as in the example at the introduction, all text is printed keeping line breaks and white spaces. There’s a starred version of this command whose output is slightly different.

The code above produces the following output:

Verbatim-like text can also be used in a paragraph by means of the \verb command.

The code above produces the following output:

Using listings to highlight code

To use the lstlisting environment you have to add the following line to the preamble of your document:

Here’s an example of using the lstlisting environment from the listings package:

The code above produces the following output:

In this example, the output ignores all L a T e X commands and the text is printed keeping all the line breaks and white spaces typed. Let’s see a second example:

The code above produces the following output:

The additional parameter inside brackets [language=Python] enables code highlighting for this particular programming language (Python), special words are in boldface font and comments are italicized. See the reference guide for a complete list of supported programming languages.

Importing code from a file

Code is usually stored in a source file, therefore a command that automatically pulls code from a file becomes very handy.

The command \lstinputlisting[language=Octave] imports the code from the file BitXorMatrix.m, the additional parameter in between brackets enables language highlighting for the Octave programming language. If you need to import only part of the file you can specify two comma-separated parameters inside the brackets. For instance, to import the code from the line 2 to the line 12, the previous command becomes

If firstline or lastline is omitted, it’s assumed that the values are the beginning of the file, or the bottom of the file, respectively.

Code styles and colours

Code formatting with the listing package is highly customisable. Let’s see an example

The code above produces the following output:

As you see, the code colouring and styling greatly improves readability.

In this example the package xcolor is imported and then the command \definecolor<><><> is used to define new colours in rgb format that will later be used. For more information see: using colours in L a T e X

There are essentially two commands that generate the style for this example:

\lstdefinestyle <. >Defines a new code listing style called «mystyle». Inside the second pair of braces the options that define this style are passed; see the reference guide for a full description of these and some other parameters. \lstset Enables the style «mystyle». This command can be used within your document to switch to a different style if needed.

Captions and the list of Listings

Just like in floats (tables and figures), captions can be added to a listing for a more clear presentation.

The code above produces the following output:

Adding the comma-separated parameter caption=Python example inside the brackets, enables the caption. This caption can be later used in the list of Listings.

Sample Overleaf project

Reference guide

Supported languages

supported languages (and its dialects if possible, dialects are specified in brackets and default dialects are italized):

Источник

Оформление исходного кода в документах LaTeX

verbatim

Простейший способ — использовать окружение \begin. \end . Разумеется, подсветки синтаксиса при этом не будет. Для кода в строке используется «короткий verbatim», который удобно настроить с помощью пакета fancyvrb :

Управление размером шрифта в окружении verbatim (установлен \footnotesize ):

listings

Фрагмент кода внутри строки оформляется следующим образом

Проблема с UTF-8

При попытке вставить в код текст на кириллице (не в комментарий, а именно в код — текст должен был выводиться в графическом окне) было получено сообщение об ошибке вида:

При этом кодировка основного документа — UTF-8, что указано в преамбуле:

Сообщения об ошибках исчезнут, если указать в настройках \lstset использование не-ASCII символов:

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

minted

Вставим в документ код на C++ шрифтом размера \footnotesize :

и получим после трансляции

Теперь все будет работать.

Еще раз напомню, в версиях minted > 2.0 все работает «из коробки».

Оформление листингов в виде рисунков

Для этого поместим листинг, оформленный с помощью minted в окружение figure :

Картинка-листинг будет выровнена по левому краю страницы

Для выравнивания по центру нужно поставить в преамбуле документа:

Короткое имя и настройка макросов

Чтобы не писать всякий раз

или нечто подобное, можно ввести собственное название для макросов вставки кода на заданном языке с заданными настройками. Делается это при помощи команды \newminted :

Например, указав в преамбуле документа

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

Заметим, что даже если вы не задаете никаких настроек, а просто хотите переопределить имя макроса, пустые скобки, обозначающие место вставки настроек, должны присутствовать

Код внутри строки текста

Чтобы вставить код прямо в строку текста, используем команду \mintinline

Например, создадим новое окружение для вставки Perl-кода:

Вот как это работает:

Какие языки поддерживает minted

Узнать, какие языки поддерживает minted можно, набрав в командной строке

На данный момент таких языков более 300.

Читайте также

Комментарии

Дмитрий Храмов
Компьютерное моделирование и все, что с ним связано: сбор данных, их анализ, разработка математических моделей, софт для моделирования, визуализации и оформления публикаций. Ну и за жизнь немного.

Источник

Вставка кода в этот документ LaTeX с отступом

Как вставить код в документ LaTeX? Есть ли что-то вроде:

Единственное, что мне действительно нужно, это отступ и шрифт фиксированной ширины. Подсветка синтаксиса может быть хорошей, хотя это определенно не требуется.

Простая конфигурация для заголовка LaTeX (до \begin ):

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

Пример использования в документе:

Вы также можете использовать среду verbatim

Вот как добавить встроенный код:

Вы можете добавить встроенный код с помощью <\tt code >или \texttt < code >. Если вы хотите отформатировать встроенный код, то лучше всего создать собственную команду

Также обратите внимание, что блоки кода могут быть загружены из других файлов с

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

Это пакет, который облегчает выразительную подсветку синтаксиса в LaTeX, используя мощную библиотеку Pygments. Пакет также предоставляет опции для настройки выделенного вывода исходного кода с помощью fancyvrb.

Это гораздо более развитый и настраиваемый, чем любой другой пакет!

Поскольку это еще не было упомянуто здесь, возможно, стоит добавить еще одну опцию, пакет spverbatim (без подсветки синтаксиса):

Также, если подсветка синтаксиса не требуется, упакуйте alltt :

Источник

Вставка кода в этот документ LaTeX с отступом

Как вставить код в документ LaTeX? Есть ли что-то вроде:

Единственное, что мне действительно нужно, это отступ и шрифт фиксированной ширины. Подсветка синтаксиса может быть хорошей, хотя это определенно не требуется.

ОТВЕТЫ

Ответ 1

Простая конфигурация для заголовка LaTeX (до \begin ):

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

Пример использования в документе:

Ответ 2

Вы также можете использовать среду verbatim

Ответ 3

Вот как добавить встроенный код:

Вы можете добавить встроенный код с помощью <\tt code >или \texttt < code >. Если вы хотите отформатировать встроенный код, лучше всего создать собственную команду

Также обратите внимание, что блоки кода можно загружать из других файлов с помощью

Ответ 4

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

Ответ 5

Это пакет, который облегчает выразительную подсветку синтаксиса в LaTeX, используя мощную библиотеку Pygments. Пакет также предоставляет опции для настройки выделенного вывода исходного кода с помощью fancyvrb.

Это гораздо более развитый и настраиваемый, чем любой другой пакет!

Ответ 6

Поскольку это еще не было упомянуто здесь, возможно, стоит добавить еще одну опцию, пакет spverbatim (без подсветки синтаксиса):

Также, если подсветка синтаксиса не требуется, упакуйте alltt :

Ответ 7

Ответ 8

Чеканка работает в Overleaf, TeX Live и MiKTeX.

Источник