mod_imap.html.en revision 97a9a944b5887e91042b019776c41d5dd74557af
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer<?xml version="1.0" encoding="ISO-8859-1"?>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
6b26240dca29e026900a83d51c75ca230a072a16Thiemo Wiedemeyer<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
98890889ffb2e8f6f722b00e265a211f13b5a861Corneliu-Claudiu Prodescu This file is generated from xml source: DO NOT EDIT
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2eeec5240b424984e3ee26296da1eeab6c6d739eChristian Maeder --><title>mod_imap - Apache HTTP Server</title><link href="/style/css/manual-sbar-right-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="right sidebar - blue (font 100%)" /><link href="/style/css/manual-sbar-right-90pc.css" rel="alternate stylesheet" media="all" type="text/css" title="right sidebar - blue (font 90%)" /><link href="/style/css/manual-sbar-right-fix15.css" rel="stylesheet" media="all" type="text/css" title="right sidebar - blue (font fix 15)" /><link href="/style/css/manual-sbar-right-fix13.css" rel="alternate stylesheet" media="all" type="text/css" title="right sidebar - blue (font fix 13)" /><link href="/style/css/manual-sbar-right-100pc-b.css" rel="alternate stylesheet" media="all" type="text/css" title="right sidebar - black (font 100%)" /><link href="/style/css/manual-sbar-right-90pc-b.css" rel="alternate stylesheet" media="all" type="text/css" title="right sidebar - black (font 90%)" /><link href="/style/css/manual-sbar-right-fix15-b.css" rel="alternate stylesheet" media="all" type="text/css" title="right sidebar - black (font fix 15)" /><link href="/style/css/manual-sbar-right-fix13-b.css" rel="alternate stylesheet" media="all" type="text/css" title="right sidebar - black (font fix 13)" /><link href="/style/css/manual-sbar-left-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="left sidebar - blue (font 100%)" /><link href="/style/css/manual-sbar-left-90pc.css" rel="alternate stylesheet" media="all" type="text/css" title="left sidebar - blue (font 90%)" /><link href="/style/css/manual-sbar-left-fix15.css" rel="alternate stylesheet" media="all" type="text/css" title="left sidebar - blue (font fix 15)" /><link href="/style/css/manual-sbar-left-fix13.css" rel="alternate stylesheet" media="all" type="text/css" title="left sidebar - blue (font fix 13)" /><link href="/style/css/manual-sbar-left-100pc-b.css" rel="alternate stylesheet" media="all" type="text/css" title="left sidebar - black (font 100%)" /><link href="/style/css/manual-sbar-left-90pc-b.css" rel="alternate stylesheet" media="all" type="text/css" title="left sidebar - black (font 90%)" /><link href="/style/css/manual-sbar-left-fix15-b.css" rel="alternate stylesheet" media="all" type="text/css" title="left sidebar - black (font fix 15)" /><link href="/style/css/manual-sbar-left-fix13-b.css" rel="alternate stylesheet" media="all" type="text/css" title="left sidebar - black (font fix 13)" /><link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="loose style - blue (font 100%)" /><link href="/style/css/manual-loose-90pc.css" rel="alternate stylesheet" media="all" type="text/css" title="loose style - blue (font 90%)" /><link href="/style/css/manual-loose-fix15.css" rel="alternate stylesheet" media="all" type="text/css" title="loose style - blue (font fix 15)" /><link href="/style/css/manual-loose-fix13.css" rel="alternate stylesheet" media="all" type="text/css" title="loose style - blue (font fix 13)" /><link href="/style/css/manual-loose-100pc-b.css" rel="alternate stylesheet" media="all" type="text/css" title="loose style - black (font 100%)" /><link href="/style/css/manual-loose-90pc-b.css" rel="alternate stylesheet" media="all" type="text/css" title="loose style - black (font 90%)" /><link href="/style/css/manual-loose-fix15-b.css" rel="alternate stylesheet" media="all" type="text/css" title="loose style - black (font fix 15)" /><link href="/style/css/manual-loose-fix13-b.css" rel="alternate stylesheet" media="all" type="text/css" title="loose style - black (font fix 13)" /><link href="/images/favicon.ico" rel="shortcut icon" /></head><body><div id="page-header"><p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p><p class="apache">Apache HTTP Server Version 2.0</p><img alt="" src="/images/feather.gif" /></div><div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.0</a> &gt; <a href="./">Modules</a></div><div id="page-content"><div id="preamble"><h1>Apache Module mod_imap</h1><table class="module"><tr><th>Description:
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer </th><td>Server-side imagemap processing</td></tr><tr><th><a href="module-dict.html#Status">Status:
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer </a></th><td>Base</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:
7520452bb30b5abbd471f82352fc4c1c937e02c5Till Mossakowski </a></th><td>imap_module</td></tr></table><h3>Summary</h3>
7520452bb30b5abbd471f82352fc4c1c937e02c5Till Mossakowski <p>This module processes <code>.map</code> files, thereby
7520452bb30b5abbd471f82352fc4c1c937e02c5Till Mossakowski replacing the functionality of the <code>imagemap</code> CGI
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer program. Any directory or document type configured to use the
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer handler <code>imap-file</code> (using either
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <code class="directive"><a href="/mod/mod_mime.html#addhandler">AddHandler</a></code> or
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <code class="directive"><a href="/mod/core.html#sethandler">SetHandler</a></code>)
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer will be processed by this module.</p>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <p>The following directive will activate files ending with
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <code>.map</code> as imagemap files:</p>
8bdd8707c8e341f1fc57fcbf884520bfe06a5028Christian Maeder
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer<div class="example"><p><code>AddHandler imap-file map</code></p></div>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <p>Note that the following is still supported:</p>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer<div class="example"><p><code>AddType application/x-httpd-imap map</code></p></div>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <p>However, we are trying to phase out "magic MIME types" so we
b0adcc203b4267d5535b430372935a5f36726db1Simon Ulbricht are deprecating this method.</p>
38122cbf09ad3dcc31a826cc4093f630515a5cfcChristian Maeder</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>
83263d411f611d9902ef4d98c93be6ad9361c833Christian Maeder
abea93ed557b22ea833e1524ee5ca11afc12208aSimon Ulbricht <p>The imagemap module adds some new features that were not
521045d36343cd17dd217a81d4b9422ad6ab6a07Christian Maeder possible with previously distributed imagemap programs.</p>
9a9860760c6f30558e5e60049692b6fc63904590Markus Gross
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <ul>
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer <li>URL references relative to the Referer: information.</li>
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer <li>Default &lt;BASE&gt; assignment through a new map
8836fa284a241af325aa6f41234b5130b26ec4f9Thiemo Wiedemeyer directive <code>base</code>.</li>
8836fa284a241af325aa6f41234b5130b26ec4f9Thiemo Wiedemeyer
331603b37dec12e37e2e1df9634ef0f2c5c73ddfThiemo Wiedemeyer <li>No need for <code>imagemap.conf</code> file.</li>
7ae38566aaf40710cd83ffa3ba25655c4ad22741Thiemo Wiedemeyer
1a389234e68da7c3d087b038307ed8c66fc6dc32Thiemo Wiedemeyer <li>Point references.</li>
f059d29e63508be7316ac161428eee7fc804736eChristian Maeder
1c039dc13801bb9c90ad6a1bac0e56af19fd2fbfMihai Codescu <li>Configurable generation of imagemap menus.</li>
38122cbf09ad3dcc31a826cc4093f630515a5cfcChristian Maeder </ul>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="section"><h2>Imagemap File</h2>
f7b9d64160c23654b7288a3b0ee3e2b95af3e752Thiemo Wiedemeyer
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <p>The lines in the imagemap files can have one of several
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer formats:</p>
3a6decfd748f532d5cb03fbcb7a42fa37b0faab3Christian Maeder
f7b9d64160c23654b7288a3b0ee3e2b95af3e752Thiemo Wiedemeyer<div class="example"><p><code>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer directive value [x,y ...]<br />
1842453990fed8a1bd7a5ac792d7982c1d2bfcd5Christian Maeder directive value "Menu text" [x,y ...]<br />
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer directive value x,y ... "Menu text"
c208973c890b8f993297720fd0247bc7481d4304Christian Maeder</code></p></div>
b6a59f004903ac7bc96323ee3ef09c01fd221157Christian Maeder <p>The directive is one of <code>base</code>,
f7b9d64160c23654b7288a3b0ee3e2b95af3e752Thiemo Wiedemeyer <code>default</code>, <code>poly</code>, <code>circle</code>,
55c5e901b5c3466300009135585bc70bd576dcb6Christian Maeder <code>rect</code>, or <code>point</code>. The value is an
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer absolute or relative URL, or one of the special values listed
ec25781c1180ea07f66b48c34f93cf5634e9277cChristian Maeder below. The coordinates are <code>x,y</code> pairs separated by
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer whitespace. The quoted text is used as the text of the link if
f7b9d64160c23654b7288a3b0ee3e2b95af3e752Thiemo Wiedemeyer a imagemap menu is generated. Lines beginning with '#' are
f7b9d64160c23654b7288a3b0ee3e2b95af3e752Thiemo Wiedemeyer comments.</p>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder<h3>Imagemap File Directives</h3>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <p>There are six directives allowed in the imagemap file. The
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer directives can come in any order, but are processed in the
d1066b8fb69179973dcab47154858d77e72760a7Thiemo Wiedemeyer order they are found in the imagemap file.</p>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer
4e9e95ba35a68f3c767bc0b23ebf9e904e442517Christian Maeder <dl>
f7b9d64160c23654b7288a3b0ee3e2b95af3e752Thiemo Wiedemeyer <dt><code>base</code> Directive</dt>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer
3587928ae948e8505f5af052dd4dc7cd97b6638eChristian Maeder <dd>Has the effect of <code>&lt;BASE HREF="value"&gt;</code>.
a7e5c17a679fa2dae5998cd04c7e9e06c05c8164Christian Maeder The non-absolute URLs of the map-file are taken relative to
f9e0b18852b238ddb649d341194e05d7200d1bbeChristian Maeder this value. The <code>base</code> directive overrides
697e63e30aa3c309a1ef1f9357745111f8dfc5a9Christian Maeder ImapBase as set in a .htaccess file or in the server
1e3aca4178372af672efb237d16087c603fe5564Christian Maeder configuration files. In the absence of an ImapBase
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer configuration directive, <code>base</code> defaults to
4b136ad539bd9f4e115dff4eee4d552a42d4437eChristian Maeder <code>http://server_name/</code>.<br />
f456529a89bfb620d39e5fd5b0a53b24643db96dDominik Luecke <code>base_uri</code> is synonymous with <code>base</code>.
a79266feb130561fa1a95ae0429d0574f625f6ceChristian Maeder Note that a trailing slash on the URL is significant.</dd>
f7b9d64160c23654b7288a3b0ee3e2b95af3e752Thiemo Wiedemeyer
f7b9d64160c23654b7288a3b0ee3e2b95af3e752Thiemo Wiedemeyer <dt><code>default</code> Directive</dt>
f7b9d64160c23654b7288a3b0ee3e2b95af3e752Thiemo Wiedemeyer
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <dd>The action taken if the coordinates given do not fit any
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer of the <code>poly</code>, <code>circle</code> or
f7b9d64160c23654b7288a3b0ee3e2b95af3e752Thiemo Wiedemeyer <code>rect</code> directives, and there are no
0d0278c34a374b29c2d6c58b39b8b56e283d48e8Christian Maeder <code>point</code> directives. Defaults to
2028dc2c091bb60343e15985948a59b955276cbfChristian Maeder <code>nocontent</code> in the absence of an ImapDefault
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer configuration setting, causing a status code of <code>204 No
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer Content</code> to be returned. The client should keep the
16e45483b5ce48f0b92d01c817242a8c9b8bae02Christian Maeder same page displayed.</dd>
ddc662fdf0207eae2034d7b68ae5e2225c575207Thiemo Wiedemeyer
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <dt><code>poly</code> Directive</dt>
28ca54b0d63d1d26a991711c8c7e85c474994715Christian Maeder
71654489020a03cf6ce9f2947f3da26a996f9c32Razvan Pascanu <dd>Takes three to one-hundred points, and is obeyed if the
71654489020a03cf6ce9f2947f3da26a996f9c32Razvan Pascanu user selected coordinates fall within the polygon defined by
02a84229da51532505a93fc2abfca1ccf81b4446Razvan Pascanu these points.</dd>
71654489020a03cf6ce9f2947f3da26a996f9c32Razvan Pascanu
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer <dt><code>circle</code></dt>
331603b37dec12e37e2e1df9634ef0f2c5c73ddfThiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer <dd>Takes the center coordinates of a circle and a point on
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer the circle. Is obeyed if the user selected point is with the
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer circle.</dd>
331603b37dec12e37e2e1df9634ef0f2c5c73ddfThiemo Wiedemeyer
32d98ca5e560cf6c1062a0463be4c350af32bed5Thiemo Wiedemeyer <dt><code>rect</code> Directive</dt>
331603b37dec12e37e2e1df9634ef0f2c5c73ddfThiemo Wiedemeyer
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer <dd>Takes the coordinates of two opposing corners of a
32d98ca5e560cf6c1062a0463be4c350af32bed5Thiemo Wiedemeyer rectangle. Obeyed if the point selected is within this
32d98ca5e560cf6c1062a0463be4c350af32bed5Thiemo Wiedemeyer rectangle.</dd>
331603b37dec12e37e2e1df9634ef0f2c5c73ddfThiemo Wiedemeyer
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer <dt><code>point</code> Directive</dt>
c40b7badd217089d8a256dabdf8f7d4e219ca215Thiemo Wiedemeyer
d71a37fb09bce02af6c98e7a5ab0aa5639058e4fThiemo Wiedemeyer <dd>Takes a single point. The point directive closest to the
71654489020a03cf6ce9f2947f3da26a996f9c32Razvan Pascanu user selected point is obeyed if no other directives are
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer satisfied. Note that <code>default</code> will not be
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer followed if a <code>point</code> directive is present and
71654489020a03cf6ce9f2947f3da26a996f9c32Razvan Pascanu valid coordinates are given.</dd>
53e76316f409f6b1b57ed3d2e5cb9cfe1cb511e5Thiemo Wiedemeyer </dl>
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer<h3>Values</h3>
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer <p>The values for each of the directives can any of the following:</p>
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
e49fd57c63845c7806860a9736ad09f6d44dbaedChristian Maeder <dl>
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer <dt>a URL</dt>
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer
0b8b26a22f136a9b2a8e99d655f6fe6b0b96008cThiemo Wiedemeyer <dd>The URL can be relative or absolute URL. Relative URLs
0b8b26a22f136a9b2a8e99d655f6fe6b0b96008cThiemo Wiedemeyer can contain '..' syntax and will be resolved relative to the
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer <code>base</code> value.<br />
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer <code>base</code> itself will not resolved according to the
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer current value. A statement <code>base mailto:</code> will
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer work properly, though.</dd>
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder <dt><code>map</code></dt>
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer <dd>Equivalent to the URL of the imagemap file itself. No
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer coordinates are sent with this, so a menu will be generated
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer unless ImapMenu is set to 'none'.</dd>
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer <dt><code>menu</code></dt>
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer <dd>Synonymous with <code>map</code>.</dd>
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer <dt><code>referer</code></dt>
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer <dd>Equivalent to the URL of the referring document. Defaults
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer to <code>http://servername/</code> if no Referer: header was
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer present.</dd>
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer <dt><code>nocontent</code></dt>
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer <dd>Sends a status code of <code>204 No Content</code>,
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer telling the client to keep the same page displayed. Valid for
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder all but <code>base</code>.</dd>
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder
0b8b26a22f136a9b2a8e99d655f6fe6b0b96008cThiemo Wiedemeyer <dt><code>error</code></dt>
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer <dd>Fails with a <code>500 Server Error</code>. Valid for all
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer but <code>base</code>, but sort of silly for anything but
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer <code>default</code>.</dd>
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer </dl>
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer
ea76e25262c3325f293fbdd6560f180ca18f9be4Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer<h3>Coordinates</h3>
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer <dl>
d71a37fb09bce02af6c98e7a5ab0aa5639058e4fThiemo Wiedemeyer <dt><code>0,0 200,200</code></dt>
d71a37fb09bce02af6c98e7a5ab0aa5639058e4fThiemo Wiedemeyer
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer <dd>A coordinate consists of an <code>x</code> and a <code>y</code>
d71a37fb09bce02af6c98e7a5ab0aa5639058e4fThiemo Wiedemeyer value separated by a comma. The coordinates are separated
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer from each other by whitespace. To accommodate the way Lynx
39a2520d13a7d43f0c0fa71b94255c3f7c500005Christian Maeder handles imagemaps, should a user select the coordinate
39a2520d13a7d43f0c0fa71b94255c3f7c500005Christian Maeder <code>0,0</code>, it is as if no coordinate had been
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer selected.</dd>
d71a37fb09bce02af6c98e7a5ab0aa5639058e4fThiemo Wiedemeyer </dl>
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer<h3>Quoted Text</h3>
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer <dl>
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer <dt><code>"Menu Text"</code></dt>
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer <dd>After the value or after the coordinates, the line
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer optionally may contain text within double quotes. This string
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer is used as the text for the link if a menu is
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer generated:<br />
92e96be605537638d75e9d3023ab698bd89cf889Thiemo Wiedemeyer <code>&lt;a HREF="http://foo.com/"&gt;Menu
92e96be605537638d75e9d3023ab698bd89cf889Thiemo Wiedemeyer text&lt;/a&gt;</code><br />
fa1bf658051ac503f27ff1b59edb093398eed6edThiemo Wiedemeyer If no quoted text is present, the name of the link will be
fa1bf658051ac503f27ff1b59edb093398eed6edThiemo Wiedemeyer used as the text:<br />
fa1bf658051ac503f27ff1b59edb093398eed6edThiemo Wiedemeyer <code>&lt;a
d24317c8197e565e60c8f41309de246249c1e57eChristian Maeder HREF="http://foo.com/"&gt;http://foo.com&lt;/a&gt;</code><br />
fa1bf658051ac503f27ff1b59edb093398eed6edThiemo Wiedemeyer It is impossible to escape double quotes within this
92e96be605537638d75e9d3023ab698bd89cf889Thiemo Wiedemeyer text.</dd>
92e96be605537638d75e9d3023ab698bd89cf889Thiemo Wiedemeyer </dl>
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder
0d0278c34a374b29c2d6c58b39b8b56e283d48e8Christian Maeder</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div><div class="section"><h2>Example Mapfile</h2>
92e96be605537638d75e9d3023ab698bd89cf889Thiemo Wiedemeyer
92e96be605537638d75e9d3023ab698bd89cf889Thiemo Wiedemeyer<div class="example"><p><code>
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer #Comments are printed in a 'formatted' or
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer 'semiformatted' menu.<br />
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer #And can contain html tags. &lt;hr&gt;<br />
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer base referer<br />
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer poly map "Could I have a menu, please?" 0,0 0,10 10,10
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer 10,0<br />
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer rect .. 0,0 77,27 "the directory of the referer"<br />
aa21e7aa42fef563dea0cc77edbde76f66cdbe88Thiemo Wiedemeyer circle http://www.inetnebr.com/lincoln/feedback/ 195,0
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer 305,27<br />
d7aa4e1cbe00f7f3add4da911673b3b176b140c3Thiemo Wiedemeyer rect another_file "in same directory as referer" 306,0
d9f20cf968e246ec283f0c09f60af4b47b174398Thiemo Wiedemeyer 419,27<br />
d9f20cf968e246ec283f0c09f60af4b47b174398Thiemo Wiedemeyer point http://www.zyzzyva.com/ 100,100<br />
d9f20cf968e246ec283f0c09f60af4b47b174398Thiemo Wiedemeyer point http://www.tripod.com/ 200,200<br />
d9f20cf968e246ec283f0c09f60af4b47b174398Thiemo Wiedemeyer rect mailto:nate@tripod.com 100,150 200,0 "Bugs?"<br />
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder</code></p></div>
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder
d9f20cf968e246ec283f0c09f60af4b47b174398Thiemo Wiedemeyer</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>
d9f20cf968e246ec283f0c09f60af4b47b174398Thiemo Wiedemeyer
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer<div class="example"><p><code>
39a2520d13a7d43f0c0fa71b94255c3f7c500005Christian Maeder &lt;A HREF="/maps/imagemap1.map"&gt;<br />
4014fb09362f3e38a91d7bb11b1484a4790e9297Thiemo Wiedemeyer &lt;IMG ISMAP SRC="/images/imagemap1.gif"&gt;<br />
da1f9fa9339a0115d0559411929835bcff74e5f5Thiemo Wiedemeyer &lt;/A&gt;
39a2520d13a7d43f0c0fa71b94255c3f7c500005Christian Maeder</code></p></div>
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer</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>Description:
da1f9fa9339a0115d0559411929835bcff74e5f5Thiemo Wiedemeyer </th><td>Default base for imagemap files</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
da1f9fa9339a0115d0559411929835bcff74e5f5Thiemo Wiedemeyer </a></th><td>ImapBase map|referer|<em>URL</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder </a></th><td><code>ImapBase http://servername/</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
4014fb09362f3e38a91d7bb11b1484a4790e9297Thiemo Wiedemeyer </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
da1f9fa9339a0115d0559411929835bcff74e5f5Thiemo Wiedemeyer </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
4014fb09362f3e38a91d7bb11b1484a4790e9297Thiemo Wiedemeyer </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer </a></th><td>mod_imap</td></tr></table>
3e3efd4ce838940032e875e6d08712a177c9c1d0Thiemo Wiedemeyer <p>The <code class="directive">ImapBase</code> directive sets the default
3e3efd4ce838940032e875e6d08712a177c9c1d0Thiemo Wiedemeyer <code>base</code> used in the imagemap files. Its value is
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder overridden by a <code>base</code> directive within the imagemap
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder file. If not present, the <code>base</code> defaults to
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder <code>http://servername/</code>.</p>
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder</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>Description:
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder </th><td>Default action when an imagemap is called with coordinates
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyerthat are not explicitly mapped</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer </a></th><td>ImapDefault error|nocontent|map|referer|<em>URL</em></td></tr><tr><th><a href="directive-dict.html#Default">Default:
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer </a></th><td><code>ImapDefault nocontent</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer </a></th><td>mod_imap</td></tr></table>
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder <p>The <code class="directive">ImapDefault</code> directive sets the default
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer <code>default</code> used in the imagemap files. Its value is
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer overridden by a <code>default</code> directive within the
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer imagemap file. If not present, the <code>default</code> action
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder is <code>nocontent</code>, which means that a <code>204 No
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer Content</code> is sent to the client. In this case, the client
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder should continue to display the original page.</p>
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer</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>Description:
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder </th><td>Action if no coordinates are given when calling
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyeran imagemap</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder </a></th><td>ImapMenu
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder none|formatted|semiformatted|unformatted</td></tr><tr><th><a href="directive-dict.html#Context">Context:
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer </a></th><td>Indexes</td></tr><tr><th><a href="directive-dict.html#Status">Status:
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module:
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder </a></th><td>mod_imap</td></tr></table>
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder <p>The <code class="directive">ImapMenu</code> directive determines the
84ba39232a012abf2085c8a421ebce6abc52d56eThiemo Wiedemeyer action taken if an imagemap file is called without valid
80df5ce65c2bad7a0643106e524fe33cdcfab5b6Thiemo Wiedemeyer coordinates.</p>
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder <dl>
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder <dt><code>none</code></dt>
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder <dd>If ImapMenu is <code>none</code>, no menu is generated,
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder and the <code>default</code> action is performed.</dd>
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer <dt><code>formatted</code></dt>
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer <dd>A <code>formatted</code> menu is the simplest menu.
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer Comments in the imagemap file are ignored. A level one header
32d98ca5e560cf6c1062a0463be4c350af32bed5Thiemo Wiedemeyer is printed, then an hrule, then the links each on a separate
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder line. The menu has a consistent, plain look close to that of
788bd3c33ec5aaeb90a1932c341ff837116410cfThiemo Wiedemeyer a directory listing.</dd>
32d98ca5e560cf6c1062a0463be4c350af32bed5Thiemo Wiedemeyer
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer <dt><code>semiformatted</code></dt>
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder <dd>In the <code>semiformatted</code> menu, comments are
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer printed where they occur in the imagemap file. Blank lines
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer are turned into HTML breaks. No header or hrule is printed,
84ba39232a012abf2085c8a421ebce6abc52d56eThiemo Wiedemeyer but otherwise the menu is the same as a
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder <code>formatted</code> menu.</dd>
84ba39232a012abf2085c8a421ebce6abc52d56eThiemo Wiedemeyer
1ac36418f204bbe56f4cd951a979180721758999Christian Maeder <dt><code>unformatted</code></dt>
370e81d7af7821f0ac6ee0643613e87a727841e7Thiemo Wiedemeyer
84ba39232a012abf2085c8a421ebce6abc52d56eThiemo Wiedemeyer <dd>Comments are printed, blank lines are ignored. Nothing is
66fd8f017efdb8a6c862c3f1856dfaef90865dd5Thiemo Wiedemeyer printed that does not appear in the imagemap file. All breaks
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder and headers must be included as comments in the imagemap
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder file. This gives you the most flexibility over the appearance
239991d3955da0cfb760af4d506069446e1676b7Christian Maeder of your menus, but requires you to treat your map files as
545d0cd78159cade346b579d06052638b19b0f72Thiemo Wiedemeyer HTML instead of plaintext.</dd>
1a389234e68da7c3d087b038307ed8c66fc6dc32Thiemo Wiedemeyer </dl>
1a389234e68da7c3d087b038307ed8c66fc6dc32Thiemo Wiedemeyer</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div></body></html>