root/Apache-Clickable/trunk/README

Revision 637 (checked in by miyagawa, 18 years ago)

add

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 NAME
2     Apache::Clickable - Make URLs and Emails in HTML clickable
3
4 SYNOPSIS
5       # in httpd.conf
6       <Location /clickable>
7       SetHandler perl-script
8       PerlHandler Apache::Clickable
9       </Location>
10
11       # filter aware
12       PerlModule Apache::Clickable
13       SetHandler perl-script
14       PerlSetVar Filter On
15       PerlHandler Apache::Clickable Apache::AntiSpam Apache::Compress
16
17 DESCRIPTION
18     Apache::Clickable is a filter to make URLs in HTML clickable. With
19     URI::Find and Email::Find, this module finds URL and Email in HTML
20     document, and automatically constructs hyperlinks for them.
21
22     For example,
23
24       <body>
25       Documentation is available at http://www.foobar.com/ freely.<P>
26       someone@foobar.com 
27       </body>
28
29     This HTML would be filtered to:
30
31       <body>
32       Documentation is available at <a href="http://www.foobar.com/">http://www.foobar.com</a> freely.<P>
33       <a href="mailto:someone@foobar.com">someone@foobar.com</a>
34       </body>
35
36     This module is Filter aware, meaning that it can work within
37     Apache::Filter framework without modification.
38
39 CONFIGURATION
40       PerlSetVar ClickableTarget _blank
41       PerlSetVar ClickableEmail Off
42
43     ClickableTarget
44           PerlSetVar ClickableTarget _blank
45
46         specifies target window name of hyperlinks. If set "_blank" for
47         example, it filters to:
48
49           <a href="http://www.foobar.com/" target="_blank">http://www.foobar.com/</a>
50
51         None by default.
52
53     ClickableEmail
54           PerlSetVar ClickableEmail Off
55
56         specifies whether it makes email clickable. On by default. See the
57         Apache::AntiSpam manpage for more.
58
59 TODO
60     *   Configurable hyperlink construction using subclass.
61
62     *   Currently, this module requires HTML::Parser, not to make duplicate
63         hyperlinks. Maybe this can be done without HTML::Parser.
64
65 AUTHOR
66     Tatsuhiko Miyagawa <miyagawa@bulknews.net>
67
68     This library is free software; you can redistribute it and/or modify it
69     under the same terms as Perl itself.
70
71 SEE ALSO
72     the Apache::Filter manpage, the Apache::AntiSpam manpage, the URI::Find
73     manpage, the Email::Find manpage, the HTML::Parser manpage
74
Note: See TracBrowser for help on using the browser.