• Do not register here on develop.twiki.org, login with your twiki.org account.
• Use View topic Item7848 for generic doc work for TWiki-6.1.1. Use View topic Item7851 for doc work on extensions that are not part of a release. More... Close
• Anything you create or change in standard webs (Main, TWiki, Sandbox etc) will be automatically reverted on every SVN update.
Does this site look broken?. Use the LitterTray web for test cases.

Item5439: Proposal to have chapter editing off by default

Item Form Data

AppliesTo: Component: Priority: CurrentState: WaitingFor: TargetRelease ReleasedIn
Extension EditChapterPlugin Low New   n/a  

Edit Form Data

Reported By:
Applies To:
Current State:
Waiting For:
Target Release:
Released In:


Currently EditChapterPlugin is enabled for all headings by default. In fact, it is impossible to completely disable it even if one sets EDITCHAPTERPLUGIN_ENABLED to off in TWikiPreferences. The reason is that some cases, such as INCLUDED topics or heading defined in DBQUERY formats do not respect the plugin preference setting. In some cases, these edit links may be simply undesired but in other cases they do not work at all (producing unexpected results).

This introduces a high degree of unpredictability in the plugin's use.

I would make case that it would be more desirable to have it not render heading edit links by default. Then this functionality could be enabled for specific situations as desired, or the administrator could turn it on for entire site by setting the EDITCHAPTERPLUGIN_ENABLED to on in TWikiPreferences and accept the compromises this might present. This would be a more conservative approach that reduces the incidence of problems/errors. At present, there is no option but to deal with these complications across the entire site and with existing applications, even if one only wants this functionality only in a few places.

The approach I'm advocating is that followed by earlier similar plugins such as SectionalEditPlugin. That is, if one wanted to apply this to the entire site, one had to explicitly enable it. Otherwise, it was only applied where specifically enabled.

To address the concern that users would install the plugin and wonder why nothing happens, simply include notes at the end of installation instructions about enabling the plugin in a topic, web or site-wide.

-- TWiki:Main/LynnwoodBrown - 13 Mar 2008

Summary Proposal to have chapter editing off by default
ReportedBy TWiki:Main.LynnwoodBrown

SVN Range TWiki-5.0.0, Sun, 09 Mar 2008, build 16496
AppliesTo Extension
Component EditChapterPlugin
Priority Low
CurrentState New


TargetRelease n/a

Topic revision: r1 - 2008-03-13 - LynnwoodBrown
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2023 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback