Bug 4173: Followup: Document KohaAuthorisedValues plugin

[koha.git] / Koha / Template / Plugin / KohaAuthorisedValues.pm

diff --git a/Koha/Template/Plugin/KohaAuthorisedValues.pm b/Koha/Template/Plugin/KohaAuthorisedValues.pm
index 58297c0..68b1347 100644 (file)
--- a/Koha/Template/Plugin/KohaAuthorisedValues.pm
+++ b/Koha/Template/Plugin/KohaAuthorisedValues.pm
@@ -24,6 +24,24 @@ use base qw( Template::Plugin );
 
 use C4::Koha;
 
+=pod
+
+This plugin allows one to get the description for an authorised value
+from within a template.
+
+First, include the line '[% USE KohaAuthorisedValues %]' at the top
+of the template to enable the plugin.
+
+To use, call KohaAuthorisedValues.GetByCode with the category
+of the authorised value, the code to look up, and optionally,
+the OPAC flag ( if set, it will return the OPAC description rather
+than the Intranet description ).
+
+For example: [% KohaAuthorisedValues.GetByCode( 'LOST', item.itemlost, 1 ) %]
+will print the OPAC description for the LOST value stored in item.itemlost.
+
+=cut
+
 sub GetByCode {
     my ( $self, $category, $code, $opac ) = @_;
     return GetAuthorisedValueByCode( $category, $code, $opac );