[Rt-commit] rt branch, 4.0/remove-duplicate-makeclicky-docs, created. rt-4.0.19-83-g1f8ee98

Alex Vandiver alexmv at bestpractical.com
Fri Apr 25 15:18:29 EDT 2014


The branch, 4.0/remove-duplicate-makeclicky-docs has been created
        at  1f8ee98673ae6fc64a00c648fa10c5c631800f7b (commit)

- Log -----------------------------------------------------------------
commit 1f8ee98673ae6fc64a00c648fa10c5c631800f7b
Author: Alex Vandiver <alexmv at bestpractical.com>
Date:   Fri Apr 25 15:16:57 2014 -0400

    Remove duplicated MakeClicky documentation
    
    The docs added in 224edae0 were a merely a copy of the <%doc> block in /Elements/MakeClicky; stop forcing changes to be made in what are effectively two equal documents.  The docs/ version is POD-formatted, and more discoverable, so keep that copy.

diff --git a/share/html/Elements/MakeClicky b/share/html/Elements/MakeClicky
index 444b876..8efe78c 100644
--- a/share/html/Elements/MakeClicky
+++ b/share/html/Elements/MakeClicky
@@ -180,46 +180,3 @@ pos($$content) = 0;
 $cache->(store => $content) if defined $cache;
 
 </%INIT>
-<%doc>
-
-MakeClicky detects various formats of data in headers and email
-messages, and extends them with supporting links.  By default, RT
-provides two formats:
-
- * 'httpurl': detects http:// and https:// URLs and adds '[Open URL]'
-   link after the URL.
-
- * 'httpurl_overwrite': also detects URLs as 'httpurl' format, but
-   replace URL with link.
-
-To extend this with your own types of data, use the callback.
-It will be provided with:
-
- * 'types': An array reference of hash references.  Modify this array
-    reference to add your own types; the first matching type will be
-    used.  Each hashref should contain:
-   - 'name': The name of the data format; this is used in the
-      configuration file to enable the format.
-   - 'regex': A regular expression to match against
-   - 'action': The name of the action to run (see "actions", below)
-
- * 'actions': A hash reference of 'actions'.  Modify this hash
-    reference to change or add action types.  Values are subroutine
-    references which will get called when needed.  They should return
-    the modified string. Note that subroutine must escape HTML.
-
- * 'handle': A reference to a subroutine reference; modify it if you
-    have to. This can be used to add pre- or post-processing around
-    all actions.
-
- * 'cache': An undefined variable that should be replaced with a
-   subroutine reference. This subroutine will be called twice, once with
-   the arguments fetch => content_ref and once with store =>
-   content_ref. In the fetch case, if a cached copy is found, return the
-   cached content, otherwise return a false value. When passed store,
-   you should populate your cache with the content. The return value is
-   ignored in this case.
-
-Read more about writing new actions in docs/extending/clickable_links.pod
-
-</%doc>

-----------------------------------------------------------------------


More information about the rt-commit mailing list