README
134 lines
| 4.9 KiB
| text/plain
|
TextLexer
Jean-Philippe Lang
|
r638 | = CodeRay | ||
| [- Tired of blue'n'gray? Try the original version of this documentation on | ||||
|
Jean-Philippe Lang
|
r3478 | coderay.rubychan.de[http://coderay.rubychan.de/doc/] (use Ctrl+Click to open it in its own frame.) -] | ||
|
Jean-Philippe Lang
|
r638 | |||
| == About | ||||
| CodeRay is a Ruby library for syntax highlighting. | ||||
| Syntax highlighting means: You put your code in, and you get it back colored; | ||||
| Keywords, strings, floats, comments - all in different colors. | ||||
| And with line numbers. | ||||
| *Syntax* *Highlighting*... | ||||
| * makes code easier to read and maintain | ||||
| * lets you detect syntax errors faster | ||||
| * helps you to understand the syntax of a language | ||||
| * looks nice | ||||
| * is what everybody should have on their website | ||||
| * solves all your problems and makes the girls run after you | ||||
|
Jean-Philippe Lang
|
r4619 | Version: 0.9.7 | ||
|
Jean-Philippe Lang
|
r638 | Author:: murphy (Kornelius Kalnbach) | ||
| Contact:: murphy rubychan de | ||||
| Website:: coderay.rubychan.de[http://coderay.rubychan.de] | ||||
| License:: GNU LGPL; see LICENSE file in the main directory. | ||||
| == Installation | ||||
| You need RubyGems[http://rubyforge.org/frs/?group_id=126]. | ||||
| % gem install coderay | ||||
| === Dependencies | ||||
|
Jean-Philippe Lang
|
r3478 | CodeRay needs Ruby 1.8.6 or later. It also runs with Ruby 1.9.1+ and JRuby 1.1+. | ||
|
Jean-Philippe Lang
|
r638 | |||
| == Example Usage | ||||
| (Forgive me, but this is not highlighted.) | ||||
| require 'coderay' | ||||
| tokens = CodeRay.scan "puts 'Hello, world!'", :ruby | ||||
| page = tokens.html :line_numbers => :inline, :wrap => :page | ||||
| puts page | ||||
| == Documentation | ||||
| See CodeRay. | ||||
|
Jean-Philippe Lang
|
r3478 | Please report errors in this documentation to <murphy rubychan de>. | ||
|
Jean-Philippe Lang
|
r638 | |||
| == Credits | ||||
| === Special Thanks to | ||||
| * licenser (Heinz N. Gies) for ending my QBasic career, inventing the Coder | ||||
| project and the input/output plugin system. | ||||
| CodeRay would not exist without him. | ||||
|
Jean-Philippe Lang
|
r3478 | * bovi (Daniel Bovensiepen) for helping me out on various occasions. | ||
|
Jean-Philippe Lang
|
r638 | |||
| === Thanks to | ||||
| * Caleb Clausen for writing RubyLexer (see | ||||
| http://rubyforge.org/projects/rubylexer) and lots of very interesting mail | ||||
| traffic | ||||
|
Jean-Philippe Lang
|
r3478 | * birkenfeld (Georg Brandl) and mitsuhiku (Arnim Ronacher) for PyKleur, now pygments. | ||
| You guys rock! | ||||
|
Jean-Philippe Lang
|
r638 | * Jamis Buck for writing Syntax (see http://rubyforge.org/projects/syntax) | ||
| I got some useful ideas from it. | ||||
| * Doug Kearns and everyone else who worked on ruby.vim - it not only helped me | ||||
| coding CodeRay, but also gave me a wonderful target to reach for the Ruby | ||||
| scanner. | ||||
|
Jean-Philippe Lang
|
r3478 | * everyone who uses CodeBB on http://www.rubyforen.de and http://www.python-forum.de | ||
| * iGEL, magichisoka, manveru, WoNáDo and everyone I forgot from rubyforen.de | ||||
| * Dethix from ruby-mine.de | ||||
| * zickzackw | ||||
| * Dookie (who is no longer with us...) and Leonidas from http://www.python-forum.de | ||||
|
Jean-Philippe Lang
|
r638 | * Andreas Schwarz for finding out that CaseIgnoringWordList was not case | ||
| ignoring! Such things really make you write tests. | ||||
|
Jean-Philippe Lang
|
r3478 | * closure for the first version of the Scheme scanner. | ||
| * Stefan Walk for the first version of the JavaScript and PHP scanners. | ||||
| * Josh Goebel for another version of the JavaScript scanner, a SQL and a Diff scanner. | ||||
| * Jonathan Younger for pointing out the licence confusion caused by wrong LICENSE file. | ||||
| * Jeremy Hinegardner for finding the shebang-on-empty-file bug in FileType. | ||||
| * Charles Oliver Nutter and Yehuda Katz for helping me benchmark CodeRay on JRuby. | ||||
| * Andreas Neuhaus for pointing out a markup bug in coderay/for_redcloth. | ||||
| * 0xf30fc7 for the FileType patch concerning Delphi file extensions. | ||||
| * The folks at redmine.org - thank you for using and fixing CodeRay! | ||||
| * Keith Pitt for his SQL scanners | ||||
| * Rob Aldred for the terminal encoder | ||||
| * Trans for pointing out $DEBUG dependencies | ||||
| * Flameeyes for finding that Term::ANSIColor was obsolete | ||||
|
Jean-Philippe Lang
|
r4619 | * Etienne Massip for reporting a serious bug in JavaScript scanner | ||
|
Jean-Philippe Lang
|
r638 | * matz and all Ruby gods and gurus | ||
| * The inventors of: the computer, the internet, the true color display, HTML & | ||||
|
Jean-Philippe Lang
|
r3478 | CSS, VIM, Ruby, pizza, microwaves, guitars, scouting, programming, anime, | ||
|
Jean-Philippe Lang
|
r638 | manga, coke and green ice tea. | ||
| Where would we be without all those people? | ||||
| === Created using | ||||
| * Ruby[http://ruby-lang.org/] | ||||
|
Jean-Philippe Lang
|
r3478 | * Chihiro (my Sony VAIO laptop); Henrietta (my old MacBook); | ||
| Triella, born Rico (my new MacBook); as well as | ||||
| Seras and Hikari (my PCs) | ||||
| * RDE[http://homepage2.nifty.com/sakazuki/rde_e.html], | ||||
| VIM[http://vim.org] and TextMate[http://macromates.com] | ||||
| * Subversion[http://subversion.tigris.org/] | ||||
| * Redmine[http://redmine.org/] | ||||
| * Firefox[http://www.mozilla.org/products/firefox/], | ||||
| Firebug[http://getfirebug.com/], Safari[http://www.apple.com/safari/], and | ||||
|
Jean-Philippe Lang
|
r638 | Thunderbird[http://www.mozilla.org/products/thunderbird/] | ||
|
Jean-Philippe Lang
|
r3478 | * RubyGems[http://docs.rubygems.org/] and Rake[http://rake.rubyforge.org/] | ||
| * TortoiseSVN[http://tortoisesvn.tigris.org/] using Apache via | ||||
|
Jean-Philippe Lang
|
r638 | XAMPP[http://www.apachefriends.org/en/xampp.html] | ||
| * RDoc (though I'm quite unsatisfied with it) | ||||
|
Jean-Philippe Lang
|
r3478 | * Microsoft Windows (yes, I confess!) and MacOS X | ||
|
Jean-Philippe Lang
|
r638 | * GNUWin32, MinGW and some other tools to make the shell under windows a bit | ||
|
Jean-Philippe Lang
|
r3478 | less useless | ||
|
Jean-Philippe Lang
|
r638 | * Term::ANSIColor[http://term-ansicolor.rubyforge.org/] | ||
|
Jean-Philippe Lang
|
r3478 | * PLEAC[http://pleac.sourceforge.net/] code examples | ||
|
Jean-Philippe Lang
|
r638 | |||
|
Jean-Philippe Lang
|
r3478 | === Free | ||
|
Jean-Philippe Lang
|
r638 | |||
| * As you can see, CodeRay was created under heavy use of *free* software. | ||||
| * So CodeRay is also *free*. | ||||
| * If you use CodeRay to create software, think about making this software | ||||
| *free*, too. | ||||
| * Thanks :) | ||||