=== WP SyntaxHighlighter ===
Contributors: redcocker
Donate link: http://www.near-mint.com/blog/donate/
Tags: syntaxhighlighter, code, snippet, syntax, highlight, highlighting
Requires at least: 2.8
Tested up to: 3.2.1
Stable tag: 1.4.3

This plugin is code syntax highlighter based on SyntaxHighlighter ver. 3.0.83 and 2.1.382.

== Description ==

This plugin is code syntax highlighter based on Alex Gorbatchev's SyntaxHighlighter ver. 3.0.83 and 2.1.382.

= Features =

* Based on Alex Gorbatchev's "[SyntaxHighlighter](http://alexgorbatchev.com/SyntaxHighlighter/ "SyntaxHighlighter")" JavaScript library.
* Including both SyntaxHighlighter 3.0.83 and 2.1.382.(Can switch between 3.0.83 and 2.1.382.)
* You can operate in Visual Editor, No need to use HTML Editor.
* Using two buttons, easy to wrap your code in `<pre>` tag and change language and options of previously-markuped code.
* Once your code is wrapped in `<pre>` tag, You can type 'tabs' for indent.
* Easy to configure features through the setting panel.
* Support "[Dynamic Brush Loading](http://alexgorbatchev.com/SyntaxHighlighter/manual/api/autoloader.html "A key feature")" which allows to load only necessary brush files dynamically.
* Loading JavaScripts on only posts, pages, home, archives, search results and comments which have the code to highlight.
* Localization: English(Default), 日本語(Japanese, UTF-8).

= Supported languages =

AppleScript, ActionScript3, Bash, ColdFusion, C, C++, C#, CSS, Delphi, Diff, Erlang, Groovy, HTML, Java, Java FX, JavaScript, Pascal, Patch, Perl, PHP, Plain text, PowerShell, Python, Ruby, Ruby on Rails, Sass, SCSS, Shell, SQL, VB, VB NET, XHTML, XML and XSLT

Note: A part of languages are only for SyntaxHighlighter 3.0.

You can also add following languages using bundled sample plugin.

F#, Lua(only for SyntaxHighlighter 3.0), Processing, R, S, S-PLUS, Tcl, Verilog and YAML

For details, see "sample" directory.

There are many other languages for "SyntaxHighlighter". But I can't bundle them because they are not compatible with this plugin license. If you want, try to search.

= Recommended plugin =

"WP SyntaxHighlighter" has useful built-in buttons to mark-up your code.

However, If you want, you can also use the feature-rich "[SyntaxHighlighter TinyMCE Button](http://wordpress.org/extend/plugins/syntaxhighlighter-tinymce-button/ "Recommended plugin")".

= Thanks =

* "SyntaxHighlighter" libraries was created by [Alex Gorbatchev](http://alexgorbatchev.com/SyntaxHighlighter/ "Alex Gorbatchev").
* F# brush was written by [Steve Gilham](http://stevegilham.blogspot.com/2009/10/syntaxhighlighter-20-brushes-for-f-and.html "Steve Gilham").
* "shBrushLua.js" was created by [최익필](http://ikpil.com/1191 "최익필").
* "shBrushProcessing.js" was created by [Sebastian Korczak](http://en.myinventions.pl/index.php?page=ProcessingSyntaxHighlighting "Sebastian Korczak").
* The css for "shBrushProcessing.js" was written by [Sebastian Korczak](http://en.myinventions.pl/index.php?page=ProcessingSyntaxHighlighting "Sebastian Korczak").
* "shBrushR.js" was created by [Yihui Xie](http://yihui.name/en/2010/09/syntaxhighlighter-brush-for-the-r-language "Yihui Xie").
* "shBrushTcl.js" was created by [henix](http://www.henix-blog.co.cc/blog/tcl-syntaxhighlighter-brush.html "henix").
* "shBrushVerilog.js" was created by [Hanly De Los Santos](http://www.hdelossantos.com/2010/05/20/verilog-syntaxhighlighter-brush/ "Hanly De Los Santos").
* "shBrushYaml.js" was created by [Nicolas Perriault](http://prendreuncafe.com/blog/post/2009/07/26/YAML-Brush-for-the-SyntaxHighlighter-Javascript-Library "Nicolas Perriault").

== Installation ==

= Installation =

1. Upload plugin folder to the `/wp-content/plugins/` directory.
1. Activate the plugin through the 'Plugins' menu in WordPress.
1. If you need, go to Settings -> WP SyntaxHighlighter to configure.

= Usage =

**Usage: To wrap your code in `<pre>` tag with "SH TinyMCE Button".**

If you have previously-written code on your post or page, by this way, you can wrap your code in `<pre>` tag for 'SyntaxHighlighter'.

1. With the mouse, select and highlight your code where you want to aplly "SyntaxHighlighter".
1. Click "pre" button.
1. Select language and options.
1. Click "Insert" button.

**Usage: To paste your code into the post or page with "SH TinyMCE Button".**

If you want to copy the code from the other document and paste into your post or page, this way is best. Your pasted code will be warpped in `<pre>` tag automatically.

1. Click "CODE" button.
1. Select language and options and paste your code into textbox.
1. Click "Insert" button.

**Usage: To change language and options of previously-markuped code with "SH TinyMCE Button".**

1. With the mouse, select and highlight your code.
1. Click "pre" button.
1. Change language and options.
1. Click "Update" button.

**Usage: To indent by tabs.**

1. Just type tab in your code. But till your code is wrapped in `<pre>` tag, you can not type any tabs.

**Usage: Using HTML Editor without "SH TinyMCE Button".**

1. Just wrap Your Code in `<pre>` tag with the class attribute as below in HTML Editor or using the "Preformatted" style in Visual Editor.

However, your codes **must be escape to HTML entities in HTML Editor**.

Just escape following 5 characters: <, >, &, ", '

`<pre class="brush: lang">Your Code</pre>` *"lang" = your language

* e.g. `<pre class="brush: php">Your PHP Code</pre>`
* e.g. `<pre class="brush: xhtml">Your XHTML Code</pre>`

See "[Available languages](http://alexgorbatchev.com/SyntaxHighlighter/manual/brushes/ "Brushes")". *"Brush aliases" means "lang".

You can also use some options with `<pre>` tag.

See "[Options](http://alexgorbatchev.com/SyntaxHighlighter/manual/configuration/ "Class value")".

* e.g. `<pre class="brush: xhtml; first-line: 10">Your Code</pre>`
* e.g. `<pre class="brush: php; html-script: true">Your Code</pre>`

This plugin also can support `<script>` tag method. However, No one should use `<script>` tag. You must use "HTML Editor" to type `<script>` tag, and when switching to "Visual Editor", TinyMCE will destroy your tag.

Even if using "<script>" method, your codes must be escape to HTML entities. 

Just escape following 3 characters: <, >, &

**Usage: Post a comment with code(s).**

Note: This function is on beta testing now! Once you enable "Commnets" in "Higlight your code in" option through the setting panel, this plugin allows visitors to post their source code as comments.

1. Just wrap Your Code in `<pre>` tag with the class attribute as when you use HTML Editor without "SH TinyMCE Button"

`<pre class="brush: lang">Your Code</pre>` *"lang" = your language

* e.g. `<pre class="brush: php">Your PHP Code</pre>`

You do not need to escape your code to HTML entities. This plugin will escape your code to HTML entities automatically when you post new comment. However, When you eidt your posted commnets and save them, this plugin do not escape automatically.

For security purposes, if someone eidts his own posted commnets and saves them without escaping his code manually, right before your blog is displayed, this plugin will escape them automatically. However once you deactivate this plugin, un-escaped code will be displayed. Therefore, I highly recommend to re-edit or delete such a comment.

If standard comment system is replaced with other comment system(e.g. DISQUS etc.), the code in commnets will not be highlighted.

= Legacy mode =

You can switch to "Legacy mode" through setting panel.
"Legacy mode" allows you to use the old style tag in ver. 1.5.

Your codes must be escape to HTML entities, even if using "<textarea>" method.

Just escape following 5 characters: <, >, &, ", '

See "[Ver. 1.5 Usage](http://code.google.com/p/syntaxhighlighter/wiki/Usage "Old style tag")".

In "Legacy mode", your selected brushes(languages) will be pre-loaded. Only pre-loaded brushes(languages) can highlight your source code with old style tag. The old style tag can't depended on "autoloader" in ver. 3.0 mode. By default, all brushes(languages) will be pre-loaded in "Legacy mode".

"Legacy mode" may save your previous posts with old style tag. However, No one should continue using old style tag. You must use "HTML Editor" to type old style tag.

= Add new languages(brush files) =

You can add new languages(brush files) using "Action hooks" and associative array.

For details, see "sample" directory.

There is a sample plugin for adding new languages.

== Frequently Asked Questions ==

= Q. I want to change language and options of previously-markuped code with "pre" button. But I can't select whole my code. =

A. You need not to select whole your code. It's enough to select first line of your code.

= Q. After the update to new version, Buttons do not work correctly. =

A. Old javascript files may be cached. Please clear your browser's cache or delete cached javascript files.

= Q. The buttons disappear in the fullscreen mode. =

A. When using WordPress 3.2 or higher, The buttons don't appear in the fullscreen mode.

= Q. "pre" button does not work in the fullscreen mode. =

A. You can use "pre" button only for updating language and options in the fullscreen mode. That is only when using with WordPress 3.1.4 or older.

= Q. How to stop translating my code with "Google Translate". =

A. Go to setting panel and enter "notranslate" into "Class name". When another class has already been defined, add "notranslate" separated by space.

== Screenshots ==

1. This is a highlighted code.
2. This is setting panel.
3. This is "SH TinyMCE" button.
4. This is pop up window at the click of "pre" button.
5. This is pop up window at the click of "CODE" button.

== Changelog ==

= 1.4.3 =
* Added new theme "Random" to apply different theme on each page.
* Added break statements to foreach loops for performance improvement.
* Changed the conditional branching for performance improvement.
* Changed "the_content" hook priority to prevent conflict.
* Added "others" checkbox into "Higlight your code in" option to allow highlighting in particular pages.
* Added new hook to add css files for external plugin.
* Added new method to add brush files for external plugin.
* Bundled new sample plugin.

= 1.4 =
* "Autoloading JavaScripts" function will be applicable to not only posts and pages but also home, archives, search results and comments.
* This plugin allows visitors to post comments with their code.
* Changed the conditional branching for adding stylesheet.
* Fix a bug: The addtional stylesheet isn't added in Categories, Archives and Search result.
* Fix a bug: A message can't be translate into Japanese.

= 1.3.9 =
* Added "Higlight your code in" option that allows you highlight your code in Categories, Archives and Search result.
* Added "Title" and "Line Number Padding" options.
* Users allows "Default languages settings" to be reflected in buttons and "autoloader".
* Changed processing code for creating buttons.
* Changed the method to add javascripts and css into setting panel.
* Fix a bug: The misdescribed argument of wp_enqueue_style() function.
* Fix a bug: WP SyntaxHighlighter don't work with [WP to Twitter](http://wordpress.org/extend/plugins/wp-to-twitter/ "WP to Twitter") etc.

= 1.3.8.2 =
* Fix a bug: The misdescribed `<script>` tag caused HTML validation errors.

= 1.3.8.1 =
* The value of $wp_sh_ver was updated.

= 1.3.8 =
* Fix a bug: When selectd ver.2.1.382, "copy to clipboard" icon is disappeared from tool bar.

= 1.3.7 =
* Added the option to choose pop-up windows size.
* Changed the method to get plugin directory url.

= 1.3.6 =
* Fix "Notice: has_cap was called with an argument that is deprecated since version 2.0! Usage of user levels by plugins and themes is deprecated. Use roles and capabilities instead." when "WP_DEBUG" is turned on.
* Changed processing javascripts for admin panel.

= 1.3.5 =
* Can define your own stylesheet for the code block.
* Can choose TinyMCE toolbar row which buttons will be placed in.
* Add legacy `<pre>` and `<textarea>` tags and attribtes to TinyMCE extended_valid_elements.
* Added "System Info" in setting panel.
* Changed processing code for creating buttons.

= 1.3 =
* In ver. 2.0 or "Legacy mode", loaded languages become pre-selectable through setting panel.
* "Reset All Setting" button Added to setting panel.
* `<script>` and `<textarea>` tag methods are supported.
* Fix a bug: In "Legacy mode", the source code with old style tag can't be highlighted correctly.

= 1.2.3 =
* Added more language for ver. 2.1.382 by defaut, or this version will load all bundled languages for ver. 2.1.382 by defaut.(added languages are: Actionscript3, Bash shell, ColdFusion, Diff, Erlang, Groovy, JavaFX, Perl, Plain Text, PowerShell,Scala)
* Added "Action hooks" and associative array for developers.
* Fix a bug: When choosen "MDUltra" theme in ver. 2.1, "Your Current Theme" in setting panel can't be updated correctly.

= 1.2.2 =
* To prevent conflict with other TinyMCE button, the priority of a function hooked has been changed.
* Removed an unnecessary file from the file set.

= 1.2.1 =
* Fix a bug: "CODE" button does not work in fullscreen mode.

= 1.2 =
* Added "CODE" button which allows to paste sourcecode into post or page, keeping indent by tab.
* Enable to change language and options of previously-markuped code.
* Button icons has been changed.
* layout of buttons on TinyMCE popup window has been changed.

= 1.1.1 =
* Fix a bug: Sometimes Code do not be highlighted in home.

= 1.1 =
* Adding the button to type `<pre>` tag in Visual Editor.
* You can preview your current theme in setting panel.
* Fix a bug: Setting values in databese can't be removed when uninstall.

= 1.0.1 =
* Fix a warning in setting panel.

= 1.0 =
* This is the initial release.

== Upgrade Notice ==

= 1.4.3 =
This version has a new feature and some changes.

= 1.4 =
This version has some new features, changes and bug fix.

= 1.3.9 =
This version has some new features, changes and bug fix.

= 1.3.8.2 =
This version has a bug fix.

= 1.3.8.1 =
This version has a low-priority change.

= 1.3.8 =
This version has a bug fix.

= 1.3.7 =
This version has a new feature and change.

= 1.3.6 =
This version has some changes and bug fix.

= 1.3.5 =
This version has some new features and changes.

= 1.3 =
This version has some new features, changes and a bug fix.

= 1.2.2 =
This version has some low-priority changes.

= 1.2.1 =
This version has a bug fix.

= 1.2 =
This version has some new features.

= 1.1.1 =
This version fixes a bug.

= 1.1 =
This version has some new features and a bug fix.

= 1.0.1 =
This version fixes a warning in setting panel.

= 1.0 =
This is the initial release.