885f064b61
References #148 The js and css config files are directly placed in /htmlarea directory. The old ones downunder are not reset with this commit, until we give OK to go. The lang constant will be placed to addlang.txt in a 2cd commit, since this may change and there is already a pending constant. I have not added another option by now to explicitly choose the s9y configs in htmlarea, if someone has custom ones in 2k11/admin and wants to switch back to the origins. Is this really a real and valid user case?
272 lines
18 KiB
JavaScript
272 lines
18 KiB
JavaScript
/**
|
||
* @fileOverview The Serendipity CKEDITOR custom config file:
|
||
* ckeditor_s9y_config.js, v. 1.7, last modified 2014-11-17 by Ian
|
||
*/
|
||
|
||
/**
|
||
* Substitute every config option to CKEDITOR in here,
|
||
* rename the file to ckeditor_custom_config.js and
|
||
* copy it to /templates/2k11/admin.
|
||
* In there change anything to be upgrade independent
|
||
* NOTE: Use at own risk! Be careful!
|
||
*/
|
||
CKEDITOR.editorConfig = function( config ) {
|
||
|
||
// ACF - Advanced Content Filter works in two modes:
|
||
// automatic – the filter is configured by editor features (like plugins, buttons, and commands) that are enabled with configuration options
|
||
// such as CKEDITOR.config.plugins, CKEDITOR.config.extraPlugins, and CKEDITOR.config.toolbar,
|
||
// custom – the filter is configured by the CKEDITOR.config.allowedContent option and only features that match this setting are activated.
|
||
// In both modes it is possible to extend the filter configuration by using the CKEDITOR.config.extraAllowedContent setting.
|
||
// If you want to disable Advanced Content Filter, set CKEDITOR.config.allowedContent to true.
|
||
// All available editor features will be activated and input data will not be filtered.
|
||
// Allowed content rules. This setting is used when instantiating CKEDITOR.editor.filter.
|
||
// The following values are accepted:
|
||
// CKEDITOR.filter.allowedContentRules – defined rules will be added to the CKEDITOR.editor.filter.
|
||
// true – will disable the filter (data will not be filtered, all features will be activated).
|
||
// default – the filter will be configured by loaded features (toolbar items, commands, etc.).
|
||
// In all cases filter configuration may be extended by extraAllowedContent. This option may be especially useful,
|
||
// when you want to use the default allowedContent value along with some additional rules.
|
||
//
|
||
// List of regular expressions to be executed on ***input HTML***, indicating HTML source code that, when matched, must not be available in the WYSIWYG mode for editing.
|
||
|
||
// allow <script> tags
|
||
//config.protectedSource.push( /<(script)[^>]*>.*<\/script>/ig ); // set already as default in ckeditor.js, by [/<script[\s\S]*?<\/script>/gi,/<noscript[\s\S]*?<\/noscript>/gi]
|
||
// allow S9y imageselectorplus plugin mediainsert tag codes
|
||
config.protectedSource.push( /<(mediainsert)[^>]*>[\s\S]*?<\/mediainsert>/img );
|
||
// allow a Smarty like {} tag syntax without inner whitespace, which would be some other code part.
|
||
config.protectedSource.push( /\{[a-zA-Z\$].*?\}/gi );
|
||
// allow wp like [[mytag]] [[{$mytag}]] widget tags
|
||
config.protectedSource.push(/\[\[([^\[\]])+\]\]/g);
|
||
|
||
// CKEDITOR.protectedSource patterns used regex Escape sequences
|
||
// \s any whitespace character;
|
||
// \S any character that is not a whitespace character
|
||
// \t tab (hex 09);
|
||
// \r carriage return (hex 0D);
|
||
// \n newline (hex 0A);
|
||
// Pattern Modifiers
|
||
// /i caseless, match both upper and lower case letters
|
||
// /m treat as multiline
|
||
// /g be greedy
|
||
|
||
// Set placeholder tag cases - elements [attributes]{styles}(classes) to protect ACF removements.
|
||
// Allowed <mediainsert>, <gallery>, <media> tags (imageselectorplus galleries) - which tells ACF to not touch the code!
|
||
// Allowed <div> is a need for Media Library inserts - which tells ACF to not touch the code!
|
||
// <img[height,width]> This Media Library image is even needed to avoid ACF OFF removement of height attributes.
|
||
// <pre[*attributes](*classes)> for previous used prettyprints by ckeditor plugin pbckcode
|
||
config.extraAllowedContent = 'mediainsert[*]{*}(*);gallery[*]{*}(*);media[*]{*}(*);script[*]{*}(*);audio[*]{*}(*);div[*]{*}(*);img[height,width];pre[*](*);';
|
||
|
||
// Prevent filler nodes in all empty blocks. - case switching source and wysiwyg mode multiple times
|
||
//config.fillEmptyBlocks = false; // default (true) - switches <p> </p> to <p></p>
|
||
//config.ignoreEmptyParagraph = false; // default(true) - Whether the editor must output an empty value ('') if it's contents is made by an empty paragraph only. (Extends to config.fillEmptyBlocks)
|
||
// It will still generate an empty <p></p> though.
|
||
//config.autoParagraph = false; // defaults(true)
|
||
// DEV NOTES: Please note that since CKEditor 4.4.5 the config.autoParagraph configuration option was marked deprecated, since changing the default value might introduce unpredictable usability issues and so it is highly unrecommended.
|
||
|
||
// The configuration setting that controls the ENTER mode is "config.enterMode" and it offers three options:
|
||
// (1) The default creates a paragraph element each time the "enter" key is pressed:
|
||
//config.enterMode = CKEDITOR.ENTER_P; // inserts <p></p>
|
||
// (2) You can choose to create a "div" element instead of a paragraph:
|
||
//config.enterMode = CKEDITOR.ENTER_DIV; // inserts <div></div>
|
||
// (3) If you prefer to not wrap the text in anything, you can choose to insert a line break tag:
|
||
//config.enterMode = CKEDITOR.ENTER_BR; // inserts <br />
|
||
// You can always use SHIFT+ENTER to set a br in the P-mode default option or change the SHIFT-mode to something else
|
||
//config.shiftEnterMode = CKEDITOR.ENTER_BR;
|
||
// Better learn to do it via keyboard commands, see cheatsheet toolbar button.
|
||
|
||
// Whether to use HTML entities in the output.
|
||
//config.entities = false; // defaults(true)
|
||
|
||
//config.htmlEncodeOutput = false; // defaults(true)
|
||
|
||
// UI configurations - just some examples
|
||
//config.uiColor = 'transparent'; // standard, but better disable config.uiColor all
|
||
//config.uiColor = '#CFD1CF'; // standard grey
|
||
//config.uiColor = '#f5f5f5'; // standard light grey
|
||
//config.uiColor = '#E6EDF3'; // extreme light blue
|
||
//config.uiColor = '#DFE8F6'; // very light blue
|
||
//config.uiColor = '#9AB8F3'; // light blue/violet
|
||
//config.uiColor = '#AADC6E'; // light green
|
||
//config.uiColor = '#FFDC6E'; // light gold
|
||
//config.uiColor = '#FF8040'; // mango
|
||
//config.uiColor = '#FF2400'; // scarlet red
|
||
//config.uiColor = '#14B8C4'; // light turquoise
|
||
config.skin = 'moono'; // this is default
|
||
config.height = 400; // dito
|
||
|
||
// Allow certain font sizes, eg.
|
||
//config.fontSize_sizes = '8/8px;9/9px;10/10px;11/11px;12/12px;14/14px;15/15px;16/16px;18/18px;20/20px;22/22px;24/24px;26/26px;28/28px;36/36px;48/48px;72/72px' ;
|
||
// Allow one(!) default font label, eg.
|
||
//config.font_defaultLabel = 'Arial';
|
||
// Add other font names to the list of fonts names to be displayed in the Font combo in the toolbar. - eg.
|
||
//config.font_names = config.font_names +
|
||
// 'Arial/Arial, Helvetica, sans-serif;' +
|
||
// 'Times New Roman/Times New Roman, Times, serif;' +
|
||
// 'Verdana';
|
||
|
||
// Add custom Serendipity styles to ckeditor wysiwyg-mode, to repect css image floats
|
||
// we can not use templates/yourTemplate/admin/ as a path here, since we would need template and userTemplate path parts as dynamic vars
|
||
config.contentsCss = 'htmlarea/wysiwyg-style.css';
|
||
|
||
// Native spell check functionality is by default disabled in the editor, use disableNativeSpellChecker to enable it:
|
||
//config.disableNativeSpellChecker = false;
|
||
|
||
// Remove custom toolbar buttons and plugins from all toolbars
|
||
// A list of plugins that must not be loaded. This setting makes it possible to avoid loading some plugins defined in the CKEDITOR.config.plugins setting, without having to touch it and potentially break it.
|
||
config.removePlugins = 'flash,iframe,forms'; // possible strict suggestions: 'flash,iframe,elementspath,save,font,showblocks,div,liststyle,pagebreak,smiley,specialchar,horizontalrule,indentblock,justify,pastefromword,newpage,preview,print,stylescombo'
|
||
config.removeButtons = 'Preview,Styles'; // these buttons are useless in Serendipity and therefore not set. Without even the toolbar Groups break better on screens.
|
||
|
||
// We cheat ckeditor instances by adding all available button names (in s9ypluginbuttons) to "both" toolbar instances, in case of having two textareas.
|
||
// The instanciation will only take the ones being currently initiated in wysiwyg_init.tpl output, in the source code.
|
||
// The hooked and added extraPlugins in wysiwyg_init become not automatically true for preset toolbars (Basic, Standard, Full) like this, but do for the fallback toolbarGroups later on.
|
||
var s9ypluginbuttonsAll = s9ymediabuttons.concat(s9ypluginbuttons);
|
||
//console.log('is ckeditor_s9y_config.js');
|
||
|
||
// in case of toolbar : Basic (keep inser:image, else s9ymediabutton does not work!)
|
||
config.toolbar_Basic = [
|
||
{ name: 'basicstyles', items : [ 'Bold','Italic','Underline','Superscript' ] },
|
||
{ name: 'paragraph', items : [ 'NumberedList', 'BulletedList', 'Blockquote' ] },
|
||
{ name: 'styles', items : [ 'Format', ] },
|
||
{ name: 's9yml', items : s9ymediabuttons },
|
||
{ name: 'insert', items : [ 'Image' ] },
|
||
{ name: 'links', items : [ 'Link','Unlink' ] },
|
||
{ name: 'document', items : [ 'Source' ] },
|
||
{ name: 'codesnippet', items : [ 'CodeSnippet' ] },
|
||
{ name: 'mediaembed', items : [ 'MediaEmbed' ] },
|
||
{ name: 'others', items : s9ypluginbuttons }
|
||
];
|
||
// console.log(JSON.stringify(config.toolbar_Basic));
|
||
|
||
// in case of toolbar : Standard
|
||
config.toolbar_Standard = [
|
||
{ name: 'basicstyles', items : [ 'Format','-','Bold','Italic','Underline','Strike','Subscript','Superscript','-','RemoveFormat' ] },
|
||
{ name: 'clipboard', items : [ 'Cut', 'Copy', 'Paste', 'PasteText', '-', 'Undo', 'Redo'] },
|
||
{ name: 'insert', items : [ 'Image', '-', 'Table', 'HorizontalRule', 'SpecialChar'] },
|
||
{ name: 'paragraph', groups : [ 'list', 'blocks', 'align' ], items: [ 'NumberedList', 'BulletedList', '-', 'Blockquote' ] },
|
||
{ name: 'links', items : [ 'Link','Unlink','Anchor' ] },
|
||
{ name: 'editing', groups: [ 'find', 'selection', 'spellchecker' ], items: [ 'Scayt' ] },
|
||
{ name: 'codesnippet', items : [ 'CodeSnippet' ] },
|
||
{ name: 'mediaembed', items : [ 'MediaEmbed' ] },
|
||
{ name: 'others', items : s9ypluginbuttonsAll },
|
||
{ name: 'document', groups: [ 'mode', 'document', 'doctools' ], items: [ 'Source' ] },
|
||
{ name: 'about', items : [ 'About', ] },
|
||
{ name: 'cheatsheet', items : ['CheatSheet'] }
|
||
];
|
||
// console.log(JSON.stringify(config.toolbar_Standard));
|
||
|
||
// in case of toolbar : Full (moved 'Source' and removed 'Font','Preview' buttons)
|
||
config.toolbar_Full = [
|
||
{ name: 'styles', items : [ 'Styles','Format',/*'Font',*/'FontSize' ] },
|
||
{ name: 'basicstyles', items : [ 'Bold','Italic','Underline','Strike','Subscript','Superscript','-','RemoveFormat' ] },
|
||
{ name: 'clipboard', items : [ 'Cut','Copy','Paste','PasteText','PasteFromWord','-','Undo','Redo' ] },
|
||
{ name: 'document', items : [ /*'Source','-',*/'Save','NewPage','DocProps',/*'Preview',*/'Print','-','Templates' ] },
|
||
{ name: 'editing', items : [ 'Find','Replace','-','SelectAll','-','SpellChecker', 'Scayt' ] },
|
||
{ name: 'forms', items : [ 'Form', 'Checkbox', 'Radio', 'TextField', 'Textarea', 'Select', 'Button', 'ImageButton', 'HiddenField' ] },
|
||
{ name: 'paragraph', items : [ 'NumberedList','BulletedList','-','Outdent','Indent','-','Blockquote','CreateDiv','-','JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock','-','BidiLtr','BidiRtl' ] },
|
||
{ name: 'links', items : [ 'Link','Unlink','Anchor' ] },
|
||
{ name: 'insert', items : [ 'Image','Flash','Table','HorizontalRule','Smiley','SpecialChar','PageBreak' ] },
|
||
{ name: 'colors', items : [ 'TextColor','BGColor' ] },
|
||
{ name: 'codesnippet', items : [ 'CodeSnippet' ] },
|
||
{ name: 'mediaembed', items : [ 'MediaEmbed' ] },
|
||
{ name: 'others', items : s9ypluginbuttonsAll },
|
||
{ name: 'tools', items : [ 'Maximize', 'ShowBlocks','-','About' ] },
|
||
{ name: 'document', groups : [ 'mode', 'document', 'doctools' ], items : [ 'Source' ] },
|
||
{ name: 'cheatsheet', items : ['CheatSheet'] }
|
||
];
|
||
// console.log(JSON.stringify(config.toolbar_Full));
|
||
|
||
// in case of toolbar : Default S9y
|
||
config.toolbar_Default = [
|
||
{ name: 'tools', items: [ 'Maximize' ] },
|
||
{ name: 'styles', items: [ 'Format' ] },
|
||
{ name: 'basicstyles', groups: [ 'basicstyles', 'cleanup' ], items: [ 'Bold', 'Italic', 'RemoveFormat' ] },
|
||
{ name: 'paragraph', groups: [ 'list', 'indent', 'blocks', 'align' ], items: [ 'NumberedList', 'BulletedList', '-', 'Outdent', 'Indent', '-', 'Blockquote' ] },
|
||
{ name: 'links', items: [ 'Link', 'Unlink', 'Anchor' ] },
|
||
{ name: 's9yml', items : s9ymediabuttons },
|
||
{ name: 'insert', items: [ 'insert', 'Image', '-', 'Table', 'HorizontalRule', 'SpecialChar' ] },
|
||
{ name: 'clipboard', groups: [ 'clipboard', 'undo' ], items: [ 'Cut', 'Copy', 'Paste', 'PasteText', '-', 'Undo', 'Redo' ] },
|
||
{ name: 'editing', groups: [ 'find', 'selection', 'spellchecker' ], items: [ 'Scayt' ] },
|
||
{ name: 'codesnippet', items : [ 'CodeSnippet' ] },
|
||
{ name: 'others', items: s9ypluginbuttons },
|
||
{ name: 'document', groups: [ 'mode', 'document', 'doctools' ], items: [ 'Source' ] },
|
||
{ name: 'about', items: [ 'About' ] }
|
||
];
|
||
// console.log(JSON.stringify(config.toolbar_s9y));
|
||
|
||
// This is the 'CKE PRESET' toolbar select name with CKE 'Default' values, also acting as a fallback in order. Do not touch!
|
||
// Note: There is another (internal) fallback toolbar in case of errors, which appearance looks like a re-arranged 4-liner toolbar,
|
||
// which will provide the 'others' group, but no additionally added plugins (like mediaembed and cheatsheet).
|
||
// This is the official Toolbar configuration generated automatically by the editor, based on config.toolbarGroups.
|
||
config.toolbar_CKE = [
|
||
{ name: 'document', groups: [ 'mode', 'document', 'doctools' ], items: [ 'Source', '-', 'Save', 'NewPage', /*'Preview', */'Print', '-', 'Templates' ] },
|
||
{ name: 'clipboard', groups: [ 'clipboard', 'undo' ], items: [ 'Cut', 'Copy', 'Paste', 'PasteText', 'PasteFromWord', '-', 'Undo', 'Redo' ] },
|
||
{ name: 'editing', groups: [ 'find', 'selection', 'spellchecker' ], items: [ 'Find', 'Replace', '-', 'SelectAll', '-', 'Scayt' ] },
|
||
{ name: 'forms', items: [ 'Form', 'Checkbox', 'Radio', 'TextField', 'Textarea', 'Select', 'Button', 'ImageButton', 'HiddenField' ] },
|
||
'/',
|
||
{ name: 'basicstyles', groups: [ 'basicstyles', 'cleanup' ], items: [ 'Bold', 'Italic', 'Underline', 'Strike', 'Subscript', 'Superscript', '-', 'RemoveFormat' ] },
|
||
{ name: 'paragraph', groups: [ 'list', 'indent', 'blocks', 'align', 'bidi' ], items: [ 'NumberedList', 'BulletedList', '-', 'Outdent', 'Indent', '-', 'Blockquote', 'CreateDiv', '-', 'JustifyLeft', 'JustifyCenter', 'JustifyRight', 'JustifyBlock', '-', 'BidiLtr', 'BidiRtl', 'Language' ] },
|
||
{ name: 'links', items: [ 'Link', 'Unlink', 'Anchor' ] },
|
||
{ name: 'insert', items: [ 'Image', 'Flash', 'Table', 'HorizontalRule', 'Smiley', 'SpecialChar', 'PageBreak', 'Iframe' ] },
|
||
'/',
|
||
{ name: 'styles', items: [ 'Styles', 'Format', 'Font', 'FontSize' ] },
|
||
{ name: 'colors', items: [ 'TextColor', 'BGColor' ] },
|
||
{ name: 'tools', items: [ 'Maximize', 'ShowBlocks' ] },
|
||
{ name: 'others', items : s9ypluginbuttonsAll },
|
||
{ name: 'about', items: [ 'About' ] }
|
||
];
|
||
|
||
// This is the official Toolbar groups and order configuration.
|
||
/*config.toolbarGroups = [
|
||
{ name: 'document', groups: [ 'mode', 'document', 'doctools' ] },
|
||
{ name: 'clipboard', groups: [ 'clipboard', 'undo' ] },
|
||
{ name: 'editing', groups: [ 'find', 'selection', 'spellchecker' ] },
|
||
{ name: 'forms' },
|
||
'/',
|
||
{ name: 'basicstyles', groups: [ 'basicstyles', 'cleanup' ] },
|
||
{ name: 'paragraph', groups: [ 'list', 'indent', 'blocks', 'align', 'bidi' ] },
|
||
{ name: 'links' },
|
||
{ name: 'insert' },
|
||
'/',
|
||
{ name: 'styles' },
|
||
{ name: 'colors' },
|
||
{ name: 'tools' },
|
||
{ name: 'others' },
|
||
{ name: 'about' }
|
||
];*/
|
||
|
||
// This is the Serendipity tweaked toolbarGroups fallback, which does not need any extras manually filled in 'others', since done automatically by ckeditor.js or by the other named toolbars
|
||
config.toolbarGroups = [
|
||
{ name: 'styles' },
|
||
{ name: 'basicstyles', groups: [ 'basicstyles', 'cleanup' ] },
|
||
// { name: 'forms' },
|
||
{ name: 'colors' },
|
||
{ name: 'paragraph', groups: [ 'list', 'indent', 'blocks', 'align', 'bidi' ] },
|
||
{ name: 'links' },
|
||
|
||
{ name: 's9yml' },
|
||
{ name: 'insert' },
|
||
// { name: 'ident' },
|
||
{ name: 'document', groups: [ /*'mode', */'document', 'doctools' ] },
|
||
{ name: 'clipboard', groups: [ 'clipboard', 'undo' ] },
|
||
{ name: 'editing', groups: [ 'find', 'selection', 'spellchecker' ] },
|
||
|
||
{ name: 'snippet', groups: [ 'codesnippet', 'snippet' ] },
|
||
{ name: 'mediaembed' },
|
||
{ name: 'others' },
|
||
{ name: 'tools' },
|
||
{ name: 'about' },
|
||
{ name: 'mode' },
|
||
{ name: 'cheatsheet' }
|
||
];
|
||
|
||
// Adding additional CKEDITOR Plugins to the config
|
||
// Download the Plugin, check version matching to this ckeditor version and drop the plugin to /htmlarea/ckeditor/chkeditor/plugins, copy the directories plugin name, eg 'mediaembed'.
|
||
// Open your personal /templates/2k11/admin/custom/ckeditor_custom_plugin.js or the default /htmlarea/ckeditor_s9y_plugin.js file
|
||
// and add the plugin name to the "extraPlugins" string.
|
||
// Now add this name to upper config.toolbarGroup also, wherever you like it to have, eg. "{ name: 'mediaembed' }," if that plugin emits a button to be placed into the toolbar.
|
||
// Or as { name: 'pluginname', items: 'PluginName' } eg { name: 'mediaembed', items: 'MediaEmbed' } in one of the upper toolbars, if that plugin emits a button to be placed into the toolbar.
|
||
// After a browser reload, the newly added plugin should load into your textareas toolbars.
|
||
// PLEASE NOTE:
|
||
// Do not use any customized CKEditor Downloads, since this will only work with the CKE PRESET toolbar!
|
||
|
||
}; |