欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

代码着色之SyntaxHighlighter项目(最流行的代码高亮)

程序员文章站 2022-05-14 15:00:56
下载地址:             &nb...

下载地址:
                或
演示地址:http://www.dreamprojections.com/syntaxhighlighter/tests/php.html

使用方法:

1、假设网页文件test.htm存放在一个目录,则将dp.syntaxhighlighter解压缩到该目录下的子目录,假设为images
2、在网页的<head></head>之间插入以下代码:

<link type="text/css" rel="stylesheet" href="images/styles/syntaxhighlighter.css"></link>

3、在网页要显示程序源代码的地方插入以下代码(其中的class="js"表示以js语法显示源代码,其他可设定的class值分别为c#、css、c、delphi、java、js、php、python、ruby、sql、vb、xml):

复制代码 代码如下:

<textarea name="code" class="js" rows="15" cols="100">
程序源代码放在这儿
</textarea>

4、在网页尾部的</body>之前插入以下代码:

复制代码 代码如下:

<html>
<head>
<title>测试</title>
<link type="text/css" rel="stylesheet" href="styles/syntaxhighlighter.css"></link>
</head>
<body>
<textarea name="code" class="java" rows="15" cols="100">
public class a{
}
</textarea>
</body>
<script class="javascript" src="scripts/shcore.js"></script>
<script class="javascript" src="scripts/shbrushcsharp.js"></script>
<script class="javascript" src="scripts/shbrushphp.js"></script>
<script class="javascript" src="scripts/shbrushjscript.js"></script>
<script class="javascript" src="scripts/shbrushjava.js"></script>
<script class="javascript" src="scripts/shbrushvb.js"></script>
<script class="javascript" src="scripts/shbrushsql.js"></script>
<script class="javascript" src="scripts/shbrushxml.js"></script>
<script class="javascript" src="scripts/shbrushdelphi.js"></script>
<script class="javascript" src="scripts/shbrushpython.js"></script>
<script class="javascript" src="scripts/shbrushruby.js"></script>
<script class="javascript" src="scripts/shbrushcss.js"></script>
<script class="javascript" src="scripts/shbrushcpp.js"></script>
<script class="javascript">
dp.syntaxhighlighter.clipboardswf ='scripts/clipboard.swf';
dp.syntaxhighlighter.highlightall('code');
</script> 
</html>


syntaxhighlighter 是google code 上的一个开源项目,主要用于给网页上的代码着色,使用十分方便,效果也不错,而且几乎支持常见的所有语言。

安装使用方法:

1. 首先在页面上添加如下代码(假设下载后的syntaxhighlighter放在syntaxhighlighter目录下面,注意目录结构):

复制代码 代码如下:

<link type="text/css" rel="stylesheet" href="syntaxhighlighter/styles/syntaxhighlighter.css"></link>
<script language="javascript" src="syntaxhighlighter/scripts/shcore.js"></script>
<script language="javascript" src="syntaxhighlighter/scripts/shbrushcsharp.js"></script>
<script language="javascript" src="syntaxhighlighter/scripts/shbrushxml.js"></script>
<script language="javascript">
window.onload = function ()
{
    dp.syntaxhighlighter.clipboardswf = 'syntaxhighlighter/scripts/clipboard.swf';
    dp.syntaxhighlighter.highlightall('code');
}
</script>

官方的安装中没有window.onload,我想这个还是需要的,毕竟,页面加载的时候我就需要给代码着色。

2. 使用方法如下:

方法一:使用pre

复制代码 代码如下:

<pre name="code" class="c-sharp">
... some code here ...
</pre>

方法二:使用textarea

复制代码 代码如下:

<textarea name="code" class="c#" cols="60" rows="10">
... some code here ...
</textarea>

另外,这里还有一些高级特性的设置方法可供参考,诸如代码折叠等。

我在互动wiki 上安装成功,安装方法如上,第一步的修改代码放到doc.php文件的最后即可,以后编辑wiki的时候直接使用html模式即可按照第二步的方法给代码着色。

ps:csdn的blog系统上使用的也是这个插件:>

=============================
http://code.google.com/p/syntaxhighlighter/downloads/list

第一步:增加样式包含

<link type=”text/css” rel=”stylesheet” href=”styles/syntaxhighlighter.css”></link>

第二步:增加代码

复制代码 代码如下:

<textarea name=”code” class=”php”>
代码放在这里
</textarea>

这里的class指的是语言有c,c#,vb,java,php,ruby,js,css,sql…

第三步包含所需要的js

复制代码 代码如下:

<script language=”javascript” src=”scripts/shcore.js”></script>
<script language=”javascript” src=”scripts/shbrushphp.js”></script>(包含对应语言的文件)
<script language=”javascript”>
dp.syntaxhighlighter.clipboardswf = ‘scripts/clipboard.swf';// 复制代码要用到
dp.syntaxhighlighter.highlightall('code');// 这里对应的就是上面的name
</script>

====================================

1.首先下载syntaxhighlighter.

2.解压到syntaxhighlighter目录中.

3.建立html文件:

复制代码 代码如下:

<pre name="code" class="ruby">
...ruby代码...
</pre>

可以应用在pre和textarea两种html标签内,name为code,class为要着色的语言,现在支持c, c#, css, delphi, java, jscript, php, python, ruby, sql, vb, xml这些语言.

4.加入所需的css和js文件:

复制代码 代码如下:

<link rel="stylesheet" type="text/css" href="./lib/syntaxhighlighter/styles/syntaxhighlighter.css" />
<script src="./lib/syntaxhighlighter/scripts/shcore.js"></script>
<script src="./lib/syntaxhighlighter/scripts/shbrushruby.js"></script>

这里只用了ruby,其他的类似.

5.接下来就是在window的onload事件内,让syntaxhighlighter工作起来.

复制代码 代码如下:

window.onload = function()

{
    dp.syntaxhighlighter.clipboardswf = './lib/syntaxhighlighter/scripts/clipboard.swf';
    dp.syntaxhighlighter.highlightall("code");
};

之后,刷新下页面,你就会发现,代码已经被着上了相应的颜色了

======================
将你要高亮显示的代码放在 pre 或 textarea 中

复制代码 代码如下:

<pre name="code" class="c-sharp">
... some code here ...
</pre>
<textarea name="code" class="c#" cols="60" rows="10">
... some code here ...
</textarea>

class选项允许你单独配置文本块。

nogutter     将不会显示行号。

nocontrols     将不会在顶部显示控制器。
collapse     将默认折叠代码。
firstline[value]     行计数开始值。默认值是 1
showcolumns     将在第一行显示行列。

这些选项和别名放置在一起,使用冒号 : 字符分隔。

复制代码 代码如下:

<pre name="code" class="html:nocontrols:firstline[10]">

... some code here ...
</pre>

语言     别名

c++     cpp, c, c++
c#     c#, c-sharp, csharp
css     css
delphi     delphi, pascal
java     java
java script     js, jscript, javascript
php     php
python     py, python
ruby     rb, ruby, rails, ror
sql     sql
vb     vb, vb.net
xml/html     xml, html, xhtml, xslt

在页面最后添加js和css引用    js有很多,若是语言固定的话,只要引入 shcore 和 shbrushxml(相应) 的js文件就行了

复制代码 代码如下:

<link type="text/css" rel="stylesheet" href="css/syntaxhighlighter.css"></link>
<script language="javascript" src="js/shcore.js"></script>
<script language="javascript" src="js/shbrushcsharp.js"></script>
<script language="javascript" src="js/shbrushxml.js"></script>
<script language="javascript">
dp.syntaxhighlighter.clipboardswf = '/flash/clipboard.swf';
dp.syntaxhighlighter.highlightall('code');//这里的 ‘code' 为上面放置代码的容器
</script>

    * syntaxhighlighter-highlightall 方法

这是一个全局函数,它找出网页上所有的代码块,将他们转换成高亮的代码块。
参数
function dp.syntaxhighlighter.highlightall(name, [showgutter], [showcontrols],
[collapseall], [firstline], [showcolumns])
 

name         必要     <pre> 和 <textarea> 元素使用的名称。

showgutter     可选     打开或关闭所有处理的代码块的行号。(默认为 true)
showcontrols     可选     打开或关闭所有处理的 <pre> 的控制器。(默认为 true)
collapseall     可选     打开或关闭所有处理的 <pre> 的折叠。如果 showcontrols 是 false 或被交换了,这个值将被忽略。(默认为 false)
firstline     可选     允许指定行号开始的第一行。当你想指明代码块在文件的哪个相对位置时有用。(默认为 1)
showcolumns     可选     将在第一行显示行列。(默认为 false)
 

所有传到 highlightall 调用的值将重载配置的对应选项.

下载地址:

http://code.google.com/p/syntaxhighlighter/


附一个小例子说一下 textarea 和 pre 的区别

复制代码 代码如下:

<html>
<head>
<title>高亮测试</title>
    <link type="text/css" rel="stylesheet" href="styles/syntaxhighlighter.css"/>
    <script language="javascript" src="scripts/shcore.js"></script>
    <script language="javascript" src="scripts/shbrushxml.js"></script>
</head>
<body>
<textarea name="code" class="xml" rows="15" cols="100">
程序源代码放在这儿afds
dp.syntaxhighlighter.highlightall('code');
dp.syntaxhighlighter.highlightall('code2');
请注译掉这二句查看效果,注意 textarea 和 pre 的分别。pre中的 《 号需要转译,要不然就原样输出了,在高亮代码没有生效的情况下。
<h1>adsfadfadf</h1>
    -------------------
<h1>adsfadfadf</h1>
</textarea>
<pre name="code2" class="xml" rows="15" cols="100">
程序源代码放在这儿afds
dp.syntaxhighlighter.highlightall('code');
dp.syntaxhighlighter.highlightall('code2');
    <h1>adsfadfadf</h1>
    -------------------
<h1>adsfadfadf</h1>
</pre>
<script class="javascript">
dp.syntaxhighlighter.highlightall('code');
dp.syntaxhighlighter.highlightall('code2');
</script>
</body>
</html>