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

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 a10bc0cb0a6a
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_browser_module"
6 link="/ru/docs/http/ngx_http_browser_module.html"
7 lang="ru">
8
9 <section name="" id="summary">
10
11 <para>
12 Модуль ngx_http_browser_module создаёт переменные, значение которых
13 зависят от строки "User-Agent" в заголовке запроса:
14 <list type="bullet">
15
16 <listitem>
17 $modern_browser — равна значению, заданному директивой
18 <link id="modern_browser_value"/>, если браузер опознан как современный;
19 </listitem>
20
21 <listitem>
22 $ancient_browser — равна значению, заданному директивой
23 <link id="ancient_browser_value"/>, если браузер опознан как устаревший;
24 </listitem>
25
26 <listitem>
27 $msie — равна "1", если браузер опознан как MSIE любой версии;
28 </listitem>
29
30 </list>
31 </para>
32
33 </section>
34
35
36 <section name="Примеры конфигурации" id="example">
37
38 <para>
39 Выбор индексного файла:
40 <example>
41 modern_browser_value "modern.";
42
43 modern_browser msie 5.5;
44 modern_browser gecko 1.0.0;
45 modern_browser opera 9.0;
46 modern_browser safari 413;
47 modern_browser konqueror 3.0;
48
49 index index.${modern_browser}html index.html;
50 </example>
51 </para>
52
53 <para>
54 Редирект для старых браузеров:
55 <example>
56 modern_browser msie 5.0;
57 modern_browser gecko 0.9.1;
58 modern_browser opera 8.0;
59 modern_browser safari 413;
60 modern_browser konqueror 3.0;
61
62 modern_browser unlisted;
63
64 ancient_browser Links Lynx netscape4;
65
66 if ($ancient_browser) {
67 rewrite ^ /ancient.html;
68 }
69 </example>
70 </para>
71
72 </section>
73
74
75 <section name="Директивы" id="directives">
76
77 <directive name="ancient_browser">
78 <syntax>ancient_browser <value>строка [строка ...]</value></syntax>
79 <default>нет</default>
80 <context>http, server, location</context>
81
82 <para>
83 Директива задаёт подстроки, при нахождении которых в строке "User-Agent",
84 браузер считается устаревшим.
85 Специальная строка "netscape4" соответствует регулярному
86 выражению "^Mozilla/[1-4]".
87 </para>
88
89 </directive>
90
91
92 <directive name="ancient_browser_value">
93 <syntax>ancient_browser_value <value>строка</value></syntax>
94 <default>ancient_browser_value 1</default>
95 <context>http, server, location</context>
96
97 <para>
98 Директива задаёт значение для переменных $ancient_browser.
99 </para>
100
101 </directive>
102
103
104 <directive name="modern_browser">
105 <syntax>modern_browser <value>браузер версия|unlisted</value></syntax>
106 <default>нет</default>
107 <context>http, server, location</context>
108
109 <para>
110 Директива задаёт версию браузера, начиная с которой он считается современным.
111 В качестве браузера можно задать msie, gecko (браузеры, созданные
112 на основе Mozilla) opera, safari, konqueror.
113 </para>
114
115 <para>
116 Версии можно задать в формате X, X.X, X.X.X, или X.X.X.X.
117 Максимальные значения для каждого их форматов соответственно — 4000,
118 4000.99, 4000.99.99, и 4000.99.99.99.
119 </para>
120
121 <para>
122 Специальное значение "unlisted" указывает считать современным браузер,
123 не описанный директивами modern_browser и <link id="ancient_browser"/>.
124 В противном случае неперечисленный браузер будет считаться устаревшим.
125 Если в запросе нет строки "User-Agent", то браузер считается неперечисленным.
126 </para>
127
128 </directive>
129
130
131 <directive name="modern_browser_value">
132 <syntax>modern_browser_value <value>строка</value></syntax>
133 <default>modern_browser_value 1</default>
134 <context>http, server, location</context>
135
136 <para>
137 Директива задаёт значение для переменных $modern_browser.
138 </para>
139
140 </directive>
141
142 </section>
143
144 </module>