Шаблон:Листинг/Документация

Шаблон предназначен для вставки в статьи листингов (фрагментов) программ, скриптов, конфигурационных файлов, текстов на различных языках разметки, с возможностью подсветки синтаксиса для множества языков, а также любого другого преформатированного текста. Полный список поддерживаемых языков можно посмотреть на странице mw:Extension:SyntaxHighlight GeSHi#Supported languages.

Параметры

1: Единственный обязательный параметр, собственно сам исходный текст листинга.

язык: Определяет язык, для которого будет применена подсветка синтаксиса (по умолчанию текст без подсветки). Значения для этого параметра берутся из таблицы по ссылке mw:Extension:SyntaxHighlight GeSHi#Supported languages.

номер: Определяет начальный номер для автоматической нумерации строк (по умолчанию не задан, без нумерации строк).

подсветка: Задает номера строк для выделения подсветкой фона (по умолчанию не задано, без выделения). Номера строк указываются через запятую (причем нумерация идет начиная с 1, и не зависит от нумерации, заданной параметром номер). Также допустимо указывать диапазоны строк (например, подсветка=3,5-7).

линия: Задает толщину линии в любых, допустимых в CSS, единицах (по умолчанию 2px).

цвет: Задает цвет линии в любом, допустимом для CSS, формате (по умолчанию #CCC).

заголовок: Задает текст верхнего колонтитула, который выводится в качестве заголовка листинга (по умолчанию пустой, не выводится). Может использоваться для вывода любого, связанного с листингом, текста.

примечание: Задает текст нижнего колонтитула (по умолчанию не задано, не выводится).

Заготовки для копирования

{{Листинг|язык=
 |номер=
 |подсветка=
 |линия=
 |цвет=
 |заголовок=
 |примечание=
 |1=
}}

{{Листинг|язык=
 |заголовок=
 |1=
}}

{{Листинг|язык=
 |1=
}}

Примеры использования

В таблице ниже показаны примеры использования шаблона для вывода исходного кода программы Hello World, написанной на языке программирования Си.

Исходный код вики-разметки	Результат
`{{Листинг\|язык=c\| #include <stdio.h> int main(void) { /* Hello World */ printf("Hello, World!\n"); return 0; } }}`	`#include <stdio.h> int main(void) { /* Hello World */ printf("Hello, World!\n"); return 0; }`
`{{Листинг\|язык=c \|номер=1 \|подсветка=6 \|линия=4px \|цвет=LightSteelBlue \|заголовок='''Пример программы на языке Си''' \|примечание=''Обратите внимание на строку 6'' \|1= #include <stdio.h> int main(void) { /* Hello World */ printf("Hello, World!\n"); return 0; } }}`	Пример программы на языке Си `#include <stdio.h> int main(void) { /* Hello World / printf("Hello, World!\n"); return 0; }` Обратите внимание на строку 6*
`{{Листинг\|линия=0\| #include <stdio.h> int main(void) { /* Hello World */ printf("Hello, World!\n"); return 0; } }}`	`#include <stdio.h> int main(void) { /* Hello World */ printf("Hello, World!\n"); return 0; }`