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

[Wallace Reis]

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

- Log -----------------------------------------------------------------
commit fa52686ac781509d22a3d838f3b80a47f463a287
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..0530fd8
--- /dev/null
+++ b/docs/writing_portlets.pod
@@ -0,0 +1,46 @@
+=head1 Introduction
+
+A "portlet" is a component used to extend your RT instance, specifically
+the "RT-at-a-glance" home and Self-Service pages.  For instance, the
+"n Highest Priority Tickets I own", "Quick Ticket Creation" and
+"Quick Search" panels on the default homepage 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 Mason template in C</opt/rt4/local/html/Elements> that defines
+your portlet's behaviour.
+
+=item Set C<$HomepageComponents> config
+
+Enable your portlet by adding its name to the C<$HomepageComponents>
+configuration variable in RT_SiteConfig.pm.
+
+=back
+
+Once you have created and installed your portlet, you will need 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 have the same preferences
+available to them.  You will have to create your element in
+C</opt/rt4/local/html/SelfService/Elements>, then exend the SelfService
+interface to call it.  Copy C</opt/rt4/html/SelfService/index.html> to
+C</opt/rt4/local/html/SelfService/index.html>, then edit it to add:
+
+    <& /SelfService/Elements/MyPortlet &>
+
+=cut

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