Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_image_filter_module.xml @ 76:4a4caa566120

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 1d315ef37215
comparison
equal deleted inserted replaced
75:2bf4cd2787c5 76:4a4caa566120
1 <?xml version="1.0" encoding="utf-8"?>
2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4
5 <module name="Директивы модуля ngx_http_image_filter_module"
6 link="/ru/docs/http/ngx_http_image_filter_module.html"
7 lang="ru">
8
9 <section name="" id="summary">
10
11 <para>
12 Модуль ngx_http_image_filter_module — это фильтр для преобразования
13 изображений в форматах JPEG, GIF и PNG (0.7.54+).
14 По умолчанию модуль не собирается, нужно разрешить его сборку
15 при конфигурировании параметром
16 <command>--with-http_image_filter_module</command>.
17 Для сборки и работы этого модуля нужна библиотека
18 <link url="http://libgd.org">libgd</link>.
19 Рекомендуется использовать самую последнию версию библиотеки,
20 на текущий момент (май 2009) это версия 2.0.35.
21 </para>
22
23 </section>
24
25
26 <section name="Пример конфигурации" id="example">
27
28 <para>
29 <example>
30 location /img/ {
31 proxy_pass http://backend;
32 image_filter resize 150 100;
33 error_page 415 = /empty;
34 }
35
36 location = /empty {
37 empty_gif;
38 }
39 </example>
40 </para>
41
42 </section>
43
44
45 <section name="Директивы" id="directives">
46
47 <directive name="image_filter">
48 <syntax>image_filter <value>(test|size|resize ширина высота|crop ширина высота)
49 </value></syntax>
50 <default>нет</default>
51 <context>location</context>
52
53 <para>
54 Директива задаёт тип преобразования изображения:
55 <list type="bullet">
56
57 <listitem>
58 test — проверка того, что ответ действительно является изображением
59 в формате JPEG, GIF или PNG. В противном случае выдаётся ошибка 415.
60 </listitem>
61
62 <listitem>
63 size — выдаёт информацию об изображении в формате JSON, например:
64 <example>
65 { "img" : { "width": 100, "height": 100, "type": "gif" } }
66 </example>
67 В случае ошибки выдаётся
68 <example>
69 {}
70 </example>
71 </listitem>
72
73 <listitem>
74 resize — пропорционально уменьшает изображение до указанных размеров.
75 Если нужно уменьшить только по одному измерению, то в качестве второго
76 можно указать "-".
77 В случае ошибки выдаётся код 415.
78 </listitem>
79
80 <listitem>
81 crop — пропорционально уменьшает изображение до размера большой стороны
82 и обрезает лишние края по другой стороне.
83 Если нужно уменьшить только по одному измерению, то в качестве второго
84 можно указать "-".
85 В случае ошибки выдаётся код 415.
86 </listitem>
87
88 </list>
89 </para>
90
91 </directive>
92
93
94 <directive name="image_filter_buffer">
95 <syntax>image_filter_buffer <value>размер</value></syntax>
96 <default>image_filter_buffer 1M</default>
97 <context>http, server, location</context>
98
99 <para>
100 Директива задаёт максимальный размер буфера для чтения изображения.
101 </para>
102
103 </directive>
104
105
106 <directive name="image_filter_jpeg_quality">
107 <syntax>image_filter_jpeg_quality <value>[0..100]</value></syntax>
108 <default>image_filter_jpeg_quality 75</default>
109 <context>http, server, location</context>
110
111 <para>
112 Директива задаёт коэффициент потери информации при обработке изображений
113 в формате JPEG. Максимальное рекомендуемое значение — 95.
114 </para>
115
116 </directive>
117
118
119 <directive name="image_filter_transparency">
120 <syntax>image_filter_transparency <value>[on|off]</value></syntax>
121 <default>image_filter_transparency on</default>
122 <context>http, server, location</context>
123
124 <para>
125 Директива определяет, сохранять ли прозрачность при обработке изображений
126 в формате PNG с цветами, заданными палитрой, и формате GIF.
127 Потеря прозрачности позволяет получить более качественное изображение.
128 Прозрачность альфа-канала в формате PNG сохраняется всегда.
129 </para>
130
131 </directive>
132
133 </section>
134
135 </module>