[Rt-commit] rt branch, 4.0/writing-portlets, created. rt-4.0.22-18-g77ae5eb

[Wallace Reis]

The branch, 4.0/writing-portlets has been created
        at  77ae5ebc7390f8e330da3bc196f6ef1c8ea08b59 (commit)

- Log -----------------------------------------------------------------
commit 77ae5ebc7390f8e330da3bc196f6ef1c8ea08b59
Author: Wallace Reis <wreis at bestpractical.com>
Date:   Fri Oct 24 15:42:15 2014 -0300

    Writing portlets documentation

diff --git a/docs/writing_portlets.pod b/docs/writing_portlets.pod
new file mode 100644
index 0000000..5fb1b30
--- /dev/null
+++ b/docs/writing_portlets.pod
@@ -0,0 +1,44 @@
+=head1 Introduction
+
+Portlet is a component used to extend your RT instance, more especifically the
+"RT-at-a-glance" home and Self-Service pages. For instance, the panels "n
+Highest Priority Tickets I own", "Quick Ticket Creation" and "Quick Search"
+are portlets.
+
+=head1 Creating the Portlet
+
+There are at least two things you have to do to create a portlet:
+
+=over
+
+=item Create the template
+
+Create a template file in C<< <rt-base-dir>/local/html/Elements >> that defines your
+portlet's behaviour.
+
+=item Set C<$HomepageComponents> config
+
+Enable your portlet by adding it's name to the C<$HomepageComponents>
+configuration variable in RT_SiteConfig.pm.
+
+=back
+
+Once you have created and installed your portlet, then you have to restart the
+webserver.
+
+=head1 Customizing home page
+
+When you click on the "Edit" link at your home page (or go there via your
+preferences), you can select which of the available portlets are displayed in
+the "body" (left) or "summary" (right) columns of the home page.
+
+=head1 Customizing Self-Service page
+
+They can also appear on the Self-Service interface, but have to be hard-coded,
+because Self-Service users don't get the same preferences available to them.
+You need to manually edit C<< <rt-base-dir>/local/html/SelfService/index.html
+>>. You just have to create your element in
+C<< <rt-base-dir>/local/html/SelfService/Elements >> and call it from within
+the index.html file with something like:
+
+    <& /SelfService/Elements/MyPortlet &>

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