Extended maintenance of Ruby versions 1.8.7 and 1.9.2 ended on July 31, 2014. Read more

In Files

  • rdoc/markup/simple_markup/preprocess.rb




Class/Module Index [+]



Handle common directives that can occur in a block of text:

: include : filename

Public Class Methods

new(input_file_name, include_path) click to toggle source
               # File rdoc/markup/simple_markup/preprocess.rb, line 11
def initialize(input_file_name, include_path)
  @input_file_name = input_file_name
  @include_path = include_path

Public Instance Methods

handle(text) click to toggle source

Look for common options in a chunk of text. Options that we don’t handle are passed back to our caller as |directive, param|

               # File rdoc/markup/simple_markup/preprocess.rb, line 20
def handle(text)
  text.gsub!(/^([ \t#]*):(\w+):\s*(.+)?\n/) do 
    prefix    = $1
    directive = $2.downcase
    param     = $3

    case directive
    when "include"
      filename = param.split[0]
      include_file(filename, prefix)

      yield(directive, param)

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus