# HG changeset patch
# User Igor Sysoev <igor@sysoev.ru>
# Date 1321349996 0
# Node ID aa4c2b46a4a3aa1547f28dd9bbc10841dbe608ad
# Parent  d87e97c0a3e468eb623dc79abd43b96abd6aa2dc
Revised ngx_http_image_filter_module documentation, unfinished.

diff -r d87e97c0a3e4 -r aa4c2b46a4a3 xml/ru/docs/http/ngx_http_image_filter_module.xml
--- a/xml/ru/docs/http/ngx_http_image_filter_module.xml	Tue Nov 15 09:03:03 2011 +0000
+++ b/xml/ru/docs/http/ngx_http_image_filter_module.xml	Tue Nov 15 09:39:56 2011 +0000
@@ -2,7 +2,7 @@
 
 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
 
-<module name="Директивы модуля ngx_http_image_filter_module"
+<module name="Модуль ngx_http_image_filter_module"
         link="/ru/docs/http/ngx_http_image_filter_module.html"
         lang="ru">
 
@@ -11,13 +11,17 @@
 <para>
 Модуль ngx_http_image_filter_module — это фильтр для преобразования
 изображений в форматах JPEG, GIF и PNG (0.7.54+).
-По умолчанию модуль не собирается, нужно разрешить его сборку
-при конфигурировании параметром
-<command>--with-http_image_filter_module</command>.
-Для сборки и работы этого модуля нужна библиотека
+<note>
+По умолчанию этот модуль не собирается, его сборку необходимо
+разрешить с помощью конфигурационного параметра
+<code>--with-http_image_filter_module</code>.
+</note>
+<note>
+Для сборки и работы этого модуля необходима библиотека
 <link url="http://libgd.org">libgd</link>.
-Рекомендуется использовать самую последнию версию библиотеки,
-на текущий момент (май 2009) это версия 2.0.35.
+Рекомендуется использовать самую последнюю версию библиотеки,
+на текущий момент это версия 2.0.35.
+</note>
 </para>
 
 </section>
@@ -28,9 +32,9 @@
 <para>
 <example>
 location /img/ {
-    proxy_pass     http://backend;
-    image_filter   resize  150 100;
-    error_page     415   = /empty;
+    proxy_pass   http://backend;
+    image_filter resize 150 100;
+    error_page   415 = /empty;
 }
 
 location = /empty {
@@ -45,22 +49,43 @@
 <section name="Директивы" id="directives">
 
 <directive name="image_filter">
-<syntax><value>(test|size|resize ширина высота|crop ширина высота)
-</value></syntax>
+    <syntax><parameter>off</parameter></syntax>
+    <syntax><parameter>test</parameter></syntax>
+    <syntax><parameter>size</parameter></syntax>
+    <syntax><parameter>rotate </parameter>
+        <value>90</value>|<value>180</value>|<value>270</value>
+    </syntax>
+    <syntax>
+        <parameter>resize </parameter>
+        <argument>ширина высота</argument>
+    </syntax>
+    <syntax>
+        <parameter>crop </parameter>
+        <argument>ширина высота</argument>
+    </syntax>
 <default/>
 <context>location</context>
 
 <para>
 Директива задаёт тип преобразования изображения:
-<list type="bullet">
+<list type="tag">
+
+<tag-name><parameter>off</parameter></tag-name>
+<tag-desc>
+отключает обработку данным модулем во вложенном location.
+</tag-desc>
 
-<listitem>
-test — проверка того, что ответ действительно является изображением
-в формате JPEG, GIF или PNG. В противном случае выдаётся ошибка 415.
-</listitem>
+<tag-name><parameter>test</parameter></tag-name>
+<tag-desc>
+проверяет, что ответ действительно является изображением
+в формате JPEG, GIF или PNG.
+В противном случае возвращается ошибка
+<http-status code="415" text="Unsupported Media Type"/>.
+</tag-desc>
 
-<listitem>
-size — выдаёт информацию об изображении в формате JSON, например:
+<tag-name><parameter>size</parameter></tag-name>
+<tag-desc>
+выдаёт информацию об изображении в формате JSON, например:
 <example>
 { "img" : { "width": 100, "height": 100, "type": "gif" } }
 </example>
@@ -68,22 +93,37 @@
 <example>
 {}
 </example>
-</listitem>
+</tag-desc>
+
+<tag-name><parameter>rotate </parameter>
+<value>90</value>|<value>180</value>|<value>270</value>
+</tag-name>
+<tag-desc>
+поворачивает изображение по часовой стрелке на указанное число градусов.
+</tag-desc>
 
-<listitem>
-resize — пропорционально уменьшает изображение до указанных размеров.
-Если нужно уменьшить только по одному измерению, то в качестве второго
-можно указать "-".
-В случае ошибки выдаётся код 415.
-</listitem>
+<tag-name><parameter>resize </parameter>
+<argument>ширина высота</argument>
+</tag-name>
+<tag-desc>
+пропорционально уменьшает изображение до указанных размеров.
+Если требуется уменьшить только по одному измерению, то в качестве второго
+можно указать “<code>-</code>”.
+В случае ошибки сервер возвращает код
+<http-status code="415" text="Unsupported Media Type"/>.
+</tag-desc>
 
-<listitem>
-crop — пропорционально уменьшает изображение до размера большой стороны
+<tag-name><parameter>crop </parameter>
+<argument>ширина высота</argument>
+</tag-name>
+<tag-desc>
+пропорционально уменьшает изображение до размера большей стороны
 и обрезает лишние края по другой стороне.
-Если нужно уменьшить только по одному измерению, то в качестве второго
-можно указать "-".
-В случае ошибки выдаётся код 415.
-</listitem>
+Если требуется уменьшить только по одному измерению, то в качестве второго
+можно указать “<code>-</code>”.
+В случае ошибки сервер возвращает код
+<http-status code="415" text="Unsupported Media Type"/>.
+</tag-desc>
 
 </list>
 </para>
@@ -94,36 +134,61 @@
 <directive name="image_filter_buffer">
 <syntax><value>размер</value></syntax>
 <default>1M</default>
-<context>http, server, location</context>
+<context>http</context>
+<context>server</context>
+<context>location</context>
 
 <para>
 Директива задаёт максимальный размер буфера для чтения изображения.
+При превышении размера сервер вернёт ошибку
+<http-status code="415" text="Unsupported Media Type"/>.
 </para>
 
 </directive>
 
 
 <directive name="image_filter_jpeg_quality">
-<syntax><value>[0..100]</value></syntax>
+<syntax><value>1..100</value></syntax>
 <default>75</default>
-<context>http, server, location</context>
+<context>http</context>
+<context>server</context>
+<context>location</context>
 
 <para>
 Директива задаёт коэффициент потери информации при обработке изображений
-в формате JPEG. Максимальное рекомендуемое значение — 95.
+в формате JPEG.
+Максимальное рекомендуемое значение — 95.
+</para>
+
+</directive>
+
+
+<directive name="image_filter_sharpen">
+<syntax><argument>процент</argument></syntax>
+<default>0</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+
+<para>
+Повышает резкость итогового изображения.
+Процент резкости может быть больше 100.
+Значение 0 отключает повышение резкости.
 </para>
 
 </directive>
 
 
 <directive name="image_filter_transparency">
-<syntax><value>[on|off]</value></syntax>
+<syntax><value>on</value>|<value>off</value></syntax>
 <default>on</default>
-<context>http, server, location</context>
+<context>http</context>
+<context>server</context>
+<context>location</context>
 
 <para>
 Директива определяет, сохранять ли прозрачность при обработке изображений
-в формате PNG с цветами, заданными палитрой, и формате GIF.
+в формате PNG с цветами, заданными палитрой, и в формате GIF.
 Потеря прозрачности позволяет получить более качественное изображение.
 Прозрачность альфа-канала в формате PNG сохраняется всегда.
 </para>