[add] HTML Purifier added to clean code

[github/wallabag/wallabag.git] / inc / 3rdparty / htmlpurifier / HTMLPurifier / ConfigSchema / schema / URI.Munge.txt

URI.Munge\r
TYPE: string/null\r
VERSION: 1.3.0\r
DEFAULT: NULL\r
--DESCRIPTION--\r
\r
<p>\r
    Munges all browsable (usually http, https and ftp)\r
    absolute URIs into another URI, usually a URI redirection service.\r
    This directive accepts a URI, formatted with a <code>%s</code> where\r
    the url-encoded original URI should be inserted (sample:\r
    <code>http://www.google.com/url?q=%s</code>).\r
</p>\r
<p>\r
    Uses for this directive:\r
</p>\r
<ul>\r
    <li>\r
        Prevent PageRank leaks, while being fairly transparent\r
        to users (you may also want to add some client side JavaScript to\r
        override the text in the statusbar). <strong>Notice</strong>:\r
        Many security experts believe that this form of protection does not deter spam-bots.\r
    </li>\r
    <li>\r
        Redirect users to a splash page telling them they are leaving your\r
        website. While this is poor usability practice, it is often mandated\r
        in corporate environments.\r
    </li>\r
</ul>\r
<p>\r
    Prior to HTML Purifier 3.1.1, this directive also enabled the munging\r
    of browsable external resources, which could break things if your redirection\r
    script was a splash page or used <code>meta</code> tags. To revert to\r
    previous behavior, please use %URI.MungeResources.\r
</p>\r
<p>\r
    You may want to also use %URI.MungeSecretKey along with this directive\r
    in order to enforce what URIs your redirector script allows. Open\r
    redirector scripts can be a security risk and negatively affect the\r
    reputation of your domain name.\r
</p>\r
<p>\r
    Starting with HTML Purifier 3.1.1, there is also these substitutions:\r
</p>\r
<table>\r
    <thead>\r
        <tr>\r
            <th>Key</th>\r
            <th>Description</th>\r
            <th>Example <code>&lt;a href=""&gt;</code></th>\r
        </tr>\r
    </thead>\r
    <tbody>\r
        <tr>\r
            <td>%r</td>\r
            <td>1 - The URI embeds a resource<br />(blank) - The URI is merely a link</td>\r
            <td></td>\r
        </tr>\r
        <tr>\r
            <td>%n</td>\r
            <td>The name of the tag this URI came from</td>\r
            <td>a</td>\r
        </tr>\r
        <tr>\r
            <td>%m</td>\r
            <td>The name of the attribute this URI came from</td>\r
            <td>href</td>\r
        </tr>\r
        <tr>\r
            <td>%p</td>\r
            <td>The name of the CSS property this URI came from, or blank if irrelevant</td>\r
            <td></td>\r
        </tr>\r
    </tbody>\r
</table>\r
<p>\r
    Admittedly, these letters are somewhat arbitrary; the only stipulation\r
    was that they couldn't be a through f. r is for resource (I would have preferred\r
    e, but you take what you can get), n is for name, m\r
    was picked because it came after n (and I couldn't use a), p is for\r
    property.\r
</p>\r
--# vim: et sw=4 sts=4\r