Mercurial > hg > nginx-site
diff xml/ru/docs/http/ngx_http_ssi_module.xml @ 76:4a4caa566120
Russian documentation import.
Changes in module.dtd: <example> now allowed to contain <value> and
<emphasis> elements (we need this to show important parts in examples),
less strict checking of <directive> syntax (we don't want to fully
document some directives, notably deprecated ones).
Known issues:
1. <syntax> elements are preserved as is, they will require manual conversion
(likely to some not-yet-existed format a la DocBook cmdsynopsis, as
currently used one seems to be incomplete);
2. <value> no longer corresponds to replaceable content, and it's use in
examples isn't correct;
3. <link doc="document#fragment"> doesn't work with current xslt, either
should be supported or changed to <link doc="document" id="fragment">.
The following files are intentionally omitted: maillists.xml (support.xml
should be used instead), experimental.xml (obsolete), faq.xml (conflicts
with existing one, needs discussion).
Not yet linked to site.
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Tue, 11 Oct 2011 12:57:50 +0000 |
parents | |
children | c76a257f3fd4 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/xml/ru/docs/http/ngx_http_ssi_module.xml Tue Oct 11 12:57:50 2011 +0000 @@ -0,0 +1,307 @@ +<?xml version="1.0" encoding="utf-8"?> + +<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> + +<module name="Директивы модуля ngx_http_ssi_module" + link="/ru/docs/http/ngx_http_ssi_module.html" + lang="ru"> + +<section name="" id="summary"> + +<para> +Модуль ngx_http_ssi_module — фильтр, обрабатывающий команды SSI (Server +Side Includes) в проходящих через него ответах. +На данный момент список поддерживаемых команд SSI неполон. +</para> + +</section> + + +<section name="Пример конфигурации" id="example"> + +<para> +<example> + location / { + ssi on; + ... + } +</example> +</para> + +</section> + + +<section name="Директивы" id="directives"> + +<directive name="ssi"> +<syntax>ssi <value>[on|off]</value></syntax> +<default>ssi off</default> +<context>http, server, location, if в location</context> + +<para> +Директива разрешает обработку команд SSI в ответах. +</para> + +</directive> + + +<directive name="ssi_silent_errors"> +<syntax>ssi_silent_errors <value>[on|off]</value></syntax> +<default>ssi_silent_errors off</default> +<context>http, server, location</context> + +<para> +Директива разрешает не выводить строку +"[an error occurred while processing the directive]", +если во время обработки SSI произошла ошибка. +</para> + +</directive> + + +<directive name="ssi_types"> +<syntax>ssi_types <value>mime-тип [mime-тип ...]</value></syntax> +<default>ssi_types text/html</default> +<context>http, server, location</context> + +<para> +Разрешает обработку команд SSI в ответах с указанными MIME-типами в дополнение +к "text/html". +</para> + +</directive> + +</section> + + +<section name="Команды SSI" id="commands"> + +<para> +Формат команды следующий +<example> +<!--# команда параметр1=значение параметр2=значение ... --> +</example> +</para> + +<para> +Ниже перечислены поддерживаемые команды: +<list type="bullet"> + +<listitem> +<emphasis>block</emphasis> — команда описывает блок, который можно использовать +как заглушку в команде include. +Внутри блока могут быть команды SSI. + +<list type="bullet"> +<listitem> +<emphasis>name</emphasis> — имя блока. +</listitem> +</list> + +Пример использования: +<example> +<!--# block name="one" --> +заглушка +<!--# endblock --> +</example> + +</listitem> + +<listitem> +<emphasis>config</emphasis> — команда задаёт некоторые параметры при обработке SSI. + +<list type="bullet"> +<listitem> +<emphasis>errmsg</emphasis> — строка, выводящаяся при ошибке во время обработки +SSI. По умолчанию используется такая строка: +<example> +[an error occurred while processing the directive] +</example> +</listitem> + +<listitem> +<emphasis>timefmt</emphasis> — строка, используемая функцией strftime(3) +для вывода дат и времени. +По умолчанию используется такой формат: +<example> +"%A, %d-%b-%Y %H:%M:%S %Z" +</example> +Для вывода времени в секундах подходит формат "%s". +</listitem> +</list> + +</listitem> + + +<listitem> +<emphasis>echo</emphasis> — команда выводит значение переменной. + +<list type="bullet"> +<listitem> +<emphasis>var</emphasis> — имя переменной. +</listitem> + +<listitem> +<emphasis>encoding</emphasis> — способ кодирования. +Возможны три значения — none, url и entity. +По умолчанию используется entity. +</listitem> + +<listitem> +<emphasis>default</emphasis> — нестандартный параметр, задающий строку, +которая выводится, если переменная не опеределена. +По умолчанию выводится строка "none". Команда +<example> +<!--# echo var="name" default="<emphasis>нет</emphasis>" --> +</example> +заменяет такую последовательность команд +<example> +<!--# if expr="$name" --><!--# echo var="name" --><!--# + else --><emphasis>нет</emphasis><!--# endif --> +</example> +</listitem> +</list> + +</listitem> + + +<listitem> +<emphasis>if</emphasis> — команда выполняет условное включение. +Поддерживаются следующие команды: +<example> +<!--# if expr="..." --> +... +<!--# elif expr="..." --> +... +<!--# else --> +... +<!--# endif --> +</example> +На данный момент поддерживаются только один уровень вложенности. + +<list type="bullet"> +<listitem> +<emphasis>expr</emphasis> — выражение. +В выражении может быть проверка существования переменной: +<example> +<!--# if expr="$name" --> +</example> +сравнение переменной с текстом: +<example> +<!--# if expr="$name = text" --> +<!--# if expr="$name != text" --> +</example> +или с регулярным выражением: +<example> +<!--# if expr="$name = /text/" --> +<!--# if expr="$name != /text/" --> +</example> +Если в text встречаются переменные, то производится подстановка их значений. +</listitem> +</list> + +</listitem> + + +<listitem> +<emphasis>include</emphasis> — команда включает в ответ результат другого запроса. + +<list type="bullet"> +<listitem> +<emphasis>file</emphasis> — задаёт включаемый файл, например: +<example> +<!--# include file="footer.html" --> +</example> +</listitem> + +<listitem> +<emphasis>virtual</emphasis> — задаёт включаемый запрос, например: +<example> +<!--# include virtual="/remote/body.php?argument=value" --> +</example> +Несколько запросов на одной странице, обрабатываемые через прокси или FastCGI, +работают параллельно. Если нужно последовательная обработка, то нужно +воспользоваться параметром wait. +</listitem> + +<listitem> +<emphasis>stub</emphasis> — нестандартный параметр, задающий имя блока, +содержимое которого будет выведено, если тело ответа на включаемый запрос +пустое или при исполнении запроса произошла ошибка, например: +<example> +<!--# block name="one" -->&nbsp;<!--# endblock --> +<!--# include virtual="/remote/body.php?argument=value" stub="one" --> +</example> +при этом содержимое замещающего блока обрабатывается в контексте включаемого +запроса. +</listitem> + +<listitem> +<emphasis>wait</emphasis> — нестандартный параметр, указывающий, нужно ли ждать +полного исполнения данного запроса, прежде чем продолжать выполнение +SSI, например: +<example> +<!--# include virtual="/remote/body.php?argument=value" wait="yes" --> +</example> +</listitem> + +<listitem> +<emphasis>set</emphasis> — нестандартный параметр, указывающий, что удачный +результат выполнения запроса нужно записать в заданную переменную, +например: +<example> +<!--# include virtual="/remote/body.php?argument=value" set="one" --> +</example> +Необходимо учитывать, что в переменные можно записать только результаты +ответов, полученные через модули +ngx_http_proxy_module и ngx_http_memcached_module. +</listitem> + +</list> + +</listitem> + +<listitem> +<emphasis>set</emphasis> — команда присваивает значение переменной. + +<list type="bullet"> +<listitem> +<emphasis>var</emphasis> — имя переменной. +</listitem> + +<listitem> +<emphasis>value</emphasis> — значение переменной. Если в присваиваемом значении +есть переменные, то производится подстановка их значений. +</listitem> +</list> + +</listitem> + +</list> +</para> + +</section> + + +<section name="Встроенные переменные" id="variables"> + +<para> +Модуль ngx_http_ssi_module поддерживает две встроенные переменные: +<list type="bullet"> + +<listitem> +$date_local, эта переменная равна текущему времени в локальной временной зоне. +Формат даты задаётся командой config с параметром timefmt. +</listitem> + +<listitem> +$date_gmt, эта переменная равна текущему времени в GMT. +Формат даты задаётся командой config с параметром timefmt. +</listitem> + +</list> +</para> + +</section> + +</module>