apfelbox

<p>Integrates the <a href="https://github.com/LeaVerou/prism" rel="nofollow ugc">Prism Syntax Highlighting Library</a> in WordPress.</p>
<p>It is called <em>detached</em>, since the code examples are not stuffed into the rich text editor, together with all the<br />
other texts and content, but they are added separately as custom fields and just referenced via short tags (like footnotes).</p>
<p>Check <em>Other Notes</em> for usage documentation.</p>
<p>The official development repository is <a href="https://github.com/apfelbox/Prism-Detached" rel="nofollow ugc">hosted on Github</a>.</p>
<h3>Usage</h3>
<p>The basic procedure is:</p>
<ol>
<li>Create a custom field and paste the code into it.</li>
<li>Insert the <code>[prism ...]</code> shorttag in your code, where you want the code block to appear.</li>
</ol>
<h4>Shorttag</h4>
<pre><code>[prism key=".." language=".." line=".." line_offset=".." post=".."]
</code></pre>
<ul>
<li><code>key</code>: the name of the custom field, which contains the code (<strong>required</strong>)</li>
<li><code>language</code>: the language to highlight</li>
<li><code>line</code>: highlighted lines (for syntax, check the <a href="http://prismjs.com/plugins/line-highlight/" rel="nofollow ugc">offical docs</a>)</li>
<li><code>line_offset</code>: the offset, with which the line numbering should start</li>
<li><code>post</code>:  if you want to include a code piece of another post, you can explicitly specify the post id here</li>
</ul>
<h4>Cached Assets loader</h4>
<p>The plugin includes (from v1.3 on) a cached assets loader, so that all needed assets are concatenated into<br />
one js and one css file to minimize the HTTP requests.<br />
To make use of the cached assets loader, just create a directory <code>/cache/</code> inside your plugin directory and make it writable for PHP.</p>
<h4>Supported languages</h4>
<p>Only the ones from the official PrismJS repository</p>
<ul>
<li>bash (Bash Unix Shell)</li>
<li>c</li>
<li>clike</li>
<li>coffeescript</li>
<li>cpp (C++)</li>
<li>css</li>
<li>groovy</li>
<li>java</li>
<li>javascript</li>
<li>markup (like: xHTML, MathML, SVG, LaTeX, RSS, XML, OWL, etc.)</li>
<li>php</li>
<li>python</li>
<li>scss (Sassy CSS)</li>
<li>sql</li>
</ul>
<h4>Creating Custom Extensions</h4>
<p>Please read the wiki page: <a href="https://github.com/apfelbox/Prism-Detached/wiki/Creating-A-Custom-Extension" rel="nofollow ugc">Creating A Custom Extension</a>.</p>


Prism Syntax Highlighter (detached)

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

mohamad wael

<p>A syntax highlighter using PrismJs.</p>
<h3>How To Use</h3>
<p>Wrap your pre tag as shown below:</p>
<pre>
[sh_prismjs_pre class="language-py line-numbers match-braces rainbow-braces" data_line="1,4-5,7" escape_html='escape']
<pre>    
class Implements_Ne:
    ''' A class which implements 
        the __ne__ method '''
    def __ne__( self, other):
        return False

class Not_Implements_Ne:
    ''' A class which does not
        implement the __ne__
        method '''
    pass
</pre>
[/sh_prismjs_pre]
</pre>
<ul>
<li>Replace name in language-NAME, by the name of the language that you wish to highlight. For example if the language is python, language-NAME should become language-py .</li>
<li>If you wish line numbers to appear, use line-numbers . </li>
<li>If you wish braces to be matched when selected use match-braces . </li>
<li>If you wish to have rainbow braces use rainbow-braces . </li>
<li>If you wish to highlight lines, you can use data_line, so in the example provided, colorize line 1, and colorize lines from 4 to 5, and colorize line 7. </li>
<li>If you wish the content of the pre to be escaped, so for example if it contains html tags that you do not wish to be rendered, you can use escape_html=’escape’</li>
</ul>
<p>For code tags, they also should be wrapped as follows:</p>
<pre>
[sh_prismjs_code class="language-html" escape_html='escape']<code>tag: <br/></code>[/sh_prismjs_code]
</pre>
<p>You must use the language-Name option, and you can use the escape_html option.</p>


Prism Syntax Highlighter (detached) vs Syntax Highlighter with PrismJS