Mercurial > hg > soundsoftware-site

annotate vendor/plugins/coderay-0.9.2/lib/.svn/text-base/README.svn-base @ 866:2cd212a468b6 bug_152

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Close obsolete branch bug_152
author Chris Cannam
date Wed, 11 May 2011 10:08:34 +0100
parents 513646585e45
children
rev   line source
Chris@0 1 = CodeRay
Chris@0 2
Chris@0 3 [- Tired of blue'n'gray? Try the original version of this documentation on
Chris@0 4 coderay.rubychan.de[http://coderay.rubychan.de/doc/] (use Ctrl+Click to open it in its own frame.) -]
Chris@0 5
Chris@0 6 == About
Chris@0 7 CodeRay is a Ruby library for syntax highlighting.
Chris@0 8
Chris@0 9 Syntax highlighting means: You put your code in, and you get it back colored;
Chris@0 10 Keywords, strings, floats, comments - all in different colors.
Chris@0 11 And with line numbers.
Chris@0 12
Chris@0 13 *Syntax* *Highlighting*...
Chris@0 14 * makes code easier to read and maintain
Chris@0 15 * lets you detect syntax errors faster
Chris@0 16 * helps you to understand the syntax of a language
Chris@0 17 * looks nice
Chris@0 18 * is what everybody should have on their website
Chris@0 19 * solves all your problems and makes the girls run after you
Chris@0 20
Chris@0 21 Version: 0.9.2
Chris@0 22 Author:: murphy (Kornelius Kalnbach)
Chris@0 23 Contact:: murphy rubychan de
Chris@0 24 Website:: coderay.rubychan.de[http://coderay.rubychan.de]
Chris@0 25 License:: GNU LGPL; see LICENSE file in the main directory.
Chris@0 26
Chris@0 27 == Installation
Chris@0 28
Chris@0 29 You need RubyGems[http://rubyforge.org/frs/?group_id=126].
Chris@0 30
Chris@0 31 % gem install coderay
Chris@0 32
Chris@0 33
Chris@0 34 === Dependencies
Chris@0 35
Chris@0 36 CodeRay needs Ruby 1.8.6 or later. It also runs with Ruby 1.9.1+ and JRuby 1.1+.
Chris@0 37
Chris@0 38
Chris@0 39 == Example Usage
Chris@0 40 (Forgive me, but this is not highlighted.)
Chris@0 41
Chris@0 42 require 'coderay'
Chris@0 43
Chris@0 44 tokens = CodeRay.scan "puts 'Hello, world!'", :ruby
Chris@0 45 page = tokens.html :line_numbers => :inline, :wrap => :page
Chris@0 46 puts page
Chris@0 47
Chris@0 48
Chris@0 49 == Documentation
Chris@0 50
Chris@0 51 See CodeRay.
Chris@0 52
Chris@0 53 Please report errors in this documentation to <murphy rubychan de>.
Chris@0 54
Chris@0 55
Chris@0 56 == Credits
Chris@0 57
Chris@0 58 === Special Thanks to
Chris@0 59
Chris@0 60 * licenser (Heinz N. Gies) for ending my QBasic career, inventing the Coder
Chris@0 61 project and the input/output plugin system.
Chris@0 62 CodeRay would not exist without him.
Chris@0 63 * bovi (Daniel Bovensiepen) for helping me out on various occasions.
Chris@0 64
Chris@0 65 === Thanks to
Chris@0 66
Chris@0 67 * Caleb Clausen for writing RubyLexer (see
Chris@0 68 http://rubyforge.org/projects/rubylexer) and lots of very interesting mail
Chris@0 69 traffic
Chris@0 70 * birkenfeld (Georg Brandl) and mitsuhiku (Arnim Ronacher) for PyKleur, now pygments.
Chris@0 71 You guys rock!
Chris@0 72 * Jamis Buck for writing Syntax (see http://rubyforge.org/projects/syntax)
Chris@0 73 I got some useful ideas from it.
Chris@0 74 * Doug Kearns and everyone else who worked on ruby.vim - it not only helped me
Chris@0 75 coding CodeRay, but also gave me a wonderful target to reach for the Ruby
Chris@0 76 scanner.
Chris@0 77 * everyone who uses CodeBB on http://www.rubyforen.de and http://www.python-forum.de
Chris@0 78 * iGEL, magichisoka, manveru, WoNáDo and everyone I forgot from rubyforen.de
Chris@0 79 * Dethix from ruby-mine.de
Chris@0 80 * zickzackw
Chris@0 81 * Dookie (who is no longer with us...) and Leonidas from http://www.python-forum.de
Chris@0 82 * Andreas Schwarz for finding out that CaseIgnoringWordList was not case
Chris@0 83 ignoring! Such things really make you write tests.
Chris@0 84 * closure for the first version of the Scheme scanner.
Chris@0 85 * Stefan Walk for the first version of the JavaScript and PHP scanners.
Chris@0 86 * Josh Goebel for another version of the JavaScript scanner, a SQL and a Diff scanner.
Chris@0 87 * Jonathan Younger for pointing out the licence confusion caused by wrong LICENSE file.
Chris@0 88 * Jeremy Hinegardner for finding the shebang-on-empty-file bug in FileType.
Chris@0 89 * Charles Oliver Nutter and Yehuda Katz for helping me benchmark CodeRay on JRuby.
Chris@0 90 * Andreas Neuhaus for pointing out a markup bug in coderay/for_redcloth.
Chris@0 91 * 0xf30fc7 for the FileType patch concerning Delphi file extensions.
Chris@0 92 * The folks at redmine.org - thank you for using and fixing CodeRay!
Chris@0 93 * Keith Pitt for his SQL scanners
Chris@0 94 * Rob Aldred for the terminal encoder
Chris@0 95 * Trans for pointing out $DEBUG dependencies
Chris@0 96 * Flameeyes for finding that Term::ANSIColor was obsolete
Chris@0 97 * matz and all Ruby gods and gurus
Chris@0 98 * The inventors of: the computer, the internet, the true color display, HTML &
Chris@0 99 CSS, VIM, Ruby, pizza, microwaves, guitars, scouting, programming, anime,
Chris@0 100 manga, coke and green ice tea.
Chris@0 101
Chris@0 102 Where would we be without all those people?
Chris@0 103
Chris@0 104 === Created using
Chris@0 105
Chris@0 106 * Ruby[http://ruby-lang.org/]
Chris@0 107 * Chihiro (my Sony VAIO laptop); Henrietta (my old MacBook);
Chris@0 108 Triella, born Rico (my new MacBook); as well as
Chris@0 109 Seras and Hikari (my PCs)
Chris@0 110 * RDE[http://homepage2.nifty.com/sakazuki/rde_e.html],
Chris@0 111 VIM[http://vim.org] and TextMate[http://macromates.com]
Chris@0 112 * Subversion[http://subversion.tigris.org/]
Chris@0 113 * Redmine[http://redmine.org/]
Chris@0 114 * Firefox[http://www.mozilla.org/products/firefox/],
Chris@0 115 Firebug[http://getfirebug.com/], Safari[http://www.apple.com/safari/], and
Chris@0 116 Thunderbird[http://www.mozilla.org/products/thunderbird/]
Chris@0 117 * RubyGems[http://docs.rubygems.org/] and Rake[http://rake.rubyforge.org/]
Chris@0 118 * TortoiseSVN[http://tortoisesvn.tigris.org/] using Apache via
Chris@0 119 XAMPP[http://www.apachefriends.org/en/xampp.html]
Chris@0 120 * RDoc (though I'm quite unsatisfied with it)
Chris@0 121 * Microsoft Windows (yes, I confess!) and MacOS X
Chris@0 122 * GNUWin32, MinGW and some other tools to make the shell under windows a bit
Chris@0 123 less useless
Chris@0 124 * Term::ANSIColor[http://term-ansicolor.rubyforge.org/]
Chris@0 125 * PLEAC[http://pleac.sourceforge.net/] code examples
Chris@0 126
Chris@0 127 === Free
Chris@0 128
Chris@0 129 * As you can see, CodeRay was created under heavy use of *free* software.
Chris@0 130 * So CodeRay is also *free*.
Chris@0 131 * If you use CodeRay to create software, think about making this software
Chris@0 132 *free*, too.
Chris@0 133 * Thanks :)