Skip to content

Commit 09f8c80

Browse files
author
Andre Malo
committed
fix links to the options directive.
(hope to) clarify, when parameters have to be quoted for the AddAlt* directives (please correct my English if neccessary :) git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@96778 13f79535-47bb-0310-9956-ffa450edef68
1 parent 9b5ffa9 commit 09f8c80

2 files changed

Lines changed: 44 additions & 41 deletions

File tree

docs/manual/mod/mod_autoindex.html.en

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -156,14 +156,15 @@ icon selected by filename</td></tr><tr><th><a href="directive-dict.html#Syntax">
156156
display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
157157
<em>File</em> is a file extension, partial filename, wild-card
158158
expression or full filename for files to describe.
159-
<em>String</em> is enclosed in double quotes (<code>"</code>).
160-
This alternate text is displayed if the client is image-incapable,
161-
has image loading disabled, or fails to retrieve the icon.</p>
159+
If <em>String</em> contains any whitespace, you have to enclose it
160+
in quotes (<code>"</code> or <code>'</code>). This alternate text
161+
is displayed if the client is image-incapable, has image loading
162+
disabled, or fails to retrieve the icon.</p>
162163
163164
<p>Examples:</p>
164165
<div class="example"><p><code>
165-
AddAlt "PDF" *.pdf<br />
166-
AddAlt "Compressed" *.gz *.zip *.Z
166+
AddAlt "PDF file" *.pdf<br />
167+
AddAlt Compressed *.gz *.zip *.Z
167168
</code></p></div>
168169
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddAltByEncoding" id="AddAltByEncoding">AddAltByEncoding</a> <a name="addaltbyencoding" id="addaltbyencoding">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
169170
</a></th><td>Alternate text to display for a file instead of an icon
@@ -177,14 +178,14 @@ selected by MIME-encoding</td></tr><tr><th><a href="directive-dict.html#Syntax">
177178
<p><code class="directive">AddAltByEncoding</code> provides the alternate
178179
text to display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
179180
<em>MIME-encoding</em> is a valid content-encoding, such as
180-
<code>x-compress</code>. <em>String</em> is enclosed in double
181-
quotes (<code>"</code>). This alternate text is displayed if the
182-
client is image-incapable, has image loading disabled, or fails to
183-
retrieve the icon.</p>
181+
<code>x-compress</code>. If <em>String</em> contains any whitespace,
182+
you have to enclose it in quotes (<code>"</code> or <code>'</code>).
183+
This alternate text is displayed if the client is image-incapable,
184+
has image loading disabled, or fails to retrieve the icon.</p>
184185
185186
<p>Example:</p>
186187
<div class="example"><p><code>
187-
AddAltByEncoding "gzip" x-gzip
188+
AddAltByEncoding gzip x-gzip
188189
</code></p></div>
189190
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddAltByType" id="AddAltByType">AddAltByType</a> <a name="addaltbytype" id="addaltbytype">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
190191
</a></th><td>Alternate text to display for a file, instead of an
@@ -198,14 +199,14 @@ icon selected by MIME content-type</td></tr><tr><th><a href="directive-dict.html
198199
<p><code class="directive">AddAltByType</code> sets the alternate text to
199200
display for a file, instead of an icon, for <code><a href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
200201
<em>MIME-type</em> is a valid content-type, such as
201-
<code>text/html</code>. <em>String</em> is enclosed in double
202-
quotes (<code>"</code>). This alternate text is displayed if the
203-
client is image-incapable, has image loading disabled, or fails to
204-
retrieve the icon.</p>
202+
<code>text/html</code>. If <em>String</em> contains any whitespace,
203+
you have to enclose it in quotes (<code>"</code> or <code>'</code>).
204+
This alternate text is displayed if the client is image-incapable,
205+
has image loading disabled, or fails to retrieve the icon.</p>
205206
206207
<p>Example:</p>
207208
<div class="example"><p><code>
208-
AddAltByType "TXT" text/plain
209+
AddAltByType 'plain text' text/plain
209210
</code></p></div>
210211
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="AddDescription" id="AddDescription">AddDescription</a> <a name="adddescription" id="adddescription">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
211212
</a></th><td>Description to display for a file</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
@@ -357,11 +358,12 @@ HeaderName HEADER.html
357358
AddType text/html .cgi
358359
</code></p></div>
359360
<p><a href="../content-negotiation.html">Content negotiation</a>
360-
will be performed if the <code>MultiViews</code> <code class="directive"><a href="../mod/core.html#option">Option</a></code> is enabled. If
361-
<em>filename</em> resolves to a static <code>text/html</code>
362-
document (not a CGI script) and the <code>Includes</code>
363-
<code class="directive"><a href="../mod/core.html#option">option</a></code> is enabled, the file
364-
will be processed for server-side includes (see the
361+
will be performed if <code class="directive"><a href="../mod/core.html#options">Options</a></code>
362+
<code>MultiViews</code> is in effect. If <em>filename</em> resolves
363+
to a static <code>text/html</code> document (not a CGI script) and
364+
either one of the <code class="directive"><a href="../mod/core.html#options">options</a></code>
365+
<code>Includes</code> or <code>IncludesNOEXEC</code> is enabled,
366+
the file will be processed for server-side includes (see the
365367
<code class="module"><a href="../mod/mod_include.html">mod_include</a></code> documentation).</p>
366368
</div>
367369

docs/manual/mod/mod_autoindex.xml

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -169,14 +169,15 @@ icon selected by filename</description>
169169
href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
170170
<em>File</em> is a file extension, partial filename, wild-card
171171
expression or full filename for files to describe.
172-
<em>String</em> is enclosed in double quotes (<code>"</code>).
173-
This alternate text is displayed if the client is image-incapable,
174-
has image loading disabled, or fails to retrieve the icon.</p>
172+
If <em>String</em> contains any whitespace, you have to enclose it
173+
in quotes (<code>"</code> or <code>'</code>). This alternate text
174+
is displayed if the client is image-incapable, has image loading
175+
disabled, or fails to retrieve the icon.</p>
175176

176177
<p>Examples:</p>
177178
<example>
178-
AddAlt "PDF" *.pdf<br />
179-
AddAlt "Compressed" *.gz *.zip *.Z
179+
AddAlt "PDF file" *.pdf<br />
180+
AddAlt Compressed *.gz *.zip *.Z
180181
</example>
181182
</usage>
182183
</directivesynopsis>
@@ -197,14 +198,14 @@ selected by MIME-encoding</description>
197198
text to display for a file, instead of an icon, for <code><a
198199
href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
199200
<em>MIME-encoding</em> is a valid content-encoding, such as
200-
<code>x-compress</code>. <em>String</em> is enclosed in double
201-
quotes (<code>"</code>). This alternate text is displayed if the
202-
client is image-incapable, has image loading disabled, or fails to
203-
retrieve the icon.</p>
201+
<code>x-compress</code>. If <em>String</em> contains any whitespace,
202+
you have to enclose it in quotes (<code>"</code> or <code>'</code>).
203+
This alternate text is displayed if the client is image-incapable,
204+
has image loading disabled, or fails to retrieve the icon.</p>
204205

205206
<p>Example:</p>
206207
<example>
207-
AddAltByEncoding "gzip" x-gzip
208+
AddAltByEncoding gzip x-gzip
208209
</example>
209210
</usage>
210211
</directivesynopsis>
@@ -225,14 +226,14 @@ icon selected by MIME content-type</description>
225226
display for a file, instead of an icon, for <code><a
226227
href="#indexoptions:fancyindexing">FancyIndexing</a></code>.
227228
<em>MIME-type</em> is a valid content-type, such as
228-
<code>text/html</code>. <em>String</em> is enclosed in double
229-
quotes (<code>"</code>). This alternate text is displayed if the
230-
client is image-incapable, has image loading disabled, or fails to
231-
retrieve the icon.</p>
229+
<code>text/html</code>. If <em>String</em> contains any whitespace,
230+
you have to enclose it in quotes (<code>"</code> or <code>'</code>).
231+
This alternate text is displayed if the client is image-incapable,
232+
has image loading disabled, or fails to retrieve the icon.</p>
232233

233234
<p>Example:</p>
234235
<example>
235-
AddAltByType "TXT" text/plain
236+
AddAltByType 'plain text' text/plain
236237
</example>
237238
</usage>
238239
</directivesynopsis>
@@ -427,12 +428,12 @@ HeaderName HEADER.html
427428
AddType text/html .cgi
428429
</example>
429430
<p><a href="../content-negotiation.html">Content negotiation</a>
430-
will be performed if the <code>MultiViews</code> <directive
431-
module="core">Option</directive> is enabled. If
432-
<em>filename</em> resolves to a static <code>text/html</code>
433-
document (not a CGI script) and the <code>Includes</code>
434-
<directive module="core">option</directive> is enabled, the file
435-
will be processed for server-side includes (see the
431+
will be performed if <directive module="core">Options</directive>
432+
<code>MultiViews</code> is in effect. If <em>filename</em> resolves
433+
to a static <code>text/html</code> document (not a CGI script) and
434+
either one of the <directive module="core">options</directive>
435+
<code>Includes</code> or <code>IncludesNOEXEC</code> is enabled,
436+
the file will be processed for server-side includes (see the
436437
<module>mod_include</module> documentation).</p>
437438
</note>
438439

0 commit comments

Comments
 (0)