Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_xslt_module.xml @ 2432:c1acbe5e1222
nginx-1.17.4
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Tue, 24 Sep 2019 18:15:21 +0300 |
parents | 95c3c3bbf1ce |
children | eeed494bba51 |
rev | line source |
---|---|
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
580
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
564
diff
changeset
|
3 <!-- |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
564
diff
changeset
|
4 Copyright (C) Igor Sysoev |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
564
diff
changeset
|
5 Copyright (C) Nginx, Inc. |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
564
diff
changeset
|
6 --> |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
564
diff
changeset
|
7 |
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 <module name="Module ngx_http_xslt_module" |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/http/ngx_http_xslt_module.html" |
589 | 12 lang="en" |
918
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
13 rev="2"> |
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 <section id="summary"> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 <para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
18 The <literal>ngx_http_xslt_module</literal> (0.7.8+) is a filter |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
19 that transforms XML responses using one or more XSLT stylesheets. |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 </para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 <para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 This module is not built by default, it should be enabled with the |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 <literal>--with-http_xslt_module</literal> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 configuration parameter. |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 <note> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 This module requires the |
564
624ac281c628
Separate links to libxml2 and libxslt.
Ruslan Ermilov <ru@nginx.com>
parents:
546
diff
changeset
|
28 <link url="http://xmlsoft.org">libxml2</link> and |
624ac281c628
Separate links to libxml2 and libxslt.
Ruslan Ermilov <ru@nginx.com>
parents:
546
diff
changeset
|
29 <link url="http://xmlsoft.org/XSLT/">libxslt</link> libraries. |
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 </note> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 </para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
33 </section> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
34 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
35 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 <section id="example" name="Example Configuration"> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 <para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 <example> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 location / { |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 xml_entities /site/dtd/entities.dtd; |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 xslt_stylesheet /site/xslt/one.xslt param=value; |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 xslt_stylesheet /site/xslt/two.xslt; |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 } |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 </example> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 </para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
47 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
48 </section> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
49 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
50 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
51 <section id="directives" name="Directives"> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
52 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
53 <directive name="xml_entities"> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
54 <syntax><value>path</value></syntax> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
55 <default/> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
56 <context>http</context> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 <context>server</context> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
58 <context>location</context> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
59 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
60 <para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
61 Specifies the DTD file that declares character entities. |
966 | 62 This file is compiled at the configuration stage. |
63 For technical reasons, the module is unable to use the | |
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
64 external subset declared in the processed XML, so it is |
966 | 65 ignored and a specially defined file is used instead. |
66 This file should not describe the XML structure. | |
67 It is enough to declare just the required character entities, for example: | |
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
68 <example> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
69 <!ENTITY nbsp "&#xa0;"> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
70 </example> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 </para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
72 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 </directive> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 |
918
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
76 <directive name="xslt_last_modified"> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
77 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
78 <default>off</default> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
79 <context>http</context> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
80 <context>server</context> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
81 <context>location</context> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
82 <appeared-in>1.5.1</appeared-in> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
83 |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
84 <para> |
966 | 85 Allows preserving the <header>Last-Modified</header> header field |
918
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
86 from the original response during XSLT transformations |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
87 to facilitate response caching. |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
88 </para> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
89 |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
90 <para> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
91 By default, the header field is removed as contents of the response |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
92 are modified during transformations and may contain dynamically generated |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
93 elements or parts that are changed independently of the original response. |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
94 </para> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
95 |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
96 </directive> |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
97 |
ae785c6aaa91
Documented ssi/sub_filter/xslt_last_modified.
Maxim Dounin <mdounin@mdounin.ru>
parents:
589
diff
changeset
|
98 |
463
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
99 <directive name="xslt_param"> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
100 <syntax><value>parameter</value> <value>value</value></syntax> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
101 <default/> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
102 <context>http</context> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
103 <context>server</context> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
104 <context>location</context> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
105 <appeared-in>1.1.18</appeared-in> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
106 |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
107 <para> |
966 | 108 Defines the parameters for XSLT stylesheets. |
463
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
109 The <value>value</value> is treated as an XPath expression. |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
110 The <value>value</value> can contain variables. |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
111 To pass a string value to a stylesheet, |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
112 the <link id="xslt_string_param"/> directive can be used. |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
113 </para> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
114 |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
115 <para> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
116 There could be several <literal>xslt_param</literal> directives. |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
117 These directives are inherited from the previous level if and |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
118 only if there are no |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
119 <literal>xslt_param</literal> and <link id="xslt_string_param"/> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
120 directives defined on the current level. |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
121 </para> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
122 |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
123 </directive> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
124 |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
125 |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
126 <directive name="xslt_string_param"> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
127 <syntax><value>parameter</value> <value>value</value></syntax> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
128 <default/> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
129 <context>http</context> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
130 <context>server</context> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
131 <context>location</context> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
132 <appeared-in>1.1.18</appeared-in> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
133 |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
134 <para> |
966 | 135 Defines the string parameters for XSLT stylesheets. |
463
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
136 XPath expressions in the <value>value</value> are not interpreted. |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
137 The <value>value</value> can contain variables. |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
138 </para> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
139 |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
140 <para> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
141 There could be several <literal>xslt_string_param</literal> directives. |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
142 These directives are inherited from the previous level if and |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
143 only if there are no |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
144 <link id="xslt_param"/> and <literal>xslt_string_param</literal> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
145 directives defined on the current level. |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
146 </para> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
147 |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
148 </directive> |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
149 |
dd9fec875834
Documented new directives: xslt_param and xslt_string_param.
Ruslan Ermilov <ru@nginx.com>
parents:
377
diff
changeset
|
150 |
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 <directive name="xslt_stylesheet"> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 <syntax> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 <value>stylesheet</value> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 [<value>parameter</value>=<value>value</value> ...]</syntax> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 <default/> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 <context>location</context> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 <para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 Defines the XSLT stylesheet and its optional parameters. |
966 | 160 A stylesheet is compiled at the configuration stage. |
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 </para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 <para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 Parameters can either be specified separately, or grouped in a |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 single line using the “<literal>:</literal>” delimiter. |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 If a parameter includes the “<literal>:</literal>” character, |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 it should be escaped as “<literal>%3A</literal>”. |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 Also, <command>libxslt</command> requires to enclose parameters |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 that contain non-alphanumeric characters into single or double quotes, |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 for example: |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 <example> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
172 param1='http%3A//www.example.com':param2=value2 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
173 </example> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
174 </para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 <para> |
966 | 177 The parameters description can contain variables, for example, |
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 the whole line of parameters can be taken from a single variable: |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 <example> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
180 location / { |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
181 xslt_stylesheet /site/xslt/one.xslt |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 $arg_xslt_params |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
183 param1='$value1':param2=value2 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 param3=value3; |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 } |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 </example> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 </para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 <para> |
966 | 190 It is possible to specify several stylesheets. |
191 They will be applied sequentially in the specified order. | |
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 </para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
193 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 </directive> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 <directive name="xslt_types"> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 <syntax><value>mime-type</value> ...</syntax> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 <default>text/xml</default> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 <context>http</context> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 <context>server</context> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 <context>location</context> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 <para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 Enables transformations in responses with the specified MIME types |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 in addition to “<literal>text/xml</literal>”. |
546
694db9597ee0
Documented the special value "*" in various "*_type" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
463
diff
changeset
|
207 The special value “<literal>*</literal>” matches any MIME type (0.8.29). |
966 | 208 If the transformation result is an HTML response, its MIME type |
209 is changed to “<literal>text/html</literal>”. | |
377
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 </para> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 </directive> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
213 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 </section> |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 |
e72701967099
English translation of ngx_http_xslt_module.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 </module> |