Bug 13618: Add POD to raw.pm
authorJonathan Druart <jonathan.druart@bugs.koha-community.org>
Fri, 17 Aug 2018 16:11:28 +0000 (13:11 -0300)
committerNick Clemens <nick@bywatersolutions.com>
Fri, 17 Aug 2018 16:14:14 +0000 (16:14 +0000)
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Koha/Template/Plugin/raw.pm

index 113ca41..f194a18 100644 (file)
@@ -28,3 +28,31 @@ sub filter {
 }
 
 1;
+
+=head1 NAME
+
+Koha::Template::Plugin::raw - TT Plugin for filtering variables as raw
+
+=head1 SYNOPSIS
+
+[% USE raw %]
+
+[% my_var | $raw %]
+
+The variable will not be modified and display at it.
+
+It is required to use a filter to display any variables in .tt or .inc
+
+In most of the case, you need to use the html filter instead.
+
+=head1 METHODS
+
+=head2 filter
+
+Will return the variable as it. Nothing is changed.
+
+=head1 AUTHOR
+
+Jonathan Druart <jonathan.druart@biblibre.com>
+
+=cut