[Rt-commit] r8909 - in rtir/branches/2.3-EXPERIMENTAL: docs

[sartak at bestpractical.com]

Author: sartak
Date: Tue Sep  4 16:02:33 2007
New Revision: 8909

Modified:
   rtir/branches/2.3-EXPERIMENTAL/   (props changed)
   rtir/branches/2.3-EXPERIMENTAL/docs/Tutorial.pod

Log:
 r40552 at onn:  sartak | 2007-09-04 16:02:23 -0400
 Copy the basics of locking into the tutorial.


Modified: rtir/branches/2.3-EXPERIMENTAL/docs/Tutorial.pod
==============================================================================
--- rtir/branches/2.3-EXPERIMENTAL/docs/Tutorial.pod	(original)
+++ rtir/branches/2.3-EXPERIMENTAL/docs/Tutorial.pod	Tue Sep  4 16:02:33 2007
@@ -171,6 +171,33 @@
 Use a bulk abandon subtab under the incidents tab to abandon multiple
 incidents at once.
 
+=head3 Locking
+
+A lock is created whenever a user performs an action on a ticket that takes
+multiple steps if a hard lock is not already in place for that ticket.
+
+An auto lock is removed once the user is done with whatever he was doing
+on the page (e.g., when he clicks "Save Changes" on the Edit page).
+It is also removed if the Unlock link is clicked from a page that generated
+an auto lock. The following actions produce an auto lock:
+
+    - Edit
+    - Split
+    - Merge
+    - Advanced
+    - Reply
+    - Resolve
+    - Reject
+    - Comment
+    - Remove
+
+Locks are advisory: if a ticket is locked by one user, other users
+will be given a notification (in red) that another user has locked
+the ticket, with the locking user's name and how long he has had
+it locked for, but they will still be allowed to edit and submit
+changes on the ticket.
+
+For more information, see L<RT::Extension::TicketLocking>.
 
 =head2 Custom fields