DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> WEB網站前端 >> 前端技巧
tinyMCE 富文本編輯器設定全解與使用心得
編輯:前端技巧     

初始化

把以下程式碼放進頁面的 head,頁面上所有 textarea 就會在載入時被轉換成編輯器:

<script language="javascript" type="text/javascript" src="jscripts/tiny_mce/tiny_mce.js"></script>
<script language="javascript" type="text/javascript">
tinyMCE.init({
  mode: "textareas"
});
</script>

第一段是腳本檔位置,它包含編輯器所需全部程式碼,主題與語言包會在初始化時才載入。第二段是初始化呼叫,其中的名稱—值屬性控制全域行為。

核心設定

mode 決定哪些欄位被轉換,可取:

  • textareas:轉換頁面上所有 textarea
  • specific_textareas:只轉換屬性值為 true 的 textarea
  • exact:只轉換 elements 設定中指定的元素

其他常用設定:

  • theme:主題名稱,放在 themes 目錄下,內建 simple、default、advanced,預設 default
  • plugins:以逗號分隔的插件清單,邏輯寫在各自的 editor_plugin.js 中
  • language:語言包代碼如 se、uk、us,預設 uk;中文建議用 zh-CN
  • elements:mode 為 exact 時使用的元素 id 清單
  • width / height:編輯器尺寸,預設沿用被替換元素的尺寸
  • content_css:編輯區內使用的 CSS 檔路徑(相對頁面)
  • theme_advanced_toolbar_location:工具列位置,top 或 bottom
  • theme_advanced_toolbar_align:工具列對齊,left、center 或 right
  • theme_advanced_buttons1 / 2 / 3:三列工具列的按鈕清單,可用 _add、_add_before 增補,或用 theme_advanced_disable 停用特定按鈕
  • theme_advanced_styles:樣式下拉選單內容,格式為 "標題=class;標題=class";不設定時會自動匯入內容區的 CSS class
  • relative_urls / remove_script_host / document_base_url:控制路徑轉換行為,整合自家資源管理器時經常需要調整
  • cleanup_on_startup / auto_cleanup_word:啟動時清理,或自動清掉從 Word 貼上的垃圾標記(舊版僅支援 IE)

valid_elements 的語法

這個設定用來白名單化允許的標籤與屬性,例如:

a[href|target=_blank],strong/b,div[align],br

意思是只保留 a、strong、div、br,並把 b 輸出為 strong、target 固定為 _blank。特殊字元含義:

  • , 分隔各標籤定義;/ 分隔同義標籤(前者為輸出用的名稱)
  • | 分隔屬性;[ ] 包住屬性清單
  • = 設屬性預設值;: 強制固定屬性值,如 border:0
  • < 驗證屬性值,? 分隔多個可選值
  • *、+、? 可作為標籤與屬性的萬用字元

要允許全部標籤與屬性用 *[*]。另有 extended_valid_elements 可在預設清單後追加,invalid_elements 則是黑名單。

常用 API

tinyMCE.triggerSave();                       // 清理並把內容寫回表單欄位
tinyMCE.updateContent('form_name');         // 反向操作:表單 → 編輯器
tinyMCE.execCommand(cmd, ui, value);        // 執行命令
tinyMCE.execInstanceCommand(id, cmd, ui, v);// 對指定實例執行命令
tinyMCE.insertLink(href, target);           // 插入或更新連結
tinyMCE.insertImage(src, alt, border, hspace, vspace, width, height, align, title, ...);
tinyMCE.getContent();                       // 取得目前編輯器的 HTML
tinyMCE.setContent(html);                   // 設定 HTML 內容
tinyMCE.getEditorInstance(editor_id);       // 取得編輯器實例
tinyMCE.openWindow(template, args);         // 開啟自訂彈出視窗

幾個實務上特別有用的自訂命令:mceInsertContent 在游標處插入內容、mceReplaceContent 取代選取區(支援 {$selection} 變數)、mceSetAttribute 批次設屬性、mceResetDesignMode 在編輯器被隱藏後重新顯示時重置設計模式。

使用心得

tinyMCE 是一款功能完整的網頁式所見即所得編輯器,官方網站是 https://www.tinymce.com/,當時最新版為 3.4.7,下載頁在 download.php。它的能力幾乎能與文書處理軟體相比,而且幾乎所有工具都能自訂,進階功能大多以插件形式提供,需要時再掛上即可。

建議下載 dev 版本,裡頭有大量範例,也能直接翻閱原始碼。接入步驟非常短:

  1. 在頁面加入 <script type="text/javascript" src="common/tiny_mce/tiny_mce_src.js"></script>,只需這一個檔案,CSS 與其他 JS 它會自行載入。
  2. 在 body 放一個 <textarea id="myRTE"></textarea>。
  3. 呼叫 init,在設定中綁定該 textarea。

完整 JSP 範例:

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Word processor example</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<script type="text/javascript" src="jscripts/tiny_mce/tiny_mce.js"></script>
<script type="text/javascript">
tinyMCE.init({
  // General options
  mode: "textareas",
  theme: "advanced",
  skin: "o2k7",
  plugins: "autolink,lists,pagebreak,style,layer,table,save,advhr,advimage,advlink,emotions,iespell,insertdatetime,preview,media,searchreplace,print,contextmenu,paste,directionality,fullscreen,template,inlinepopups",
  // Theme options
  theme_advanced_buttons1: "save,newdocument,|,bold,italic,underline,strikethrough,|,justifyleft,justifycenter,justifyright,justifyfull,|,styleselect,formatselect,fontselect,fontsizeselect",
  theme_advanced_buttons2: "cut,copy,paste,pastetext,pasteword,|,search,replace,|,bullist,numlist,|,outdent,indent,blockquote,|,undo,redo,|,link,unlink,anchor,image,cleanup,help,code,|,insertdate,inserttime,preview,|,forecolor,backcolor",
  theme_advanced_buttons3: "tablecontrols,|,hr,removeformat,visualaid,|,sub,sup,|,charmap,emotions,media,advhr,|,print,|,ltr,rtl,|,fullscreen",
  theme_advanced_toolbar_location: "top",
  theme_advanced_toolbar_align: "left",
  theme_advanced_statusbar_location: "bottom",
  theme_advanced_resizing: true,
  content_css: "css/word.css",
  template_external_list_url: "lists/template_list.js",
  external_link_list_url: "lists/link_list.js",
  external_image_list_url: "lists/image_list.js",
  template_replace_values: {
    username: "Some User",
    staffid: "991234"
  }
});
</script>
</head>
<body>
<form method="post" action="dump.php?example=true">
  <h3>Word processor example</h3>
  <!-- 注意:textarea 中的 HTML 必須做實體編碼 -->
  <textarea id="elm1" name="elm1" rows="15" cols="80" style="width: 80%">
    &lt;p&gt;第一段。&lt;/p&gt;
  </textarea>
  <input type="submit" name="save" value="Submit" />
  <input type="reset" name="reset" value="Reset" />
</form>
</body>
</html>

所需的 js 檔全部在官方下載的 dev 包 jscripts 目錄裡,把整個目錄放到專案根目錄即可。

最後補充三個實務上的注意事項:一是 textarea 內若預先放了 HTML,務必做實體編碼,否則會被瀏覽器提前解析;二是使用進階模式時,若編輯器被放在隱藏的頁籤中,切回來後可能需要呼叫 mceResetDesignMode 才能編輯;三是記得在伺服器端對提交內容做完整的標籤白名單過濾,前端編輯器的 valid_elements 只是使用者體驗層級的規範,不能當成安全防線。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved