123456789_123456789_123456789_123456789_123456789_

Class: RDoc::Markup::LinkLabelToHtml

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ToHtml, Formatter
Instance Chain:
self, ToHtml, ::RDoc::Text, Formatter
Inherits: RDoc::Markup::ToHtml
Defined in: lib/rdoc/markup/to_html.rb

Overview

Formatter dedicated to rendering tidy link labels without mutating the calling formatter’s state.

Constant Summary

::RDoc::Text - Included

MARKUP_FORMAT, SPACE_SEPARATED_LETTER_CLASS, TO_HTML_CHARACTERS

ToHtml - Inherited

LIST_TYPE_TO_HTML, TIDY_LINK_SINGLE_WORD, TIDY_LINK_WITH_BRACES, TIDY_LINK_WITH_BRACES_TAIL, URL_CHARACTERS_REGEXP_STR

Utilities

Class Method Summary

ToHtml - Inherited

.new

Creates a new formatter that will output HTML.

Formatter - Inherited

.gen_relative_url

Converts a target url to one that is relative to a given path.
.new

Creates a new Formatter.

Instance Attribute Summary

ToHtml - Inherited

#code_object

The ::RDoc::CodeObject HTML is being generated for.
#from_path

Path to this document for relative links.
#tidy_link_capturing?, #in_list_entry, #list, #res

::RDoc::Text - Included

#language

The language for this text.

Formatter - Inherited

#in_tt?

Are we currently inside tt tags?

Instance Method Summary

ToHtml - Inherited

#accept_blank_line

Adds blank_line to the output.
#accept_block_quote

Adds block_quote to the output.
#accept_heading

Adds heading to the output.
#accept_list_end

Finishes consumption of list
#accept_list_item_end

Finishes consumption of list_item
#accept_list_item_start

Prepares the visitor for consuming list_item
#accept_list_start

Prepares the visitor for consuming list
#accept_paragraph

Adds paragraph to the output.
#accept_raw

Adds raw to the output.
#accept_rule

Adds rule to the output.
#accept_table

Adds table to the output.
#accept_verbatim

Adds verbatim to the output.
#convert_string

CGI-escapes text
#end_accepting

Returns the generated output.
#gen_url

Generate a link to url with content text.
#handle_regexp_HARD_BREAK

target is a <br>.
#handle_regexp_HYPERLINK

target is a potential link.
#handle_regexp_RDOCLINK

target is an rdoc-schemed link that will be converted into a hyperlink.
#handle_regexp_TIDYLINK

This target is a link where the label is different from the URL label[url] or {long label}[url].
#html_list_name

Determines the HTML list element for list_type and open_tag
#init_link_notation_regexp_handlings

Adds regexp handlings about link notations.
#init_regexp_handlings

Adds regexp handlings.
#init_tags

Maps attributes to HTML tags.
#list_end_for

Returns the HTML end-tag for list_type
#list_item_start

Returns the HTML tag for list_type, possible using a label from list_item
#parseable?

Returns true if text is valid ruby syntax.
#start_accepting

Prepares the visitor for HTML generation.
#to_html

Converts item to HTML using Text#to_html
#append_flow_fragment, #append_to_tidy_label, #convert_complete_tidy_link, #convert_flow, #emit_tidy_link_fragment, #extract_tidy_link_parts, #finish_tidy_link, #off_tags, #on_tags, #render_tidy_link_label, #start_tidy_link, #handle_RDOCLINK

::RDoc::Text - Included

#expand_tabs

Expands tab characters in text to eight spaces.
#flush_left

Flush text left based on the shortest line.
#markup

Convert a string in markup format into HTML.
#normalize_comment

Strips hashes, expands tabs then flushes text to the left.
#parse

Normalizes text then builds a Document from it.
#snippet

The first limit characters of text as HTML.
#strip_hashes

Strips leading # characters from text
#strip_newlines

Strips leading and trailing n characters from text
#strip_stars

Strips /* */ style comments.
#to_html

Converts ampersand, dashes, ellipsis, quotes, copyright and registered trademark symbols in text to properly encoded characters.
#wrap

Wraps txt to line_len

Formatter - Inherited

#accept_document

Adds document to the output.
#add_regexp_handling_RDOCLINK

Adds a regexp handling for links of the form rdoc-…:
#add_regexp_handling_TIDYLINK

Adds a regexp handling for links of the form <text> and <word>.
#add_tag

Add a new set of tags for an attribute.
#annotate

Allows tag to be decorated with additional information.
#convert

Marks up content
#convert_flow

Converts flow items flow
#convert_regexp_handling

Converts added regexp handlings.
#convert_string

Converts a string to be fancier if desired.
#each_attr_tag,
#ignore

Use ignore in your subclass to ignore the content of a node.
#off_tags

Turns off tags for item on res
#on_tags

Turns on tags for item on res
#parse_url

Extracts and a scheme, url and an anchor id from url and returns them.
#tt?

Is tag a tt tag?
#tt_tag?

Constructor Details

.new(options, from_path = nil) ⇒ LinkLabelToHtml

[ GitHub ] 

  


# File 'lib/rdoc/markup/to_html.rb', line 602



def initialize(options, from_path = nil)
  super(options)

  self.from_path = from_path if from_path
end


  







Class Method Details



  

    .render(label, options, from_path)  
  

  [ GitHub ]


  

  


# File 'lib/rdoc/markup/to_html.rb', line 598



def self.render(label, options, from_path)
  new(options, from_path).to_html(label)
end