Code Highlight Plugin ~ readme / help file

Big Picture

The Code Highlight plugin enables displaying computer code easily. This plugin renders character entities on the fly, so you can copy/paste normal code directly into your posts and it will always look like normal code, even when editing the post (i.e., no pre-processing of the code is required).

Include line numbers (customizable starting number). The best part about the line numbers - visitors can copy/paste the code from your post, leaving the line numbers behind!

Accepts BBcode tags and doesn't render smilies. Coloration of PHP code, plus PHP manual links for PHP functions. Easy to install and easy to use. No hacks. Degrades nicely, if the plugin is off. Styling completely customizable via an included CSS file.

Settings, Settings, & Settings

Plugin Settings:
  • enable user option: If checked, each blogger will be able to decide if they want this toolbar or not. Default is "checked".
  • toolbar location: Toolbars can be above or below the post textarea, or on the top of the sidebar. This toolbar will be on the sidebar by default, and this setting lets you move it to somewhere else.
  • XHTML strict: If you want to meet XHTML strict standards, this checkbox will remove the 'target="_blank"' from the PHP documentation links. Default is "unchecked".
  • Render comments: If checked, all commenters will get this toolbar. Default is "unchecked".
User Settings:
  • "Code Highlight" toolbar: If checked, the blogger will have this toolbar available to them when they write a post or leave a comment on a post. Default is "checked".
Blog Settings:
  • This plugin has no blog settings.
Widget Settings:
  • This plugin has no widget settings.

More Info, Credits, & Links

More Info:
  • Registered users who opt to have this toolbar when posting will always have this toolbar when commenting - even if "render comments" is off (unchecked).
Credits:
  • Thanks to Stk and Yabba (http://astonishme.co.uk/) for first creation and release of this plugin.
Links:

Release History:

0.1
initial release (1-Jan-11)