> HelpOnEditLocks

The following 175 words could not be found in the dictionary of 7206 words (including 7206 LocalSpellingWords) and are highlighted below:

2nd   able   Aborting   above   actively   after   After   again   against   allows   already   always   amount   any   anyone   around   asking   assumed   available   away   back   be   become   before   behaviour   being   both   busy   button   cancelling   changes   clicks   committed   complication   concurrent   concurrently   Configuration   configure   configured   conflict   conflicts   consider   controls   current   description   did   Doe   doesn   doing   done   during   easy   edited   editlock   editors   edits   else   enabled   exit   expires   explained   feature   finished   first   following   forgets   got   having   he   her   Here   his   hit   hits   if   interaction   Jane   John   keeps   kind   leave   leaves   levels   ll   locked   Locking   locking   locks   lose   matter   may   merge   might   Miller   minutes   more   most   nasty   nobody   None   not   number   occur   once   open   or   overnight   pages   permanent   permanently   polite   presented   pressed   presses   preview   reasons   receive   restarts   result   runs   save   saying   session   She   she   should   simultaneous   some   Someone   someone   specified   start   started   starts   still   stopped   telling   tells   than   then   Therefore   they   thinks   this   three   time   timeout   timer   track   tries   try   trying   turned   two   unfortunate   until   using   values   variable   wait   waiting   warn   warned   warning   warnings   way   When   when   whoever   will   window   Without   without   would   you  

Clear message

1. Locking against concurrent editing

If two people try and edit the same wiki page at once some nasty conflicts can occur. Without any kind of warning system one of the editors can save the page, which leaves the other editor with a message warning them about the conflict. An easy way around this is to display warnings for editors that try to start editing wiki pages that are already being edited. i.e. the wiki keeps track of pages being edited.

This can be done in Moin using the editlock system. There are three levels of locking: to warn, to lock and None (turned off).

If you configure Moin to warn, when someone tries to edit a page that is already being edited, they will be presented with a warning message asking them to consider waiting until the current editor has finished.

Moin can also be configured to lock an edited page, only during editing. Here, if some tries to edit a page that is being edited they will receive a message saying that the page is locked and will not be able to edit it until the editor has finished.

A complication of this feature is that an editing session might be started and might not be finished. e.g.:

This would result in a page having permanent warnings or being permanently locked. Therefore, both warn and lock have a timeout feature. After a specified number of minutes the feature expires. Note that the timer restarts when you hit preview. If you are actively editing a page and hit preview it is assumed you are still busy and the timer starts again. If you leave the page, or exit it for more time than the timer allows the edit locking runs out and other people are free to edit the page.

1.1. Configuration

The edit_locking config variable controls the behaviour of the locking system. This can have the following values:

1.2. Aborting an edit

For the reasons explained in the timeout description above, you should always use Cancel to cancel an edit if you have enabled edit locking!

2. Example

Sample interaction of JohnMiller and JaneDoe...

no locking (None)

JohnMiller starts editing a page and JaneDoe thinks she'll edit the same page. She has no idea that someone else is editing the page so they both edit away and hit save. It doesn't matter who started first and did the most editing, whoever hits save changes first will have their changes committed and the unfortunate 2nd editor will have to try and merge their changes in or lose them.

edit warnings (warn)

JohnMiller starts editing a page and JaneDoe thinks she'll edit the same page. When she hits edit she'll see a warning telling her that someone else got there first. If she is polite she'll leave the page, but she can still save before John and he may lose his changes.

edit locking (lock)

JohnMiller starts editing a page and JaneDoe thinks she'll edit the same page. When she hits edit she'll see a warning telling her that someone else got there first and the page is locked. She will have to wait for the page to become available.