Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_image_filter_module.xml @ 183:aa4c2b46a4a3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Revised ngx_http_image_filter_module documentation, unfinished.
author Igor Sysoev <igor@sysoev.ru>
date Tue, 15 Nov 2011 09:39:56 +0000
parents 40eec261c2a6
children 4840aa7bab2c
comparison
equal deleted inserted replaced
182:d87e97c0a3e4 183:aa4c2b46a4a3
1 <?xml version="1.0" encoding="utf-8"?> 1 <?xml version="1.0" encoding="utf-8"?>
2 2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4 4
5 <module name="Директивы модуля ngx_http_image_filter_module" 5 <module name="Модуль ngx_http_image_filter_module"
6 link="/ru/docs/http/ngx_http_image_filter_module.html" 6 link="/ru/docs/http/ngx_http_image_filter_module.html"
7 lang="ru"> 7 lang="ru">
8 8
9 <section id="summary"> 9 <section id="summary">
10 10
11 <para> 11 <para>
12 Модуль ngx_http_image_filter_module — это фильтр для преобразования 12 Модуль ngx_http_image_filter_module — это фильтр для преобразования
13 изображений в форматах JPEG, GIF и PNG (0.7.54+). 13 изображений в форматах JPEG, GIF и PNG (0.7.54+).
14 По умолчанию модуль не собирается, нужно разрешить его сборку 14 <note>
15 при конфигурировании параметром 15 По умолчанию этот модуль не собирается, его сборку необходимо
16 <command>--with-http_image_filter_module</command>. 16 разрешить с помощью конфигурационного параметра
17 Для сборки и работы этого модуля нужна библиотека 17 <code>--with-http_image_filter_module</code>.
18 </note>
19 <note>
20 Для сборки и работы этого модуля необходима библиотека
18 <link url="http://libgd.org">libgd</link>. 21 <link url="http://libgd.org">libgd</link>.
19 Рекомендуется использовать самую последнию версию библиотеки, 22 Рекомендуется использовать самую последнюю версию библиотеки,
20 на текущий момент (май 2009) это версия 2.0.35. 23 на текущий момент это версия 2.0.35.
24 </note>
21 </para> 25 </para>
22 26
23 </section> 27 </section>
24 28
25 29
26 <section name="Пример конфигурации" id="example"> 30 <section name="Пример конфигурации" id="example">
27 31
28 <para> 32 <para>
29 <example> 33 <example>
30 location /img/ { 34 location /img/ {
31 proxy_pass http://backend; 35 proxy_pass http://backend;
32 image_filter resize 150 100; 36 image_filter resize 150 100;
33 error_page 415 = /empty; 37 error_page 415 = /empty;
34 } 38 }
35 39
36 location = /empty { 40 location = /empty {
37 empty_gif; 41 empty_gif;
38 } 42 }
43 47
44 48
45 <section name="Директивы" id="directives"> 49 <section name="Директивы" id="directives">
46 50
47 <directive name="image_filter"> 51 <directive name="image_filter">
48 <syntax><value>(test|size|resize ширина высота|crop ширина высота) 52 <syntax><parameter>off</parameter></syntax>
49 </value></syntax> 53 <syntax><parameter>test</parameter></syntax>
54 <syntax><parameter>size</parameter></syntax>
55 <syntax><parameter>rotate </parameter>
56 <value>90</value>|<value>180</value>|<value>270</value>
57 </syntax>
58 <syntax>
59 <parameter>resize </parameter>
60 <argument>ширина высота</argument>
61 </syntax>
62 <syntax>
63 <parameter>crop </parameter>
64 <argument>ширина высота</argument>
65 </syntax>
50 <default/> 66 <default/>
51 <context>location</context> 67 <context>location</context>
52 68
53 <para> 69 <para>
54 Директива задаёт тип преобразования изображения: 70 Директива задаёт тип преобразования изображения:
55 <list type="bullet"> 71 <list type="tag">
56 72
57 <listitem> 73 <tag-name><parameter>off</parameter></tag-name>
58 test — проверка того, что ответ действительно является изображением 74 <tag-desc>
59 в формате JPEG, GIF или PNG. В противном случае выдаётся ошибка 415. 75 отключает обработку данным модулем во вложенном location.
60 </listitem> 76 </tag-desc>
61 77
62 <listitem> 78 <tag-name><parameter>test</parameter></tag-name>
63 size — выдаёт информацию об изображении в формате JSON, например: 79 <tag-desc>
80 проверяет, что ответ действительно является изображением
81 в формате JPEG, GIF или PNG.
82 В противном случае возвращается ошибка
83 <http-status code="415" text="Unsupported Media Type"/>.
84 </tag-desc>
85
86 <tag-name><parameter>size</parameter></tag-name>
87 <tag-desc>
88 выдаёт информацию об изображении в формате JSON, например:
64 <example> 89 <example>
65 { "img" : { "width": 100, "height": 100, "type": "gif" } } 90 { "img" : { "width": 100, "height": 100, "type": "gif" } }
66 </example> 91 </example>
67 В случае ошибки выдаётся 92 В случае ошибки выдаётся
68 <example> 93 <example>
69 {} 94 {}
70 </example> 95 </example>
71 </listitem> 96 </tag-desc>
72 97
73 <listitem> 98 <tag-name><parameter>rotate </parameter>
74 resize — пропорционально уменьшает изображение до указанных размеров. 99 <value>90</value>|<value>180</value>|<value>270</value>
75 Если нужно уменьшить только по одному измерению, то в качестве второго 100 </tag-name>
76 можно указать "-". 101 <tag-desc>
77 В случае ошибки выдаётся код 415. 102 поворачивает изображение по часовой стрелке на указанное число градусов.
78 </listitem> 103 </tag-desc>
79 104
80 <listitem> 105 <tag-name><parameter>resize </parameter>
81 crop — пропорционально уменьшает изображение до размера большой стороны 106 <argument>ширина высота</argument>
107 </tag-name>
108 <tag-desc>
109 пропорционально уменьшает изображение до указанных размеров.
110 Если требуется уменьшить только по одному измерению, то в качестве второго
111 можно указать “<code>-</code>”.
112 В случае ошибки сервер возвращает код
113 <http-status code="415" text="Unsupported Media Type"/>.
114 </tag-desc>
115
116 <tag-name><parameter>crop </parameter>
117 <argument>ширина высота</argument>
118 </tag-name>
119 <tag-desc>
120 пропорционально уменьшает изображение до размера большей стороны
82 и обрезает лишние края по другой стороне. 121 и обрезает лишние края по другой стороне.
83 Если нужно уменьшить только по одному измерению, то в качестве второго 122 Если требуется уменьшить только по одному измерению, то в качестве второго
84 можно указать "-". 123 можно указать “<code>-</code>”.
85 В случае ошибки выдаётся код 415. 124 В случае ошибки сервер возвращает код
86 </listitem> 125 <http-status code="415" text="Unsupported Media Type"/>.
126 </tag-desc>
87 127
88 </list> 128 </list>
89 </para> 129 </para>
90 130
91 </directive> 131 </directive>
92 132
93 133
94 <directive name="image_filter_buffer"> 134 <directive name="image_filter_buffer">
95 <syntax><value>размер</value></syntax> 135 <syntax><value>размер</value></syntax>
96 <default>1M</default> 136 <default>1M</default>
97 <context>http, server, location</context> 137 <context>http</context>
138 <context>server</context>
139 <context>location</context>
98 140
99 <para> 141 <para>
100 Директива задаёт максимальный размер буфера для чтения изображения. 142 Директива задаёт максимальный размер буфера для чтения изображения.
143 При превышении размера сервер вернёт ошибку
144 <http-status code="415" text="Unsupported Media Type"/>.
101 </para> 145 </para>
102 146
103 </directive> 147 </directive>
104 148
105 149
106 <directive name="image_filter_jpeg_quality"> 150 <directive name="image_filter_jpeg_quality">
107 <syntax><value>[0..100]</value></syntax> 151 <syntax><value>1..100</value></syntax>
108 <default>75</default> 152 <default>75</default>
109 <context>http, server, location</context> 153 <context>http</context>
154 <context>server</context>
155 <context>location</context>
110 156
111 <para> 157 <para>
112 Директива задаёт коэффициент потери информации при обработке изображений 158 Директива задаёт коэффициент потери информации при обработке изображений
113 в формате JPEG. Максимальное рекомендуемое значение — 95. 159 в формате JPEG.
160 Максимальное рекомендуемое значение — 95.
161 </para>
162
163 </directive>
164
165
166 <directive name="image_filter_sharpen">
167 <syntax><argument>процент</argument></syntax>
168 <default>0</default>
169 <context>http</context>
170 <context>server</context>
171 <context>location</context>
172
173 <para>
174 Повышает резкость итогового изображения.
175 Процент резкости может быть больше 100.
176 Значение 0 отключает повышение резкости.
114 </para> 177 </para>
115 178
116 </directive> 179 </directive>
117 180
118 181
119 <directive name="image_filter_transparency"> 182 <directive name="image_filter_transparency">
120 <syntax><value>[on|off]</value></syntax> 183 <syntax><value>on</value>|<value>off</value></syntax>
121 <default>on</default> 184 <default>on</default>
122 <context>http, server, location</context> 185 <context>http</context>
186 <context>server</context>
187 <context>location</context>
123 188
124 <para> 189 <para>
125 Директива определяет, сохранять ли прозрачность при обработке изображений 190 Директива определяет, сохранять ли прозрачность при обработке изображений
126 в формате PNG с цветами, заданными палитрой, и формате GIF. 191 в формате PNG с цветами, заданными палитрой, и в формате GIF.
127 Потеря прозрачности позволяет получить более качественное изображение. 192 Потеря прозрачности позволяет получить более качественное изображение.
128 Прозрачность альфа-канала в формате PNG сохраняется всегда. 193 Прозрачность альфа-канала в формате PNG сохраняется всегда.
129 </para> 194 </para>
130 195
131 </directive> 196 </directive>