Назначение и синтаксис команды (:include:)

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

(:include Attach:filename [params...]:)

Здесь filename - это имя прикрепленного файла, а параметры команды рассмотрены в следующем разделе

Параметры команды (:include:)

Команда (: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

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

(:include Attach:text_1251.txt:)

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

Encoding error in file text_1251.txt

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


htmlescape

Параметр htmlescape указывает команде, что в прочитанном тексте из файла необходимо заменить символы <, > и & соответственно на &lt;, &gt; и &amp;. Это особенно полезно для вставки исходных текстов программы из прикрепленных файлов.

Например, команда

(:include Attach:html.txt:)

Выведет текст полужирным шрифтом:

Это текст с HTML-тегами

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

(:include Attach:html.txt htmlescape:)

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

<B>Это текст с HTML-тегами</B>


wikiparse

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

Например, команда

(:include Attach:wiki.txt:)

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

'''Этот текст содержит вики-нотацию'''

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

(:include Attach:wiki.txt wikiparse :)

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

Этот текст содержит вики-нотацию



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

Для вставки исходного текста программ можно использовать следующий формат команды (:include:):

<PRE>
(:include Attach:filename htmlescape:)
</PRE>