view xml/ru/docs/http/ngx_http_index_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 c76a257f3fd4
line wrap: on
line source

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">

<module name="Директивы модуля ngx_http_index_module"
        link="/ru/docs/http/ngx_http_index_module.html"
        lang="ru">

<section name="" id="summary">

<para>
Модуль ngx_http_index_module обслуживает запросы, оканчивающиеся слэшом.
</para>

</section>


<section name="Пример конфигурации" id="example">

<para>
<example>
    location  /  {
        index  index.$geo.html  index.html;
    }
</example>
</para>

</section>


<section name="Директивы" id="directives">

<directive name="index">
<syntax>index <value>файл [файл ...]</value>
</syntax>
<default>index index.html</default>
<context>http, server, location</context>

<para>
Директива определяет файлы, которые будут использоваться в качестве индекса.
В имени файла можно использовать переменные.
Наличие файлов проверяется в порядке их перечисления.
В конце списка может стоять файл с абсолютным путём.
Пример использования:
<example>
    index  index.$geo.html  index.0.html  /index.html;
</example>
</para>

<para>
Необходимо иметь ввиду, что при использовании индексного файла делается
внутренний редирект и запрос может быть обработан уже в другом location'е.
Например, запрос "/" будет фактически обработан во втором location'е
как "/index.html" в такой конфигурации:
<example>
    location  = /  {
        index  index.html;
    }

    location  /  {
        ...
    }
</example>
</para>

</directive>

</section>

</module>