=== Plugin Name ===
Contributors: apfelbox
Donate link: https://flattr.com/thing/870438/apfelbox-
Tags: prism, syntax highlighting
Requires at least: 3.4.0
Tested up to: 3.4.2
Stable tag: 1.4
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

Adds Prism Syntax Highlighting to WordPress, using custom fields for your code examples.



== Description ==

Integrates the [Prism Syntax Highlighting Library](https://github.com/LeaVerou/prism) in WordPress.

It is called *detached*, since the code examples are not stuffed into the wysiwyg editor, together with all the
other texts and content, but they are added separately as custom fields and just referenced via short tags (like footnotes).

Check *Other Notes* for usage documentation.

The official development repository is [hosted on Github](https://github.com/apfelbox/Prism-Detached).


== Installation ==

1. Upload the files to your `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress



== Frequently Asked Questions ==

= Why use custom tags? =

The (wysiwyg) editor of WordPress is quite good in mangling in manually added code. This cannot happen with custom fields.
Also, I personally, think it is more user-friendly.


= Will my code snippets be searchable with the common WordPress search? =

No. Since the code snippets are not in the actual post content, but separately in the custom fields, the default
WordPress search won't find them. [You can make your custom fields searchable, though.](http://wordpress.org/support/topic/include-custom-field-values-in-search)


= Can I add my own extensions? =
Yes. Just read through [the manual](https://github.com/apfelbox/Prism-Detached/wiki/Creating-A-Custom-Extension).

= What will happen to my custom extensions, if I update the plugin using the WordPress plugin update function? =
WordPress will remove them. WordPress completely removes the old extension directory and recreates it with the new plugin files. So make a backup of your custom extensions before updating!


== Screenshots ==

1. Add the code as custom field and reference it in the wysiwyg editor via shortcode.
2. Code highlighting in the frontend
3. You can also specify some lines, which should be marked
4. Code highlighting with marked lines in the frontend
5. Plugin options screen



== Changelog ==

= 1.4 =
* Fixed a compatibility problem with older PHP versions (< 5.4)

= 1.3 =
* Minor optical updates of the admin interface
* Refactored nearly complete plugin
* Added support for generic extensions
* Added cached assets loader
* Added support for experimental PHP plugin

= 1.2 =
* Updated the prism library to `34f0bd5247`

= 1.1 =
* Load line-highlight correctly
* Moved html attributes to the correct tag
* Fixed wrong asset loading

= 1.0 =
* Initial commit



== Upgrade Notice ==

No upgrade notice yet, just use it and give feedback. :-)



== Usage ==

The basic procedure is:

1. Create a custom field and paste the code into it.
2. Insert the `[prism ...]` shorttag in your code, where you want the code block to appear.


= Shorttag =
`[prism key=".." language=".." line=".." line_offset=".." post=".."]`

* `key`: the name of the custom field, which contains the code (**required**)
* `language`: the language to highlight
* `line`: highlighted lines (for syntax, check the [offical docs](http://prismjs.com/plugins/line-highlight/))
* `line_offset`: the offset, with which the line numbering should start
* `post`:  if you want to include a code piece of another post, you can explicitly specify the post id here


= Cached Assets loader =
The plugin includes (from v1.3 on) a cached assets loader, so that all needed assets are concatenated into
one js and one css file to minimize the HTTP requests.
To make use of the cached assets loader, just create a directory `/cache/` inside your plugin directory and make it writable for PHP.


= Supported languages =

Currently only the ones from the official repository

* css
* java
* javascript
* markup


= Creating Custom Extensions =
Please read the wiki page: [Creating A Custom Extension](https://github.com/apfelbox/Prism-Detached/wiki/Creating-A-Custom-Extension).