!! Команда [=(:include:)=]

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

** [[Назначение и синтаксис -> #syntax]]
** [[Параметры команды -> #params]]
*** [[encoding -> #encoding]]
*** [[htmlescape -> #htmlescape]]
*** [[wikiparse -> #wikiparse]]

!!! [[#syntax]] Назначение и синтаксис

Команда %code%[=(:include:)=]%% предназначена для вставки в вики-страницу содержимого прикрепленных файлов. Синтаксис команды выглядит следующим образом:

%code%
[=(:include Attach:имя_файла [параметры...]:)=]
%%

Здесь %code%имя_файла%% - это имя прикрепленного файла, содержимое которого нужно вставить в текст страницы.

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


!!! [[#params]] Параметры команды
Команда %code%[=(:include:)=]%% может принимать необязательные параметры, описанные в следующих разделах

!!!! [[#encoding]] encoding
Параметр %code%encoding%% указывает кодировку вставляемого текста. OutWiker не может самостоятельно определить кодировку файла, по умолчанию считается, что используется кодировка UTF-8.

Например, Если нужно вставить файл Attach:text_utf8.txt, прикрепленный к этой странице, созданный в кодировке UTF-8, то достаточно написать:

%code%
[=(:include Attach:text_utf8.txt:)=]
%%

В результате мы получим следующий результат:

%border%
(:include Attach:text_utf8.txt:)
%%

Для того же файла кодировку можно указать в явном виде:

%code%
[=(:include Attach:text_utf8.txt encoding=utf8 :)=]
%%

Для вставки содержимого файла Attach:text_1251.txt в кодировке cp1251 команда будет выглядеть следующим образом:

%code%
[=(:include Attach:text_1251.txt encoding=cp1251:)=]
%%

В результате ее выполнения мы увидим:

%border%
(:include Attach:text_1251.txt encoding=cp1251:)
%%

Если мы забудем указать кодировку, которая отлична от UTF-8 или укажем неверную кодировку, то получим ошибку. Например, команда

%code%
[=(:include Attach:text_1251.txt:)=]
%%

Выдаст следующий текст:

(:include Attach:text_1251.txt:)

Полный список поддерживаемый кодировок довольно обширный, его можно найти на [[http://docs.python.org/library/codecs.html#standard-encodings | этой странице]] справки по языку 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
Параметр %code%htmlescape%% указывает команде %code%[=(:include:)=]%%, что в прочитанном тексте из файла необходимо заменить символы %code%&lt;%%, %code%&gt;%% и %code%&amp;%% на %code%&amp;lt;%%, %code%&amp;gt;%% и %code%&amp;amp;%% соответственно. Это полезно для вставки исходных текстов программы из прикрепленных файлов.

Например, следующая команда без параметра %code%htmlescape%% выведет текст полужирным шрифтом, поскольку текст содержит HTML-теги &lt;b&gt;...&lt;/b&gt;.

%code%
[=(:include Attach:html.txt:)=]
%%

Результат будет таким:

%border%
(:include Attach:html.txt:)
%%

А при добавлении параметра %code%htmlescape%%: 

%code%
[=(:include Attach:html.txt htmlescape:)=]
%%

будет выведен код HTML:

%border%
(:include Attach:html.txt htmlescape:)
%%


!!!! [[#wikiparse]] wikiparse

Параметр %code%wikiparse%% указывает команде %code%[=(:include:)=]%%, что содержимое вставляемого файла предварительно необходимо пропустить через парсер викинотации, то есть, что прикрепленный файл содержит викинотацию, которую необходимо преобразовать в формат HTML для отображения.

Например, прикрпеленный файл Attach:wiki.txt содержит викинотацию, потому команда

%code%
[=(:include Attach:wiki.txt:)=]
%%

выведет следующий текст:

%border%
(:include Attach:wiki.txt:)
%%

А с параметром %code%wikiparse%%:

%code%
[=(:include Attach:wiki.txt wikiparse :)=]
%%

содержимое вики-нотации будет преобразовано в HTML для отображения на странице:

%border%
(:include Attach:wiki.txt wikiparse :)
%%

 
Если в команде [=(:include:)=] установлены одновременно параметры %code%htmlescape%% и %code%wikiparse%%, то сначала происходит замена символов HTML, а потом разбор вики-нотации.

----
'''См. также:'''
* page://wikicommand
* page://wiki-format-text
* page://wiki-attachlist
* page://wiki-childlist