Added a comment
[ikiwiki] / doc / plugins / lockedit.mdwn
1 [[!template id=plugin name=lockedit core=1 author="[[Joey]]"]]
2 [[!tag type/auth]]
3
4 This plugin allows the administrator of a wiki to lock some pages, limiting
5 who can edit them using the online interface. This doesn't prevent anyone
6 who can commit to the underlying revision control system from editing the
7 pages, however. (Unless you set up [[tips/untrusted_git_push]].)
8
9 The `locked_pages` setting configures what pages are locked. It is a
10 [[ikiwiki/PageSpec]], so you have lots of control over what kind of pages
11 to lock. For example, you could choose to lock all pages created before
12 2006, or all pages that are linked to from the page named "locked". More
13 usually though, you'll just list some names of pages to lock.
14
15 If you want to lock down a blog so only you can post to it, you can just
16 lock "*", and enable the [[opendiscussion]] plugin, so readers can still post
17 [[comments]].
18
19 Wiki administrators can always edit locked pages. The [[ikiwiki/PageSpec]]
20 can specify that some pages are not locked for some users. For example,
21 "important_page and !user(joey)" locks `important_page` while still
22 allowing joey to edit it, while "!*/Discussion and user(bob)" prevents bob
23 from editing pages except for Discussion pages.