Configuration Options"

This website contains links to software which is either no longer maintained or will be supported only until the end of 2019 (CKFinder 2). For the latest documentation about current CKSource projects, including software like CKEditor 4/CKEditor 5, CKFinder 3, Cloud Services, Letters, Accessibility Checker, please visit the new documentation website.

If you look for an information about very old versions of CKEditor, FCKeditor and CKFinder check also the CKEditor forum, which was closed in 2015. If not, please head to StackOverflow for support.

(→‎Advanced)
 
(19 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
== Overriding the Default Configurations ==
+
== Editor Behavior  ==
  
−
To simplify updating FCKeditor on your sites, the best approach is to put all your configuration in a separate file, outside the editor's package directory structure. In this way, you just need to overwrite the editor's directory to update it to a newer version.
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/AutoDetectPasteFromWord|AutoDetectPasteFromWord]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/BaseHref|BaseHref]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/CleanWordKeepsStructure|CleanWordKeepsStructure]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ContentLangDirection|ContentLangDirection]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DefaultLinkTarget|DefaultLinkTarget]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DocType|DocType]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ForcePasteAsPlainText|ForcePasteAsPlainText]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FullPage|FullPage]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkDlgHideTarget|LinkDlgHideTarget]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/MaxUndoLevels|MaxUndoLevels]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/StartupFocus|StartupFocus]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/StartupShowBlocks|StartupShowBlocks]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/TemplateReplaceAll|TemplateReplaceAll]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/TemplateReplaceCheckbox|TemplateReplaceCheckbox]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ToolbarComboPreviewCSS|ToolbarComboPreviewCSS]]
  
−
=== Step 1 ===
+
== Styles  ==
  
−
Create a file called '''"myconfig.js"''' or any other .js file and put it in the root directory of the site (or wherever you want). You will input the configuration in this file. Example: you want to change the default FCKeditor language to French. Apply this code into your file:
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/BodyId and BodyClass|BodyId and BodyClass]]
−
<pre>FCKConfig.AutoDetectLanguage = false&nbsp;;
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/CoreStyles|CoreStyles]]
−
FCKConfig.DefaultLanguage = "fr"&nbsp;;
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/CustomStyles|CustomStyles]]
−
</pre>
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/EditorAreaCSS|EditorAreaCSS]]
−
=== Step 2 ===
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/EditorAreaStyles|EditorAreaStyles]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FontColors|FontColors]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FontFormats|FontFormats]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FontNames|FontNames]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FontSizes|FontSizes]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IndentClasses|IndentClasses]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IndentLength|IndentLength]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IndentUnit|IndentUnit]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/JustifyClasses|JustifyClasses]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/RemoveFormatTags|RemoveFormatTags]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/StylesXmlPath|StylesXmlPath]]
  
−
Now we have to tell the editor that it has to load my custom configuration. There are two methodes to do it:
+
== HTML Output  ==
  
−
==== Method 1 ====
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/AdditionalNumericEntities|AdditionalNumericEntities]]
 +
*[[EMailProtection|EMailProtection and EMailProtectionFunction]]<br>
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/EnterMode|EnterMode]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FillEmptyBlocks|FillEmptyBlocks]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ForceSimpleAmpersand|ForceSimpleAmpersand]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FormatIndentator|FormatIndentator]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FormatOutput|FormatOutput]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FormatSource|FormatSource]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/HtmlEncodeOutput|HtmlEncodeOutput]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IgnoreEmptyParagraphValue|IgnoreEmptyParagraphValue]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IncludeGreekEntities|IncludeGreekEntities]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IncludeLatinEntities|IncludeLatinEntities]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ProcessHTMLEntities|ProcessHTMLEntities]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ProcessNumericEntities|ProcessNumericEntities]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ShiftEnterMode|ShiftEnterMode]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/TabSpaces|TabSpaces]]
  
−
Find the following line in the main configuration file ('''fckconfig.js'''):
+
== User Interface  ==
−
<pre>FCKConfig.CustomConfigurationsPath = ''&nbsp;;
 
−
</pre>
 
−
and put in the path of your config file ('''myconfig.js''') in the brackets:
 
−
<pre>FCKConfig.CustomConfigurationsPath = '/myconfig.js'&nbsp;;
 
−
</pre>
 
−
The above method is good, but, as you can imagine, you lose the facility not to touch the original files. In any case it is easier to remember that you just need to change one line, and all the other things remain separated.
 
  
−
==== Methode 2 ====
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/AutoDetectLanguage|AutoDetectLanguage]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ContextMenu|ContextMenu]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DefaultFontFormatLabel|DefaultFontFormatLabel]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DefaultFontSizeLabel|DefaultFontSizeLabel]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DefaultFontLabel|DefaultFontLabel]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DefaultLanguage|DefaultLanguage]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DefaultStyleLabel|DefaultStyleLabel]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DisableFFTableHandles|DisableFFTableHandles]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/DisableObjectResizing|DisableObjectResizing]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/EnableMoreFontColors|EnableMoreFontColors]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashDlgHideAdvanced|FlashDlgHideAdvanced]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FloatingPanelsZIndex|FloatingPanelsZIndex]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageDlgHideLink|ImageDlgHideLink]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageDlgHideAdvanced|ImageDlgHideAdvanced]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/Keystrokes|Keystrokes]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkDlgHideAdvanced|LinkDlgHideAdvanced]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ShowBorders|ShowBorders]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ShowDropDialog|ShowDropDialog]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SkinPath|SkinPath]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SourcePopup|SourcePopup]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SmileyColumns|SmileyColumns]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SmileyWindowHeight|SmileyWindowHeight]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SmileyWindowWidth|SmileyWindowWidth]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ToolbarCanCollapse|ToolbarCanCollapse]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ToolbarStartExpanded|ToolbarStartExpanded]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ToolbarLocation|ToolbarLocation]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ToolbarSets|ToolbarSets]]
  
−
There is an even better way to have the same results as described above, but without touching the fckconfig.js file. You can set the custom configurations path from the page that uses the editor. Example in JavaScript prefered server side language:
+
== Advanced  ==
−
<pre>var oFCKeditor = new FCKeditor( "FCKeditor1" )&nbsp;;
 
−
oFCKeditor.Config["CustomConfigurationsPath"] = "/myconfig.js" &nbsp;;
 
−
oFCKeditor.Create()&nbsp;;
 
−
</pre>
 
−
The same method can be used with your preferred server side language. Take a look at the samples to find out how to manipulate the configurations by code.
 
  
−
=== Summary ===
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/AllowQueryStringDebug|AllowQueryStringDebug]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/BrowserContextMenuOnCtrl|BrowserContextMenuOnCtrl]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/CustomConfigurationsPath|CustomConfigurationsPath]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/Debug|Debug]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FirefoxSpellChecker|FirefoxSpellChecker]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/IeSpellDownloadUrl|IeSpellDownloadUrl]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/PluginsPath|PluginsPath]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/Plugins.Add|Plugins.Add]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/PreloadImages|PreloadImages]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/PreserveSessionOnFileBrowser|PreserveSessionOnFileBrowser]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ProtectedSource.Add|ProtectedSource.Add]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ProtectedTags|ProtectedTags]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SmileyPath|SmileyPath]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SmileyImages|SmileyImages]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SpellChecker|SpellChecker]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ScaytAutoStartup|ScaytAutoStartup]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/SpellerPagesServerScript|SpellerPagesServerScript]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/TemplatesXmlPath|TemplatesXmlPath]]
 +
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/MsWebBrowserControlCompat|MsWebBrowserControlCompat]]
  
−
When overriding configurations, the following steps are done:
+
== File Browser and Uploader  ==
  
−
# The configuration in the main configuration file (fckconfig.js) are loaded.
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowser|LinkBrowser]]
−
# The configuration is overridden by the settings in the custom configuration file (if provided).
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowserURL|LinkBrowserURL]]
−
# The configuration is overridden by the settings done in the editor page (if provided), except for the "CustomConfigurationsPath", that is set after step 1.
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowserWindowWidth|LinkBrowserWindowWidth]]
−
 
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkBrowserWindowHeight|LinkBrowserWindowHeight]]
−
You don't need to include all configuration options in your custom file, just those you want to change. Your file will "override" the original one.
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowser|ImageBrowser]]
−
 
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowserURL|ImageBrowserURL]]  
−
'''NOTE''':You need to keep the original configuration file, "fckconfig.js", in the editor directory. Don't delete it. <br><br>
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowserWindowWidth|ImageBrowserWindowWidth]]
−
 
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageBrowserWindowHeight|ImageBrowserWindowHeight]]
−
<br>
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashBrowser|FlashBrowser]]
−
 
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashBrowserURL|FlashBrowserURL]]
−
== Editor Behavior ==
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashBrowserWindowWidth|FlashBrowserWindowWidth]]
−
 
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashBrowserWindowHeight|FlashBrowserWindowHeight]]
−
* [[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/BaseHref|BaseHref]]
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkUpload|LinkUpload]]
−
* BodyId and BodyClass
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkUploadURL|LinkUploadURL]]
−
* CleanWordKeepsStructure
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkUploadAllowedExtensions|LinkUploadAllowedExtensions]]
−
* DefaultLinkTarget
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/LinkUploadDeniedExtensions|LinkUploadDeniedExtensions]]
−
* DocType
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageUpload|ImageUpload]]
−
* EditorAreaCSS
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageUploadURL|ImageUploadURL]]
−
* ToolbarComboPreviewCSS
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageUploadAllowedExtensions|ImageUploadAllowedExtensions]]
−
* ForcePasteAsPlainText
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/ImageUploadDeniedExtensions|ImageUploadDeniedExtensions]]
−
* FullPage
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashUpload|FlashUpload]]
−
* StartupFocus
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashUploadURL|FlashUploadURL]]
−
* TemplateReplaceAll
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashUploadAllowedExtensions|FlashUploadAllowedExtensions]]
−
* TemplateReplaceCheckbox
+
*[[FCKeditor 2.x/Developers Guide/Configuration/Configuration Options/FlashUploadDeniedExtensions|FlashUploadDeniedExtensions]]
−
 
 
−
== HTML Output ==
 
−
 
 
−
* AdditionalNumericEntities
 
−
* EnterMode
 
−
* FillEmptyBlocks
 
−
* ForceSimpleAmpersand
 
−
* ForceStrongEm
 
−
* FormatIndentator
 
−
* FormatOutput
 
−
* FormatSource
 
−
* IncludeGreekEntities
 
−
* IncludeLatinEntities
 
−
* ProcessHTMLEntities
 
−
* ProcessNumericEntities
 
−
* ShiftEnterMode
 
−
* UseBROnCarriageReturn
 
−
 
 
−
== Advanced ==
 
−
 
 
−
* BrowserContextMenuOnCtrl
 
−
* CustomConfigurationsPath
 
−
* FirefoxSpellChecker
 
−
* GeckoUseSPAN
 
−
* IeSpellDownloadUrl
 
−
* PreserveSessionOnFileBrowser
 
−
* ProtectedSource
 
−
* ProtectedTags
 

Latest revision as of 13:29, 9 October 2009

Editor Behavior

Styles

HTML Output

User Interface

Advanced

File Browser and Uploader

Retrieved from "https://docs-old.ckeditor.com/index.php?title=FCKeditor_2.x/Developers_Guide/Configuration/Configuration_Options&oldid=2723"
This page was last edited on 9 October 2009, at 13:29.