[Bps-public-commit] r8715 - in RT-Extension-TicketLocking: .

[ruz at bestpractical.com]

Author: ruz
Date: Fri Aug 24 09:57:46 2007
New Revision: 8715

Modified:
   RT-Extension-TicketLocking/README
   RT-Extension-TicketLocking/lib/RT/Extension/TicketLocking.pm

Log:
* incorporate docs in one place

Modified: RT-Extension-TicketLocking/README
==============================================================================
--- RT-Extension-TicketLocking/README	(original)
+++ RT-Extension-TicketLocking/README	Fri Aug 24 09:57:46 2007
@@ -6,56 +6,15 @@
 
     perl Makefile.PL
     make
-    make test
     make install
 
+DOCUMENTAION
 
-To use this module, you must add the line
-
-    use RT::Extension::TicketLocking;
-
-to the bottom of your RT_SiteConfig.pm file. You must also define a lock expiry (the longest time
-a lock can remain without being automatically removed, by adding a line like the following to your
-RT_SiteConfig.pm file:
-
-    Set($LockExpiry, 300);
-    
-Expiration time is measured in seconds. If you don't wish to have your locks automatically expire,
-simply set $LockExpiry to a false value.
-
-
-If you want the MyLocks portlet to be available from the RT at a Glance page, you will need to 
-enable it with a line like this in your RT_SiteConfig.pm file
-
-Set($HomepageComponents, [qw(QuickCreate Quicksearch MyAdminQueues MySupportQueues MyReminders
-                             RefreshHomepage MyLocks)]);
-
-This is the default portlet list with MyLocks added to the end. People can then choose to add 
-the portlet to their homepage in Preferences -> RT at a glance.
-
-
-If you are running RTIR, and want the portlet to be available from the RTIR home page, you will
-need to do something similar to set the RTIR_HomepageComponents array in your RTIR_Config.pm file,
-like this:
-
-Set(@RTIR_HomepageComponents, qw(
-    QuickCreate
-    Quicksearch
-    MyAdminQueues
-    MySupportQueues
-    MyReminders
-    /RTIR/Elements/NewReports
-    /RTIR/Elements/UserDueIncidents
-    /RTIR/Elements/NobodyDueIncidents
-    /RTIR/Elements/DueIncidents
-    /RTIR/Elements/QueueSummary
-    RefreshHomepage
-    MyLocks
-));
-
-This is the default RTIR portlet list with MyLocks added to the end. People can then choose to add 
-the portlet to their homepage in Preferences -> RTIR Home.
+All documentation about this extension you can find in
+'lib/RT/Extension/TicketLocking.pm', use `perldoc` utility
+to read it.
 
+    perldoc lib/RT/Extension/TicketLocking.pm
 
 COPYRIGHT AND LICENCE
 

Modified: RT-Extension-TicketLocking/lib/RT/Extension/TicketLocking.pm
==============================================================================
--- RT-Extension-TicketLocking/lib/RT/Extension/TicketLocking.pm	(original)
+++ RT-Extension-TicketLocking/lib/RT/Extension/TicketLocking.pm	Fri Aug 24 09:57:46 2007
@@ -162,32 +162,46 @@
 =head2 LockExpiry option
 
 In the config you can set LockExpiry option to a number of seconds,
+the longest time a lock can remain without being automatically removed,
 for example:
 
     Set( $LockExpiry, 5*60 ); # lock expires after five minutes
 
+If you don't wish to have your locks automatically expire, simply
+set $LockExpiry to a false (zero or undef) value.
+
 =head2 Allowing users to use 'MyLocks' portlet
 
-Thei extension comes with a portlet users can place on thier home
-page RT's or RTIR's, to allow them to add this portlet admin have
-to place it in the list of allowed components.
+The extension comes with a portlet users can place on thier home
+page RT's or RTIR's. Using this portlet user can easily jump to
+locked tickets, remove particular lock or all locks at once.
 
-Using this portlet user can easily jump to locked tickets, remove
-particular lock or all locks at once.
+If you want the MyLocks portlet to be available then you have
+to place it in the list of allowed components.
 
-For 'RT at Glance':
+For RT:
 
     Set($HomepageComponents, [qw(
         MyLocks 
         ... list of another portlets ...
     )]);
 
-For RTIR:
+People can then choose to add the portlet to their homepage
+in Preferences -> 'RT at a glance'.
+
+If you are running RTIR, and want the portlet to be available
+from the RTIR home page, you will need to do something similar
+to set the RTIR_HomepageComponents array in your config file,
+like this:
+
     Set(@RTIR_HomepageComponents, qw(
         MyLocks
         ... list of another portlets ...
     ));
 
+People can then choose to add the portlet to their homepage
+in Preferences -> 'RTIR Home'.
+
 =head1 IMPLEMENTATION DETAILS
 
 Each type is associated with a priority. Current priorities are as follows,