From: Andre Malo Date: Thu, 14 Nov 2002 18:43:32 +0000 (+0000) Subject: - adding markup X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8be110992c89ee09e55cd99a5b827efedcdce2a0;p=thirdparty%2Fapache%2Fhttpd.git - adding markup - reformatting a bit - -> - add seealso to UseCanonicalName - add explicit XHTML example - " inside quoted text is not impossible, it can be written as " git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97520 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_imap.xml b/docs/manual/mod/mod_imap.xml index 1ca6bdbb8d5..3e7ca7efabf 100644 --- a/docs/manual/mod/mod_imap.xml +++ b/docs/manual/mod/mod_imap.xml @@ -21,17 +21,17 @@

The following directive will activate files ending with .map as imagemap files:

-AddHandler imap-file map + AddHandler imap-file map

Note that the following is still supported:

-AddType application/x-httpd-imap map + AddType application/x-httpd-imap map

However, we are trying to phase out "magic MIME types" so we are deprecating this method.

-
New Features +
New Features

The imagemap module adds some new features that were not possible with previously distributed imagemap programs.

@@ -39,7 +39,7 @@
  • URL references relative to the Referer: information.
    • -
  • Default <BASE> assignment through a new map +
  • Default <base> assignment through a new map directive base.
  • No need for imagemap.conf file.
    • @@ -50,53 +50,56 @@
-
Imagemap File +
Imagemap File

The lines in the imagemap files can have one of several formats:

- - directive value [x,y ...]
- directive value "Menu text" [x,y ...]
- directive value x,y ... "Menu text" - + + directive value [x,y ...]
+ directive value "Menu text" [x,y + ...]
+ directive value x,y ... "Menu text" + +

The directive is one of base, default, poly, circle, rect, or point. The value is an absolute or relative URL, or one of the special values listed - below. The coordinates are x,y 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 x,y + 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.

-
Imagemap File Directives -

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.

+
Imagemap File Directives +

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.

-
+
base Directive
-
Has the effect of <BASE HREF="value">. - The non-absolute URLs of the map-file are taken relative to - this value. The base directive overrides - ImapBase as set in a .htaccess file or in the server - configuration files. In the absence of an ImapBase - configuration directive, base defaults to - http://server_name/.
- base_uri is synonymous with base. - Note that a trailing slash on the URL is significant.
+

Has the effect of <base href="value"> + . The non-absolute URLs of the map-file are taken relative + to this value. The base directive overrides + ImapBase as set in a + .htaccess file or in the server configuration files. + In the absence of an ImapBase configuration + directive, base defaults to + http://server_name/.

+

base_uri is synonymous with base. + Note that a trailing slash on the URL is significant.

default Directive
The action taken if the coordinates given do not fit any of the poly, circle or rect directives, and there are no - point directives. Defaults to - nocontent in the absence of an ImapDefault - configuration setting, causing a status code of 204 No - Content to be returned. The client should keep the - same page displayed.
+ point directives. Defaults to nocontent + in the absence of an ImapDefault configuration setting, causing a status + code of 204 No Content to be returned. The client + should keep the same page displayed.
poly Directive
@@ -123,39 +126,38 @@ satisfied. Note that default will not be followed if a point directive is present and valid coordinates are given. -
-
+ +
-
Values +
Values -

The values for each of the directives can any of the following:

- +

The values for each of the directives can any of the following:

-
+
a URL
-
The URL can be relative or absolute URL. Relative URLs +

The URL can be relative or absolute URL. Relative URLs can contain '..' syntax and will be resolved relative to the - base value.
- base itself will not resolved according to the + base value.

+

base itself will not resolved according to the current value. A statement base mailto: will - work properly, though.

+ work properly, though.

map
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'.
+ unless ImapMenu is set to + none.
menu
-
Synonymous with map.
referer
Equivalent to the URL of the referring document. Defaults - to http://servername/ if no Referer: header was - present.
+ to http://servername/ if no Referer: + header was present.
nocontent
@@ -168,85 +170,96 @@
Fails with a 500 Server Error. Valid for all but base, but sort of silly for anything but default.
-
-
+ +
-
Coordinates +
Coordinates -
+
0,0 200,200
-
A coordinate consists of an x and a y +
A coordinate consists of an x and a y 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 0,0, it is as if no coordinate had been selected.
-
+
-
+
-
Quoted Text +
Quoted Text -
-
"Menu Text"
+
+
"Menu Text"
-
After the value or after the coordinates, the line +

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:
- <a HREF="http://foo.com/">Menu - text</a>
- If no quoted text is present, the name of the link will be - used as the text:
- <a - HREF="http://foo.com/">http://foo.com</a>
- It is impossible to escape double quotes within this - text.

-
-
+ generated:

+ + + <a href="http://foo.com/">Menu text</a> + + +

If no quoted text is present, the name of the link will be + used as the text:

+ + + <a href="http://foo.com/">http://foo.com</a> + + +

If you want to use double quotes within this text, you have to + write them as &quot;.

+ + +
-
Example Mapfile - - - #Comments are printed in a 'formatted' or - 'semiformatted' menu.
- #And can contain html tags. <hr>
- base referer
- poly map "Could I have a menu, please?" 0,0 0,10 10,10 - 10,0
- rect .. 0,0 77,27 "the directory of the referer"
- circle http://www.inetnebr.com/lincoln/feedback/ 195,0 - 305,27
- rect another_file "in same directory as referer" 306,0 - 419,27
- point http://www.zyzzyva.com/ 100,100
- point http://www.tripod.com/ 200,200
- rect mailto:nate@tripod.com 100,150 200,0 "Bugs?"
- +
Example Mapfile + + + #Comments are printed in a 'formatted' or 'semiformatted' menu.
+ #And can contain html tags. <hr>
+ base referer
+ poly map "Could I have a menu, please?" 0,0 0,10 10,10 10,0
+ rect .. 0,0 77,27 "the directory of the referer"
+ circle http://www.inetnebr.com/lincoln/feedback/ 195,0 305,27
+ rect another_file "in same directory as referer" 306,0 419,27
+ point http://www.zyzzyva.com/ 100,100
+ point http://www.tripod.com/ 200,200
+ rect mailto:nate@tripod.com 100,150 200,0 "Bugs?"
+
-
Referencing your mapfile +
Referencing your mapfile + + HTML example + <a href="/maps/imagemap1.map">
+ + <img ismap src="/images/imagemap1.gif">
+ + </a> + + + XHTML example + <a href="/maps/imagemap1.map">
+ + <img ismap="ismap" src="/images/imagemap1.gif" />
+ + </a> + - - <A HREF="/maps/imagemap1.map">
- <IMG ISMAP SRC="/images/imagemap1.gif">
- </A> -
ImapMenu Action if no coordinates are given when calling an imagemap -ImapMenu - none|formatted|semiformatted|unformatted -server config -virtual host -directory -.htaccess +ImapMenu none|formatted|semiformatted|unformatted +server configvirtual host +directory.htaccess Indexes @@ -256,12 +269,10 @@ an imagemap
none
-
If ImapMenu is none, no menu is generated, and the default action is performed.
formatted
-
A formatted 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 @@ -269,7 +280,6 @@ an imagemap a directory listing.
semiformatted
-
In the semiformatted menu, comments are printed where they occur in the imagemap file. Blank lines are turned into HTML breaks. No header or hrule is printed, @@ -277,7 +287,6 @@ an imagemap formatted menu.
unformatted
-
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 @@ -292,12 +301,10 @@ an imagemap ImapDefault Default action when an imagemap is called with coordinates that are not explicitly mapped -ImapDefault error|nocontent|map|referer|URL +ImapDefault error|nocontent|map|referer|URL ImapDefault nocontent -server config -virtual host -directory -.htaccess +server configvirtual host +directory.htaccess Indexes @@ -314,12 +321,10 @@ that are not explicitly mapped ImapBase Default base for imagemap files -ImapBase map|referer|URL +ImapBase map|referer|URL ImapBase http://servername/ -server config -virtual host -directory -.htaccess +server configvirtual host +directory.htaccess Indexes @@ -327,8 +332,9 @@ that are not explicitly mapped base used in the imagemap files. Its value is overridden by a base directive within the imagemap file. If not present, the base defaults to - http://servername/.

+ http://servername/.

 +UseCanonicalName \ No newline at end of file