Mercurial > hg > nginx-site
diff xml/en/docs/http/ngx_http_image_filter_module.xml @ 271:4c6d2c614d2c
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 | 9f5ee1c6fca5 |
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_image_filter_module.xml Thu Dec 22 13:39:18 2011 +0000 +++ b/xml/en/docs/http/ngx_http_image_filter_module.xml Fri Dec 23 17:29:59 2011 +0000 @@ -9,13 +9,13 @@ <section id="summary"> <para> -The <code>ngx_http_image_filter_module</code> module is a filter +The <literal>ngx_http_image_filter_module</literal> module is a filter that transforms images in JPEG, GIF, and PNG (0.7.54+) formats. </para> <para> This module is not built by default, it should be enabled with the -<code>--with-http_image_filter_module</code> +<literal>--with-http_image_filter_module</literal> configuration parameter. <note> This module utilizes the @@ -51,19 +51,19 @@ <section id="directives" name="Directives"> <directive name="image_filter"> - <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><literal>off</literal></syntax> + <syntax><literal>test</literal></syntax> + <syntax><literal>size</literal></syntax> + <syntax><literal>rotate</literal> + <literal>90</literal> | <literal>180</literal> | <literal>270</literal></syntax> <syntax> - <parameter>resize</parameter> - <argument>width</argument> - <argument>height</argument></syntax> + <literal>resize</literal> + <value>width</value> + <value>height</value></syntax> <syntax> - <parameter>crop</parameter> - <argument>width</argument> - <argument>height</argument></syntax> + <literal>crop</literal> + <value>width</value> + <value>height</value></syntax> <default/> <context>location</context> @@ -71,12 +71,12 @@ Sets the type of transformation to perform on images: <list type="tag"> -<tag-name><parameter>off</parameter></tag-name> +<tag-name><literal>off</literal></tag-name> <tag-desc> turns off module processing in a surrounding location. </tag-desc> -<tag-name><parameter>test</parameter></tag-name> +<tag-name><literal>test</literal></tag-name> <tag-desc> ensures that answers are images in either JPEG, GIF, or PNG format. Otherwise, the error @@ -84,7 +84,7 @@ is returned. </tag-desc> -<tag-name><parameter>size</parameter></tag-name> +<tag-name><literal>size</literal></tag-name> <tag-desc> outputs information about images in a JSON format, e.g.: <example> @@ -96,44 +96,44 @@ </example> </tag-desc> -<tag-name><parameter>rotate</parameter> -<value>90</value>|<value>180</value>|<value>270</value> +<tag-name><literal>rotate</literal> +<literal>90</literal>|<literal>180</literal>|<literal>270</literal> </tag-name> <tag-desc> rotates images counter-clockwise by the specified number of degrees. -The argument value can contain variables. +Value of the parameter can contain variables. Can be used either alone, or along with the -<parameter>resize</parameter> and <parameter>crop</parameter> transformations. +<literal>resize</literal> and <literal>crop</literal> transformations. </tag-desc> -<tag-name><parameter>resize</parameter> -<argument>width</argument> -<argument>height</argument> +<tag-name><literal>resize</literal> +<value>width</value> +<value>height</value> </tag-name> <tag-desc> proportionally reduces an image to the specified sizes. To reduce by only one dimension, another dimension can be specified as -“<code>-</code>”. +“<literal>-</literal>”. In case of an error, the server will return code <http-status code="415" text="Unsupported Media Type"/>. -Values of arguments can contain variables. -When used along with the <parameter>rotate</parameter> parameter, +Values of parameters can contain variables. +When used along with the <literal>rotate</literal> parameter, the rotation happens <emphasis>after</emphasis> reduction. </tag-desc> -<tag-name><parameter>crop</parameter> -<argument>width</argument> -<argument>height</argument> +<tag-name><literal>crop</literal> +<value>width</value> +<value>height</value> </tag-name> <tag-desc> proportionally reduces an image to the size of the largest side and crops extraneous edges by another side. To reduce by only one dimension, another dimension can be specified as -“<code>-</code>”. +“<literal>-</literal>”. In case of an error, the server will return code <http-status code="415" text="Unsupported Media Type"/>. -Values of arguments can contain variables. -When used along with the <parameter>rotate</parameter> parameter, +Values of parameters can contain variables. +When used along with the <literal>rotate</literal> parameter, the rotation happens <emphasis>before</emphasis> reduction. </tag-desc> @@ -160,24 +160,25 @@ <directive name="image_filter_jpeg_quality"> -<syntax><value>1..100</value></syntax> +<syntax><value>quality</value></syntax> <default>75</default> <context>http</context> <context>server</context> <context>location</context> <para> -Sets the desired quality of the transformed JPEG images. +Sets the desired <value>quality</value> of the transformed JPEG images. +Acceptable values are in the 1..100 range. Lesser values usually imply both lower image quality and less data to transfer. The maximum recommended value is 95. -The argument value can contain variables. +Value of the parameter can contain variables. </para> </directive> <directive name="image_filter_sharpen"> -<syntax><argument>percent</argument></syntax> +<syntax><value>percent</value></syntax> <default>0</default> <context>http</context> <context>server</context> @@ -187,14 +188,14 @@ Increases sharpness of the final image. The sharpness percentage can exceed 100. The value of 0 disables sharpening. -The argument value can contain variables. +Value of the parameter can contain variables. </para> </directive> <directive name="image_filter_transparency"> -<syntax><value>on</value>|<value>off</value></syntax> +<syntax><literal>on</literal>|<literal>off</literal></syntax> <default>on</default> <context>http</context> <context>server</context>