Table of Contents - CodeRay Documentation

Pages

• README_INDEX
  • CodeRay
  • About
  • Installation
  • Dependencies
  • Example Usage
  • Documentation
  • Credits
  • Special Thanks to
  • Thanks to
  • Created using
  • Free

Classes/Modules

• CodeRay
  • CodeRay Library
  • Documentation
  • Usage
  • Highlight Ruby code in a string as html
  • Highlight C code from a file in a html div
  • Highlight without typing too much
  • CodeRay Module
  • Basic Access Ways
  • Scanning
  • Encoding
  • All-in-One Encoding
  • Instanciating
  • Reusing Scanners and Encoders
• CodeRay::Duo
  • Duo
• CodeRay::Encoders
• CodeRay::Encoders::CommentFilter
• CodeRay::Encoders::Count
• CodeRay::Encoders::Debug
  • Debug Encoder
• CodeRay::Encoders::Div
• CodeRay::Encoders::Encoder
  • Encoder
• CodeRay::Encoders::Filter
  • Options
  • :tokens
• CodeRay::Encoders::HTML
  • HTML Encoder
  • Usage
  • Options
  • :tab_width
  • :css
  • :wrap
  • :title
  • :break_lines
  • :line_numbers
  • :line_number_anchors
  • :line_number_start
  • :bold_every
  • :highlight_lines
  • :hint
• CodeRay::Encoders::HTML::Output
• CodeRay::Encoders::JSON
• CodeRay::Encoders::LinesOfCode
• CodeRay::Encoders::Null
  • Null Encoder
• CodeRay::Encoders::Page
• CodeRay::Encoders::Span
• CodeRay::Encoders::Statistic
• CodeRay::Encoders::Terminal
  • Authors & License
• CodeRay::Encoders::Text
  • Options
  • :separator
• CodeRay::Encoders::TokenKindFilter
  • Options
  • :exclude
  • :include
• CodeRay::Encoders::XML
  • XML Encoder
• CodeRay::Encoders::YAML
  • YAML Encoder
• CodeRay::FileType
  • FileType
  • Usage
• CodeRay::ForRedCloth
• CodeRay::GZip
• CodeRay::Plugin
  • Plugin
• CodeRay::PluginHost
  • PluginHost
• CodeRay::Scanners
• CodeRay::Scanners::C
• CodeRay::Scanners::CPlusPlus
• CodeRay::Scanners::CSS
• CodeRay::Scanners::Clojure
• CodeRay::Scanners::Debug
  • Debug Scanner
• CodeRay::Scanners::Delphi
• CodeRay::Scanners::Diff
• CodeRay::Scanners::ERB
• CodeRay::Scanners::Groovy
• CodeRay::Scanners::HAML
• CodeRay::Scanners::HTML
• CodeRay::Scanners::JSON
• CodeRay::Scanners::Java
• CodeRay::Scanners::JavaScript
• CodeRay::Scanners::PHP
• CodeRay::Scanners::Python
• CodeRay::Scanners::Raydebug
  • Debug Scanner
• CodeRay::Scanners::Ruby
• CodeRay::Scanners::SQL
• CodeRay::Scanners::Scanner
  • Scanner
• CodeRay::Scanners::Text
• CodeRay::Scanners::XML
• CodeRay::Scanners::YAML
• CodeRay::Styles
• CodeRay::Styles::Alpha
• CodeRay::Styles::Style
• CodeRay::Tokens
  • Tokens TODO: Rewrite!
• CodeRay::Tokens::Undumping
• CodeRay::TokensProxy
• CodeRay::WordList
  • WordList
• CodeRay::WordList::CaseIgnoring

Methods

• ::[] — CodeRay::FileType
• ::[] — CodeRay::Duo
• ::coderay_path — CodeRay
• ::const_missing — CodeRay::Encoders::Encoder
• ::encode — CodeRay
• ::encode_file — CodeRay
• ::encode_tokens — CodeRay
• ::encode_with_encoding — CodeRay::Scanners::Scanner
• ::encoder — CodeRay
• ::encoding — CodeRay::Scanners::Scanner
• ::extended — CodeRay::PluginHost
• ::fetch — CodeRay::FileType
• ::file_extension — CodeRay::Encoders::Encoder
• ::file_extension — CodeRay::Scanners::Scanner
• ::get_scanner_options — CodeRay
• ::guess_encoding — CodeRay::Scanners::Scanner
• ::gunzip — CodeRay::GZip
• ::gzip — CodeRay::GZip
• ::highlight — CodeRay
• ::highlight_file — CodeRay
• ::install — CodeRay::ForRedCloth
• ::lang — CodeRay::Scanners::Scanner
• ::load — CodeRay::Tokens
• ::new — CodeRay::Duo
• ::new — CodeRay::Scanners::Scanner
• ::new — CodeRay::Encoders::Debug
• ::new — CodeRay::WordList
• ::new — CodeRay::TokensProxy
• ::new — CodeRay::Encoders::Encoder
• ::normalize — CodeRay::Scanners::Scanner
• ::scan — CodeRay
• ::scan_file — CodeRay
• ::scanner — CodeRay
• ::shebang — CodeRay::FileType
• ::to_unix — CodeRay::Scanners::Scanner
• ::token_path_to_hint — CodeRay::Encoders::HTML
• #<< — CodeRay::Encoders::Encoder
• #[] — CodeRay::PluginHost
• #[] — CodeRay::WordList::CaseIgnoring
• #[]= — CodeRay::WordList::CaseIgnoring
• #add — CodeRay::WordList
• #aliases — CodeRay::Plugin
• #all_plugins — CodeRay::PluginHost
• #append — CodeRay::Encoders::JSON
• #apply_title! — CodeRay::Encoders::HTML::Output
• #begin_group — CodeRay::Encoders::Count
• #begin_group — CodeRay::Encoders::HTML
• #begin_group — CodeRay::Encoders::TokenKindFilter
• #begin_group — CodeRay::Tokens
• #begin_group — CodeRay::Encoders::Encoder
• #begin_group — CodeRay::Encoders::XML
• #begin_group — CodeRay::Encoders::YAML
• #begin_group — CodeRay::Encoders::Terminal
• #begin_group — CodeRay::Encoders::Debug
• #begin_group — CodeRay::Encoders::JSON
• #begin_group — CodeRay::Encoders::Statistic
• #begin_line — CodeRay::Encoders::JSON
• #begin_line — CodeRay::Encoders::YAML
• #begin_line — CodeRay::Encoders::HTML
• #begin_line — CodeRay::Encoders::Debug
• #begin_line — CodeRay::Encoders::Statistic
• #begin_line — CodeRay::Encoders::Count
• #begin_line — CodeRay::Encoders::Terminal
• #begin_line — CodeRay::Encoders::Encoder
• #begin_line — CodeRay::Encoders::TokenKindFilter
• #begin_line — CodeRay::Tokens
• #binary_string — CodeRay::Scanners::Scanner
• #block_token — CodeRay::Encoders::Statistic
• #call — CodeRay::Duo
• #column — CodeRay::Scanners::Scanner
• #compile — CodeRay::Encoders::Encoder
• #const_missing — CodeRay::PluginHost
• #count — CodeRay::Tokens
• #default — CodeRay::PluginHost
• #dump — CodeRay::Tokens
• #each — CodeRay::Scanners::Scanner
• #each — CodeRay::TokensProxy
• #encode — CodeRay::Tokens
• #encode — CodeRay::Encoders::Encoder
• #encode — CodeRay::Duo
• #encode — CodeRay::TokensProxy
• #encode_tokens — CodeRay::Encoders::Encoder
• #encoder — CodeRay::Duo
• #end_group — CodeRay::Encoders::Debug
• #end_group — CodeRay::Encoders::Count
• #end_group — CodeRay::Encoders::Encoder
• #end_group — CodeRay::Encoders::TokenKindFilter
• #end_group — CodeRay::Tokens
• #end_group — CodeRay::Encoders::Statistic
• #end_group — CodeRay::Encoders::XML
• #end_group — CodeRay::Encoders::HTML
• #end_group — CodeRay::Encoders::JSON
• #end_group — CodeRay::Encoders::Terminal
• #end_group — CodeRay::Encoders::YAML
• #end_line — CodeRay::Encoders::YAML
• #end_line — CodeRay::Encoders::JSON
• #end_line — CodeRay::Encoders::Encoder
• #end_line — CodeRay::Encoders::TokenKindFilter
• #end_line — CodeRay::Tokens
• #end_line — CodeRay::Encoders::Count
• #end_line — CodeRay::Encoders::HTML
• #end_line — CodeRay::Encoders::Debug
• #end_line — CodeRay::Encoders::Statistic
• #end_line — CodeRay::Encoders::Terminal
• #file_extension — CodeRay::Encoders::Encoder
• #file_extension — CodeRay::Scanners::Scanner
• #finish — CodeRay::Encoders::YAML
• #finish — CodeRay::Encoders::XML
• #finish — CodeRay::Encoders::JSON
• #finish — CodeRay::Encoders::Statistic
• #finish — CodeRay::Encoders::LinesOfCode
• #finish — CodeRay::Encoders::Count
• #finish — CodeRay::Encoders::HTML
• #finish — CodeRay::Encoders::Filter
• #finish — CodeRay::Encoders::Encoder
• #get_output — CodeRay::Encoders::Encoder
• #highlight — CodeRay::Duo
• #highlight — CodeRay::Encoders::Encoder
• #include_group? — CodeRay::Encoders::TokenKindFilter
• #include_text_token? — CodeRay::Encoders::TokenKindFilter
• #interpreted_string_state — CodeRay::Scanners::Ruby
• #lang — CodeRay::Scanners::Scanner
• #line — CodeRay::Scanners::Scanner
• #list — CodeRay::PluginHost
• #load — CodeRay::PluginHost
• #load_all — CodeRay::PluginHost
• #load_plugin_map — CodeRay::PluginHost
• #make_plugin_hash — CodeRay::PluginHost
• #map — CodeRay::PluginHost
• #method_missing — CodeRay::Tokens
• #method_missing — CodeRay::TokensProxy
• #output — CodeRay::Encoders::Encoder
• #path_to — CodeRay::PluginHost
• #plugin_hash — CodeRay::PluginHost
• #plugin_host — CodeRay::Plugin
• #plugin_path — CodeRay::PluginHost
• #raise_inspect — CodeRay::Scanners::Scanner
• #register — CodeRay::PluginHost
• #register_for — CodeRay::Plugin
• #reset — CodeRay::Scanners::HTML
• #reset — CodeRay::Scanners::Scanner
• #reset_instance — CodeRay::Scanners::ERB
• #reset_instance — CodeRay::Scanners::Scanner
• #reset_instance — CodeRay::Scanners::PHP
• #reset_instance — CodeRay::Scanners::JavaScript
• #scan_java_script — CodeRay::Scanners::HTML
• #scan_rest — CodeRay::Scanners::Scanner
• #scan_tokens — CodeRay::Scanners::HTML
• #scan_tokens — CodeRay::Scanners::JSON
• #scan_tokens — CodeRay::Scanners::PHP
• #scan_tokens — CodeRay::Scanners::Python
• #scan_tokens — CodeRay::Scanners::Raydebug
• #scan_tokens — CodeRay::Scanners::Scanner
• #scan_tokens — CodeRay::Scanners::Java
• #scan_tokens — CodeRay::Scanners::Ruby
• #scan_tokens — CodeRay::Scanners::SQL
• #scan_tokens — CodeRay::Scanners::Text
• #scan_tokens — CodeRay::Scanners::YAML
• #scan_tokens — CodeRay::Scanners::JavaScript
• #scan_tokens — CodeRay::Scanners::C
• #scan_tokens — CodeRay::Scanners::HAML
• #scan_tokens — CodeRay::Scanners::Clojure
• #scan_tokens — CodeRay::Scanners::CPlusPlus
• #scan_tokens — CodeRay::Scanners::Groovy
• #scan_tokens — CodeRay::Scanners::ERB
• #scan_tokens — CodeRay::Scanners::CSS
• #scan_tokens — CodeRay::Scanners::Debug
• #scan_tokens — CodeRay::Scanners::Diff
• #scan_tokens — CodeRay::Scanners::Delphi
• #scanner — CodeRay::Duo
• #scanner — CodeRay::TokensProxy
• #setup — CodeRay::Scanners::ERB
• #setup — CodeRay::Encoders::Filter
• #setup — CodeRay::Scanners::PHP
• #setup — CodeRay::Scanners::HAML
• #setup — CodeRay::Encoders::Count
• #setup — CodeRay::Encoders::Encoder
• #setup — CodeRay::Scanners::HTML
• #setup — CodeRay::Scanners::Ruby
• #setup — CodeRay::Scanners::CSS
• #setup — CodeRay::Encoders::XML
• #setup — CodeRay::Encoders::HTML
• #setup — CodeRay::Encoders::JSON
• #setup — CodeRay::Encoders::LinesOfCode
• #setup — CodeRay::Encoders::Statistic
• #setup — CodeRay::Encoders::YAML
• #setup — CodeRay::Encoders::Terminal
• #setup — CodeRay::Encoders::Text
• #setup — CodeRay::Encoders::TokenKindFilter
• #setup — CodeRay::Scanners::Scanner
• #split_into_parts — CodeRay::Tokens
• #string= — CodeRay::Scanners::Scanner
• #stylesheet — CodeRay::Encoders::HTML::Output
• #text_token — CodeRay::Encoders::Statistic
• #text_token — CodeRay::Encoders::Debug
• #text_token — CodeRay::Encoders::Count
• #text_token — CodeRay::Encoders::Text
• #text_token — CodeRay::Encoders::Terminal
• #text_token — CodeRay::Encoders::Encoder
• #text_token — CodeRay::Encoders::TokenKindFilter
• #text_token — CodeRay::Encoders::YAML
• #text_token — CodeRay::Encoders::HTML
• #text_token — CodeRay::Encoders::Null
• #text_token — CodeRay::Encoders::JSON
• #text_token — CodeRay::Encoders::XML
• #title — CodeRay::Plugin
• #to_s — CodeRay::Tokens
• #token — CodeRay::Encoders::Encoder
• #tokenize — CodeRay::Scanners::Scanner
• #tokens — CodeRay::Scanners::Scanner
• #tokens — CodeRay::TokensProxy
• #tokens — CodeRay::Encoders::Encoder
• #undump — CodeRay::Tokens::Undumping
• #validate_id — CodeRay::PluginHost
• #wrap! — CodeRay::Encoders::HTML::Output
• #wrap_in! — CodeRay::Encoders::HTML::Output
• #wrapped_in — CodeRay::Encoders::HTML::Output
• #wrapped_in? — CodeRay::Encoders::HTML::Output
• #xml_scanner — CodeRay::Scanners::JavaScript