WordPress.org
Get WordPress

Plugin Directory

Changeset 708382


Ignore:
Timestamp:
05/05/2013 10:04:51 PM (13 years ago)
Author:
capynet
Message:

tagging version 1.1

Location:
wpygments
Files:
1 edited
7 copied

Legend:

Unmodified
Added
Removed

  • wpygments/tags/1.1/readme.txt

    r708364 r708382  
    55Requires at least: 3.3
    66Tested up to: 3.5.1
    7 Stable tag: 1.0
     7Stable tag: 1.1
    88License: GPLv2 or later
    99License URI: http://www.gnu.org/licenses/gpl-2.0.html
    … …  
    1515WPygments - Wordpress syntax highlighter based on [Pygments](http://pygments.org/ "")
    1616======================
    17 Server side syntax highlighter based on Pygments highlighter software.
     17
     18
     19## Installation:
     20To use this plugin you need pygments in your server:
     21
     22    sudo apt-get install python-setuptools
     23    easy_install Pygments
     24
     25That's all. Now you can download the plugin and install it in your Wordpress.
     26
     27## Usage
     28Once you get installed the plugin the usage is straightforward. just enclose your code between tokens named with the corresponding lang:
     29
     30    [javascript]....[/javascript]
     31    [php]....[/php]
     32
     33See "Languages and filetypes supported" section to know available languages.
     34
     35#### Parameters
     36Tokens support a few parameters (all optionals):
     37
     38    [php **style**="manni" **linenumbers**="table"]....[/php]
     39
     40`style="manni"` defines code styling. Currently are 22 available styles.<br>
     41Default styling is `default` wich is very nice, but maybe you like other styles. see "Color styles" section.
     42
     43`linenumbers="false"` indicates if it should show the numbers and which format. `linenumbers="table"` or `linenumbers="inline"`
     44
     45#### Examples
     46    [javascript]
     47    //comment line
     48    var foo = "foo";
     49    var bar = function(){
     50        var baz;
     51    }
     52    [/javascript]
     53
     54Outputs highlighted js with **default** style, and **no** (false) linenumbers.
     55
     56    [javascript style="monokai" linenumbers="inline"]
     57    //comment line
     58    var foo = "foo";
     59    var bar = function(){
     60        var baz;
     61    }
     62    [/javascript]
     63
     64Outputs highlighted js with **monokai** style, linenumbers.
     65
     66
     67##Color styles
     68These are supported color styles:
     69
     70* `monokai`<br>
     71![monokai example](Documentation/img/style__0018_Layer-20.png "")
     72
     73* `manni`<br>
     74![monokai example](Documentation/img/style__0017_Layer-19.png "")
     75
     76* `rrt`<br>
     77![monokai example](Documentation/img/style__0016_Layer-18.png "")
     78
     79* `perldoc`<br>
     80![monokai example](Documentation/img/style__0015_Layer-17.png "")
     81
     82* `borland`<br>
     83![monokai example](Documentation/img/style__0014_Layer-16.png "")
     84
     85* `colorful`<br>
     86![monokai example](Documentation/img/style__0013_Layer-15.png "")
     87
     88* `default`<br>
     89![monokai example](Documentation/img/style__0012_Layer-14.png "")
     90
     91* `murphy`<br>
     92![monokai example](Documentation/img/style__0011_Layer-13.png "")
     93
     94* `vs`<br>
     95![monokai example](Documentation/img/style__0010_Layer-12.png "")
     96
     97* `trac`<br>
     98![monokai example](Documentation/img/style__0009_Layer-11.png "")
     99
     100* `tango`<br>
     101![monokai example](Documentation/img/style__0008_Layer-10.png "")
     102
     103* `fruity`<br>
     104![monokai example](Documentation/img/style__0007_Layer-9.png "")
     105
     106* `autumn`<br>
     107![monokai example](Documentation/img/style__0006_Layer-8.png "")
     108
     109* `bw`<br>
     110![monokai example](Documentation/img/style__0005_Layer-7.png "")
     111
     112* `emacs`<br>
     113![monokai example](Documentation/img/style__0004_Layer-6.png "")
     114
     115* `vim`<br>
     116![monokai example](Documentation/img/style__0003_Layer-5.png "")
     117
     118* `pastie`<br>
     119![monokai example](Documentation/img/style__0002_Layer-4.png "")
     120
     121* `friendly`<br>
     122![monokai example](Documentation/img/style__0001_Layer-3.png "")
     123
     124* `native`<br>
     125![monokai example](Documentation/img/style__0000_Layer-1.png "")
     126
     127
     128##Languages and filetypes supported
     129
     130Pygments not only highlights languages. also highlights filetypes like .conf **Nginx** configuration file, **Apache** (filenames .htaccess, apache.conf, apache2.conf), etc.
     131
     132NOTE: to use see "Usage" section
     133
     134#####important sdsd;
     135#####General
     136* `apacheconf`: (.htaccess, apache.conf, apache2.conf)
     137* `bash`, `sh`, `ksh`:
     138    (*.sh, *.ksh, *.bash, *.ebuild, *.eclass, .bashrc, bashrc)
     139* `ini`, `cfg`: (*.ini, *.cfg)
     140* `makefile`:
     141    (*.mak, Makefile, makefile, Makefile.*, GNUmakefile)
     142* `nginx`:
     143    Nginx configuration file
     144* `yaml`:
     145    (*.yaml, *.yml)
     146* `perl`:
     147    Perl (*.pl, *.pm)
     148* `vb.net`:
     149    VB.net (*.vb, *.bas)
     150* `console`:
     151    Bash Session (*.sh-session)
     152
     153#####Javascript
     154* `javascript`: Pure Javascript
     155* `coffeescript`: Pure CoffeeScript
     156* `json`: Pure JSON
     157
     158#####PHP
     159* `cssphp`: PHP embedded in CSS
     160* `htmlphp`: PHP embedded in HTML
     161* `jsphp`: PHP embedded in JS
     162* `php`: Pure PHP
     163* `xmlphp`: PHP embedded in XML
     164
     165#####Ruby
     166* `ruby`, `duby`: Ruby (*.rb, *.rbw, *.rake, *.gemspec, *.rbx, *.duby)
     167* `csserb`, `cssruby`: Ruby embedded in CSS
     168* `xmlerb`, `xmlruby`: Ruby embedded in XML
     169
     170#####CSS and CSS compilers
     171* `css`:
     172    CSS (*.css)
     173* `sass`:
     174    Sass (*.sass)
     175* `scss`:
     176    SCSS (*.scss)
     177
     178#####HTML and HTML template systems
     179* `html`:
     180    HTML (*.html, *.htm, *.xhtml, *.xslt)
     181* `haml`:
     182    Haml (*.haml)
     183* `jade`:
     184    Jade (*.jade)
     185
     186#####SQL
     187* `sql`:
     188    SQL (*.sql)
     189* `sqlite3`:
     190    sqlite3con (*.sqlite3-console)
     191* `mysql`:
     192    MySQL
     193
     194#####Python, jinja & Django
     195* `python`: Pure Python
     196* `python3`: Pure Python 3
     197* `xmldjango`, `xmljinja`: Django/Jinja embedded in XML
     198* `cssdjango`, `cssjinja`: Django/Jinja embedded in CSS
     199* `django`, `jinja`: Pure Django/Jinja
     200* `htmldjango`, `htmljinja`: Django/Jinja embedded in HTML
     201* `jsdjango`, `jsjinja`: Django/Jinja embedded in Javascript
     202
     203#####Java & Groovy
     204* `java`:
     205    Java (*.java)
     206* `groovy`:
     207    Groovy (*.groovy)
     208* `jsp`:
     209    Java Server Page (*.jsp)
     210
     211#####C, C++, Objetive-c, C Sharp
     212* `cobjdump`: c-objdump (*.c-objdump)
     213* `c`: C (*.c, *.h, *.idc)
     214* `cpp`: C++ (*.cpp, *.hpp, *.c++, *.h++, *.cc, *.hh, *.cxx, *.hxx)
     215* `csharp`: C# (*.cs)
     216* `objectivec`: (*.m)
     217
     218#####XML
     219* `xml`: (*.xml, *.xsl, *.rss, *.xslt, *.xsd, *.wsdl)
     220* `xslt`: (*.xsl, *.xslt)
     221
    18222
    19223## Installation:
    … …  
    39243
    40244## Installation:
     245
    41246To use this plugin you need pygments in your server:
    42247
    43 ```
    44 sudo apt-get install python-setuptools
    45 easy_install Pygments
    46 ```
     248    sudo apt-get install python-setuptools
     249    easy_install Pygments
     250
     251That's all. Now you can download the plugin and install it in your Wordpress.
     252
    472531. Upload the plugin to the `/wp-content/plugins/` directory
    48 2. Activate the plugin through the 'Plugins' menu in WordPress
     2541. Activate the plugin through the 'Plugins' menu in WordPress
    49255
    50256Once you get installed the plugin the usage is straightforward. just enclose your code between tokens named with the corresponding lang:
    51257
    52 [javascript]....[/javascript]
    53 
    54 [php]....[/php]
     258    [javascript]....[/javascript]
     259
     260    [php]....[/php]
    55261
    56262== Frequently asked questions ==
    … …  
    62268== Screenshots ==
    63269
    64 1. /assets/screenshot-1.png
    65 2. /assets/screenshot-1.png
     2701. Example highlighted code
     2712.  Another example highlighted code
    66272
    67273== Changelog ==
     274
     275= 1.1 =
     276* readme.txt fix
     277
    68278= 1.0 =
    69279* First stable release

  • wpygments/trunk/readme.txt

    r708364 r708382  
    55Requires at least: 3.3
    66Tested up to: 3.5.1
    7 Stable tag: 1.0
     7Stable tag: 1.1
    88License: GPLv2 or later
    99License URI: http://www.gnu.org/licenses/gpl-2.0.html
    … …  
    1515WPygments - Wordpress syntax highlighter based on [Pygments](http://pygments.org/ "")
    1616======================
    17 Server side syntax highlighter based on Pygments highlighter software.
     17
     18
     19## Installation:
     20To use this plugin you need pygments in your server:
     21
     22    sudo apt-get install python-setuptools
     23    easy_install Pygments
     24
     25That's all. Now you can download the plugin and install it in your Wordpress.
     26
     27## Usage
     28Once you get installed the plugin the usage is straightforward. just enclose your code between tokens named with the corresponding lang:
     29
     30    [javascript]....[/javascript]
     31    [php]....[/php]
     32
     33See "Languages and filetypes supported" section to know available languages.
     34
     35#### Parameters
     36Tokens support a few parameters (all optionals):
     37
     38    [php **style**="manni" **linenumbers**="table"]....[/php]
     39
     40`style="manni"` defines code styling. Currently are 22 available styles.<br>
     41Default styling is `default` wich is very nice, but maybe you like other styles. see "Color styles" section.
     42
     43`linenumbers="false"` indicates if it should show the numbers and which format. `linenumbers="table"` or `linenumbers="inline"`
     44
     45#### Examples
     46    [javascript]
     47    //comment line
     48    var foo = "foo";
     49    var bar = function(){
     50        var baz;
     51    }
     52    [/javascript]
     53
     54Outputs highlighted js with **default** style, and **no** (false) linenumbers.
     55
     56    [javascript style="monokai" linenumbers="inline"]
     57    //comment line
     58    var foo = "foo";
     59    var bar = function(){
     60        var baz;
     61    }
     62    [/javascript]
     63
     64Outputs highlighted js with **monokai** style, linenumbers.
     65
     66
     67##Color styles
     68These are supported color styles:
     69
     70* `monokai`<br>
     71![monokai example](Documentation/img/style__0018_Layer-20.png "")
     72
     73* `manni`<br>
     74![monokai example](Documentation/img/style__0017_Layer-19.png "")
     75
     76* `rrt`<br>
     77![monokai example](Documentation/img/style__0016_Layer-18.png "")
     78
     79* `perldoc`<br>
     80![monokai example](Documentation/img/style__0015_Layer-17.png "")
     81
     82* `borland`<br>
     83![monokai example](Documentation/img/style__0014_Layer-16.png "")
     84
     85* `colorful`<br>
     86![monokai example](Documentation/img/style__0013_Layer-15.png "")
     87
     88* `default`<br>
     89![monokai example](Documentation/img/style__0012_Layer-14.png "")
     90
     91* `murphy`<br>
     92![monokai example](Documentation/img/style__0011_Layer-13.png "")
     93
     94* `vs`<br>
     95![monokai example](Documentation/img/style__0010_Layer-12.png "")
     96
     97* `trac`<br>
     98![monokai example](Documentation/img/style__0009_Layer-11.png "")
     99
     100* `tango`<br>
     101![monokai example](Documentation/img/style__0008_Layer-10.png "")
     102
     103* `fruity`<br>
     104![monokai example](Documentation/img/style__0007_Layer-9.png "")
     105
     106* `autumn`<br>
     107![monokai example](Documentation/img/style__0006_Layer-8.png "")
     108
     109* `bw`<br>
     110![monokai example](Documentation/img/style__0005_Layer-7.png "")
     111
     112* `emacs`<br>
     113![monokai example](Documentation/img/style__0004_Layer-6.png "")
     114
     115* `vim`<br>
     116![monokai example](Documentation/img/style__0003_Layer-5.png "")
     117
     118* `pastie`<br>
     119![monokai example](Documentation/img/style__0002_Layer-4.png "")
     120
     121* `friendly`<br>
     122![monokai example](Documentation/img/style__0001_Layer-3.png "")
     123
     124* `native`<br>
     125![monokai example](Documentation/img/style__0000_Layer-1.png "")
     126
     127
     128##Languages and filetypes supported
     129
     130Pygments not only highlights languages. also highlights filetypes like .conf **Nginx** configuration file, **Apache** (filenames .htaccess, apache.conf, apache2.conf), etc.
     131
     132NOTE: to use see "Usage" section
     133
     134#####important sdsd;
     135#####General
     136* `apacheconf`: (.htaccess, apache.conf, apache2.conf)
     137* `bash`, `sh`, `ksh`:
     138    (*.sh, *.ksh, *.bash, *.ebuild, *.eclass, .bashrc, bashrc)
     139* `ini`, `cfg`: (*.ini, *.cfg)
     140* `makefile`:
     141    (*.mak, Makefile, makefile, Makefile.*, GNUmakefile)
     142* `nginx`:
     143    Nginx configuration file
     144* `yaml`:
     145    (*.yaml, *.yml)
     146* `perl`:
     147    Perl (*.pl, *.pm)
     148* `vb.net`:
     149    VB.net (*.vb, *.bas)
     150* `console`:
     151    Bash Session (*.sh-session)
     152
     153#####Javascript
     154* `javascript`: Pure Javascript
     155* `coffeescript`: Pure CoffeeScript
     156* `json`: Pure JSON
     157
     158#####PHP
     159* `cssphp`: PHP embedded in CSS
     160* `htmlphp`: PHP embedded in HTML
     161* `jsphp`: PHP embedded in JS
     162* `php`: Pure PHP
     163* `xmlphp`: PHP embedded in XML
     164
     165#####Ruby
     166* `ruby`, `duby`: Ruby (*.rb, *.rbw, *.rake, *.gemspec, *.rbx, *.duby)
     167* `csserb`, `cssruby`: Ruby embedded in CSS
     168* `xmlerb`, `xmlruby`: Ruby embedded in XML
     169
     170#####CSS and CSS compilers
     171* `css`:
     172    CSS (*.css)
     173* `sass`:
     174    Sass (*.sass)
     175* `scss`:
     176    SCSS (*.scss)
     177
     178#####HTML and HTML template systems
     179* `html`:
     180    HTML (*.html, *.htm, *.xhtml, *.xslt)
     181* `haml`:
     182    Haml (*.haml)
     183* `jade`:
     184    Jade (*.jade)
     185
     186#####SQL
     187* `sql`:
     188    SQL (*.sql)
     189* `sqlite3`:
     190    sqlite3con (*.sqlite3-console)
     191* `mysql`:
     192    MySQL
     193
     194#####Python, jinja & Django
     195* `python`: Pure Python
     196* `python3`: Pure Python 3
     197* `xmldjango`, `xmljinja`: Django/Jinja embedded in XML
     198* `cssdjango`, `cssjinja`: Django/Jinja embedded in CSS
     199* `django`, `jinja`: Pure Django/Jinja
     200* `htmldjango`, `htmljinja`: Django/Jinja embedded in HTML
     201* `jsdjango`, `jsjinja`: Django/Jinja embedded in Javascript
     202
     203#####Java & Groovy
     204* `java`:
     205    Java (*.java)
     206* `groovy`:
     207    Groovy (*.groovy)
     208* `jsp`:
     209    Java Server Page (*.jsp)
     210
     211#####C, C++, Objetive-c, C Sharp
     212* `cobjdump`: c-objdump (*.c-objdump)
     213* `c`: C (*.c, *.h, *.idc)
     214* `cpp`: C++ (*.cpp, *.hpp, *.c++, *.h++, *.cc, *.hh, *.cxx, *.hxx)
     215* `csharp`: C# (*.cs)
     216* `objectivec`: (*.m)
     217
     218#####XML
     219* `xml`: (*.xml, *.xsl, *.rss, *.xslt, *.xsd, *.wsdl)
     220* `xslt`: (*.xsl, *.xslt)
     221
    18222
    19223## Installation:
    … …  
    39243
    40244## Installation:
     245
    41246To use this plugin you need pygments in your server:
    42247
    43 ```
    44 sudo apt-get install python-setuptools
    45 easy_install Pygments
    46 ```
     248    sudo apt-get install python-setuptools
     249    easy_install Pygments
     250
     251That's all. Now you can download the plugin and install it in your Wordpress.
     252
    472531. Upload the plugin to the `/wp-content/plugins/` directory
    48 2. Activate the plugin through the 'Plugins' menu in WordPress
     2541. Activate the plugin through the 'Plugins' menu in WordPress
    49255
    50256Once you get installed the plugin the usage is straightforward. just enclose your code between tokens named with the corresponding lang:
    51257
    52 [javascript]....[/javascript]
    53 
    54 [php]....[/php]
     258    [javascript]....[/javascript]
     259
     260    [php]....[/php]
    55261
    56262== Frequently asked questions ==
    … …  
    62268== Screenshots ==
    63269
    64 1. /assets/screenshot-1.png
    65 2. /assets/screenshot-1.png
     2701. Example highlighted code
     2712.  Another example highlighted code
    66272
    67273== Changelog ==
     274
     275= 1.1 =
     276* readme.txt fix
     277
    68278= 1.0 =
    69279* First stable release
Note: See TracChangeset for help on using the changeset viewer.