Arturo Bernal created JSPWIKI-1313:
--------------------------------------

             Summary: Modernise the page editors, with Markdown in mind
                 Key: JSPWIKI-1313
                 URL: https://issues.apache.org/jira/browse/JSPWIKI-1313
             Project: JSPWiki
          Issue Type: Improvement
            Reporter: Arturo Bernal


This is a proposal for discussion, not an implementation. The page editors have 
not kept pace with the rest of the wiki, and the Markdown syntax 
(jspwiki.syntax=markdown, module jspwiki-markdown) has no editor that is built 
around it.

 

What exists today in the default template: plain.jsp (Snipe, with a live 
preview checkbox and a preview column), wysiwyg.jsp (MooEditable, which depends 
on Mootools, see JSPWIKI-1097 and JSPWIKI-1312), CKeditor.jsp and TinyMCE.jsp. 
The last two load scripts/ckeditor and scripts/tinymce, but those directories 
are not in the repository, so they only work if an administrator installs the 
library. The FCK editor is only present in the legacy template 210, together 
with fckconfig.js, fckstyles.xml and fcktemplates.xml in webapp/scripts. The 
Markdown module ships a Snipe extension, Wiki.Snips.Markdown.js, and the syntax 
decorator for the WYSIWYG HTML to wiki conversion is configurable with 
jspwiki.syntax.decorator.

 

Proposal: provide one maintained editor for the plain text modes, with syntax 
highlighting for JSPWiki and Markdown, a preview that stays synchronised with 
the text (building on the live preview that plain.jsp already has), helpers for 
links, plugins and attachments, and drag and drop of attachments 
(JSPWIKI-1209). Whether a WYSIWYG mode is wanted for Markdown is an open 
question. Candidate libraries need to be evaluated for an ASF compatible 
licence, size and maintenance status; CodeMirror and ProseMirror based editors 
are the obvious ones to look at. If the editors that need a separately 
installed library, or the FCK files of template 210, are not used any more, 
removing them would be part of the work.

 

Related issues: JSPWIKI-1215 (FCK and CKEditor end of life), JSPWIKI-1180 
(plain editor and full Markdown support), JSPWIKI-1192, JSPWIKI-1191, 
JSPWIKI-1193, JSPWIKI-1209 and JSPWIKI-623. I suggest to discuss the direction 
on [[email protected]|mailto:[email protected]] before any code is 
written.



--
This message was sent by Atlassian Jira
(v10.3.26#10030026)

Reply via email to