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, 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.
#in_tidylink_label?

Returns true if we are processing inside a tidy link label.
#in_list_entry, #list, #res

::RDoc::Text - Included

#language

The language for this text.

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.
#apply_tidylink_label_special_handling

Special handling for tidy link labels.
#convert_string

CGI-escapes text
#deduplicate_heading_id

Returns a unique heading ID, appending -1, -2, etc.
#emit_inline,
#end_accepting

Returns the generated output.
#gen_url

Generates an HTML link or image tag for the given url and text.
#handle_BOLD, #handle_BOLD_WORD, #handle_EM, #handle_EM_WORD, #handle_HARD_BREAK, #handle_PLAIN_TEXT, #handle_REGEXP_HANDLING_TEXT,
#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_SUPPRESSED_CROSSREF

Converts suppressed cross-reference text to HTML by removing the leading backslash.
#handle_STRIKE, #handle_TIDYLINK, #handle_TT,
#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.
#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
#handle_inline, #handle_RDOCLINK

::RDoc::Text - Included

#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,
#to_html_characters

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-…:
#annotate

Allows tag to be decorated with additional information.
#apply_regexp_handling

Applies regexp handling to text and returns an array of [text, converted?] pairs.
#convert

Marks up content
#convert_string

Converts a string to be fancier if desired.
#handle_BOLD

Called when processing bold nodes while traversing inline nodes from handle_inline.
#handle_BOLD_WORD

Called when processing bold word nodes while traversing inline nodes from handle_inline.
#handle_EM

Called when processing emphasis nodes while traversing inline nodes from handle_inline.
#handle_EM_WORD

Called when processing emphasis word nodes while traversing inline nodes from handle_inline.
#handle_HARD_BREAK

Called when processing a hard break while traversing inline nodes from handle_inline.
#handle_inline

Parses inline text, traverse the resulting nodes, and calls the appropriate handler methods.
#handle_PLAIN_TEXT

Called when processing plain text while traversing inline nodes from handle_inline.
#handle_REGEXP_HANDLING_TEXT

Called when processing regexp-handling-processed text while traversing inline nodes from handle_inline.
#handle_STRIKE

Called when processing strike nodes while traversing inline nodes from handle_inline.
#handle_TEXT

Called when processing text node while traversing inline nodes from handle_inline.
#handle_TIDYLINK

Called when processing tidylink nodes while traversing inline nodes from handle_inline.
#handle_TT

Called when processing tt nodes while traversing inline nodes from handle_inline.
#ignore

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

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

Traverses nodes and calls the appropriate handler methods Nodes formats are described in InlineParser#parse
#tt?

Is tag a tt tag?

Constructor Details

.new(options, from_path = nil) ⇒ LinkLabelToHtml

[ GitHub ] 

  


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



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 595



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