• Do not register here on develop.twiki.org, login with your twiki.org account.
• Use View topic Item7700 for generic doc work for TWiki-6.0.2. Use View topic Item7703 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.

Item7479: document nowysiwyg parameter for edit script in TWiki.TWikiScripts

Item Form Data

AppliesTo: Component: Priority: CurrentState: WaitingFor: TargetRelease ReleasedIn
Engine Documentation Enhancement No Action Required   n/a  

Edit Form Data

Summary:
Reported By:
Codebase:
Applies To:
Component:
Priority:
Current State:
Waiting For:
Target Release:
Released In:
 

Detail

To produce an edit link that honors the user's EDITMETHOD setting the nowysiwyg parameter to the edit script must be set to %IF{ "$ EDITMETHOD!='wysiwyg'" then="0" else="1" }%.

As a new TWiki user, I found this simple fact challenging to discover. Eventually I found examples in templates, a brief mention of the parameter in TinyMCEFrequentlyAskedQuestions, and some detailed discussion in PreferencesForRawEditOrWysiwygEdit.

To make this easier for others to find in the future I suggest that the nowysiwyg parameter be documented on the edit script in TWiki.TWikiScripts, mentioning %IF{ "$ EDITMETHOD!='wysiwyg'" then="0" else="1" }% as a value that will honor the user's EDITMETHOD setting.

-- TWiki:Main/DavidDAllen - 2014-04-03

I prefer not to document this. The EDITMETHOD is the preferred use.

The nowysiwyg should be retired because it has an issue: If the user is not authenticated and hits an edit link, the test for wysiwyg is done before the user is authenticated, hence it will be wrong for all users who have set "raw" in EDITMETHOD. The proper way is to read the edit preference in the edit script.

-- TWiki:Main.PeterThoeny - 2014-04-04

As a followup on the issue I mentioned I filed Item7480.

-- TWiki:Main.PeterThoeny - 2014-04-04

I agree with your assessment and prefer your suggested fix.

-- TWiki:Main.DavidDAllen - 2014-04-04

ItemTemplate
Summary document nowysiwyg parameter for edit script in TWiki.TWikiScripts
ReportedBy TWiki:Main.DavidDAllen
Codebase 6.0.0
SVN Range TWiki-6.0.1-trunk, Sat, 22 Mar 2014, build 27164
AppliesTo Engine
Component Documentation
Priority Enhancement
CurrentState No Action Required
WaitingFor

Checkins

TargetRelease n/a
ReleasedIn

Edit | Attach | Watch | Print version | History: r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r3 - 2014-04-04 - DavidDAllen
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback