# Команда (:include:)

## Содержание

- Назначение и синтаксис
- Параметры команды

- encoding
- htmlescape
- wikiparse

## Назначение и синтаксис

Команда (:include:) предназначена для вставки в вики-страницу содержимого прикрепленных файлов. Синтаксис команды выглядит следующим образом:
(:include Attach:имя_файла [параметры...]:)
Здесь имя_файла - это имя прикрепленного файла, содержимое которого нужно вставить в текст страницы.
Дополнительные параметры команды рассмотрены далее.

## Параметры команды

Команда (:include:) может принимать необязательные параметры, описанные в следующих разделах

### encoding

Параметр encoding указывает кодировку вставляемого текста. OutWiker не может самостоятельно определить кодировку файла, по умолчанию считается, что используется кодировка UTF-8.
Например, Если нужно вставить файл text_utf8.txt, прикрепленный к этой странице, созданный в кодировке UTF-8, то достаточно написать:
(:include Attach:text_utf8.txt:)
В результате мы получим следующий результат:
Текст в
кодировке UTF-8
Для того же файла кодировку можно указать в явном виде:
(:include Attach:text_utf8.txt encoding=utf8 :)
Для вставки содержимого файла text_1251.txt в кодировке cp1251 команда будет выглядеть следующим образом:
(:include Attach:text_1251.txt encoding=cp1251:)
В результате ее выполнения мы увидим:
Это текст
в кодировке 1251
Если мы забудем указать кодировку, которая отлична от UTF-8 или укажем неверную кодировку, то получим ошибку. Например, команда
(:include Attach:text_1251.txt:)
Выдаст следующий текст:
Ошибка кодировки файла 'text_1251.txt'
Полный список поддерживаемый кодировок довольно обширный, его можно найти на этой странице справки по языку Python. Перечислим наиболее используемые кодировки (одна и та же кодировка может иметь несколько названий):

- utf8, utf-8, utf_8, U8, UTF;
- cp1251, windows-1251;
- koi8_r;
- koi8_u;
- utf_32, utf-32, utf32;
- utf_16, utf-16, utf16;
- mac_cyrillic, maccyrillic;
- cp866, 866, IBM866;

### htmlescape

Параметр htmlescape указывает команде (:include:), что в прочитанном тексте из файла необходимо заменить символы <, > и & на &lt;, &gt; и &amp; соответственно. Это полезно для вставки исходных текстов программы из прикрепленных файлов.
Например, следующая команда без параметра htmlescape выведет текст полужирным шрифтом, поскольку текст содержит HTML-теги <b>...</b>.
(:include Attach:html.txt:)
Результат будет таким:
Это текст с HTML-тегами
А при добавлении параметра htmlescape:
(:include Attach:html.txt htmlescape:)
будет выведен код HTML:
<b>Это текст с HTML-тегами</b>

### wikiparse

Параметр wikiparse указывает команде (:include:), что содержимое вставляемого файла предварительно необходимо пропустить через парсер викинотации, то есть, что прикрепленный файл содержит викинотацию, которую необходимо преобразовать в формат HTML для отображения.
Например, прикрпеленный файл wiki.txt содержит викинотацию, потому команда
(:include Attach:wiki.txt:)
выведет следующий текст:
'''Этот текст содержит вики-нотацию'''
А с параметром wikiparse:
(:include Attach:wiki.txt wikiparse :)
содержимое вики-нотации будет преобразовано в HTML для отображения на странице:
Этот текст содержит вики-нотацию
Если в команде (:include:) установлены одновременно параметры htmlescape и wikiparse, то сначала происходит замена символов HTML, а потом разбор вики-нотации.

См. также:

- Вики-команды
- Форматирование текста
- Команда (:attachlist:)
- Команда (:childlist:)