-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
109 lines (68 loc) · 5.75 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
=== SyntaxHighlighter Evolved Biferno ===
Contributors: sandrobilbeisi
Donate link: http://www.viper007bond.com/wordpress-plugins/syntaxhighlighter/donate/
Tags: syntax, highlighter, biferno, code, CSS, html, bfr, sourcecode
Requires at least: 2.7
Tested up to: 3.2.1
Stable tag: 1.0.2
Adds support for the Biferno language to the SyntaxHighlighter Evolved plugin using the [sourcecode language="biferno"] tag.
== Description ==
<b>SyntaxHighlighter Evolved Biferno</b> is a plugin for self-hosted WordPress that adds support to Alex Mills' (Viper007) [SyntaxHighlighter Evolved](http://wordpress.org/extend/plugins/syntaxhighlighter/) plugin for the Biferno language .
It provides a brush designed to work with the SyntaxHighlighter Evolved WordPress plugin .
= Features: =
- Biferno opening and closing tags are captured
- Variables within double-quoted strings are captured
- Numerical values are captured
- a large superset of Biferno's function names are recognized
- Custom function names are captured
= Notes: =
- To be able to use this plugin, you will need the SyntaxHighlighter Evolved plugin installed.
- this plugin follows the programming conventions outlined by [Alex Mills](http://www.viper007bond.com/) (Viper007) for extending his plugin: [Adding A New Brush (Language)](http://www.viper007bond.com/wordpress-plugins/syntaxhighlighter/adding-a-new-brush-language/)
- uses my [Biferno JavaScript brush for SyntaxHighlighter](http://www.sandrobilbeisi.org/wp/works/web-development/biferno-javascript-brush-for-syntaxhighlighter-shbrush-js/).
- this plugin is based on similar work by apollox2: [Scott Selikoff](http://www.selikoff.net/) [SyntaxHighlighter Evolved AppleScript](http://wordpress.org/extend/plugins/syntaxhighlighter-evolved-applescript/)
- [SyntaxHighlighter Evolved](http://wordpress.org/extend/plugins/syntaxhighlighter/) Wordpress plugin by Alex Mills (Viper007) is based on the [SyntaxHighlighter JavaScript package by Alex Gorbatchev](http://alexgorbatchev.com/SyntaxHighlighter/).
== Installation ==
###Prerequisite###
In order to use SyntaxHighlighter Evolved Biferno, you must first install [SyntaxHighlighter Evolved](http://wordpress.org/extend/plugins/syntaxhighlighter/).
###Installation###
Extract all files from the ZIP file, making sure to keep the file/folder structure intact, and then upload it to /wp-content/plugins/.
###Plugin Activation###
Go to the admin area of your WordPress install and click on the "Plugins" menu. Click on "Activate" for the "SyntaxHighlighter Evolved: Biferno" plugin.
###Plugin Usage###
Just wrap your code in `[sourcecode language="biferno"]`your code here `[/sourcecode]`
or
wrap your code in `[biferno]`, such as `[biferno]` code here `[/biferno]` .
The shortcodes accept a wide variety of parameters here are a few examples taken from the SyntaxHighlighter Evolved's settings page.
###Shortcode Parameters###
These are the parameters you can pass to the shortcode and what they do. For the booleans (i.e. on/off), pass **true**/**1** or **false**/**0**.
- **`lang`** or **`language`** Ñ The language syntax to highlight with. You can alternately just use that as the tag, such as `[biferno]code[/biferno]`. Click [here](http://alexgorbatchev.com/SyntaxHighlighter/manual/brushes/) for a list of valid tags (under "aliases").
- **`autolinks`** Ñ Toggle automatic URL linking.
- **`classname`** Ñ Add an additional CSS class to the code box.
- **`collapse`** Ñ Toggle collapsing the code box by default, requiring a click to expand it. Good for large code posts.
- **`firstline`** Ñ An interger specifying what number the first line should be (for the line numbering).
- **`gutter`** Ñ Toggle the left-side line numbering.
- **`highlight`** Ñ A comma-sperated list of line numbers to highlight. You can also specify a range. Example: 2,5-10,12
- **`htmlscript`** Ñ Toggle highlighting any extra HTML/XML. Good for when you're mixing HTML/XML with another language, such as having Biferno script inside an HTML web page. This only works with Biferno and certain other languages.
- **`light`** Ñ Toggle light mode which disables the gutter and toolbar all at once.
- **`padlinenumbers`** Ñ Controls line number padding. Valid values are **false** (no padding), **true** (automatic padding), or an integer (forced padding).
- **`title`** (v3 only) Ñ Sets some text to show up before the code. Very useful when combined with the **`collapse`** parameter.
- **`toolbar`** Ñ Toggle the toolbar (buttons in v2, the about question mark in v3)
- **`wraplines`** (v2 only) Ñ Toggle line wrapping.
Some example shortcodes:
- `[biferno]your code here[/biferno]`
- `[code lang="biferno"]your code here[/code]`
- `[sourcecode language="biferno" autolinks="false" classname="myclass" collapse="false" firstline="1" gutter="true" highlight="1-3,6,9" htmlscript="true" light="false" padlinenumbers="false" smarttabs="true" tabsize="4" toolbar="true" title="example-filename.bfr"]your code here[/css]`
== Frequently Asked Questions ==
= The code is just being displayed raw. It isn't being converted into a code box or anything. What's wrong? =
Make sure your theme's `footer.php` file has `<?php wp_footer(); ?>` somewhere inside of it, otherwise the plugin won't be able to do it's thing.
> **INFO:** When you find a that a keyword or a other special word of Biferno is not highlighted. Please write entry into the forum of this plugin. -> <a href="http://wordpress.org/tags/syntaxhighlighter-evolved-biferno?forum_id=10" title="Wordpress Support Forum">Support Forum</a>
== Screenshots ==
1. This is a sample image of the plugin in action as applied to Biferno code.
== Upgrade Notice ==
= 1.0.2 = Documentation improvements.
= 1.0.1 = This is the first peer-reviewed and published version.
== Changelog ==
= 1.0.2 =
* minor documentation improvements.
= 1.0.1 =
* Initial release