ConfigSchema/schema/URI.Munge.txt

0001 URI.Munge
0002 TYPE: string/null
0003 VERSION: 1.3.0
0004 DEFAULT: NULL
0005 --DESCRIPTION--
0006
0007 <p>
0008     Munges all browsable (usually http, https and ftp)
0009     absolute URIs into another URI, usually a URI redirection service.
0010     This directive accepts a URI, formatted with a <code>%s</code> where
0011     the url-encoded original URI should be inserted (sample:
0012     <code>http://www.google.com/url?q=%s</code>).
0013 </p>
0014 <p>
0015     Uses for this directive:
0016 </p>
0017 <ul>
0018     <li>
0019         Prevent PageRank leaks, while being fairly transparent
0020         to users (you may also want to add some client side JavaScript to
0021         override the text in the statusbar). <strong>Notice</strong>:
0022         Many security experts believe that this form of protection does not deter spam-bots.
0023     </li>
0024     <li>
0025         Redirect users to a splash page telling them they are leaving your
0026         website. While this is poor usability practice, it is often mandated
0027         in corporate environments.
0028     </li>
0029 </ul>
0030 <p>
0031     Prior to HTML Purifier 3.1.1, this directive also enabled the munging
0032     of browsable external resources, which could break things if your redirection
0033     script was a splash page or used <code>meta</code> tags. To revert to
0034     previous behavior, please use %URI.MungeResources.
0035 </p>
0036 <p>
0037     You may want to also use %URI.MungeSecretKey along with this directive
0038     in order to enforce what URIs your redirector script allows. Open
0039     redirector scripts can be a security risk and negatively affect the
0040     reputation of your domain name.
0041 </p>
0042 <p>
0043     Starting with HTML Purifier 3.1.1, there is also these substitutions:
0044 </p>
0045 <table>
0046     <thead>
0047         <tr>
0048             <th>Key</th>
0049             <th>Description</th>
0050             <th>Example <code>&lt;a href=""&gt;</code></th>
0051         </tr>
0052     </thead>
0053     <tbody>
0054         <tr>
0055             <td>%r</td>
0056             <td>1 - The URI embeds a resource<br />(blank) - The URI is merely a link</td>
0057             <td></td>
0058         </tr>
0059         <tr>
0060             <td>%n</td>
0061             <td>The name of the tag this URI came from</td>
0062             <td>a</td>
0063         </tr>
0064         <tr>
0065             <td>%m</td>
0066             <td>The name of the attribute this URI came from</td>
0067             <td>href</td>
0068         </tr>
0069         <tr>
0070             <td>%p</td>
0071             <td>The name of the CSS property this URI came from, or blank if irrelevant</td>
0072             <td></td>
0073         </tr>
0074     </tbody>
0075 </table>
0076 <p>
0077     Admittedly, these letters are somewhat arbitrary; the only stipulation
0078     was that they couldn't be a through f. r is for resource (I would have preferred
0079     e, but you take what you can get), n is for name, m
0080     was picked because it came after n (and I couldn't use a), p is for
0081     property.
0082 </p>
0083 --# vim: et sw=4 sts=4