You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by nd...@apache.org on 2002/11/14 19:50:09 UTC
cvs commit: httpd-2.0/docs/manual/mod mod_imap.html.en quickreference.html.en
nd 2002/11/14 10:50:09
Modified: docs/manual/mod mod_imap.html.en quickreference.html.en
Log:
update transformation
Revision Changes Path
1.12 +114 -104 httpd-2.0/docs/manual/mod/mod_imap.html.en
Index: mod_imap.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_imap.html.en,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- mod_imap.html.en 7 Oct 2002 15:23:02 -0000 1.11
+++ mod_imap.html.en 14 Nov 2002 18:50:09 -0000 1.12
@@ -20,18 +20,18 @@
<p>The following directive will activate files ending with
<code>.map</code> as imagemap files:</p>
-<div class="example"><p><code>AddHandler imap-file map</code></p></div>
+ <div class="example"><p><code>AddHandler imap-file map</code></p></div>
<p>Note that the following is still supported:</p>
-<div class="example"><p><code>AddType application/x-httpd-imap map</code></p></div>
+ <div class="example"><p><code>AddType application/x-httpd-imap map</code></p></div>
<p>However, we are trying to phase out "magic MIME types" so we
are deprecating this method.</p>
</div><div id="quickview"><h3 class="directives">Directives</h3><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#imapbase">ImapBase</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#imapdefault">ImapDefault</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#imapmenu">ImapMenu</a></li>
-</ul><h3>Topics</h3><ul id="topics"><li><img alt="" src="../images/down.gif" /> New Features</li><li><img alt="" src="../images/down.gif" /> Imagemap File</li><li><img alt="" src="../images/down.gif" /> Example Mapfile</li><li><img alt="" src="../images/down.gif" /> Referencing your mapfile</li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2>New Features</h2>
+</ul><h3>Topics</h3><ul id="topics"><li><img alt="" src="../images/down.gif" /> <a href="#features">New Features</a></li><li><img alt="" src="../images/down.gif" /> <a href="#imapfile">Imagemap File</a></li><li><img alt="" src="../images/down.gif" /> <a href="#example">Example Mapfile</a></li><li><img alt="" src="../images/down.gif" /> <a href="#referencing">Referencing your mapfile</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="features" id="features">New Features</a></h2>
<p>The imagemap module adds some new features that were not
possible with previously distributed imagemap programs.</p>
@@ -39,7 +39,7 @@
<ul>
<li>URL references relative to the Referer: information.</li>
- <li>Default <BASE> assignment through a new map
+ <li>Default <code><base></code> assignment through a new map
directive <code>base</code>.</li>
<li>No need for <code>imagemap.conf</code> file.</li>
@@ -48,53 +48,55 @@
<li>Configurable generation of imagemap menus.</li>
</ul>
-</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2>Imagemap File</h2>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="imapfile" id="imapfile">Imagemap File</a></h2>
<p>The lines in the imagemap files can have one of several
formats:</p>
-<div class="example"><p><code>
- directive value [x,y ...]<br />
- directive value "Menu text" [x,y ...]<br />
- directive value x,y ... "Menu text"
-</code></p></div>
+ <div class="example"><p><code>
+ directive value [<var>x</var>,<var>y</var> ...]<br />
+ directive value "<var>Menu text</var>" [<var>x</var>,<var>y</var>
+ ...]<br />
+ directive value <var>x</var>,<var>y</var> ... "<var>Menu text</var>"
+ </code></p></div>
+
<p>The directive is one of <code>base</code>,
<code>default</code>, <code>poly</code>, <code>circle</code>,
<code>rect</code>, or <code>point</code>. The value is an
absolute or relative URL, or one of the special values listed
- below. The coordinates are <code>x,y</code> pairs separated by
- whitespace. The quoted text is used as the text of the link if
- a imagemap menu is generated. Lines beginning with '#' are
+ below. The coordinates are <code><var>x</var>,<var>y</var></code>
+ pairs separated by whitespace. The quoted text is used as the text of
+ the link if a imagemap menu is generated. Lines beginning with '#' are
comments.</p>
-<h3>Imagemap File Directives</h3>
- <p>There are six directives allowed in the imagemap file. The
- directives can come in any order, but are processed in the
- order they are found in the imagemap file.</p>
+ <h3><a name="imapfile:directives" id="imapfile:directives">Imagemap File Directives</a></h3>
+ <p>There are six directives allowed in the imagemap file. The
+ directives can come in any order, but are processed in the
+ order they are found in the imagemap file.</p>
- <dl>
+ <dl>
<dt><code>base</code> Directive</dt>
- <dd>Has the effect of <code><BASE HREF="value"></code>.
- The non-absolute URLs of the map-file are taken relative to
- this value. The <code>base</code> directive overrides
- ImapBase as set in a .htaccess file or in the server
- configuration files. In the absence of an ImapBase
- configuration directive, <code>base</code> defaults to
- <code>http://server_name/</code>.<br />
- <code>base_uri</code> is synonymous with <code>base</code>.
- Note that a trailing slash on the URL is significant.</dd>
+ <dd><p>Has the effect of <code><base href="<var>value</var>">
+ </code>. The non-absolute URLs of the map-file are taken relative
+ to this value. The <code>base</code> directive overrides
+ <code class="directive"><a href="#imapbase">ImapBase</a></code> as set in a
+ <code>.htaccess</code> file or in the server configuration files.
+ In the absence of an <code class="directive">ImapBase</code> configuration
+ directive, <code>base</code> defaults to
+ <code>http://server_name/</code>.</p>
+ <p><code>base_uri</code> is synonymous with <code>base</code>.
+ Note that a trailing slash on the URL is significant.</p></dd>
<dt><code>default</code> Directive</dt>
<dd>The action taken if the coordinates given do not fit any
of the <code>poly</code>, <code>circle</code> or
<code>rect</code> directives, and there are no
- <code>point</code> directives. Defaults to
- <code>nocontent</code> in the absence of an ImapDefault
- configuration setting, causing a status code of <code>204 No
- Content</code> to be returned. The client should keep the
- same page displayed.</dd>
+ <code>point</code> directives. Defaults to <code>nocontent</code>
+ in the absence of an <code class="directive"><a href="#imapdefault">ImapDefault</a></code> configuration setting, causing a status
+ code of <code>204 No Content</code> to be returned. The client
+ should keep the same page displayed.</dd>
<dt><code>poly</code> Directive</dt>
@@ -121,39 +123,38 @@
satisfied. Note that <code>default</code> will not be
followed if a <code>point</code> directive is present and
valid coordinates are given.</dd>
- </dl>
-
+ </dl>
+
-<h3>Values</h3>
+ <h3><a name="imapfile:values" id="imapfile:values">Values</a></h3>
- <p>The values for each of the directives can any of the following:</p>
-
+ <p>The values for each of the directives can any of the following:</p>
- <dl>
+ <dl>
<dt>a URL</dt>
- <dd>The URL can be relative or absolute URL. Relative URLs
+ <dd><p>The URL can be relative or absolute URL. Relative URLs
can contain '..' syntax and will be resolved relative to the
- <code>base</code> value.<br />
- <code>base</code> itself will not resolved according to the
+ <code>base</code> value.</p>
+ <p><code>base</code> itself will not resolved according to the
current value. A statement <code>base mailto:</code> will
- work properly, though.</dd>
+ work properly, though.</p></dd>
<dt><code>map</code></dt>
<dd>Equivalent to the URL of the imagemap file itself. No
coordinates are sent with this, so a menu will be generated
- unless ImapMenu is set to 'none'.</dd>
+ unless <code class="directive"><a href="#imapmenu">ImapMenu</a></code> is set to
+ <code>none</code>.</dd>
<dt><code>menu</code></dt>
-
<dd>Synonymous with <code>map</code>.</dd>
<dt><code>referer</code></dt>
<dd>Equivalent to the URL of the referring document. Defaults
- to <code>http://servername/</code> if no Referer: header was
- present.</dd>
+ to <code>http://servername/</code> if no <code>Referer:</code>
+ header was present.</dd>
<dt><code>nocontent</code></dt>
@@ -166,72 +167,86 @@
<dd>Fails with a <code>500 Server Error</code>. Valid for all
but <code>base</code>, but sort of silly for anything but
<code>default</code>.</dd>
- </dl>
-
+ </dl>
+
-<h3>Coordinates</h3>
+ <h3><a name="imapfile:coords" id="imapfile:coords">Coordinates</a></h3>
- <dl>
+ <dl>
<dt><code>0,0 200,200</code></dt>
- <dd>A coordinate consists of an <code>x</code> and a <code>y</code>
+ <dd>A coordinate consists of an <var>x</var> and a <var>y</var>
value separated by a comma. The coordinates are separated
from each other by whitespace. To accommodate the way Lynx
handles imagemaps, should a user select the coordinate
<code>0,0</code>, it is as if no coordinate had been
selected.</dd>
- </dl>
-
+ </dl>
+
-<h3>Quoted Text</h3>
+ <h3><a name="imapfile:quotedtext" id="imapfile:quotedtext">Quoted Text</a></h3>
- <dl>
- <dt><code>"Menu Text"</code></dt>
+ <dl>
+ <dt><code>"<var>Menu Text</var>"</code></dt>
- <dd>After the value or after the coordinates, the line
+ <dd><p>After the value or after the coordinates, the line
optionally may contain text within double quotes. This string
is used as the text for the link if a menu is
- generated:<br />
- <code><a HREF="http://foo.com/">Menu
- text</a></code><br />
- If no quoted text is present, the name of the link will be
- used as the text:<br />
- <code><a
- HREF="http://foo.com/">http://foo.com</a></code><br />
- It is impossible to escape double quotes within this
- text.</dd>
- </dl>
-
-</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2>Example Mapfile</h2>
-
-<div class="example"><p><code>
- #Comments are printed in a 'formatted' or
- 'semiformatted' menu.<br />
- #And can contain html tags. <hr><br />
- base referer<br />
- poly map "Could I have a menu, please?" 0,0 0,10 10,10
- 10,0<br />
- rect .. 0,0 77,27 "the directory of the referer"<br />
- circle http://www.inetnebr.com/lincoln/feedback/ 195,0
- 305,27<br />
- rect another_file "in same directory as referer" 306,0
- 419,27<br />
- point http://www.zyzzyva.com/ 100,100<br />
- point http://www.tripod.com/ 200,200<br />
- rect mailto:nate@tripod.com 100,150 200,0 "Bugs?"<br />
-</code></p></div>
-
-</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2>Referencing your mapfile</h2>
-
-<div class="example"><p><code>
- <A HREF="/maps/imagemap1.map"><br />
- <IMG ISMAP SRC="/images/imagemap1.gif"><br />
- </A>
-</code></p></div>
+ generated:</p>
+
+ <div class="example"><p><code>
+ <a href="http://foo.com/"><var>Menu text</var></a>
+ </code></p></div>
+
+ <p>If no quoted text is present, the name of the link will be
+ used as the text:</p>
+
+ <div class="example"><p><code>
+ <a href="http://foo.com/">http://foo.com</a>
+ </code></p></div>
+
+ <p>If you want to use double quotes within this text, you have to
+ write them as <code>&quot;</code>.</p></dd>
+ </dl>
+
+
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="example" id="example">Example Mapfile</a></h2>
+
+ <div class="example"><p><code>
+ #Comments are printed in a 'formatted' or 'semiformatted' menu.<br />
+ #And can contain html tags. <hr><br />
+ base referer<br />
+ poly map "Could I have a menu, please?" 0,0 0,10 10,10 10,0<br />
+ rect .. 0,0 77,27 "the directory of the referer"<br />
+ circle http://www.inetnebr.com/lincoln/feedback/ 195,0 305,27<br />
+ rect another_file "in same directory as referer" 306,0 419,27<br />
+ point http://www.zyzzyva.com/ 100,100<br />
+ point http://www.tripod.com/ 200,200<br />
+ rect mailto:nate@tripod.com 100,150 200,0 "Bugs?"<br />
+ </code></p></div>
+
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="referencing" id="referencing">Referencing your mapfile</a></h2>
+
+ <div class="example"><h3>HTML example</h3><p><code>
+ <a href="/maps/imagemap1.map"><br />
+ <span class="indent">
+ <img ismap src="/images/imagemap1.gif"><br />
+ </span>
+ </a>
+ </code></p></div>
+
+ <div class="example"><h3>XHTML example</h3><p><code>
+ <a href="/maps/imagemap1.map"><br />
+ <span class="indent">
+ <img ismap="ismap" src="/images/imagemap1.gif" /><br />
+ </span>
+ </a>
+ </code></p></div>
+
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ImapBase" id="ImapBase">ImapBase</a> <a name="imapbase" id="imapbase">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Default base for imagemap files</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><code>ImapBase map|referer|<em>URL</em></code></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td><code>ImapBase map|referer|<var>URL</var></code></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>ImapBase http://servername/</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
@@ -241,11 +256,11 @@
<code>base</code> used in the imagemap files. Its value is
overridden by a <code>base</code> directive within the imagemap
file. If not present, the <code>base</code> defaults to
- <code>http://servername/</code>.</p>
-</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ImapDefault" id="ImapDefault">ImapDefault</a> <a name="imapdefault" id="imapdefault">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
+ <code>http://<var>servername</var>/</code>.</p>
+<h3>See also</h3><ul><li><code class="directive"><a href="../mod/core.html#usecanonicalname">UseCanonicalName</a></code></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ImapDefault" id="ImapDefault">ImapDefault</a> <a name="imapdefault" id="imapdefault">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Default action when an imagemap is called with coordinates
that are not explicitly mapped</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><code>ImapDefault error|nocontent|map|referer|<em>URL</em></code></td></tr><tr><th><a href="directive-dict.html#Default">Default:
+ </a></th><td><code>ImapDefault error|nocontent|map|referer|<var>URL</var></code></td></tr><tr><th><a href="directive-dict.html#Default">Default:
</a></th><td><code>ImapDefault nocontent</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
@@ -261,8 +276,7 @@
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ImapMenu" id="ImapMenu">ImapMenu</a> <a name="imapmenu" id="imapmenu">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description:
</a></th><td>Action if no coordinates are given when calling
an imagemap</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><code>ImapMenu
- none|formatted|semiformatted|unformatted</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </a></th><td><code>ImapMenu none|formatted|semiformatted|unformatted</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
</a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
</a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
</a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
@@ -273,12 +287,10 @@
<dl>
<dt><code>none</code></dt>
-
<dd>If ImapMenu is <code>none</code>, no menu is generated,
and the <code>default</code> action is performed.</dd>
<dt><code>formatted</code></dt>
-
<dd>A <code>formatted</code> menu is the simplest menu.
Comments in the imagemap file are ignored. A level one header
is printed, then an hrule, then the links each on a separate
@@ -286,7 +298,6 @@
a directory listing.</dd>
<dt><code>semiformatted</code></dt>
-
<dd>In the <code>semiformatted</code> menu, comments are
printed where they occur in the imagemap file. Blank lines
are turned into HTML breaks. No header or hrule is printed,
@@ -294,7 +305,6 @@
<code>formatted</code> menu.</dd>
<dt><code>unformatted</code></dt>
-
<dd>Comments are printed, blank lines are ignored. Nothing is
printed that does not appear in the imagemap file. All breaks
and headers must be included as comments in the imagemap
1.41 +3 -4 httpd-2.0/docs/manual/mod/quickreference.html.en
Index: quickreference.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/quickreference.html.en,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -r1.40 -r1.41
--- quickreference.html.en 14 Nov 2002 05:40:00 -0000 1.40
+++ quickreference.html.en 14 Nov 2002 18:50:09 -0000 1.41
@@ -303,11 +303,10 @@
<tr><td><a href="core.html#ifmodule"><IfModule [!]<var>module-name</var>> ...
</IfModule></a></td><td /><td>svdh</td><td>C</td></tr><tr><td class="descr" colspan="4">Encloses directives that are processed conditional on the
presence or absence of a specific module</td></tr>
-<tr class="odd"><td><a href="mod_imap.html#imapbase">ImapBase map|referer|<em>URL</em></a></td><td> http://servername/ </td><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Default <code>base</code> for imagemap files</td></tr>
-<tr><td><a href="mod_imap.html#imapdefault">ImapDefault error|nocontent|map|referer|<em>URL</em></a></td><td> nocontent </td><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">Default action when an imagemap is called with coordinates
+<tr class="odd"><td><a href="mod_imap.html#imapbase">ImapBase map|referer|<var>URL</var></a></td><td> http://servername/ </td><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Default <code>base</code> for imagemap files</td></tr>
+<tr><td><a href="mod_imap.html#imapdefault">ImapDefault error|nocontent|map|referer|<var>URL</var></a></td><td> nocontent </td><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">Default action when an imagemap is called with coordinates
that are not explicitly mapped</td></tr>
-<tr class="odd"><td><a href="mod_imap.html#imapmenu">ImapMenu
- none|formatted|semiformatted|unformatted</a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Action if no coordinates are given when calling
+<tr class="odd"><td><a href="mod_imap.html#imapmenu">ImapMenu none|formatted|semiformatted|unformatted</a></td><td /><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Action if no coordinates are given when calling
an imagemap</td></tr>
<tr><td><a href="core.html#include">Include <var>file-path</var>|<var>directory-path</var></a></td><td /><td>svd</td><td>C</td></tr><tr><td class="descr" colspan="4">Includes other configuration files from within
the server configuration files</td></tr>