ckeditor syntaxhighlighter代码高亮插件配置分享

图片 7

上网搜索了一下相关的文章不少,大同小异,本人一直使用的是CKeditor的文字编辑器,所以偿试使用网上很多网友介绍的SyntaxHighlighter配合CKEditor插件的方式实现。可能是因为SyntaxHighlighter和CKEditor版本不同,过程中遇到了一些问题,解决的同时也根据个人理解做部分调整,所以本文所描述的方法仅供参考。
一、SyntaxHighlighter简介
SyntaxHighlighter是一套在浏览器上对各种代码进行语法着色的独立JavaScript库。
下载网站:
脚本之家下载:本文使用的版本是3.0.83版,下载后只需要syntaxhighlighter文件夹下的“scripts”和“styles”文件夹内的文件,在代码语法着色高亮显示的页面引用“styles/shCore.css”样式文件,“scripts/shCore.js”JS文件,因为每一种代码语言都要引用各自的JS文件,为了降低HTTP请求,把所有代码语言的JS文件内容都放到一个“scripts/shBrushSeaYee.js”JS文件里,把所代码写成一行,优化一下。
例如: 复制代码 代码如下: link
rel=”stylesheet” type=”text/css”
href=”/syntaxhighlighter/styles/shCoreDefault.css” / script
language=”javascript” type=”text/javascript”
src=”/syntaxhighlighter/scripts/shCore.js”/script script
language=”javascript” type=”text/javascript”
src=”/syntaxhighlighter/scripts/shBrushSeaYee.js”/script
二、CKEditor简介
CKeditor是一个专门使用在网页上属于开放源代码的所见即所得文字编辑器。它志于轻量化,不需要太复杂的安装步骤即可使用。它可和PHP、JavaScript、ASP、ASP.NET、ColdFusion、Java、以及ABAP等不同的编程语言相结合。它原名FCKEditor,在2009年发布更新到3.0,并改名为CKEditor。原来叫FCK,是因为最初的开发者叫Frederico
Calderia Knabben;现在叫CK,意指”Content and
Knowledge”。据官方的解释,CKEditor是对FCKEditor的代码的完全重写,而且此项工作从2007年就开始了,更新包括:新的用户界面,一个支持Plug-in的Javascript
API,并提供对视觉障碍者的使用支持。 下载网站:
本文使用的版本是3.5.3版,安装配置都比较简单,本文不再赘述。
三、CKEditor代码语法着色高亮显示的插件开发
1、在”ckeditor/plugins/”目录下新建一个”insertcode”目录,然后在”insertcode”目录下新建一个”plugin.js”,输入以下代码:
复制代码 代码如下:
CKEDITOR.plugins.add(‘insertcode’, { init: function(editor) { //plugin
code goes here var pluginName = ‘Insertcode’;
CKEDITOR.dialog.add(pluginName, this.path + ‘insertcode.js’);
editor.config.flv_path = editor.config.flv_path || (this.path);
editor.addCommand(pluginName, new CKEDITOR.dialogCommand(pluginName));
editor.ui.addButton(‘Insertcode’, { label: ‘插入代码’, command:
pluginName, icon: this.path + ‘insertcode.gif’ }); } });
注:第1行代码中“insertcode”必须与文件夹名称相同且区分大小写字母,因为在Linux系统的Web服务器中,路径是区分大小写字母的。
2、”insertcode”目录下放入一个”insertcode.gif”16*16大小的图片,可自己做或上网找。
3、”insertcode”目录下新建一个”insertcode.js”,输入如下代码: 复制代码 代码如下:
CKEDITOR.dialog.add(‘Insertcode’, function(editor){ var escape =
function(value){return value;}; return{ title: ‘插入代码’, resizable:
CKEDITOR.DIALOG_RESIZE_BOTH, minWidth: 720, minHeight: 520, contents:
[{ id: ‘cb’, name: ‘cb’, label: ‘cb’, title: ‘cb’, elements: [{ type:
‘select’, label: ‘Language’, id: ‘lang’, required: true, ‘default’:
‘csharp’, items: [[‘ActionScript3’, ‘as3’], [‘Bash/shell’, ‘bash’],
[‘ColdFusion’, ‘cf’], [‘C#’, ‘csharp’], [‘C++’, ‘cpp’], [‘CSS’,
‘css’], [‘Delphi’, ‘delphi’], [‘Diff’, ‘diff’], [‘Groovy’,
‘groovy’], [‘JavaScript’, ‘js’], [‘Java’, ‘java’], [‘JavaFX’,
‘jfx’], [‘Perl’, ‘perl’], [‘PHP’, ‘php’], [‘Plain Text’,
‘plain’], [‘PowerShell’, ‘ps’], [‘Python’, ‘py’], [‘Ruby’,
‘rails’], [‘Scala’, ‘scala’], [‘SQL’, ‘sql’], [‘Visual Basic’,
‘vb’], [‘XML’, ‘xml’]] }, { type: ‘textarea’, style:
‘width:718px;height:450px’, label: ‘Code’, id: ‘code’, rows: 31,
‘default’: ” }] }], onOk: function(){ code = this.getValueOf(‘cb’,
‘code’); lang = this.getValueOf(‘cb’, ‘lang’); html = ” + escape(code)

从官网 下载ckeditor,我下载的是CKEditor 3.3.1
。CKEditor与原来的FCKeditor有太大的不同了,作为开发人员,在做自己的博客的时候总是需要贴代码的,只好给它先做一个插入代码的插件了。高亮代码用的是”SyntaxHighlighter
“。

最近由于自己想做一个网站形式的代码库,自已写一个在线文本编辑器,对于现在的我来,确实是很不切实际,呵呵!再说了,现在有一个非常好的在线文本编辑器(ckeditor)了,我和必再去费这等功夫呢!有现成的,拿过用就是的呗!正所谓的拿来主义!不过这个在线文本编辑器,对于我们程序员来说有一个算是缺陷吧!没有代码高亮的功能!这样把代码贴上去,很不好看!今天晚上,我总是把他给弄出来了。当然也采在别人的肩膀上做成的。在此感谢他们的分享!费话不多说了!咱们进入正题吧!

  • ”; editor.insertHtml(“pre class=/”brush:” + lang + “;/”” + html +
    “/pre”); }, onLoad: function(){} }; });
    4、在”ckeditor/”目录下找到“config.js”文件,这是CKEditor的配置文件,添加如下代码:
    复制代码 代码如下:config.extraPlugins =
    ‘insertcode’;
    注:代码中“insertcode”也必须与文件夹名称相同,区分大小写字母。
    要在CKEditor工具栏添加按钮就在此配置文件中添加上“,Insertcode”,依然要注意区分大小写字母。至此就大功造成了。

1、在”ckeditor/plugins/”目录下新建一个”insertcode”目录,然后在”insertcode”目录下新建一个”plugin.js”,输入以下代码:

首先去官方网站下载个ckeditor

CKEDITOR.plugins.add(‘insertcode’, { requires: [‘dialog’], 
init: function(a){
var b = a.addCommand(‘insertcode’, new CKEDITOR.dialogCommand(‘insertcode’));
a.ui.addButton(‘insertcode’, {
label: a.lang.insertcode.toolbar, command: ‘insertcode’,icon: this.path + ‘images/code.jpg’
});
CKEDITOR.dialog.add(‘insertcode’, this.path + ‘dialogs/insertcode.js’); 
} });

其次去官方网站下载个syntaxhighlighter
,这个是代码高亮插件。

2、增加”images”目录,放入一个”code.jpg”的图片(附件中上传了一个code的jpg图片,大家可以直接使用)。

还有就是请把我下面提供下载的Demo里的syntaxhighlighter/shBrushes.js文件

3、增加”dialogs”目录,新建一个”insertcode.js”,输入如下代码:

下载以后,把他们解压,加入项目,如下所示:

CKEDITOR.dialog.add(‘insertcode’, function(editor){ 
 var escape = function(value){    return value;   };   return { 
  title: ‘Insert Code Dialog’, 
  resizable: CKEDITOR.DIALOG_RESIZE_BOTH,    minWidth: 720, 
  minHeight: 480,    contents: [{     id: ‘cb’,     name: ‘cb’, 
   label: ‘cb’,     title: ‘cb’,     elements: [{      type: ‘select’, 
    label: ‘Language’,      id: ‘lang’,      required: true, 
    ‘default’: ‘csharp’, 
    items: [[‘ActionScript3’, ‘as3’], [‘Bash/shell’, ‘bash’], [‘C#’, ‘csharp’], [‘C++’, ‘cpp’], [‘CSS’, ‘css’], [‘Delphi’, ‘delphi’], [‘Diff’, ‘diff’], [‘Groovy’, ‘groovy’], [‘Html’, ‘xhtml’], [‘JavaScript’, ‘js’], [‘Java’, ‘java’], [‘JavaFX’, ‘jfx’], [‘Perl’, ‘perl’], [‘PHP’, ‘php’], [‘Plain Text’, ‘plain’], [‘PowerShell’, ‘ps’], [‘Python’, ‘py’], [‘Ruby’, ‘rails’], [‘Scala’, ‘scala’], [‘SQL’, ‘sql’], [‘Visual Basic’, ‘vb’], [‘XML’, ‘xml’]] 
   }, {      type: ‘textarea’,      style: ‘width:700px;height:420px’, 
    label: ‘Code’,      id: ‘code’,      rows: 31,      ‘default’: ” 
   }]    }],    onOk: function(){ 
   code = this.getValueOf(‘cb’, ‘code’); 
   lang = this.getValueOf(‘cb’, ‘lang’); 
   html = ” + escape(code) + ”; 
   editor.insertHtml(“<pre class=/”brush:” + lang + “;/”>” + html + “</pre>”); 
  },    onLoad: function(){    }   };  });

图片 1

 我是用”syntaxhighlighter”来做代码高亮的,如果你不喜欢它也可以换成其它的。 

然后在ckeditor下面新建一个文件夹,命名为:insertcode,然后在”insertcode”目录下新建一个”plugin.js”,输入以下代码:

4、接下来就是把插件加入到CKEditor里了,我是直接修改CKEditor插件的核心文件的,因为我是把“插入代码”功能做为一个编辑器必要的功能来使用的。

CKEDITOR.plugins.add(‘insertcode’, {   requires: [‘dialog’],
  init: function (a) {
    var b = a.addCommand(‘insertcode’, new CKEDITOR.dialogCommand(‘insertcode’));
    a.ui.addButton(‘insertcode’, {
      label: a.lang.insertcode.toolbar,       command: ‘insertcode’,
      icon: this.path + ‘images/code.jpg’     });
    CKEDITOR.dialog.add(‘insertcode’, this.path + ‘dialogs/insertcode.js’);
  } });

    
找到ckeditor目录下的”ckeditor.js”,这里的代码是经过压缩的,我们用CKEditor原来的about插件做参考。查找”about”,找到”fullPage:false,height:200,plugins:’about,basicstyles “,我们在”about”后面增加”,insertcode”,这里就变成”plugins:’about,insertcode ,basicstyles”。

目录结构如下图:图二

    继续查找”about”,找到”j.add(‘about’,{init:function(l){var
m=l.addCommand(‘about’,new
a.dialogCommand(‘about’));m.modes={wysiwyg:1,source:1};m.canUndo=false;l.ui.addButton(‘About’,{label:l.lang.about.title,command:’about’});a.dialog.add(‘about’,this.path+’dialogs/about.js’);}}); “,我们在这个分号后面增加”j.add(‘insertcode’, {requires: [‘dialog’],init:
function(l){l.addCommand(‘insertcode’, new
a.dialogCommand(‘insertcode’));l.ui.addButton(‘insertcode’, {label:
l.lang.insertcode.toolbar,command: ‘insertcode’,icon: this.path +
‘images/code.jpg’});a.dialog.add(‘insertcode’, this.path +
‘dialogs/insertcode.js’);}}); “。

图片 2

   
接下来查找”i.toolbar_Basic=”,这就是CKEditor默认的工具栏了,我们在这里加上”,insertcode “,你可以加在你想要的位置。比如我的”[‘Maximize’,’ShowBlocks’,’-‘,’insertcode’] “。

再新建一个images文件夹,放入一个”code.jpg”的图片,如上图所示,当然图片可以从google找一个,16*16大小的就好了。

    5、进入”ckeditor/lang”,分别在”en.js”,”zh.js”,”zh-cn.js”中增加”,insertcode:’Insert Code’ “,”,insertcode:’插入代碼’ “,”,insertcode:’插入代码’ “。

再新建一个dialogs文件夹,新建一个”insertcode.js”,输入如下代码:

   
6、对CKEditor的修改已经OK了,还有最后一步就是在你需要高亮代码的页面引用:

CKEDITOR.dialog.add(‘insertcode’, function (editor) {
  var escape = function (value) {     return value;   };   return {
    title: ‘Insert Code Dialog’,
    resizable: CKEDITOR.DIALOG_RESIZE_BOTH,     minWidth: 720,
    minHeight: 480,     contents: [{       id: ‘cb’,       name: ‘cb’,
      label: ‘cb’,       title: ‘cb’,       elements: [{
        type: ‘select’,         label: ‘Language’,         id: ‘lang’,
        required: true,         ‘default’: ‘csharp’,
        items: [[‘ActionScript3’, ‘as3’], [‘Bash/shell’, ‘bash’], [‘C#’, ‘csharp’], [‘C++’, ‘cpp’], [‘CSS’, ‘css’], [‘Delphi’, ‘delphi’], [‘Diff’, ‘diff’], [‘Groovy’, ‘groovy’], [‘Html’, ‘xhtml’], [‘JavaScript’, ‘js’], [‘Java’, ‘java’], [‘JavaFX’, ‘jfx’], [‘Perl’, ‘perl’], [‘PHP’, ‘php’], [‘Plain Text’, ‘plain’], [‘PowerShell’, ‘ps’], [‘Python’, ‘py’], [‘Ruby’, ‘rails’], [‘Scala’, ‘scala’], [‘SQL’, ‘sql’], [‘Visual Basic’, ‘vb’], [‘XML’, ‘xml’]]
      }, {         type: ‘textarea’,
        style: ‘width:700px;height:420px’,         label: ‘Code’,
        id: ‘code’,         rows: 31,         ‘default’: ”       }]
    }],     onOk: function () {
      code = this.getValueOf(‘cb’, ‘code’);
      lang = this.getValueOf(‘cb’, ‘lang’);
      html = ” + escape(code) + ”;
      editor.insertHtml(“<pre class=”brush:” + lang + “;”>” + html + “</pre>”);
    },     onLoad: function () {     }   }; });

<link type = "text/css" rel = "stylesheet" href ="js/syntaxhighlighter/styles/shCore.css" /> 
<link type = "text/css" rel = "stylesheet" href ="js/syntaxhighlighter/styles/shThemeDefault.css" /> 
<script type = "text/javascript" src = "js/syntaxhighlighter/scripts/shCore.js" > </script> 
<script type = "text/javascript" src = "js/syntaxhighlighter/scripts/shBrushes.js" ></script>

接下来,我们就把高亮插件插入到ckeditor里来,找到ckeditor文件夹下的”ckeditor.js”。按ctrl+F查找”about”,找到”fullPage:false,height:200,plugins:’about,basicstyles”,我们在”about”后面增加”,insertcode”,这里就变成”plugins:’about,insertcode,basicstyles”。

这四个文件在syntaxhighlighter的下载包里都有,最后,还在页面增加这段JS:

如图:

<script type= “text/javascript” > 
SyntaxHighlighter.config.clipboardSwf= ‘js/syntaxhighlighter/scripts/clipboard.swf’ ; 
SyntaxHighlighter.all();  </script>

图片 3

CKEditor的”插入代码”插件就OK了。

 继续查找”about”,找到”j.add(‘about’,{init:function(l){var
m=l.addCommand(‘about’,new
a.dialogCommand(‘about’));m.modes={wysiwyg:1,source:1};m.canUndo=false;l.ui.addButton(‘About’,{label:l.lang.about.title,command:’about’});a.dialog.add(‘about’,this.path+’dialogs/about.js’);}});”,我们在这个分号后面增加”j.add(‘insertcode’,
{requires: [‘dialog’],init: function(l){l.addCommand(‘insertcode’, new
a.dialogCommand(‘insertcode’));l.ui.addButton(‘insertcode’, {label:
l.lang.insertcode.toolbar,command: ‘insertcode’,icon: this.path +
‘images/code.jpg’});a.dialog.add(‘insertcode’, this.path +
‘dialogs/insertcode.js’);}});”。

提示个小bug

 如下图:

修改之后insertcode图标的title为空。我把你的代码中的”label:
a.lang.insertcode.toolbar”(共2处)改为”label:
a.lang.insertcode”。解决!

图片 4

 接下来继续在ckeditor.js查找”i.toolbar_Basic=”,这就是CKEditor默认的工具栏了,我们在这里加上”,insertcode”,比如我的”[‘Maximize’,’ShowBlocks’,’-‘,’insertcode’]”

我添加在如下图选中的文本那个地方:

图片 5

最后一步:进入”ckeditorlang”,请注意是分别在“en.js”,”zh.js”,”zh-cn.js”中增加”,insertcode:’Insert
Code'”,”,insertcode:’插入代碼'”,”,insertcode:’插入代码'”,一定要按这个顺序加哦。

如下图是en.js中的,zh-cn.js,zh.js我就不一一截图了。

图片 6

最后在页面上添加如下引用:

<head runat="server">
  <title></title>
  <link type="text/css" rel="stylesheet" href="syntaxhighlighter_3.0.83/styles/shCore.css" />
  <link type="text/css" rel="stylesheet" href="syntaxhighlighter_3.0.83/styles/shThemeDefault.css" /> 
  <script type="text/javascript" src="syntaxhighlighter_3.0.83/scripts/shCore.js"></script>
  <script type="text/javascript" src="syntaxhighlighter_3.0.83/scripts/shBrushes.js"></script>
  <script type="text/javascript" src="ckeditor/ckeditor.js"></script>
  <link type="text/css" rel="Stylesheet" href="syntaxhighlighter_3.0.83/styles/shCoreDefault.css" />
  <script type="text/javascript">    SyntaxHighlighter.all();</script>
</head>

页面的代码如下:

<form id="form1" runat="server">
  <div>
    <asp:TextBox ID="txtcontent" runat="server" TextMode="MultiLine" Height="310px" 
      Width="100%"></asp:TextBox>
    <script type="text/javascript">
      CKEDITOR.replace('<%= txtcontent.ClientID %>', { skin: 'office2003' });
    </script> 
    </script>--%>
    <asp:Button runat="server" Text="Button" OnClick="Unnamed1_Click" />
  </div>
  <asp:Literal ID="Literal1" runat="server"></asp:Literal>
  </form>

后台代码:

protected void Unnamed1_Click(object sender, EventArgs e)
    {
        this.Literal1.Text = txtcontent.Text;
    }

还有就是在页面的@ Page指令中加入
ValidateRequest=”false”,加入后的@Page指令如下:

<%@ Page Language=”C#” AutoEventWireup=”true”
CodeFile=”Default.aspx.cs” Inherits=”_Default” ValidateRequest=”false”
%>

否则会报错的。

效果图:

图片 7

怎么获取这个文本编辑器里的文本今天白天再写吧!该睡觉了,1点多了,O My god!

(O YE!现在总是很完善了的)

我的Demo下载:Cheditor+syntaxhighlighter
Demo ,如果还有点不懂,请多多参考这个Demo,或者给我留言吧!

参考博文:

You can leave a response, or trackback from your own site.

Leave a Reply

网站地图xml地图