In Files

  • rdoc/markup/to_texinfo.rb

Files

Class/Module Index [+]

Quicksearch

RDoc::Markup::ToTexInfo

Convert SimpleMarkup to basic TexInfo format

TODO: WTF is AttributeManager for?

Public Instance Methods

accept_blank_line(attributes, text) click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 48
def accept_blank_line(attributes, text)
  @text << "\n"
end
            
accept_heading(attributes, text) click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 31
def accept_heading(attributes, text)
  heading = ['@majorheading', '@chapheading'][text.head_level - 1] || '@heading'
  @text << "#{heading} #{format(text)}"
end
            
accept_list_end(attributes, text) click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 40
def accept_list_end(attributes, text)
  @text << '@end itemize'
end
            
accept_list_item(attributes, text) click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 44
def accept_list_item(attributes, text)
  @text << "@item\n#{format(text)}"
end
            
accept_list_start(attributes, text) click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 36
def accept_list_start(attributes, text)
  @text << '@itemize @bullet'
end
            
accept_paragraph(attributes, text) click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 23
def accept_paragraph(attributes, text)
  @text << format(text)
end
            
accept_rule(attributes, text) click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 52
def accept_rule(attributes, text)
  @text << '-----'
end
            
accept_verbatim(attributes, text) click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 27
def accept_verbatim(attributes, text)
  @text << "@verb{|#{format(text)}|}"
end
            
end_accepting() click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 19
def end_accepting
  @text.join("\n")
end
            
format(text) click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 56
def format(text)
  text.txt.
    gsub(/@/, "@@").
    gsub(/\{/, "@{").
    gsub(/\}/, "@}").
    # gsub(/,/, "@,"). # technically only required in cross-refs
    gsub(/\+([\w]+)\+/, "@code{\\1}").
    gsub(/\<tt\>([^<]+)\<\/tt\>/, "@code{\\1}").
    gsub(/\*([\w]+)\*/, "@strong{\\1}").
    gsub(/\<b\>([^<]+)\<\/b\>/, "@strong{\\1}").
    gsub(/_([\w]+)_/, "@emph{\\1}").
    gsub(/\<em\>([^<]+)\<\/em\>/, "@emph{\\1}")
end
            
start_accepting() click to toggle source
 
               # File rdoc/markup/to_texinfo.rb, line 15
def start_accepting
  @text = []
end
            

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