百度富文本編輯器ueditor使用總結

最近做的項目用到了ueditor這個東東，但是他的一些配置文檔對初次使用者來說很難以理解，故作此總結

 

1.ueditor 官方地址：http://ueditor.baidu.com/website/index.html

   開發文檔地址：http://ueditor.baidu.com/website/document.html

   下載地址：http://ueditor.baidu.com/website/download.html （這里可選開發版，或MINI版）

 

2. 從官網上下載完整源碼包，解壓到任意目錄，解壓后的源碼目錄結構如下所示：

     _examples：編輯器完整版的示例頁面

    dialogs：彈出對話框對應的資源和js文件

    themes：樣式圖片和樣式文件   PHP/jsp/.net：涉及到服務器端操作的后台文件，根據你選擇的不同后台版本，這里也會不同，這里我們選擇php

    third-party：第三方插件(包括代碼高亮，源碼編輯等組件）

    editor_all.js：_src目錄下所有文件的打包文件（用於發布版本）

    editor_api.js: API接口配置文件（開發版本）

    editor_all_min.js：editor_all.js文件的壓縮版，建議在正式部署時才采用

    editor_config.js：編輯器的配置文件，建議和編輯器實例化頁面置於同一目錄

 

3.編輯器的實例化頁面，導入編輯器需要的三個入口文件，示例代碼如下：

 

<script type="text/javascript" charset="utf-8" src="../umeditor.config.js"></script>

    <!--使用版-->
    <!--<script type="text/javascript" charset="utf-8" src="../umeditor.all.js"></script>-->

    <!--開發版-->
    <script type="text/javascript" charset="utf-8" src="editor_api.js"></script>
    <script type="text/javascript" src="../lang/zh-cn/zh-cn.js"></script>

 

 

4.然后在編輯器的實例化頁面中創建編輯器實例及其DOM容器，示例代碼如下：

 

<textarea name="后台取值的key" id="myEditor">這里寫你的初始化內容</textarea>
<script type="text/javascript">
    var editor = new UE.ui.Editor();
    editor.render("myEditor");
    //1.2.4以后可以使用一下代碼實例化編輯器
    //UE.getEditor('myEditor')
</script>

5.在editor_config.js中查找URL變量配置編輯器在你項目中的路徑。

 

官網示例：

 

//強烈推薦以這種方式進行絕對路徑配置
URL= window.UEDITOR_HOME_URL||"/UETest/ueditor/";

我的配置：

 

 

(function () {
    /**
     * 編輯器資源文件根路徑。它所表示的含義是：以編輯器實例化頁面為當前路徑，指向編輯器資源文件（即dialog等文件夾）的路徑。
     * 鑒於很多同學在使用編輯器的時候出現的種種路徑問題，此處強烈建議大家使用"相對於網站根目錄的相對路徑"進行配置。
     * "相對於網站根目錄的相對路徑"也就是以斜杠開頭的形如"/myProject/umeditor/"這樣的路徑。
     * 如果站點中有多個不在同一層級的頁面需要實例化編輯器，且引用了同一UEditor的時候，此處的URL可能不適用於每個頁面的編輯器。
     * 因此，UEditor提供了針對不同頁面的編輯器可單獨配置的根路徑，具體來說，在需要實例化編輯器的頁面最頂部寫上如下代碼即可。當然，需要令此處的URL等於對應的配置。
     * window.UMEDITOR_HOME_URL = "/xxxx/xxxx/";
     */

    /**
     * @author wusuopubupt
     * @date 2013-10-24
     *
     * set window.UMEDITOR_HOME_URL = "/ueditor/";
     *
     * */
    window.UMEDITOR_HOME_URL = "/ueditor/";  //注意就是這里！

    var URL = window.UMEDITOR_HOME_URL || (function(){

        function PathStack() {

6.如果用editor_api.js （也就是不用editor.all.js）開發時,打開editor_api.js,代碼如下

 

 

/**
 * 開發版本的文件導入
 */
(function (){
    var paths  = [
            'editor.js',
            'core/browser.js',
            'core/utils.js',
            'core/EventBase.js',
            'core/dtd.js',
            'core/domUtils.js',
            'core/Range.js',
            'core/Selection.js',
            'core/Editor.js',
            'core/filterword.js',
            'core/node.js',
            'core/htmlparser.js',
            'core/filternode.js',
            'plugins/inserthtml.js',
            'plugins/image.js',
            'plugins/justify.js',
            'plugins/font.js',
            'plugins/link.js',
            'plugins/print.js',
            'plugins/paragraph.js',
            'plugins/horizontal.js',
            'plugins/cleardoc.js',
            'plugins/undo.js',
            'plugins/paste.js',
            'plugins/list.js',
            'plugins/source.js',
            'plugins/enterkey.js',
            'plugins/preview.js',
            'plugins/basestyle.js',
            'plugins/video.js',
            'plugins/selectall.js',
            'plugins/removeformat.js',
            'plugins/keystrokes.js',
            'plugins/dropfile.js',
            'ui/widget.js',
            'ui/button.js',
            'ui/toolbar.js',
            'ui/menu.js',
            'ui/dropmenu.js',
            'ui/splitbutton.js',
            'ui/colorsplitbutton.js',
            'ui/popup.js',
            'ui/scale.js',
            'ui/colorpicker.js',
            'ui/combobox.js',
            'ui/buttoncombobox.js',
            'ui/modal.js',
            'ui/tooltip.js',
            'ui/tab.js',
            'ui/separator.js',
            'ui/scale.js',
            'adapter/adapter.js',
            'adapter/button.js',
            'adapter/fullscreen.js',
            'adapter/dialog.js',
            'adapter/popup.js',
            'adapter/imagescale.js',
            'adapter/autofloat.js',
            'adapter/source.js',
            'adapter/combobox.js'
        ],
        /**
         * @author wusuopubupt
         * @date 2013-10-24
         *
         * modified  baseURL = '/ueditor/src/';
         */
        baseURL = '/ueditor/src/';
    for (var i=0,pi;pi = paths[i++];) {
        document.write('<script type="text/javascript" src="'+ baseURL + pi +'"></script>');
    }
})();

可以看到，這里有一項：baseURL，就是JS文件的路由，這里要根據ueditor_api.js文件的實際路徑去配置！
    
  7.文件上傳問題：

 

打開ueditor.config.js，可以看到如下配置：

 

//圖片上傳配置區
       ,imageUrl:URL+"php/imageUp.php"             //圖片上傳提交地址
       //,imagePath:URL + "php/"                     //圖片修正地址，引用了fixedImagePath,如有特殊需求，可自行配置
       ,imagePath:"http://test.mathandcs.com/"
       ,imageFieldName:"upfile"                   //圖片數據的key,若此處修改，需要在后台對應文件修改對應參數

這里的imageURL是圖片上傳所調用的php文件的地址，而imagePath則是為新上傳的圖片生成的圖片地址的host部分；

 

再打開ueditor/php/下的imageUp.php文件，有配置如下：

 

$config = array(
        "savePath" => "/var/www/store/upload/" ,             //存儲文件夾
        "maxSize" => 1000 ,                   //允許的文件最大尺寸，單位KB
        "allowFiles" => array( ".gif" , ".png" , ".jpg" , ".jpeg" , ".bmp" )  //允許的文件格式
    );
    //上傳文件目錄
    //$Path = "upload/";
    $Path = "/var/www/store/upload/";

   這里需要把上傳文件到服務器的目的地址（上傳文件保存文件）savePath修改成你指定的文件地址。

 

由於相對路徑和絕對路徑的問題，生成的地址有可能是錯的，這時就要hack一下生成圖片URL的JS文件：

ueditor/dialogs/image/image.js 中修改：

 

/**
                 * @author wusuopubupt
                 * @date 2013-10-24
                 * @return url modified
                 * */
                var reg = /\/var\/www\/test\/upload\//;
                url = url.replace(reg,"");

                var $img = $("<img src='" + editor.options.imagePath + url + "' class='edui-image-pic' />"),
                    $item = $("<div class='edui-image-item edui-image-upload-item'><div class='edui-image-close'></div></div>").append($img);

這里的正則的規則要根據具體情況來定！

 

 

至此，Ueditor便在我的環境中配置成功了。

更多詳細的文檔請參考ueditor官網DOC：http://ueditor.baidu.com/website/document.html