User Tools

Site Tools


how_to:editor_configuration_more_options

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
how_to:editor_configuration_more_options [2011/11/26 10:35]
Connie [SpellCheck]
how_to:editor_configuration_more_options [2013/04/19 15:04] (current)
Line 15: Line 15:
  
 The editor skin defines the graphic set which is used for the editor area. The editor skin defines the graphic set which is used for the editor area.
 +
 GetSimple ships with one skin, which sits in the directory //your getsimple installation/​admin/​template/​js/​ckeditor/​skins/​getsimple// ​ GetSimple ships with one skin, which sits in the directory //your getsimple installation/​admin/​template/​js/​ckeditor/​skins/​getsimple// ​
  
Line 25: Line 26:
 This example shows the //advanced toolbar// + the skin //​v2//​. ​ This example shows the //advanced toolbar// + the skin //​v2//​. ​
   - CKeditor comes with three skins: //kama//, //​office2003//​ and //v2//. GetSimple does not use these, but uses it's own skin, //​getsimple//​   - CKeditor comes with three skins: //kama//, //​office2003//​ and //v2//. GetSimple does not use these, but uses it's own skin, //​getsimple//​
-  - If you haven'​t done yet, download CKEditor from [[http://​ckeditor.com/​download]] and unpack it to your local harddisk. Open the directory //​ckeditor/​skins//​ and upload the skin which you want to use to your GetSimple-directory at the server: //​your_getsimple_installation/​admin/​template/​js/​ckeditor/​skins//​+  - If you haven'​t done yet, download CKEditor from [[http://​ckeditor.com/​download]] and unpack it to your local harddisk.\\ Open the directory //​ckeditor/​skins//​ and upload the skin which you want to use to your GetSimple-directory at the server: //​your_getsimple_installation/​admin/​template/​js/​ckeditor/​skins//​
   - edit the configuration,​ //​gsconfig.php//​ and re-upload it to your server.   - edit the configuration,​ //​gsconfig.php//​ and re-upload it to your server.
  
Line 35: Line 36:
 ===== Enter Mode: Paragraph or LineBreak? ===== ===== Enter Mode: Paragraph or LineBreak? =====
  
-You can define the behaviour of the ENTER KEY. The CKEditor-documentation explains: //Sets the behavior for the ENTER key. It also dictates other behaviour rules in the editor, like whether the <br> element is to be used as a paragraph separator when indenting text.//+You can define the behaviour of the ENTER KEY.  
 + 
 +The CKEditor-documentation explains: //Sets the behavior for the ENTER key. It also dictates other behaviour rules in the editor, like whether the <br> element is to be used as a paragraph separator when indenting text.//
  
 You can define the behaviour for the ENTER Key and the SHIFT-ENTER Key. You can define the behaviour for the ENTER Key and the SHIFT-ENTER Key.
Line 41: Line 44:
   - BR: lines are broken with <br> elements   - BR: lines are broken with <br> elements
   - DIV: new <div> blocks are created   - DIV: new <div> blocks are created
 +
 Edit your //​gsconfig.php//​ and re-upload it to the server. Edit your //​gsconfig.php//​ and re-upload it to the server.
   define('​GSEDITOROPTIONS',"​skin : '​v2', ​   define('​GSEDITOROPTIONS',"​skin : '​v2', ​
Line 50: Line 54:
 ===== Default Font Labels ===== ===== Default Font Labels =====
    
-A visual editor should offer a choice of fonts and font-sizes. If you activated the advanced Toolbar, you will get combo boxes for fonts and font-sizes in the second ribbon. As soon as you click into the editor-area,​ these values will be activated. +A visual editor should offer a choice of fonts and font-sizes. ​\\ If you activated the advanced Toolbar, you will get combo boxes for fonts and font-sizes in the second ribbon. ​\\ As soon as you click into the editor-area,​ these values will be activated. ​\\ You can restrict the available fonts as well. 
-You can restrict the available fonts as well.+
 To populate these combo boxes with the default values of your site, use these settings: To populate these combo boxes with the default values of your site, use these settings:
   # WYSIWYG Editor Options   # WYSIWYG Editor Options
Line 65: Line 69:
  
 In the readme-file which comes with the CKeditor-in-GetSimple-Integration,​ we read that the toolbar can't collapse. In the readme-file which comes with the CKeditor-in-GetSimple-Integration,​ we read that the toolbar can't collapse.
-But it can. The following option defines the behaviour, which is //false// by default. When set to //true//, you will see a small arrow-button at the right of the ribbon.+But it can.\\ The following option defines the behaviour, which is //false// by default. ​ ​\\ ​When set to //true//, you will see a small arrow-button at the right of the ribbon. 
 {{:​how_to:​ckeditor_collapse.jpg|}} {{:​how_to:​ckeditor_collapse.jpg|}}
   # WYSIWYG Editor Options   # WYSIWYG Editor Options
Line 94: Line 99:
 ===== Entities and Special Characters ===== ===== Entities and Special Characters =====
  
-By default, the editor converts special characters like umlauts (üäö ...) to their HTML-equivalents. This is not needed anymore if you encode your pages in UTF-8. So you can set this option to //false//.+By default, the editor converts special characters like umlauts (üäö ...) to their HTML-equivalents.\\ This is not needed anymore if you encode your pages in UTF-8. So you can set this option to //false//. 
   # WYSIWYG Editor Options   # WYSIWYG Editor Options
   define('​GSEDITOROPTIONS',"​skin : '​v2', ​   define('​GSEDITOROPTIONS',"​skin : '​v2', ​
Line 108: Line 114:
 ===== Language Direction ===== ===== Language Direction =====
  
-In many languages the //​reading-//​ or //​write-direction//​ is from left to right. In German, English, French or whatever. In other languages the reading-direction goes from right to left: in Arabic, Farsi, Hebrew and many others. Other languages go from Top to Down or from Down to Top. +In many languages the //​reading-//​ or //​write-direction//​ is from left to right. In German, English, French or whatever. ​\\ In other languages the reading-direction goes from right to left: in Arabic, Farsi, Hebrew and many others.\\ Other languages go from Top to Down or from Down to Top. 
  
-The editor follows per default the settings of the //user interface language direction// (f.e. your browser-settings). If this does not work correctly or you want to force the direction, set the option //​contentsLangDirection//​+The editor follows per default the settings of the //user interface language direction// (f.e. your browser-settings).\\ If this does not work correctly or you want to force the direction, set the option //​contentsLangDirection//​
 {{:​how_to:​ckeditor-rtl.jpg|}} {{:​how_to:​ckeditor-rtl.jpg|}}
   # WYSIWYG Editor Options   # WYSIWYG Editor Options
Line 126: Line 132:
   ​   ​
 The editor allows 3 options: ​ The editor allows 3 options: ​
-  - ui = as defined by the user interaction interface (default) +  - ''​ui'' ​= as defined by the user interaction interface (default) 
-  - ltr = left to right   +  - ''​ltr'' ​= left to right   
-  - rtl = right to left+  - ''​rtl'' ​= right to left
  
 There is not top-down until now ;=) There is not top-down until now ;=)
 ===== Email Protection ===== ===== Email Protection =====
  
-sometimes it is necessary to add some email-adresses into a website. And it is always necessary to protect these adresses from spam-harvesters.+sometimes it is necessary to add some email-adresses into a website. ​\\ And it is always necessary to protect these adresses from spam-harvesters.
  
-So you can enable some kind of email protection in the editor options. ​ +You can enable some kind of email protection in the editor options ​(''​emailProtection : '​encode'''​).\\ See more info here: [[http://​docs.cksource.com/​ckeditor_api/​symbols/​CKEDITOR.config.html#​.emailProtection]]
-See more info here: [[http://​docs.cksource.com/​ckeditor_api/​symbols/​CKEDITOR.config.html#​.emailProtection]]+
  
-so add to gsconfig.php-editor-options:​+Add to gsconfig.php-editor-options:​
   # WYSIWYG Editor Options   # WYSIWYG Editor Options
   define('​GSEDITOROPTIONS',"​skin : '​v2', ​   define('​GSEDITOROPTIONS',"​skin : '​v2', ​
Line 165: Line 170:
  
  
-There are two options which are necessary:+==== Necessary modifications====
  
   - Enable the feature (''​scayt_autoStartup:​true''​)   - Enable the feature (''​scayt_autoStartup:​true''​)
   - Define the language for the spellchecker (''​scayt_sLang:'​de_DE'''​)\\ The default language is en_US, so you should define the language when you need another language. \\ Possible values for the languages are: //en_US, en_GB, pt_BR, da_DK, nl_NL, en_CA, fi_FI, fr_FR, fr_CA, de_DE, el_GR, it_IT, nb_NO, pt_PT, es_ES, sv_SE//​. ​   - Define the language for the spellchecker (''​scayt_sLang:'​de_DE'''​)\\ The default language is en_US, so you should define the language when you need another language. \\ Possible values for the languages are: //en_US, en_GB, pt_BR, da_DK, nl_NL, en_CA, fi_FI, fr_FR, fr_CA, de_DE, el_GR, it_IT, nb_NO, pt_PT, es_ES, sv_SE//​. ​
 +  - add the spellchecker-symbols to the toolbar\\ There are 2 symbols: the symbol ''​Spellchecker''​ opens the text in a dialogue window, allows to choose the language to check with and to correct the text, the second symbol, ''​Scayt''​ opens a pop-up-dialogue to activate / deactivate the spellchecker and to set some options.
  
-So add to the gsconfig.php:+So add //​SCAYT-options//​ to editor-options and //'​Scayt'// ​to the toolbar in gsconfig.php
  
   # WYSIWYG Editor Options   # WYSIWYG Editor Options
-  define('​GSEDITOROPTIONS',"​skin : 'v2' +  define('​GSEDITOROPTIONS',"​scayt_autoStartup:​true,​ scayt_sLang:'de_DE'"); 
-  ​enterMode: CKEDITOR.ENTER_P,​ +   
-  ​shiftEnterMode : CKEDITOR.ENTER_BR+  ​# WYSIWYG toolbars (advancedbasic or [custom config]) 
-  ​fontSize_defaultLabel : '11px', +  ​define('GSEDITORTOOL',"['Source','​-','​Cut'​,'​Copy'​,'​Paste'​
-  font_defaultLabel : 'Verdana', +  'PasteText','​PasteFromWord','​-','​Undo'​
-  font_names : 'Arial;Times New Roman;​Verdana', +  'Redo','​Find','​Replace','​-','​SelectAll','​RemoveFormat','​SpellChecker','​Scayt'​],'/',​
-  toolbarCanCollapse : true, +
-  colorButton_enableMore : true, +
-  entities : false+
-  ​contentsLangDirection : 'ltr', +
-  emailProtection : 'encode', +
-  scayt_autoStartup:​true+
-  ​scayt_sLang:​'de_DE'+
   ");   ");
 +  ​
 +**Attention:​** ​
 +
 +There is a bug in CKEditor SpellChecker'​s plugin which you should be aware of:
 +
 +if spellchecker is enabled and **the cursor is placed in a list** (whether unordered or ordered list), do not switch to SourceCode mode!
 +When switching back your list will be "​destroyed"​ because the spellchecker plugin adds superfluous list-elements to the source code
 +
 +It's tested with the newest CKEditor version (3.6.2), the bug is still there
 +this is no GetSimple bug, so we have to wait until that bug is fixed in CKEditor
 ---- ----
how_to/editor_configuration_more_options.1322303700.txt.gz · Last modified: 2013/04/19 14:56 (external edit)