docs/manual/mod/mod_autoindex.xml.ja

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.ja.xsl"?>
   4 <!-- English Revision: 689261 -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_autoindex.xml.meta">
  24
  25 <name>mod_autoindex</name>
  26 <description>Unix の <code>ls</code> コマンドや
  27     Win32 の <code>dir</code> シェルコマンドに似た
  28     ディレクトリインデックスを生成する</description>
  29 <status>Base</status>
  30 <sourcefile>mod_autoindex.c</sourcefile>
  31 <identifier>autoindex_module</identifier>
  32
  33 <summary>
  34       <p>ディレクトリのインデックスは二つの情報源のうちの
  35       一つから生成できます:</p>
  36
  37     <ul>
  38       <li>普通は <code>index.html</code> と呼ばれる
  39       ユーザによって書かれたファイル。
  40       <directive module="mod_dir">DirectoryIndex</directive>
  41       ディレクティブでこのファイル名を設定します。
  42       これは <module>mod_dir</module> で制御されます。</li>
  43
  44       <li>もしくは、サーバによって生成された一覧。
  45       その他のディレクティブでこの一覧の書式を制御します。
  46       <directive
  47       module="mod_autoindex">AddIcon</directive>, <directive
  48       module="mod_autoindex">AddIconByEncoding</directive> と
  49       <directive module="mod_autoindex">AddIconByType</directive>
  50       を使うことで、様々なファイルタイプに対してアイコン一覧を
  51       セットします。つまり、リストされたファイル毎に、
  52       ファイルにマッチした一番最初のアイコンが表示されます。
  53       これらは <module>mod_autoindex</module> で制御されます。</li>
  54     </ul>
  55     <p>望むならば、自動インデックス生成を完全に除去 (あるいは置換)
  56     できるように、この二つの機能は分離されています。</p>
  57
  58     <p>自動インデックス生成は <code>Options +Indexes</code>
  59     を使うことで有効になります。詳細については、
  60     <directive module="core">Options</directive>
  61     ディレクティブをご覧下さい。</p>
  62
  63     <p>もし <code><a href="#indexoptions.fancyindexing"
  64     >FancyIndexing</a></code>オプションが
  65     <directive module="autoindex">IndexOptions</directive>
  66     ディレクティブに与えられているならば、
  67     列の先頭は表示の順番を制御するリンクになります。
  68     先頭のリンクを選択すると、一覧は再生成されて
  69     その列の値でソートされます。
  70     同じ先頭を続けて選択すると、交互に昇順と降順とになります。
  71     これらの列の先頭のリンクは、
  72     <directive module="mod_autoindex">IndexOptions</directive>
  73     ディレクティブの
  74     <code>SuppressColumnSorting</code>
  75     オプションで消すことができます。</p>
  76
  77     <p>"Size" でソートした場合は、用いられるのは
  78     <em>実際の</em>ファイルのサイズであって、
  79     表示の値ではないことに注意してください -
  80     たとえ両方ともが "1K" と表示されていたとしても、
  81     1010 バイトのファイルは必ず 1011
  82     バイトのファイルよりも前 (昇順の場合) に表示されます。</p>
  83 </summary>
  84
  85 <section id="query">
  86     <title>Autoindex リクエストクエリー引数</title>
  87
  88     <p>Apache 2.0.23 で、
  89     コラムソートのためにクエリー引数を再編成して、
  90     新しいクエリーオプションのグループを導入しました。
  91     出力に対するクライアントのすべての制御を効率的に抹消
  92     できるように、
  93     <code><a href="#indexoptions.ignoreclient">IndexOptions
  94     IgnoreClient</a></code> が導入されました。</p>
  95
  96     <p>コラムソートのヘッダそれ自体が、
  97     下記のソートクエリーオプションを付加する
  98     自分自身を参照するリンクです。
  99     下記のオプションのどれでも、
 100     ディレクトリリソースへのリクエストに加えることができます。</p>
 101
 102     <ul>
 103       <li><code>C=N</code> は、ファイル名でソートします。</li>
 104
 105       <li><code>C=M</code> は、更新日時、
 106       ディレクトリ、ファイル名の順でソートします。</li>
 107
 108       <li><code>C=S</code> は、サイズ、
 109       ディレクトリ、ファイル名の順でソートします。</li>
 110
 111       <li class="separate"><code>C=D</code> は、説明、
 112       ディレクトリ、ファイル名の順でソートします。</li>
 113
 114       <li><code>O=A</code> は、昇順で表をソートします。</li>
 115
 116       <li class="separate"><code>O=D</code> は、降順で表をソートします。</li>
 117
 118       <li><code>F=0</code> は、単純な表の書式にします。
 119       (FancyIndex ではありません。)</li>
 120
 121       <li><code>F=1</code> は、FancyIndex
 122       表示の表の書式にします。</li>
 123
 124       <li><code>F=2</code> は、表を HTML
 125       のテーブルを使った FancyIndex の書式にします。</li>
 126
 127       <li><code>V=0</code>
 128       は、バージョンによるソートを無効にします。</li>
 129
 130       <li class="separate"><code>V=1</code>
 131       は、バージョンによるソートを有効にします。</li>
 132
 133       <li><code>P=<var>pattern</var></code>
 134       は、与えられた <var>pattern</var>
 135       に適合したファイルのみを表示します。</li>
 136     </ul>
 137
 138     <p>"P (パターンの P)" クエリー引数は、
 139     通常の <directive module="mod_autoindex">IndexIgnore</directive>
 140     ディレクティブが処理された<em>後</em>に検査され、
 141     ファイル名全てが、他の autoindex
 142     リスト処理と同様の判定基準下に置かれ続ける
 143     ことに注意してください。
 144     <module>mod_autoindex</module> のクエリー引数パーサ (解析) は、
 145     認識不能なオプションにぶつかると即座に停止します。
 146     クエリー引数は上の表に従って
 147     正しい形式になっていなければなりません。</p>
 148
 149     <p>下の単純な例は、これらのクエリーオプションを
 150     表します。これをそのまま切り取って HEADER.html
 151     ファイルに保存することもできます。
 152     mod_autoindex が X=Go 入力にぶつかる前に
 153     引数が全て解釈されるように、
 154     未知の引数 "X" はリストの最後に置かれています。</p>
 155
 156     <example>
 157       &lt;form action="" method="get"&gt;<br />
 158       <indent>
 159         Show me a &lt;select name="F"&gt;<br />
 160         <indent>
 161           &lt;option value="0"&gt; Plain list&lt;/option&gt;<br />
 162           &lt;option value="1" selected="selected"&gt; Fancy list&lt;/option&gt;<br />
 163           &lt;option value="2"&gt; Table list&lt;/option&gt;<br />
 164         </indent>
 165         &lt;/select&gt;<br />
 166         Sorted by &lt;select name="C"&gt;<br />
 167         <indent>
 168           &lt;option value="N" selected="selected"&gt; Name&lt;/option&gt;<br />
 169           &lt;option value="M"&gt; Date Modified&lt;/option&gt;<br />
 170           &lt;option value="S"&gt; Size&lt;/option&gt;<br />
 171           &lt;option value="D"&gt; Description&lt;/option&gt;<br />
 172         </indent>
 173         &lt;/select&gt;<br />
 174         &lt;select name="O"&gt;<br />
 175         <indent>
 176           &lt;option value="A" selected="selected"&gt; Ascending&lt;/option&gt;<br />
 177           &lt;option value="D"&gt; Descending&lt;/option&gt;<br />
 178         </indent>
 179         &lt;/select&gt;<br />
 180         &lt;select name="V"&gt;<br />
 181         <indent>
 182           &lt;option value="0" selected="selected"&gt; in Normal order&lt;/option&gt;<br />
 183           &lt;option value="1"&gt; in Version order&lt;/option&gt;<br />
 184         </indent>
 185         &lt;/select&gt;<br />
 186         Matching &lt;input type="text" name="P" value="*" /&gt;<br />
 187         &lt;input type="submit" name="X" value="Go" /&gt;<br />
 188       </indent>
 189       &lt;/form&gt;
 190     </example>
 191
 192 </section>
 193
 194 <directivesynopsis>
 195 <name>AddAlt</name>
 196 <description>アイコンの代わりに
 197 表示される、ファイル名で選択された代替テキスト</description>
 198 <syntax>AddAlt <var>string</var> <var>file</var> [<var>file</var>] ...</syntax>
 199 <contextlist><context>server config</context>
 200 <context>virtual host</context>
 201 <context>directory</context><context>.htaccess</context>
 202 </contextlist>
 203 <override>Indexes</override>
 204
 205 <usage>
 206     <p><directive>AddAlt</directive> は、<code><a
 207     href="#indexoptions.fancyindexing">FancyIndexing</a></code>
 208     において、アイコンの代わりに表示する代替テキストを提供します。
 209     <var>file</var> は、説明するファイルのファイル拡張子、
 210     ファイル名の一部、ワイルドカード表現、完全なファイル名の
 211     どれかになります。
 212     <var>string</var> に空白がある場合は引用符  (<code>"</code>
 213     か <code>'</code>) で囲む必要があります。
 214     この文字列は、クライアントが画像を表示できない場合や
 215     画像のロードを無効にしている場合や
 216     アイコンの取得に失敗したときに表示されます。</p>
 217
 218     <example><title>例</title>
 219       AddAlt "PDF file" *.pdf<br />
 220       AddAlt Compressed *.gz *.zip *.Z
 221     </example>
 222 </usage>
 223 </directivesynopsis>
 224
 225 <directivesynopsis>
 226 <name>AddAltByEncoding</name>
 227 <description>アイコンの代わりに表示される、MIME 符号化方法で選択された
 228 代替テキスト</description>
 229 <syntax>AddAltByEncoding <var>string</var> <var>MIME-encoding</var>
 230 [<var>MIME-encoding</var>] ...</syntax>
 231 <contextlist><context>server config</context>
 232 <context>virtual host</context>
 233 <context>directory</context><context>.htaccess</context>
 234 </contextlist>
 235 <override>Indexes</override>
 236
 237 <usage>
 238     <p><directive>AddAltByEncoding</directive> は、
 239     <code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>
 240     において、アイコンの代わりに表示する代替文字列を提供します。
 241     <var>MIME-encoding</var> は有効な符号化、例えば
 242     <code>x-compress</code>
 243     です。
 244     <var>string</var> に空白があるときは、引用符 (<code>"</code> か
 245     <code>'</code>) で囲む必要があります。
 246     この文字列は、クライアントが画像を表示できない場合や
 247     画像のロードを無効にしている場合や
 248     アイコンの取得に失敗したときに表示されます。</p>
 249
 250     <example><title>例</title>
 251       AddAltByEncoding gzip x-gzip
 252     </example>
 253 </usage>
 254 </directivesynopsis>
 255
 256 <directivesynopsis>
 257 <name>AddAltByType</name>
 258 <description>アイコンの代わりに
 259 表示される、MIME タイプで選択された代替テキスト</description>
 260 <syntax>AddAltByType <var>string</var> <var>MIME-type</var>
 261 [<var>MIME-type</var>] ...</syntax>
 262 <contextlist><context>server config</context>
 263 <context>virtual host</context>
 264 <context>directory</context><context>.htaccess</context>
 265 </contextlist>
 266 <override>Indexes</override>
 267
 268 <usage>
 269     <p><directive>AddAltByType</directive> は、
 270     <code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>
 271     において、アイコンの代わりに表示する代替文字列を設定します。
 272     <var>MIME-type</var> は有効なタイプ、例えば
 273     <code>text/html</code>
 274     です。
 275     <var>string</var> に空白があるときは、引用符 (<code>"</code> か
 276     <code>'</code>) で囲む必要があります。
 277     この文字列は、クライアントが画像を表示できない場合や
 278     画像のロードを無効にしている場合や
 279     アイコンの取得に失敗したときに表示されます。</p>
 280
 281     <example><title>例</title>
 282       AddAltByType 'plain text' text/plain
 283     </example>
 284 </usage>
 285 </directivesynopsis>
 286
 287 <directivesynopsis>
 288 <name>AddDescription</name>
 289 <description>ファイルに対して表示する説明</description>
 290 <syntax>AddDescription <var>string</var> <var>file</var> [<var>file</var>] ...</syntax>
 291 <contextlist><context>server config</context>
 292 <context>virtual host</context>
 293 <context>directory</context><context>.htaccess</context>
 294 </contextlist>
 295 <override>Indexes</override>
 296
 297 <usage>
 298     <p><code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>
 299     において、ファイルに対して表示する説明を設定します。
 300     <var>file</var> は説明するファイルのファイル拡張子、
 301     ファイル名の一部、ワイルドカード表現、完全なファイル名の
 302     どれかになります。
 303     <var>string</var> は二重引用符 (<code>"</code>) で囲まれます。</p>
 304
 305     <example><title>例</title>
 306       AddDescription "The planet Mars" /web/pics/mars.gif
 307     </example>
 308
 309     <p>通常のデフォルトの説明領域は 23 バイトの幅です。
 310     <code><a href="#indexoptions.suppressicon"
 311     >IndexOptions SuppressIcon</a></code>
 312     オプションで 6 バイト追加、
 313     <code><a href="#indexoptions.suppresssize"
 314     >IndexOptions SuppressSize</a></code>
 315     オプションで 7 バイト追加、
 316     <code><a href="#indexoptions.suppresslastmodified"
 317     >IndexOptions SuppressLastModified</a></code>
 318     オプションで 19 バイト追加されます。
 319     ですから、デフォルトの説明コラムの最大幅は
 320     55 バイトになります。</p>
 321
 322     <p>このコラムの大きさを上書きしたり、
 323     説明が無制限長でもよいようにするための詳細に関しては、
 324     <a href="#indexoptions.descriptionwidth">DescriptionWidth</a>
 325     という
 326     <directive module="mod_autoindex">IndexOptions</directive>
 327     のキーワードをご覧下さい。</p>
 328
 329     <note><title>警告</title>
 330       <p><directive>AddDescription</directive>
 331       で定義された説明テキストは、タグや文字列といった
 332       HTML マークアップを含むことができます。
 333       もし、説明コラムの幅によってタグ付けされた要素が丸め込まれた
 334        (太字の語句の最後が切れるといった) 場合、
 335       出力結果は、ディレクトリ一覧の残りの部分に影響を与えるでしょう。</p>
 336     </note>
 337 </usage>
 338 </directivesynopsis>
 339
 340 <directivesynopsis>
 341 <name>AddIcon</name>
 342 <description>ファイルに表示するアイコンを名前で選択</description>
 343 <syntax>AddIcon <var>icon</var> <var>name</var>
 344 [<var>name</var>] ...</syntax>
 345 <contextlist><context>server config</context>
 346 <context>virtual host</context>
 347 <context>directory</context><context>.htaccess</context>
 348 </contextlist>
 349 <override>Indexes</override>
 350
 351 <usage>
 352     <p><code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>
 353     において、
 354     <var>name</var> で終わるファイルの隣に表示するアイコンを設定します。
 355     <var>icon</var> は、(% でエスケープされた) アイコンへの相対 URL
 356     か、他の書式 (<var>alttext</var>, <var>url</var>) です。
 357     ここで <var>alttext</var>
 358     は、非グラフィカルブラウザ向けにアイコンに付けられたテキストタグです。
 359     </p>
 360
 361     <p><var>name</var> は、ディレクトリに対応する <code>^^DIRECTORY^^</code>
 362     か、空白行に対応する <code>^^BLANKICON^^</code>  (一覧が正しく表示されるために) か、
 363     ファイル拡張子か、ワイルドカード表現か、ファイル名の一部か
 364     完全なファイル名です。</p>
 365
 366     <example><title>例</title>
 367       AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm<br />
 368       AddIcon /icons/dir.xbm ^^DIRECTORY^^<br />
 369       AddIcon /icons/backup.xbm *~
 370     </example>
 371
 372     <p>もし可能なら、
 373     <directive>AddIcon</directive>
 374     より
 375     <directive module="mod_autoindex">AddIconByType</directive>
 376     を優先的に使うべきでしょう。</p>
 377 </usage>
 378 </directivesynopsis>
 379
 380 <directivesynopsis>
 381 <name>AddIconByEncoding</name>
 382 <description>ファイルに表示するアイコンを MIME
 383 符号化方法で選択</description>
 384 <syntax>AddIconByEncoding <var>icon</var> <var>MIME-encoding</var>
 385 [<var>MIME-encoding</var>] ...</syntax>
 386 <contextlist><context>server config</context>
 387 <context>virtual host</context>
 388 <context>directory</context><context>.htaccess</context>
 389 </contextlist>
 390 <override>Indexes</override>
 391
 392 <usage>
 393     <p><code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>
 394     において、ファイルの隣に表示するアイコンを設定します。
 395     <var>icon</var> は、(% でエスケープされた) アイコンへの相対 URL
 396     か、他の書式 <code>(<var>alttext</var>, <var>url</var>)</code> です。
 397     ここで <var>alttext</var>
 398     は、非グラフィカルブラウザ向けにアイコンに付けられたテキストタグです。
 399     </p>
 400
 401     <p><var>MIME-encoding</var> は、有効なコンテントエンコーディング、
 402     例えば <code>x-compress</code>です。</p>
 403
 404     <example><title>例</title>
 405       AddIconByEncoding /icons/compress.xbm x-compress
 406     </example>
 407 </usage>
 408 </directivesynopsis>
 409
 410 <directivesynopsis>
 411 <name>AddIconByType</name>
 412 <description>ファイルの隣に表示するアイコンを
 413 MIME タイプによって選択</description>
 414 <syntax>AddIconByType <var>icon</var> <var>MIME-type</var>
 415 [<var>MIME-type</var>] ...</syntax>
 416 <contextlist><context>server config</context>
 417 <context>virtual host</context>
 418 <context>directory</context><context>.htaccess</context>
 419 </contextlist>
 420 <override>Indexes</override>
 421
 422 <usage>
 423     <p><code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>
 424     において、ファイルの隣に表示するアイコンを設定します。
 425     <var>icon</var> は、(% でエスケープされた) アイコンへの相対 URL
 426     か、他の書式 <code>(<var>alttext</var>, <var>url</var>)</code> です。
 427     ここで <var>alttext</var>
 428     は、非グラフィカルブラウザ向けにアイコンに付けられたテキストタグです。
 429     </p>
 430
 431     <p><var>MIME-type</var> は、要求されたタイプに該当する
 432     ワイルドカード表現です。</p>
 433
 434     <example><title>例</title>
 435       AddIconByType (IMG,/icons/image.xbm) image/*
 436     </example>
 437 </usage>
 438 </directivesynopsis>
 439
 440 <directivesynopsis>
 441 <name>DefaultIcon</name>
 442 <description>特定のアイコンが何も設定されていない時に
 443 ファイルに表示するアイコン</description>
 444 <syntax>DefaultIcon <var>url-path</var></syntax>
 445 <contextlist><context>server config</context>
 446 <context>virtual host</context>
 447 <context>directory</context><context>.htaccess</context>
 448 </contextlist>
 449 <override>Indexes</override>
 450
 451 <usage>
 452     <p><code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>
 453     において、
 454     特定のアイコンがない場合にファイルに表示するアイコンを設定します。
 455     <var>url-path</var> は、(% でエスケープされた) アイコンへの相対 URL
 456     です。</p>
 457
 458     <example><title>例</title>
 459       DefaultIcon /icon/unknown.xbm
 460     </example>
 461 </usage>
 462 </directivesynopsis>
 463
 464 <directivesynopsis>
 465 <name>HeaderName</name>
 466 <description>
 467 インデックス一覧の先頭に挿入されるファイルの名前</description>
 468 <syntax>HeaderName <var>filename</var></syntax>
 469 <contextlist><context>server config</context>
 470 <context>virtual host</context>
 471 <context>directory</context><context>.htaccess</context>
 472 </contextlist>
 473 <override>Indexes</override>
 474
 475 <usage>
 476     <p><directive>HeaderName</directive>
 477     ディレクティブは、
 478     インデックス一覧の先頭に挿入するファイルの名前を設定します。
 479     <var>Filename</var> は取り込むファイルの名前です。</p>
 480
 481     <example><title>例</title>
 482       HeaderName HEADER.html
 483     </example>
 484
 485     <note>
 486       <p>HeaderName も <directive
 487       module="mod_autoindex">ReadmeName</directive>
 488       も両方とも現在は、<var>filename</var>
 489       をインデックスされているディレクトリに用いられた URI
 490       に対する相対 URI パスとして扱います。
 491       <var>filename</var> がスラッシュで始まる場合は、
 492       <directive module="core">DocumentRoot</directive>
 493       からの相対パスとなります。</p>
 494
 495       <example><title>例</title>
 496         HeaderName /include/HEADER.html
 497       </example>
 498
 499       <p><var>filename</var> は
 500       メジャーコンテントタイプが "<code>text/*</code>"
 501        (<em>例えば</em>、<code>text/html</code>,
 502       <code>text/plain</code> 等です。)
 503       のドキュメントとして解決
 504       されなければなりません。これはつまり、
 505       もし CGI スクリプトの実際のファイルタイプが
 506       次のディレクティブのようにして実際の出力とは異なって
 507       <code>text/html</code> としてマークされている場合、
 508       <var>filename</var>
 509       は CGI スクリプトを参照するかも知れない、
 510       ということを意味します:</p>
 511
 512       <example>
 513         AddType text/html .cgi
 514       </example>
 515
 516       <p><directive module="core">Options</directive> <code>MultiViews</code> が
 517       有効になっている場合は、
 518       <a href="../content-negotiation.html">コンテントネゴシエーション</a>
 519       が行なわれます。
 520       もし <var>filename</var> が (CGI スクリプトでない) 静的な
 521       <code>text/html</code> ドキュメントで解決され、
 522       <directive module="core">options</directive>
 523       <code>Includes</code> か <code>IncludesNOEXEC</code>
 524       が有効になっている場合は、
 525       ファイルはサーバーサイドインクルードで処理されます
 526       (<module>mod_include</module> ドキュメントを参照して下さい)。</p>
 527     </note>
 528
 529     <p>もし <directive>HeaderName</directive> で指定されたファイルが
 530     HTML ドキュメントの開始部分 (&lt;html&gt;, &lt;head&gt;,
 531     等) を含んでいたら、
 532     <a href="#indexoptions.suppresshtmlpreamble"><code>IndexOptions
 533     +SuppressHTMLPreamble</code></a>
 534     を設定して、これらのタグが繰り返されないようにしたいと思うでしょう。</p>
 535 </usage>
 536 </directivesynopsis>
 537
 538 <directivesynopsis>
 539 <name>IndexIgnore</name>
 540 <description>ディレクトリ一覧を行なう際に無視すべき
 541 ファイルリストに追加</description>
 542 <syntax>IndexIgnore <var>file</var> [<var>file</var>] ...</syntax>
 543 <contextlist><context>server config</context>
 544 <context>virtual host</context>
 545 <context>directory</context><context>.htaccess</context>
 546 </contextlist>
 547 <override>Indexes</override>
 548
 549 <usage>
 550     <p><directive>IndexIgnore</directive> ディレクティブは、
 551     ディレクトリの一覧を行う際に無視すべきファイルリストに追加します。
 552     <var>file</var> は、
 553     シェル形式のワイルドカード表現か完全なファイル名です。
 554     IndexIgnore が複数ある場合は、無視するリストに追加が行われ、
 555     置換は行われません。デフォルトではリストには <code>.</code>
 556     (カレントディレクトリ) が含まれています。</p>
 557
 558     <example>
 559       IndexIgnore README .htaccess *.bak *~
 560     </example>
 561 </usage>
 562 </directivesynopsis>
 563
 564 <directivesynopsis>
 565 <name>IndexOptions</name>
 566 <description>ディレクトリインデックスの様々な設定項目
 567 </description>
 568 <syntax>IndexOptions  [+|-]<var>option</var> [[+|-]<var>option</var>] ...</syntax>
 569 <contextlist><context>server config</context>
 570 <context>virtual host</context>
 571 <context>directory</context><context>.htaccess</context>
 572 </contextlist>
 573 <override>Indexes</override>
 574
 575 <usage>
 576     <p><directive>IndexOptions</directive>
 577     は、ディレクトリインデックスの挙動を指定します。
 578     <var>option</var> は次のどれかです:</p>
 579
 580     <dl>
 581       <dt><a name="indexoptions.charset"
 582                id="indexoptions.charset"
 583       >Charset=<var>character-set</var></a> (<em>Apache 2.0.61
 584       以降</em>)</dt>
 585
 586       <dd><code>Charset</code> キーワードで、
 587       生成されるページの文字セットを指定できます。
 588       下位のファイルシステムが Unicode ベースかどうかに依存しますが、
 589       デフォルト値は <var>ISO-8859-1</var> か <var>UTF-8</var>
 590       になります。
 591
 592       <example><title>Example:</title>
 593         IndexOptions Charset=UTF-8
 594       </example>
 595       </dd>
 596
 597       <dt><a name="indexoptions.type"
 598                id="indexoptions.type"
 599       >Type=<var>MIME content-type</var></a> (<em>Apache 2.0.61
 600       以降</em>)</dt>
 601
 602       <dd><code>Type</code> キーワードで、
 603       生成されるページの MIME コンテントタイプを指定できます。
 604       デフォルト値は <var>text/html</var> になります。
 605
 606       <example><title>Example:</title>
 607         IndexOptions Type=text/plain
 608       </example>
 609       </dd>
 610
 611       <dt><a name="indexoptions.descriptionwidth"
 612                id="indexoptions.descriptionwidth"
 613       >DescriptionWidth=[<var>n</var> | *]</a>
 614       (<em>2.0.23 以降</em>)</dt>
 615
 616       <dd><code>DescriptionWidth</code>
 617       キーワードは説明コラムの幅を文字数で指定することができます。</dd>
 618
 619       <dd><code>-DescriptionWidth</code> (または非設定) で、
 620       <module>mod_autoindex</module> が最適な幅を計算するようにできます。</dd>
 621
 622       <dd><code>DescriptionWidth=<var>n</var></code>
 623       で、コラム幅を <var>n</var> バイトに固定します。</dd>
 624
 625       <dd><code>DescriptionWidth=*</code>
 626       は、最長の説明に合わせて必要な長さまでコラムを延ばします。</dd>
 627
 628       <dd><strong>説明を丸め込んだ場合特有の危険については
 629       <directive module="mod_autoindex">AddDescription</directive>
 630       セクションをお読み下さい。</strong></dd>
 631
 632       <dt><a name="indexoptions.fancyindexing"
 633                id="indexoptions.fancyindexing">FancyIndexing</a></dt>
 634
 635       <dd>飾り付きインデックスをオンにします。</dd>
 636
 637       <dt><a name="indexoptions.foldersfirst"
 638                id="indexoptions.foldersfirst">FoldersFirst</a>
 639       (<em>2.0.23 以降</em>)</dt>
 640
 641       <dd>このオプションが有効になった場合、サブディレクトリの一覧は
 642       <em>必ず</em>最初に現われて、通常のファイルはその後に続きます。
 643       一覧は基本的には、ファイルとディレクトリの二つの部分に分けられて、
 644       それぞれは別々にソートされ、その後サブディレクトリを先にして
 645       表示が行なわれます。例えばソート順が名前の降順になっていて、
 646       <code>FoldersFirst</code> が有効になっている場合は、
 647       サブディレクトリ <code>Zed</code> はサブディレクトリ
 648       <code>Beta</code> よりも前にリストされ、通常のファイル
 649       <code>Gamma</code> や <code>Alpha</code>
 650       よりも前にリストされます。<strong>このオプションは
 651       <a href="#indexoptions.fancyindexing"><code>FancyIndexing</code></a>
 652       も有効になっているときにのみ有効です。</strong></dd>
 653
 654       <dt><a name="indexoptions.htmltable"
 655                id="indexoptions.htmltable">HTMLTable</a> <em>(実験的、
 656       Apache 2.0.23 以降)</em></dt>
 657
 658       <dd>この実験的なオプションは <code>FancyIndexing</code> とともに指定することで、
 659       飾りの付いたディレクトリ一覧のためにテーブルを使った単純な表を作ります。
 660       これは古いブラウザを混乱させるかもしれないことに注意してください。
 661       WinNT やその他 utf-8
 662       が有効なプラットホームのように、ファイル名や説明テキストが
 663       右読みになったり左読みになりえる場合は特に必要です。</dd>
 664
 665       <dt><a name="indexoptions.iconsarelinks"
 666                id="indexoptions.iconsarelinks">IconsAreLinks</a></dt>
 667
 668       <dd>これは、FancyIndexing において、
 669       アイコンもファイル名へのリンクの一部にします。</dd>
 670
 671       <dt><a name="indexoptions.iconheight"
 672                id="indexoptions.iconheight">IconHeight[=<var
 673                >pixels</var>]</a></dt>
 674
 675       <dd>このオプションが、<code>IconWidth</code> とともに
 676       使われている場合は、サーバはファイルアイコンのための
 677       <code>img</code> タグに <code>height</code> と <code>width</code>
 678       属性を取り込むようになります。
 679       これによって、イメージ全てをロードし終わるまで待たなくても、
 680       ブラウザはページレイアウトをあらかじめ計算することができます。
 681       このオプションに何も値が与えられなければ、Apache
 682       ソフトウェアで提供されているアイコンの標準の高さが
 683       デフォルトなります。</dd>
 684
 685       <dt><a name="indexoptions.iconwidth"
 686                id="indexoptions.iconwidth">IconWidth[=<var
 687                >pixels</var>]</a></dt>
 688
 689       <dd>このオプションが、<code>IconHeight</code> とともに使われている場合は、
 690       サーバはファイルアイコンのための <code>img</code>
 691       タグに <code>height</code> と <code>width</code>
 692       属性を取り込むようになります。
 693       これによって、イメージ全てをロードし終わるまで待たなくても、
 694       ブラウザはページレイアウトをあらかじめ計算することができます。
 695       このオプションに何も値が与えられなければ、Apache
 696       ソフトウェアで提供されているアイコンの標準の高さが
 697       デフォルトなります。</dd>
 698
 699       <dt><a name="indexoptions.ignorecase"
 700                id="indexoptions.ignorecase">IgnoreCase</a></dt>
 701
 702       <dd>このオプションが有効であると、ファイル名は大文字小文字を区別せずにソートされます。
 703       例えばファイル名が昇順でソートされ、<code>IgnoreCase</code> が有効であれば、
 704       Zeta は alfa の後にリストされます
 705       (注意: GAMMA は常に gamma の前になります)。</dd>
 706
 707       <dt><a name="indexoptions.ignoreclient"
 708                id="indexoptions.ignoreclient">IgnoreClient</a></dt>
 709
 710       <dd>このオプションで <module>mod_autoindex</module> は、
 711       クライアントからの全てのクエリー変数を無視するようになります。
 712       これはソート順も含みます。
 713       (つまり <code><a href="#indexoptions.suppresscolumnsorting"
 714       >SuppressColumnSorting</a></code>
 715       も有効になります。)</dd>
 716
 717       <dt><a name="indexoptions.namewidth"
 718                id="indexoptions.namewidth">NameWidth=[<var>n</var>
 719                | *]</a></dt>
 720
 721       <dd><code>NameWidth</code> キーワードでファイル名コラムの幅をバイト数で
 722       指定できます。</dd>
 723
 724       <dd><code>-NameWidth</code> (または非設定) で、
 725       <module>mod_autoindex</module> が最適な幅を計算するようにできます。</dd>
 726
 727       <dd><code>NameWidth=<var>n</var></code>
 728       で、コラム幅を <var>n</var> バイトに固定します。</dd>
 729
 730       <dd><code>NameWidth=*</code>
 731       は、必要な長さまでコラムを延ばします。</dd>
 732
 733       <dt><a name="indexoptions.scanhtmltitles"
 734                id="indexoptions.scanhtmltitles">ScanHTMLTitles</a></dt>
 735
 736       <dd>FancyIndexing のために、
 737        HTML ドキュメントからタイトルを取り出すことを可能にします。
 738       もしファイルに
 739       <directive module="mod_autoindex">AddDescription</directive>
 740       で説明が与えられていなければ、
 741       httpd は <code>title</code> タグの値を読むためにドキュメントを読み始めます。
 742       これは CPU や disk に負荷をかけます。</dd>
 743
 744       <dt><a name="indexoptions.showforbidden"
 745                id="indexoptions.showforbidden">ShowForbidden</a></dt>
 746
 747       <dd>通常 Apache はサブリクエストの結果が<code>HTTP_UNAUTHORIZED</code> や
 748       <code>HTTP_FORBIDDEN</code> のファイルは一覧に表示しません。
 749       このオプションを指定すると、そのようなファイルも一覧に表示します。</dd>
 750
 751       <dt><a name="indexoptions.suppresscolumnsorting"
 752                id="indexoptions.suppresscolumnsorting"
 753                >SuppressColumnSorting</a></dt>
 754
 755       <dd>もし指定されていれば、Apache は
 756       FancyIndexing で表示されているディレクトリ一覧での
 757       コラムの先頭を、ソートのためのリンクにしなくなります。
 758       デフォルトの挙動は、リンクとします。
 759       コラムの先頭を選ぶとコラムの値に従ってディレクトリリストを
 760       ソートします。
 761       <strong>Apache 2.0.23 以前では、これは同時に
 762       ソート文字列のためのクエリー引数の解析も無効にします。
 763       </strong>
 764       この挙動は Apache 2.0.23 では
 765       <a href="#indexoptions.ignoreclient"><code>IndexOptions
 766       IgnoreClient</code></a> で制御されるようになっています。</dd>
 767
 768       <dt><a name="indexoptions.suppressdescription"
 769                id="indexoptions.suppressdescription"
 770                >SuppressDescription</a></dt>
 771
 772       <dd>これは FancyIndexing におけるファイルの説明を消去します。
 773       デフォルトでは、説明は定義されておらず、
 774       このオプションを使うと他のために 23
 775       文字の空白を稼ぐことができます。 ファイルの説明に関する情報は、
 776       <directive module="mod_autoindex">AddDescription</directive>
 777       をご覧下さい。また、説明のコラムサイズを制限する
 778       <code><a href="#indexoptions.descriptionwidth">DescriptionWidth</a></code>
 779       インデックスオプションもご覧下さい。</dd>
 780
 781       <dt><a name="indexoptions.suppresshtmlpreamble"
 782                id="indexoptions.suppresshtmlpreamble"
 783                >SuppressHTMLPreamble</a></dt>
 784
 785       <dd>通常、
 786       <directive module="mod_autoindex">HeaderName</directive>
 787       ディレクティブで指定したファイルを
 788       ディレクトリが実際に含んでいれば、標準的な HTML プリアンブル
 789       (<code>&lt;html&gt;</code>, <code>&lt;head&gt;</code>, <em>等</em>) の後に、
 790       モジュールはファイルの中身をインクルードします。
 791       <code>SuppressHTMLPreamble</code> オプションは、
 792       この挙動を無効にできて、
 793       モジュールがヘッダーファイルの中身から表示を始めます。
 794       この場合、ヘッダーファイルは正しい HTML
 795       命令を含んでいなければなりません。
 796       ヘッダーファイルが存在しない場合は、プリアンブルは通常通り
 797       生成されます。</dd>
 798
 799       <dt><a name="indexoptions.suppressicon"
 800                id="indexoptions.suppressicon">SuppressIcon</a> (<em>Apache
 801       2.0.23 以降</em>)</dt>
 802
 803       <dd>
 804       これは FancyIndexing の一覧からアイコンを消去します。
 805       <code>SuppressIcon</code> と <code>SuppressRules</code>
 806       と組合わせることによって正しい HTML 3.2 の出力が得られます。
 807       HTML 3.2 の最終規格は、 <code>img</code> と <code>hr</code>
 808       が <code>pre</code> ブロックに入る (FancyIndexing 一覧で書式に使われています)
 809       ことを禁止しています。</dd>
 810
 811       <dt><a name="indexoptions.suppresslastmodified"
 812                id="indexoptions.suppresslastmodified"
 813                >SuppressLastModified</a></dt>
 814
 815       <dd>FancyIndexing 一覧において最終更新日時の表示を消去します。</dd>
 816
 817       <dt><a name="indexoptions.suppressrules"
 818                id="indexoptions.suppressrules">SuppressRules</a>
 819        (<em>Apache 2.0.23 以降</em>) </dt>
 820
 821       <dd>ディレクトリ一覧において水平区切り線 (<code>hr</code> タグ) を消去します。
 822       <code>SuppressIcon</code> と <code>SuppressRules</code>
 823       と組合わせることによって正しい HTML 3.2 の出力が得られます。
 824       HTML 3.2 の最終規格は、 <code>img</code> と <code>hr</code>
 825       が <code>pre</code> ブロックに入る (FancyIndexing 一覧で書式に使われています)
 826       ことを禁止しています。</dd>
 827
 828       <dt><a name="indexoptions.suppresssize"
 829                id="indexoptions.suppresssize">SuppressSize</a></dt>
 830
 831       <dd>FancyIndexing 一覧においてファイルサイズの表示を消去します。</dd>
 832
 833       <dt><a name="indexoptions.trackmodified"
 834                id="indexoptions.trackmodified">TrackModified</a>
 835                (<em>Apache 2.0.23 以降</em>)</dt>
 836
 837       <dd>これは HTTP ヘッダ中に、
 838       ディレクトリの <code>Last-Modified</code> や
 839       <code>ETag</code> を含めます。
 840       これは、オペレーティングシステムやファイルシステムが
 841       適切な stat() の返り値を返す場合にのみ有効です。
 842       いくつかの UNIX システム、OS2 の JFS や Win32 の NTFS
 843       ボリュームはそうなっています。
 844       例えば、OS2 と Win32 FAT ボリュームはそうではありません。
 845       この機能が有効になると、クライアントやプロキシは
 846       <code>HEAD</code> リクエストを行うことによって、
 847       ファイル一覧の変化を追跡することができるようになります。
 848       オペレーティングシステムによっては、新規ファイルや
 849       移動ファイルは正しく追跡するけれども、
 850       ディレクトリ中のファイルのサイズや日付は追跡しないということに
 851       注意してください。
 852       <strong>既に存在するファイルのサイズや日付のスタンプが変化しても、
 853       全ての Unix プラットホームでは、
 854       <code>Last-Modified</code> ヘッダーを更新しません。</strong>
 855       もしこれが重要であれば、
 856       このオプションを無効のままにしてください。</dd>
 857
 858       <dt><a name="indexoptions.versionsort"
 859                id="indexoptions.versionsort">VersionSort</a>
 860       (<em>Apache 2.0a3 以降</em>)</dt>
 861
 862       <dd><code>VersionSort</code> キーワードはバージョン番号を含んだファイルが
 863       自然な方法でソートされるようにします。
 864       文字列は通常通りソートされ、
 865       それ以外の、説明や名前中の数となる部分文字列は
 866       その数値で比較されます。
 867
 868       <example><title>例:</title>
 869         foo-1.7<br />
 870         foo-1.7.2<br />
 871         foo-1.7.12<br />
 872         foo-1.8.2<br />
 873         foo-1.8.2a<br />
 874         foo-1.12
 875       </example>
 876
 877       <p>番号が 0 から始まる場合は、端数と考えられます</p>
 878
 879       <example>
 880         foo-1.001<br />
 881         foo-1.002<br />
 882         foo-1.030<br />
 883         foo-1.04
 884       </example>
 885       </dd>
 886
 887       <dt><a name="indexoptions.xhtml"
 888                id="indexoptions.xhtml">XHTML</a>
 889       (<em>Apache 2.0.49 以降</em>)</dt>
 890
 891       <dd><code>XHTML</code> キーワードを指定すると、<module>mod_autoindex</module>
 892       は HTML 3.2 の代わりに XHTML 1.0 のコードを出力するようになります。</dd>
 893     </dl>
 894
 895    <!--
 896      XXX: we should consider to allow sections inside <usage>
 897      this would require some xslt changes...
 898    -->
 899    <dl><dt>増減指定できる IndexOptions</dt>
 900    <dd>
 901      <p>Apache 1.3.3 では、
 902      <directive>IndexOptions</directive>
 903      ディレクティブの扱いで幾つかの大きな変化が導入されました。
 904      特に、</p>
 905
 906      <ul>
 907      <li>一つのディレクトリに対する複数の
 908      <directive>IndexOptions</directive>
 909      ディレクティブは、現在では一つにマージされます。
 910
 911      <example>
 912        &lt;Directory /foo&gt;
 913        <indent>
 914          IndexOptions HTMLTable<br />
 915          IndexOptions SuppressColumnsorting
 916        </indent>
 917        &lt;/Directory&gt;
 918      </example>
 919
 920      <p>の結果は、次の指定と同一の結果になります。</p>
 921
 922      <example>
 923        IndexOptions HTMLTable SuppressColumnsorting
 924      </example>
 925      </li>
 926
 927      <li>増減構文
 928      (<em>すなわち</em>、'+' や '-'
 929      の接頭辞が付くキーワード) の追加。</li>
 930      </ul>
 931
 932      <p>'+' や '-' 接頭辞の付いたキーワードに出会うとそれは、
 933      その時点での <directive>IndexOptions</directive>
 934      の設定 (これは上流のディレクトリを受け継ぎます)
 935      に対して適応されます。
 936      しかしながら、接頭辞の付かないキーワードが処理された場合は、
 937      受け継いだオプション全てとそれまで出会った増減設定全てが
 938      消去されます。次の例を考えてみてください:</p>
 939
 940      <example>
 941        IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing<br />
 942        IndexOptions +SuppressSize
 943      </example>
 944
 945      <p>最終的な効果は
 946      <code>IndexOptions&nbsp;FancyIndexing&nbsp;+SuppressSize</code>
 947      と同一です。
 948      接頭辞の付かない <code>FancyIndexing</code>
 949      でそれ以前の増減キーワードは無効になり、
 950      その後の累積が始まるからです。</p>
 951
 952      <p>あるディレクトリにおいて上位のディレクトリに指定された設定に影響されることなく
 953      <directive>IndexOptions</directive> を設定したい場合、
 954      <code>+</code> や <code>-</code>
 955      接頭辞の付かないキーワードで設定してください。</p>
 956    </dd>
 957    </dl>
 958 </usage>
 959 </directivesynopsis>
 960
 961 <directivesynopsis>
 962 <name>IndexOrderDefault</name>
 963 <description>
 964 ディレクトリインデックスの標準の順番付けを設定</description>
 965 <syntax>IndexOrderDefault Ascending|Descending
 966 Name|Date|Size|Description</syntax>
 967 <default>IndexOrderDefault Ascending Name</default>
 968 <contextlist><context>server config</context>
 969 <context>virtual host</context>
 970 <context>directory</context><context>.htaccess</context>
 971 </contextlist>
 972 <override>Indexes</override>
 973
 974 <usage>
 975     <p><directive>IndexOrderDefault</directive> ディレクティブは
 976     <code><a href="#indexoptions.fancyindexing">FancyIndexing</a></code>
 977     インデックスオプションと併せて用いられます。
 978     デフォルトでは、FancyIndexing
 979     のディレクトリ一覧はファイル名の昇順で表示されます。
 980     <directive>IndexOrderDefault</directive>
 981     で、初期状態の表示順番を変えることができます。</p>
 982
 983     <p><directive>IndexOrderDefault</directive>
 984     は二つの引数をとります。一つ目はソートの方向を指示する
 985     <code>Ascending</code> か <code>Descending</code> のいずれかです。
 986     二つ目の引数は <code>Name</code>, <code>Date</code>,
 987     <code>Size</code> か <code>Description</code>
 988     のいずれか一つのキーワードであって、1つ目のソートキーを指定します。
 989     2つ目のソートキーは<em>常に</em>ファイル名の昇順になります。</p>
 990
 991     <p>このディレクティブと <code><a
 992     href="#indexoptions.suppresscolumnsorting">SuppressColumnSorting</a></code>
 993     インデックスオプションとを組み合わせることで、
 994     ディレクトリ一覧をある特定の順番でのみ表示するようにできます。
 995     これは、
 996     クライアントが別の順番でディレクトリ一覧をリクエストすることを防ぎます。</p>
 997 </usage>
 998 </directivesynopsis>
 999
1000 <directivesynopsis>
1001 <name>IndexStyleSheet</name>
1002 <description>ディレクトリインデックスに CSS スタイルシートを追加する</description>
1003 <syntax>IndexStyleSheet <var>url-path</var></syntax>
1004 <contextlist><context>server config</context><context>virtual host</context>
1005 <context>directory</context><context>.htaccess</context>
1006 </contextlist>
1007 <override>Indexes</override>
1008
1009 <usage>
1010     <p><directive>IndexStyleSheet</directive> ディレクティブは
1011     インデックス表示に使用される CSS のファイル名を設定します。
1012     </p>
1013     <example>
1014       <title>例</title>
1015       IndexStyleSheet "/css/style.css"
1016     </example>
1017 </usage>
1018 </directivesynopsis>
1019
1020 <directivesynopsis>
1021 <name>IndexHeadInsert</name>
1022 <description>インデックスページの HEAD セクションにテキストを挿入する</description>
1023 <syntax>IndexHeadInsert <var>"markup ..."</var></syntax>
1024 <contextlist><context>server config</context><context>virtual host</context>
1025 <context>directory</context><context>.htaccess</context>
1026 </contextlist>
1027 <override>Indexes</override>
1028
1029 <usage>
1030     <p><directive>IndexHeadInsert</directive> ディレクティブを使って
1031     インデックスとして生成されたHTMLの <var>&lt;head&gt;</var> セクションに
1032     挿入する文字列を指定します。</p>
1033     <example>
1034       <title>Example</title>
1035       IndexHeadInsert "&lt;link rel=\"sitemap\" href=\"/sitemap.html\"&gt;"
1036     </example>
1037 </usage>
1038 </directivesynopsis>
1039
1040 <directivesynopsis>
1041 <name>ReadmeName</name>
1042 <description>インデックス一覧の最後に挿入されるファイルの名前</description>
1043 <syntax>ReadmeName <var>filename</var></syntax>
1044 <contextlist><context>server config</context>
1045 <context>virtual host</context>
1046 <context>directory</context><context>.htaccess</context>
1047 </contextlist>
1048 <override>Indexes</override>
1049
1050 <usage>
1051     <p><directive>ReadmeName</directive> ディレクティブは、
1052     インデックスの終わりに付け加えられるファイルの名前を設定します。
1053     <var>filename</var> は挿入するファイルの名前で、
1054     一覧の行われている位置から相対的なものとして解釈されます。
1055     <var>filename</var> がスラッシュで始まる場合は、
1056     <directive module="core">DocumentRoot</directive>
1057     からの相対パスとなります。</p>
1058
1059     <example><title>例</title>
1060       ReadmeName FOOTER.html
1061     </example>
1062
1063     <example><title>例 2</title>
1064     ReadmeName /include/FOOTER.html
1065     </example>
1066
1067     <p>より詳細にまでこの挙動について記述している <directive
1068     module="mod_autoindex">HeaderName</directive>
1069     もご覧下さい。</p>
1070 </usage>
1071 </directivesynopsis>
1072
1073 </modulesynopsis>