comparison vendor/gems/coderay-0.9.7/lib/.svn/text-base/README.svn-base @ 210:0579821a129a

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