ckeditor的配置及使用

時間 2019-11-12

標籤 ckeditor 配置使用简体版

原文原文鏈接

1、使用方法：
一、在頁面<head>中引入ckeditor核心文件ckeditor.js
<script type="text/javascript" src="ckeditor/ckeditor.js"></script>javascript

二、在使用編輯器的地方插入HTML控件<textarea>
<textarea id="TextArea1" cols="20" rows="2" class="ckeditor"></textarea>
若是是ASP.NET環境，也可用服務器端控件<TextBox>
<asp:TextBox ID="tbContent" runat="server" TextMode="MultiLine" class="ckeditor"></asp:TextBox>
注意在控件中加上 class="ckeditor" 。php

三、將相應的控件替換成編輯器代碼
<script type="text/javascript">
    CKEDITOR.replace('TextArea1');
   //若是是在ASP.NET環境下用的服務器端控件<TextBox>
    CKEDITOR.replace('tbContent');
   //如果<TextBox>控件在母版頁中，要這樣寫
    CKEDITOR.replace('<%=tbContent.ClientID.Replace("_","$") %>');
</script>

四、配置編輯器css

    ckeditor的配置都集中在 ckeditor/config.js 文件中，下面是一些經常使用的配置參數：
   // 界面語言，默認爲 'en'
    config.language = 'zh-cn';
   // 設置寬高
    config.width = 400;
    config.height = 400;
   // 編輯器樣式，有三種：'kama'（默認）、'office2003'、'v2'
    config.skin = 'v2';
   // 背景顏色
    config.uiColor = '#FFF';
   // 工具欄（基礎'Basic'、全能'Full'、自定義）plugins/toolbar/plugin.js
    config.toolbar = 'Basic';
    config.toolbar = 'Full';
    這將配合：
    config.toolbar_Full = [
       ['Source','-','Save','NewPage','Preview','-','Templates'],
       ['Cut','Copy','Paste','PasteText','PasteFromWord','-','Print', 'SpellChecker', 'Scayt'],
       ['Undo','Redo','-','Find','Replace','-','SelectAll','RemoveFormat'],
       ['Form', 'Checkbox', 'Radio', 'TextField', 'Textarea', 'Select', 'Button', 'ImageButton', 'HiddenField'],
       '/',
       ['Bold','Italic','Underline','Strike','-','Subscript','Superscript'],
        ['NumberedList','BulletedList','-','Outdent','Indent','Blockquote'],
        ['JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock'],
        ['Link','Unlink','Anchor'],
       ['Image','Flash','Table','HorizontalRule','Smiley','SpecialChar','PageBreak'],
       '/',
        ['Styles','Format','Font','FontSize'],
        ['TextColor','BGColor']
    ];
    //工具欄是否能夠被收縮
    config.toolbarCanCollapse = true;
    //工具欄的位置
    config.toolbarLocation = 'top';//可選：bottom
    //工具欄默認是否展開
    config.toolbarStartupExpanded = true;
   // 取消「拖拽以改變尺寸」功能 plugins/resize/plugin.js
    config.resize_enabled = false;
    //改變大小的最大高度
    config.resize_maxHeight = 3000;
    //改變大小的最大寬度
    config.resize_maxWidth = 3000;
    //改變大小的最小高度
    config.resize_minHeight = 250;
    //改變大小的最小寬度
    config.resize_minWidth = 750;
   // 當提交包含有此編輯器的表單時，是否自動更新元素內的數據
    config.autoUpdateElement = true;
   // 設置是使用絕對目錄仍是相對目錄，爲空爲相對目錄
    config.baseHref = ''
    // 編輯器的z-index值
    config.baseFloatZIndex = 10000;
   //設置快捷鍵
    config.keystrokes = [
       [ CKEDITOR.ALT + 121 /*F10*/, 'toolbarFocus' ], //獲取焦點
        [ CKEDITOR.ALT + 122 /*F11*/, 'elementsPathFocus' ], //元素焦點
       [ CKEDITOR.SHIFT + 121 /*F10*/, 'contextMenu' ], //文本菜單
       [ CKEDITOR.CTRL + 90 /*Z*/, 'undo' ], //撤銷
        [ CKEDITOR.CTRL + 89 /*Y*/, 'redo' ], //重作
        [ CKEDITOR.CTRL + CKEDITOR.SHIFT + 90 /*Z*/, 'redo' ], //
        [ CKEDITOR.CTRL + 76 /*L*/, 'link' ], //連接
        [ CKEDITOR.CTRL + 66 /*B*/, 'bold' ], //粗體
        [ CKEDITOR.CTRL + 73 /*I*/, 'italic' ], //斜體
        [ CKEDITOR.CTRL + 85 /*U*/, 'underline' ], //下劃線
        [ CKEDITOR.ALT + 109 /*-*/, 'toolbarCollapse' ]
    ]
    //設置快捷鍵可能與瀏覽器快捷鍵衝突 plugins/keystrokes/plugin.js.
    config.blockedKeystrokes = [
        CKEDITOR.CTRL + 66 /*B*/,
        CKEDITOR.CTRL + 73 /*I*/,
        CKEDITOR.CTRL + 85 /*U*/
    ]
    //設置編輯內元素的背景色的取值 plugins/colorbutton/plugin.js.
    config.colorButton_backStyle = {
        element : 'span',
        styles : { 'background-color' : '#(color)' }
    }
    //設置前景色的取值 plugins/colorbutton/plugin.js
    config.colorButton_colors = '000,800000,8B4513,2F4F4F,008080,000080,4B0082,696969,B22222,A52A2A,DAA520,
        006400,40E0D0,0000CD,800080,808080,F00,FF8C00,FFD700,008000,0FF,00F,EE82EE,
        A9A9A9,FFA07A,FFA500,FFFF00,00FF00,AFEEEE,ADD8E6,DDA0DD,D3D3D3,FFF0F5,
        FAEBD7,FFFFE0,F0FFF0,F0FFFF,F0F8FF,E6E6FA,FFF’html

    //是否在選擇顏色時顯示「其它顏色」選項 plugins/colorbutton/plugin.js
    config.colorButton_enableMore = false
    //區塊的前景色默認值設置 plugins/colorbutton/plugin.js
    config.colorButton_foreStyle = {
        element : 'span',
        styles : { 'color' : '#(color)' }
    };
    //所須要添加的CSS文件在此添加可以使用相對路徑和網站的絕對路徑
    config.contentsCss = './contents.css';
    //文字方向
    config.contentsLangDirection = 'rtl'; //從左到右
    //CKeditor的配置文件若不想配置留空便可
    CKEDITOR.replace( 'myfiled', { customConfig : './config.js' } );
    //界面編輯框的背景色 plugins/dialog/plugin.js
    config.dialog_backgroundCoverColor = '#fffefd'; //可設置參考
    config.dialog_backgroundCoverColor = 'white' //默認
    //背景的不透明度數值應該在：0.0～1.0 之間 plugins/dialog/plugin.js
    config.dialog_backgroundCoverOpacity = 0.5
    //移動或者改變元素時邊框的吸附距離單位：像素 plugins/dialog/plugin.js
    config.dialog_magnetDistance = 20;
    //是否拒絕本地拼寫檢查和提示默認爲拒絕目前僅firefox和safari支持 plugins/wysiwygarea/plugin.js.
    config.disableNativeSpellChecker = true
    //進行表格編輯功能如：添加行或列目前僅firefox支持 plugins/wysiwygarea/plugin.js
    config.disableNativeTableHandles = true; //默認爲不開啓
    //是否開啓圖片和表格的改變大小的功能 config.disableObjectResizing = true;
    config.disableObjectResizing = false //默認爲開啓
    //設置HTML文檔類型
    config.docType = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd%22' ;

    //是否對編輯區域進行渲染 plugins/editingblock/plugin.js
    config.editingBlock = true;
    //編輯器中回車產生的標籤
    config.enterMode = CKEDITOR.ENTER_P; //可選：CKEDITOR.ENTER_BR或CKEDITOR.ENTER_DIV
    //是否使用HTML實體進行輸出 plugins/entities/plugin.js
    config.entities = true;
    //定義更多的實體 plugins/entities/plugin.js
    config.entities_additional = '#39'; //其中#代替了&
    //是否轉換一些難以顯示的字符爲相應的HTML字符 plugins/entities/plugin.js
    config.entities_greek = true;
    //是否轉換一些拉丁字符爲HTML plugins/entities/plugin.js
    config.entities_latin = true;
    //是否轉換一些特殊字符爲ASCII字符如"This is Chinese: 漢語."轉換爲"This is Chinese: 漢語." plugins/entities/plugin.js
    config.entities_processNumerical = false;
    //添加新組件
    config.extraPlugins = 'myplugin'; //非默認僅示例
    //使用搜索時的高亮色 plugins/find/plugin.js
    config.find_highlight = {
        element : 'span',
        styles : { 'background-color' : '#ff0', 'color' : '#00f' }
    };
    //默認的字體名 plugins/font/plugin.js
    config.font_defaultLabel = 'Arial';
    //字體編輯時的字符集能夠添加經常使用的中文字符：宋體、楷體、黑體等 plugins/font/plugin.js
    config.font_names = 'Arial;Times New Roman;Verdana';
    //文字的默認式樣 plugins/font/plugin.js
    config.font_style = {
        element   : 'span',
        styles   : { 'font-family' : '#(family)' },
        overrides : [ { element : 'font', attributes : { 'face' : null } } ]
    };
    //字體默認大小 plugins/font/plugin.js
    config.fontSize_defaultLabel = '12px';
    //字體編輯時可選的字體大小 plugins/font/plugin.js
    config.fontSize_sizes ='8/8px;9/9px;10/10px;11/11px;12/12px;14/14px;16/16px;18/18px;20/20px;22/22px;24/24px;26/26px;28/28px;36/36px;48/48px;72/72px'
    //設置字體大小時使用的式樣 plugins/font/plugin.js
    config.fontSize_style = {
        element   : 'span',
        styles   : { 'font-size' : '#(size)' },
        overrides : [ { element : 'font', attributes : { 'size' : null } } ]
    };
    //是否強制複製來的內容去除格式 plugins/pastetext/plugin.js
    config.forcePasteAsPlainText =false //不去除
    //是否強制用「&」來代替「&」plugins/htmldataprocessor/plugin.js
    config.forceSimpleAmpersand = false;
    //對address標籤進行格式化 plugins/format/plugin.js
    config.format_address = { element : 'address', attributes : { class : 'styledAddress' } };
    //對DIV標籤自動進行格式化 plugins/format/plugin.js
    config.format_div = { element : 'div', attributes : { class : 'normalDiv' } };
    //對H1標籤自動進行格式化 plugins/format/plugin.js
    config.format_h1 = { element : 'h1', attributes : { class : 'contentTitle1' } };
    //對H2標籤自動進行格式化 plugins/format/plugin.js
    config.format_h2 = { element : 'h2', attributes : { class : 'contentTitle2' } };
    //對H3標籤自動進行格式化 plugins/format/plugin.js
    config.format_h1 = { element : 'h3', attributes : { class : 'contentTitle3' } };
    //對H4標籤自動進行格式化 plugins/format/plugin.js
    config.format_h1 = { element : 'h4', attributes : { class : 'contentTitle4' } };
    //對H5標籤自動進行格式化 plugins/format/plugin.js
    config.format_h1 = { element : 'h5', attributes : { class : 'contentTitle5' } };
    //對H6標籤自動進行格式化 plugins/format/plugin.js
    config.format_h1 = { element : 'h6', attributes : { class : 'contentTitle6' } };
    //對P標籤自動進行格式化 plugins/format/plugin.js
    config.format_p = { element : 'p', attributes : { class : 'normalPara' } };
    //對PRE標籤自動進行格式化 plugins/format/plugin.js
    config.format_pre = { element : 'pre', attributes : { class : 'code' } };
    //用分號分隔的標籤名字在工具欄上顯示 plugins/format/plugin.js
    config.format_tags = 'p;h1;h2;h3;h4;h5;h6;pre;address;div';
    //是否使用完整的html編輯模式如使用，其源碼將包含：<html><body></body></html>等標籤
    config.fullPage = false;
    //是否忽略段落中的空字符若不忽略則字符將以「」表示 plugins/wysiwygarea/plugin.js
    config.ignoreEmptyParagraph = true;
    //在清除圖片屬性框中的連接屬性時是否同時清除兩邊的<a>標籤 plugins/image/plugin.js
    config.image_removeLinkByEmptyURL = true;
    //一組用逗號分隔的標籤名稱，顯示在左下角的層次嵌套中 plugins/menu/plugin.js.
    config.menu_groups ='clipboard,form,tablecell,tablecellproperties,tablerow,tablecolumn,table,anchor,link,image,flash,checkbox,radio,textfield,hiddenfield,imagebutton,button,select,textarea';
    //顯示子菜單時的延遲，單位：ms plugins/menu/plugin.js
    config.menu_subMenuDelay = 400;
    //當執行「新建」命令時，編輯器中的內容 plugins/newpage/plugin.js
    config.newpage_html = '';
    //當從word裏複製文字進來時，是否進行文字的格式化去除 plugins/pastefromword/plugin.js
    config.pasteFromWordIgnoreFontFace = true; //默認爲忽略格式
    //是否使用<h1><h2>等標籤修飾或者代替從word文檔中粘貼過來的內容 plugins/pastefromword/plugin.js
    config.pasteFromWordKeepsStructure = false;
    //從word中粘貼內容時是否移除格式 plugins/pastefromword/plugin.js
    config.pasteFromWordRemoveStyle = false;
    //對應後臺語言的類型來對輸出的HTML內容進行格式化，默認爲空
    config.protectedSource.push( /<"?["s"S]*?"?>/g );   // PHP Code
    config.protectedSource.push( //g );   // ASP Code
    config.protectedSource.push( /(]+>["s|"S]*?<"/asp:[^">]+>)|(]+"/>)/gi );   // ASP.Net Code
    //當輸入：shift+Enter時插入的標籤
    config.shiftEnterMode = CKEDITOR.ENTER_P; //可選：CKEDITOR.ENTER_BR或CKEDITOR.ENTER_DIV
    //可選的表情替代字符 plugins/smiley/plugin.js.
    config.smiley_descriptions = [
        ':)', ':(', ';)', ':D', ':/', ':P',
        '', '', '', '', '', '',
        '', ';(', '', '', '', '',
        '', ':kiss', '' ];

    //對應的表情圖片 plugins/smiley/plugin.js
    config.smiley_images = [
        'regular_smile.gif','sad_smile.gif','wink_smile.gif','teeth_smile.gif','confused_smile.gif','tounge_smile.gif',
        'embaressed_smile.gif','omg_smile.gif','whatchutalkingabout_smile.gif','angry_smile.gif','angel_smile.gif','shades_smile.gif',
        'devil_smile.gif','cry_smile.gif','lightbulb.gif','thumbs_down.gif','thumbs_up.gif','heart.gif',
        'broken_heart.gif','kiss.gif','envelope.gif'];
    //表情的地址 plugins/smiley/plugin.js
    config.smiley_path = 'plugins/smiley/images/';
    //頁面載入時，編輯框是否當即得到焦點 plugins/editingblock/plugin.js plugins/editingblock/plugin.js.
    config.startupFocus = false;
    //載入時，以何種方式編輯源碼和所見即所得 "source"和"wysiwyg" plugins/editingblock/plugin.js.
    config.startupMode ='wysiwyg';
    //載入時，是否顯示框體的邊框 plugins/showblocks/plugin.js
    config.startupOutlineBlocks = false;
    //是否載入樣式文件 plugins/stylescombo/plugin.js.
    config.stylesCombo_stylesSet = 'default';
    //如下爲可選
    config.stylesCombo_stylesSet = 'mystyles';
    config.stylesCombo_stylesSet = 'mystyles:/editorstyles/styles.js';
    config.stylesCombo_stylesSet = 'mystyles:http://www.example.com/editorstyles/styles.js';
    //起始的索引值
    config.tabIndex = 0;
    //當用戶鍵入TAB時，編輯器走過的空格數，( ) 當值爲0時，焦點將移出編輯框 plugins/tab/plugin.js
    config.tabSpaces = 0;
    //默認使用的模板 plugins/templates/plugin.js.
    config.templates = 'default';
    //用逗號分隔的模板文件plugins/templates/plugin.js.
    config.templates_files = [ 'plugins/templates/templates/default.js' ]
    //當使用模板時，「編輯內容將被替換」框是否選中 plugins/templates/plugin.js
    config.templates_replaceContent = true;
    //主題
    config.theme = 'default';
    //撤銷的記錄步數 plugins/undo/plugin.js
    config.undoStackSize =20;
   // 在 CKEditor 中集成 CKFinder，注意 ckfinder 的路徑選擇要正確。
   //CKFinder.SetupCKEditor(null, '/ckfinder/');

2、一些使用技巧

一、在頁面中即時設置編輯器

<script type="text/javascript">
       // 示例1：設置工具欄爲基本工具欄，高度爲70
       CKEDITOR.replace('<%=tbLink.ClientID.Replace("_","$") %>',
        { toolbar:'Basic', height:70 });
       //示例2：工具欄爲自定義類型
       CKEDITOR.replace( 'editor1',
        {
             toolbar :
             [
               //加粗     斜體，     下劃線      穿過線      下標字        上標字
                ['Bold','Italic','Underline','Strike','Subscript','Superscript'],
               // 數字列表          實體列表            減少縮進    增大縮進
                ['NumberedList','BulletedList','-','Outdent','Indent'],
               //左對齊             居中對齊          右對齊          兩端對齊
                ['JustifyLeft','JustifyCenter','JustifyRight','JustifyBlock'],
               //超連接取消超連接錨點
                ['Link','Unlink','Anchor'],
               //圖片    flash    表格       水平線            表情       特殊字符        分頁符
                ['Image','Flash','Table','HorizontalRule','Smiley','SpecialChar','PageBreak'],
               '/',
               // 樣式       格式      字體    字體大小
                ['Styles','Format','Font','FontSize'],
               //文本顏色     背景顏色
                ['TextColor','BGColor'],
               //全屏           顯示區塊
                ['Maximize', 'ShowBlocks','-']
             ]
        }
    );
</script>

3、精簡ckeditor

    在部署到Web服務器上時，下列文件夾和文件均可以刪除：
    /_samples ：示例文件夾；
    /_source ：未壓縮源程序；
    /lang文件夾下除 zh-cn.js、en.js 之外的文件（也能夠根據須要保留其餘語言文件）；
    根目錄下的 changes.html(更新列表)，install.html(安裝指向)，license.html(使用許可)；
    /skins 目錄下不須要的皮膚，通常用V2(簡單，樸素) ，若是隻保留V2則必須在config.js中指定皮膚。java

四，版本問題數據庫

在CKEditor的官方網站上下載，最要下載所有功能，最後獲得的壓縮包是ckeditor_4.1.1_full.zip，若是選擇simple或者standed，可能會有些功能不能用，好比字體顏色，背景顏色，這下功能在standed版本里面就不支持。因此你會很奇怪明明設置了['TextColor','BGColor']，可是文本顏色和背景顏色選項就是不顯示。瀏覽器

五，去掉默認的段落標記安全

去除CKEditor自動添加的<p></p>標籤的方法,其實很簡單,有兩種辦法：服務器

1.在ckeditor目錄下的config.js添加如下配置參數便可:session

config.enterMode = CKEDITOR.ENTER_BR：屏蔽換行符<br>
config.shiftEnterMode = CKEDITOR.ENTER_P:屏蔽段落<p>

2.直接更改編輯器默認模式爲源代碼模式，在ckeditor目錄下的config.js添加如下配置：

config.startupMode = 'source';

六，和kcfinder搭配使用

默認狀況下CKEditor是沒有上傳圖片功能的，能夠在編輯器中粘貼圖片，這樣的話保存在數據庫中的是圖片的源文件，這很容易出現問題，即便字段是text格式的也很容易就超出最大範圍了，因此要配合kcfinder來上傳文件。一個是ck一個是kc真實一對好兄弟。

在配置CKEditor的配置文件ckeditor\config.js中添加如下配置

    config.filebrowserBrowseUrl = 'kcfinder/browse.php?type=files';  
    config.filebrowserImageBrowseUrl = 'kcfinder/browse.php?type=images';  
    config.filebrowserFlashBrowseUrl = 'kcfinder/browse.php?type=flash';  
    config.filebrowserUploadUrl = 'kcfinder/upload.php?type=files';  
    config.filebrowserImageUploadUrl = 'kcfinder/upload.php?type=images';  
    config.filebrowserFlashUploadUrl = 'kcfinder/upload.php?type=flash';

要注意若是kcfinder的路徑放在CKEditor的同一級目錄下不能這樣

config.filebrowserBrowseUrl = '/kcfinder/browse.php?type=files';

要注意爲安全考慮默認狀況下是不容許上傳圖片的，在本身的源代碼中要設置能夠上傳，代碼以下

session_start();
if(!empty($_SESSION['USERNAME'])&&!empty($_SESSION['PASSWORD'])){
$_SESSION['KCFINDER']['disabled'] = false;
}else{
echo "<script>top.location.href="http://xxx.com/login.php"> 
}

這個就是判斷是不是登錄用戶，不是登錄用戶的話不可使用，而且跳轉到登錄界面去登錄，網上有人說把這個放在kcfinder\config.php這個kcfinder的配置文件中我發現這個是行不通的。這樣設置以後在選擇上傳圖片的時候會有錯誤，以下

文章出處：http://www.cnblogs.com/tylerdonet/archive/2013/04/27/3046170.html

參考資料：http://www.docin.com/p-656706746.html