Mercurial > hg > nginx-site

comparison xml/cn/docs/http/ngx_http_image_filter_module.xml @ 792:ceb8a4e374b7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated the Chinese documentation.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 25 Dec 2012 06:34:37 +0000
parents
children
comparison
equal deleted inserted replaced
791:15f2bab0740d 792:ceb8a4e374b7
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Igor Sysoev
5 Copyright (C) Nginx, Inc.
6 -->
7
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9
10 <module name="ngx_http_image_filter_module模块"
11 link="/cn/docs/http/ngx_http_image_filter_module.html"
12 lang="cn"
13 translator="Cen Zheng"
14 rev="1">
15
16 <section id="summary">
17
18 <para>
19 <literal>ngx_http_image_filter_module</literal> 模块（0.7.54+）是一个
20 过滤器，它可以对JPEG,GIF和PNG等图像进行变换。
21 </para>
22
23 <para>
24 这个模块并不是默认编译的，需要通过
25 <literal>--with-http_image_filter_module</literal>编译选项来启用。
26 <note>
27 这个模块使用了
28 <link url="http://libgd.org">libgd</link> 库。
29 推荐使用这个库可用的最新版本；在写这个文档时它的最新版本是2.0.35。
30 </note>
31 </para>
32
33 </section>
34
35
36 <section id="example" name="配置例子">
37
38 <para>
39 <example>
40 location /img/ {
41 proxy_pass http://backend;
42 image_filter resize 150 100;
43 image_filter rotate 90;
44 error_page 415 = /empty;
45 }
46
47 location = /empty {
48 empty_gif;
49 }
50 </example>
51 </para>
52
53 </section>
54
55
56 <section id="directives" name="指令">
57
58 <directive name="image_filter">
59 <syntax><literal>off</literal></syntax>
60 <syntax><literal>test</literal></syntax>
61 <syntax><literal>size</literal></syntax>
62 <syntax>
63 <literal>rotate</literal>
64 <literal>90</literal> | <literal>180</literal> |
65 <literal>270</literal></syntax>
66 <syntax>
67 <literal>resize</literal>
68 <value>width</value>
69 <value>height</value></syntax>
70 <syntax>
71 <literal>crop</literal>
72 <value>width</value>
73 <value>height</value></syntax>
74 <default/>
75 <context>location</context>
76
77 <para>
78 设置图像变换的操作：
79 <list type="tag">
80
81 <tag-name><literal>off</literal></tag-name>
82 <tag-desc>
83 在所在location关闭模块处理。
84 </tag-desc>
85
86 <tag-name><literal>test</literal></tag-name>
87 <tag-desc>
88 确保应答是JPEG，GIF或PNG格式的图像。否则错误
89 <http-status code="415" text="Unsupported Media Type"/>
90 将被返回。
91 </tag-desc>
92
93 <tag-name><literal>size</literal></tag-name>
94 <tag-desc>
95 以JSON格式返回图像信息。例如：
96 <example>
97 { "img" : { "width": 100, "height": 100, "type": "gif" } }
98 </example>
99 如果有错误发生，将会返回如下：
100 <example>
101 {}
102 </example>
103 </tag-desc>
104
105 <tag-name><literal>rotate</literal>
106 <literal>90</literal>|<literal>180</literal>|<literal>270</literal>
107 </tag-name>
108 <tag-desc>
109 将图像逆时针旋转指定角度。
110 参数的值可以包含变量。
111 可以单独使用，或与
112 <literal>resize</literal> 和 <literal>crop</literal> 变换同时使用.
113 </tag-desc>
114
115 <tag-name><literal>resize</literal>
116 <value>width</value>
117 <value>height</value>
118 </tag-name>
119 <tag-desc>
120 按比例缩小图像至指定大小。
121 如果想只指定其中一维，另一维可以指定为：
122 “<literal>-</literal>”。
123 如果有错误发生，服务器会返回
124 <http-status code="415" text="Unsupported Media Type"/>.
125 参数的值可以包含变量。
126 当与 <literal>rotate</literal> 参数同时使用时,
127 旋转发生在缩放 <emphasis>之后</emphasis>。
128 </tag-desc>
129
130 <tag-name><literal>crop</literal>
131 <value>width</value>
132 <value>height</value>
133 </tag-name>
134 <tag-desc>
135 按比例以图像的最短边为准对图像大小进行缩小，然后裁剪另一边多出来的部分。
136 如果想只指定其中一维，另一维可以指定为：
137 “<literal>-</literal>”。
138 如果有错误发生，服务器会返回
139 <http-status code="415" text="Unsupported Media Type"/>.
140 参数的值可以包含变量。
141 当与 <literal>rotate</literal> 参数同时使用时,
142 旋转发生在裁剪 <emphasis>之前</emphasis>。
143 </tag-desc>
144
145 </list>
146 </para>
147
148 </directive>
149
150
151 <directive name="image_filter_buffer">
152 <syntax><value>size</value></syntax>
153 <default>1M</default>
154 <context>http</context>
155 <context>server</context>
156 <context>location</context>
157
158 <para>
159 设置用来读图像的缓冲区的最大值。
160 若图像超过这个大小，服务器会返回
161 <http-status code="415" text="Unsupported Media Type"/>.
162 </para>
163
164 </directive>
165
166
167 <directive name="image_filter_jpeg_quality">
168 <syntax><value>quality</value></syntax>
169 <default>75</default>
170 <context>http</context>
171 <context>server</context>
172 <context>location</context>
173
174 <para>
175 设置变换后的JPEG图像的 <value>质量</value> 。
176 可配置值： 1 ~ 100 。
177 更小的值意味着更差的图像质量以及更少需要传输的数据。
178 推荐的最大值是95.
179 参数的值可以包含变量。
180 </para>
181
182 </directive>
183
184
185 <directive name="image_filter_sharpen">
186 <syntax><value>percent</value></syntax>
187 <default>0</default>
188 <context>http</context>
189 <context>server</context>
190 <context>location</context>
191
192 <para>
193 增加最终图像的锐度。
194 锐度百分比可以超过100.
195 0为关闭锐化。
196 参数的值可以包含变量。
197 </para>
198
199 </directive>
200
201
202 <directive name="image_filter_transparency">
203 <syntax><literal>on</literal>|<literal>off</literal></syntax>
204 <default>on</default>
205 <context>http</context>
206 <context>server</context>
207 <context>location</context>
208
209 <para>
210 定义当对PNG，或者GIF图像进行颜色变换时是否需要保留透明度。
211 损失透明度有可能可以获得更高的图像质量。
212 PNG图像中的alpha通道的透明度默认会一直被保留。
213 </para>
214
215 </directive>
216
217 </section>
218
219 </module>