Option to require an edit comment when saving a page

Requiring an edit comment helps to prevent people forgetting to fill in an edit message and helps to let new users know about the comment feature.

This option is not meant as a way to really force people to fill in a useful comment, since there will always people who just fill in "..." or something like that to bypass this check.

Implementation of feature request: http://moinmo.in/FeatureRequests/OptionToRequireEditComment


The first patch set adds the require_comment option, the second patch set makes sure that the editor is shown again when any save error occurs.

The patches have been tested using the text and GUI editors. None of the commandline editing tools (account homepage, maint globaledit) use action/edit.py (but PageEditor directly) so they should not be affected by this patch.

The pytest testsuite does not show any problems with these patches.

[Thomas.J.Waldmann, 2012-09-20 15:11:48]

http://codereview.appspot.com/6547045/diff/6003/MoinMoin/action/edit.py
File MoinMoin/action/edit.py (right):

http://codereview.appspot.com/6547045/diff/6003/MoinMoin/action/edit.py#newco...
MoinMoin/action/edit.py:163: raise pg.SaveError(_('TextCha: Wrong answer! Try
again below...'))
btw, doing late changes of i18n strings will mean that they will be untranslated
for most languages in the release.

most translators are not quickly updating the translations.

http://codereview.appspot.com/6547045/diff/6003/MoinMoin/action/edit.py#newco...
MoinMoin/action/edit.py:171: pg.set_raw_body(savetext, modified=1)
^ is this call not needed in your new code below?

[Matthijs Kooijman, 2012-09-20 15:22:26]

> > MoinMoin/action/edit.py:163: raise pg.SaveError(_('TextCha: Wrong answer!
Try
> > again below...'))
> btw, doing late changes of i18n strings will mean that they will be
> untranslated for most languages in the release.
> most translators are not quickly updating the translations.

Not sure how late in the release we are, just stumbled upon this old
patch again today :-)

In any case, I guess the usability won't be affected much if this string
is left at the old value, it's a little bit confusing at worst.

I'll be happy to provide a Dutch translation update ;-)

If you think it would be better to delay this for a next release, feel
free.

> >
http://codereview.appspot.com/6547045/diff/6003/MoinMoin/action/edit.py#newco...
> > MoinMoin/action/edit.py:171: pg.set_raw_body(savetext, modified=1)
> ^ is this call not needed in your new code below?
Nope, because I now pass preview=savetext to sendEditor, sendEditor
handles this. I guess I hadn't noticed this code when I initially wrote
the patch a few years back, but now looked more closely at sendEditor to
get the patch working for new pages as well and found this.

[Thomas.J.Waldmann, 2012-09-20 15:36:22]

you can update the strings. just wanted to note. wrong strings are worse than
non-translated ones.

just make sure that the preview text AND the text it will finally save are both
as edited by the user.