mod_imap.html revision 1997e02bed99bd0c081962ade257a0ea12ebe15b
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
15a44745412679c30a6d022733925af70a38b715David Lawrence BGCOLOR="#FFFFFF"
15a44745412679c30a6d022733925af70a38b715David Lawrence TEXT="#000000"
15a44745412679c30a6d022733925af70a38b715David Lawrence LINK="#0000FF"
15a44745412679c30a6d022733925af70a38b715David Lawrence VLINK="#000080"
15a44745412679c30a6d022733925af70a38b715David Lawrence ALINK="#FF0000"
15a44745412679c30a6d022733925af70a38b715David Lawrence<!--#include virtual="header.html" -->
9259fed3d8ac5d1efa9b5a647969e40c9c934484Andreas Gustafsson<p>This module provides for server-side imagemap processing.</p>
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson><STRONG>Source File:</STRONG></A> mod_imap.c
9259fed3d8ac5d1efa9b5a647969e40c9c934484Andreas GustafssonHREF="module-dict.html#ModuleIdentifier"
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson><STRONG>Module Identifier:</STRONG></A> imap_module
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas GustafssonHREF="module-dict.html#compatibility"
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson><STRONG>Compatibility:</STRONG></A> Available in Apache 1.1 and later.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<p>This module processes <CODE>.map</CODE> files, thereby replacing
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafssonthe functionality of the <CODE>imagemap</CODE> CGI program. Any
7a184cd4e5a54a4e530f9bff8a4e46be392d0b52Brian Wellingtondirectory or document type configured to use the handler
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<CODE>imap-file</CODE> (using either <CODE><A
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas GustafssonHREF="mod_mime.html#addhandler">AddHandler</A> </CODE> or <CODE><A
9df7d74e421cf715c6e3cbbad2aba6d33a5d1c9bBrian WellingtonHREF="mod_mime.html#sethandler">SetHandler</A></CODE>) will be
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafssonprocessed by this module.</p>
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<p>The following directive will
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrenceactivate files ending with <CODE>.map</CODE> as imagemap files:
1a69a1a78cfaa86f3b68bbc965232b7876d4da2aDavid Lawrence<BLOCKQUOTE><CODE>AddHandler imap-file map</CODE></BLOCKQUOTE>
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas GustafssonNote that the following is still supported:
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson <BLOCKQUOTE><CODE>AddType application/x-httpd-imap map</CODE></BLOCKQUOTE>
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas GustafssonHowever, we are trying to phase out "magic MIME types" so we are deprecating
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<LI><A HREF="#imapdefault">ImapDefault</A>
6e49e91bd08778d7eae45a2229dcf41ed97cc636David LawrenceThe imagemap module adds some new features that were not
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafssonpossible with previously distributed imagemap programs.<P>
7a184cd4e5a54a4e530f9bff8a4e46be392d0b52Brian Wellington<LI>URL references relative to the Referer: information.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<LI>Default <BASE> assignment through a new map directive
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<LI>No need for <CODE>imagemap.conf</CODE> file.
7a184cd4e5a54a4e530f9bff8a4e46be392d0b52Brian Wellington<LI>Point references.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<LI>Configurable generation of imagemap menus.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas GustafssonThe lines in the imagemap files can have one of several formats:
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<CODE>directive value [x,y ...]</CODE><BR>
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence<CODE>directive value "Menu text" [x,y ...]</CODE><BR>
9df7d74e421cf715c6e3cbbad2aba6d33a5d1c9bBrian Wellington<CODE>directive value x,y ... "Menu text"</CODE><BR>
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas GustafssonThe directive is one of <CODE>base</CODE>, <CODE>default</CODE>,
6e49e91bd08778d7eae45a2229dcf41ed97cc636David Lawrence<CODE>poly</CODE>, <CODE>circle</CODE>, <CODE>rect</CODE>, or
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<CODE>point</CODE>. The value is an absolute or relative URL, or one
fb01226bcd598c36b5edc566489c890c39f03ed3Brian Wellingtonof the special values listed below. The coordinates are
7a184cd4e5a54a4e530f9bff8a4e46be392d0b52Brian Wellington<CODE>x,y</CODE> pairs separated by whitespace. The quoted text is
fb01226bcd598c36b5edc566489c890c39f03ed3Brian Wellingtonused as the text of the link if a imagemap menu is generated. Lines
fb01226bcd598c36b5edc566489c890c39f03ed3Brian Wellingtonbeginning with '#' are comments.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas GustafssonThere are six directives allowed in the imagemap file. The directives
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafssoncan come in any order, but are processed in the order they are found
7dde2780aeae0da4e965d823578a604d8ce1215fAndreas Gustafssonin the imagemap file.
7dde2780aeae0da4e965d823578a604d8ce1215fAndreas Gustafsson<DD>Has the effect of <CODE><BASE HREF="value"></CODE>. The
7dde2780aeae0da4e965d823578a604d8ce1215fAndreas Gustafsson non-absolute URLs of the map-file are taken relative to this value.
7dde2780aeae0da4e965d823578a604d8ce1215fAndreas Gustafsson The <CODE>base</CODE> directive overrides ImapBase as set in a
7dde2780aeae0da4e965d823578a604d8ce1215fAndreas Gustafsson .htaccess file or in the server configuration files. In the absence
7dde2780aeae0da4e965d823578a604d8ce1215fAndreas Gustafsson of an ImapBase configuration directive, <CODE>base</CODE> defaults to
7dde2780aeae0da4e965d823578a604d8ce1215fAndreas Gustafsson <CODE>base_uri</CODE> is synonymous with <CODE>base</CODE>. Note that
7dde2780aeae0da4e965d823578a604d8ce1215fAndreas Gustafsson a trailing slash on the URL is significant.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<DD>The action taken if the coordinates given do not fit any of the
7dde2780aeae0da4e965d823578a604d8ce1215fAndreas Gustafsson <CODE>poly</CODE>, <CODE>circle</CODE> or <CODE>rect</CODE>
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson directives, and there are no <CODE>point</CODE> directives. Defaults
9df7d74e421cf715c6e3cbbad2aba6d33a5d1c9bBrian Wellington to <CODE>nocontent</CODE> in the absence of an ImapDefault
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson configuration setting, causing a status code of <CODE>204 No
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson Content</CODE> to be returned. The client should keep the same
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson page displayed.
9259fed3d8ac5d1efa9b5a647969e40c9c934484Andreas Gustafsson<DD>Takes three to one-hundred points, and is obeyed if the user selected
c885fad9b8bf204ae9e62c9acb0321e2bcca30a4Andreas Gustafsson coordinates fall within the polygon defined by these points.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<DD>Takes the center coordinates of a circle and a point on the circle. Is
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson obeyed if the user selected point is with the circle.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<DD>Takes the coordinates of two opposing corners of a rectangle. Obeyed
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson if the point selected is within this rectangle.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson<DD>Takes a single point. The point directive closest to the user
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson selected point is obeyed if no other directives are satisfied.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson Note that <CODE>default</CODE> will not be followed if a
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson <CODE>point</CODE> directive is present and valid coordinates are
8c7eaac6bbcc9746afe8f57b60bb964745c01eafAndreas GustafssonThe values for each of the directives can any of the following:
8c7eaac6bbcc9746afe8f57b60bb964745c01eafAndreas Gustafsson <DD>The URL can be relative or absolute URL. Relative URLs can
8c7eaac6bbcc9746afe8f57b60bb964745c01eafAndreas Gustafsson contain '..' syntax and will be resolved relative to the
8c7eaac6bbcc9746afe8f57b60bb964745c01eafAndreas Gustafsson <CODE>base</CODE> itself will not resolved according to the current
8c7eaac6bbcc9746afe8f57b60bb964745c01eafAndreas Gustafsson value. A statement <CODE>base mailto:</CODE> will work properly, though.
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson <DD>Equivalent to the URL of the imagemap file itself. No
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson coordinates are sent with this, so a menu will be generated
f93d33e24fdf76eb2558168f018b8992bcfc5681Andreas Gustafsson unless ImapMenu is set to 'none'.
HREF="directive-dict.html#Syntax"
HREF="directive-dict.html#Context"
HREF="directive-dict.html#Override"
HREF="directive-dict.html#Module"
HREF="directive-dict.html#Compatibility"
HREF="directive-dict.html#Syntax"
HREF="directive-dict.html#Context"
HREF="directive-dict.html#Override"
HREF="directive-dict.html#Module"
HREF="directive-dict.html#Compatibility"
HREF="directive-dict.html#Syntax"
HREF="directive-dict.html#Context"
HREF="directive-dict.html#Override"
HREF="directive-dict.html#Module"
HREF="directive-dict.html#Compatibility"
<!--#include virtual="footer.html" -->