Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_image_filter_module.xml @ 271:4c6d2c614d2c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Cleaned up XML tag mess: - all of <parameter> and <code>, and some of <dirname>, <value>, and <command> were replaced by <literal>; - the rest of <dirname> were replaced by links; - <argument> were replaced by <value>; - <value> is now rendered in HTML in italic; - <literal> and <path> can now contain <value>. Cleaned up terminology mess: - directives take "parameters".
author Ruslan Ermilov <ru@nginx.com>
date Fri, 23 Dec 2011 17:29:59 +0000
parents 945d7299c26c
children daae2b619815
comparison
equal deleted inserted replaced
270:945d7299c26c 271:4c6d2c614d2c
7 lang="ru"> 7 lang="ru">
8 8
9 <section id="summary"> 9 <section id="summary">
10 10
11 <para> 11 <para>
12 Модуль <code>ngx_http_image_filter_module</code> — это фильтр для преобразования 12 Модуль <literal>ngx_http_image_filter_module</literal> — это фильтр
13 изображений в форматах JPEG, GIF и PNG (0.7.54+). 13 для преобразования изображений в форматах JPEG, GIF и PNG (0.7.54+).
14 </para> 14 </para>
15 15
16 <para> 16 <para>
17 По умолчанию этот модуль не собирается, его сборку необходимо 17 По умолчанию этот модуль не собирается, его сборку необходимо
18 разрешить с помощью конфигурационного параметра 18 разрешить с помощью конфигурационного параметра
19 <code>--with-http_image_filter_module</code>. 19 <literal>--with-http_image_filter_module</literal>.
20 <note> 20 <note>
21 Для сборки и работы этого модуля необходима библиотека 21 Для сборки и работы этого модуля необходима библиотека
22 <link url="http://libgd.org">libgd</link>. 22 <link url="http://libgd.org">libgd</link>.
23 Рекомендуется использовать самую последнюю версию библиотеки, 23 Рекомендуется использовать самую последнюю версию библиотеки,
24 на текущий момент это версия 2.0.35. 24 на текущий момент это версия 2.0.35.
49 49
50 50
51 <section name="Директивы" id="directives"> 51 <section name="Директивы" id="directives">
52 52
53 <directive name="image_filter"> 53 <directive name="image_filter">
54 <syntax><parameter>off</parameter></syntax> 54 <syntax><literal>off</literal></syntax>
55 <syntax><parameter>test</parameter></syntax> 55 <syntax><literal>test</literal></syntax>
56 <syntax><parameter>size</parameter></syntax> 56 <syntax><literal>size</literal></syntax>
57 <syntax><parameter>rotate</parameter> 57 <syntax><literal>rotate</literal>
58 <value>90</value> | <value>180</value> | <value>270</value></syntax> 58 <literal>90</literal> | <literal>180</literal> | <literal>270</literal></syntax>
59 <syntax> 59 <syntax>
60 <parameter>resize</parameter> 60 <literal>resize</literal>
61 <argument>ширина</argument> 61 <value>ширина</value>
62 <argument>высота</argument></syntax> 62 <value>высота</value></syntax>
63 <syntax> 63 <syntax>
64 <parameter>crop</parameter> 64 <literal>crop</literal>
65 <argument>ширина</argument> 65 <value>ширина</value>
66 <argument>высота</argument></syntax> 66 <value>высота</value></syntax>
67 <default/> 67 <default/>
68 <context>location</context> 68 <context>location</context>
69 69
70 <para> 70 <para>
71 Задаёт тип преобразования изображения: 71 Задаёт тип преобразования изображения:
72 <list type="tag"> 72 <list type="tag">
73 73
74 <tag-name><parameter>off</parameter></tag-name> 74 <tag-name><literal>off</literal></tag-name>
75 <tag-desc> 75 <tag-desc>
76 отключает обработку данным модулем во вложенном location. 76 отключает обработку данным модулем во вложенном location.
77 </tag-desc> 77 </tag-desc>
78 78
79 <tag-name><parameter>test</parameter></tag-name> 79 <tag-name><literal>test</literal></tag-name>
80 <tag-desc> 80 <tag-desc>
81 проверяет, что ответ действительно является изображением 81 проверяет, что ответ действительно является изображением
82 в формате JPEG, GIF или PNG. 82 в формате JPEG, GIF или PNG.
83 В противном случае возвращается ошибка 83 В противном случае возвращается ошибка
84 <http-status code="415" text="Unsupported Media Type"/>. 84 <http-status code="415" text="Unsupported Media Type"/>.
85 </tag-desc> 85 </tag-desc>
86 86
87 <tag-name><parameter>size</parameter></tag-name> 87 <tag-name><literal>size</literal></tag-name>
88 <tag-desc> 88 <tag-desc>
89 выдаёт информацию об изображении в формате JSON, например: 89 выдаёт информацию об изображении в формате JSON, например:
90 <example> 90 <example>
91 { "img" : { "width": 100, "height": 100, "type": "gif" } } 91 { "img" : { "width": 100, "height": 100, "type": "gif" } }
92 </example> 92 </example>
94 <example> 94 <example>
95 {} 95 {}
96 </example> 96 </example>
97 </tag-desc> 97 </tag-desc>
98 98
99 <tag-name><parameter>rotate</parameter> 99 <tag-name><literal>rotate</literal>
100 <value>90</value>|<value>180</value>|<value>270</value> 100 <literal>90</literal>|<literal>180</literal>|<literal>270</literal>
101 </tag-name> 101 </tag-name>
102 <tag-desc> 102 <tag-desc>
103 поворачивает изображение против часовой стрелки на указанное число градусов. 103 поворачивает изображение против часовой стрелки на указанное число градусов.
104 В значении аргумента допустимо использование переменных. 104 В значении параметра допустимо использование переменных.
105 Можно использовать как отдельно, так и совместно с преобразованиями 105 Можно использовать как отдельно, так и совместно с преобразованиями
106 <parameter>resize</parameter> и <parameter>crop</parameter>. 106 <literal>resize</literal> и <literal>crop</literal>.
107 </tag-desc> 107 </tag-desc>
108 108
109 <tag-name><parameter>resize</parameter> 109 <tag-name><literal>resize</literal>
110 <argument>ширина</argument> 110 <value>ширина</value>
111 <argument>высота</argument> 111 <value>высота</value>
112 </tag-name> 112 </tag-name>
113 <tag-desc> 113 <tag-desc>
114 пропорционально уменьшает изображение до указанных размеров. 114 пропорционально уменьшает изображение до указанных размеров.
115 Если требуется уменьшить только по одному измерению, то в качестве второго 115 Если требуется уменьшить только по одному измерению, то в качестве второго
116 можно указать “<code>-</code>”. 116 можно указать “<literal>-</literal>”.
117 В случае ошибки сервер возвращает код 117 В случае ошибки сервер возвращает код
118 <http-status code="415" text="Unsupported Media Type"/>. 118 <http-status code="415" text="Unsupported Media Type"/>.
119 В значениях аргументов допустимо использование переменных. 119 В значениях параметров допустимо использование переменных.
120 При использовании совместно с <parameter>rotate</parameter>, 120 При использовании совместно с <literal>rotate</literal>,
121 поворот изображения происходит <emphasis>после</emphasis> 121 поворот изображения происходит <emphasis>после</emphasis>
122 уменьшения размеров изображения. 122 уменьшения размеров изображения.
123 </tag-desc> 123 </tag-desc>
124 124
125 <tag-name><parameter>crop</parameter> 125 <tag-name><literal>crop</literal>
126 <argument>ширина</argument> 126 <value>ширина</value>
127 <argument>высота</argument> 127 <value>высота</value>
128 </tag-name> 128 </tag-name>
129 <tag-desc> 129 <tag-desc>
130 пропорционально уменьшает изображение до размера большей стороны 130 пропорционально уменьшает изображение до размера большей стороны
131 и обрезает лишние края по другой стороне. 131 и обрезает лишние края по другой стороне.
132 Если требуется уменьшить только по одному измерению, то в качестве второго 132 Если требуется уменьшить только по одному измерению, то в качестве второго
133 можно указать “<code>-</code>”. 133 можно указать “<literal>-</literal>”.
134 В случае ошибки сервер возвращает код 134 В случае ошибки сервер возвращает код
135 <http-status code="415" text="Unsupported Media Type"/>. 135 <http-status code="415" text="Unsupported Media Type"/>.
136 В значениях аргументов допустимо использование переменных. 136 В значениях параметров допустимо использование переменных.
137 При использовании совместно с <parameter>rotate</parameter>, 137 При использовании совместно с <literal>rotate</literal>,
138 поворот изображения происходит <emphasis>до</emphasis> 138 поворот изображения происходит <emphasis>до</emphasis>
139 уменьшения размеров изображения. 139 уменьшения размеров изображения.
140 </tag-desc> 140 </tag-desc>
141 141
142 </list> 142 </list>
160 160
161 </directive> 161 </directive>
162 162
163 163
164 <directive name="image_filter_jpeg_quality"> 164 <directive name="image_filter_jpeg_quality">
165 <syntax><value>1..100</value></syntax> 165 <syntax><value>качество</value></syntax>
166 <default>75</default> 166 <default>75</default>
167 <context>http</context> 167 <context>http</context>
168 <context>server</context> 168 <context>server</context>
169 <context>location</context> 169 <context>location</context>
170 170
171 <para> 171 <para>
172 Задаёт желаемое качество преобразованного изображения в формате JPEG. 172 Задаёт желаемое <value>качество</value> преобразованного изображения в формате JPEG.
173 Допустимые значения находятся в диапазоне 1..100.
173 Меньшим значениям обычно соответствует худшее качество изображения 174 Меньшим значениям обычно соответствует худшее качество изображения
174 и меньший объём передаваемых данных. 175 и меньший объём передаваемых данных.
175 Максимальное рекомендуемое значение — 95. 176 Максимальное рекомендуемое значение — 95.
176 В значении аргумента допустимо использование переменных. 177 В значении параметра допустимо использование переменных.
177 </para> 178 </para>
178 179
179 </directive> 180 </directive>
180 181
181 182
182 <directive name="image_filter_sharpen"> 183 <directive name="image_filter_sharpen">
183 <syntax><argument>процент</argument></syntax> 184 <syntax><value>процент</value></syntax>
184 <default>0</default> 185 <default>0</default>
185 <context>http</context> 186 <context>http</context>
186 <context>server</context> 187 <context>server</context>
187 <context>location</context> 188 <context>location</context>
188 189
189 <para> 190 <para>
190 Повышает резкость итогового изображения. 191 Повышает резкость итогового изображения.
191 Процент резкости может быть больше 100. 192 Процент резкости может быть больше 100.
192 Значение 0 отключает повышение резкости. 193 Значение 0 отключает повышение резкости.
193 В значении аргумента допустимо использование переменных. 194 В значении параметра допустимо использование переменных.
194 </para> 195 </para>
195 196
196 </directive> 197 </directive>
197 198
198 199
199 <directive name="image_filter_transparency"> 200 <directive name="image_filter_transparency">
200 <syntax><value>on</value>|<value>off</value></syntax> 201 <syntax><literal>on</literal>|<literal>off</literal></syntax>
201 <default>on</default> 202 <default>on</default>
202 <context>http</context> 203 <context>http</context>
203 <context>server</context> 204 <context>server</context>
204 <context>location</context> 205 <context>location</context>
205 206