2008-01-13 22:34:05 -05:00
|
|
|
require 'rdoc'
|
|
|
|
|
|
|
|
|
|
##
|
|
|
|
|
# RDoc::Markup parses plain text documents and attempts to decompose them into
|
|
|
|
|
# their constituent parts. Some of these parts are high-level: paragraphs,
|
|
|
|
|
# chunks of verbatim text, list entries and the like. Other parts happen at
|
|
|
|
|
# the character level: a piece of bold text, a word in code font. This markup
|
|
|
|
|
# is similar in spirit to that used on WikiWiki webs, where folks create web
|
|
|
|
|
# pages using a simple set of formatting rules.
|
|
|
|
|
#
|
|
|
|
|
# RDoc::Markup itself does no output formatting: this is left to a different
|
|
|
|
|
# set of classes.
|
|
|
|
|
#
|
2008-04-26 12:14:19 -04:00
|
|
|
# RDoc::Markup is extendable at runtime: you can add \new markup elements to
|
|
|
|
|
# be recognised in the documents that RDoc::Markup parses.
|
2008-01-13 22:34:05 -05:00
|
|
|
#
|
|
|
|
|
# RDoc::Markup is intended to be the basis for a family of tools which share
|
|
|
|
|
# the common requirement that simple, plain-text should be rendered in a
|
|
|
|
|
# variety of different output formats and media. It is envisaged that
|
2008-06-04 05:37:38 -04:00
|
|
|
# RDoc::Markup could be the basis for formatting RDoc style comment blocks,
|
2008-01-13 22:34:05 -05:00
|
|
|
# Wiki entries, and online FAQs.
|
|
|
|
|
#
|
|
|
|
|
# == Synopsis
|
|
|
|
|
#
|
2008-04-26 12:14:19 -04:00
|
|
|
# This code converts +input_string+ to HTML. The conversion takes place in
|
|
|
|
|
# the +convert+ method, so you can use the same RDoc::Markup converter to
|
|
|
|
|
# convert multiple input strings.
|
2008-01-13 22:34:05 -05:00
|
|
|
#
|
|
|
|
|
# require 'rdoc/markup/to_html'
|
2010-04-02 00:40:47 -04:00
|
|
|
#
|
2008-01-13 22:34:05 -05:00
|
|
|
# h = RDoc::Markup::ToHtml.new
|
2010-04-02 00:40:47 -04:00
|
|
|
#
|
2008-04-26 12:14:19 -04:00
|
|
|
# puts h.convert(input_string)
|
2008-01-13 22:34:05 -05:00
|
|
|
#
|
|
|
|
|
# You can extend the RDoc::Markup parser to recognise new markup
|
|
|
|
|
# sequences, and to add special processing for text that matches a
|
2008-06-04 05:37:38 -04:00
|
|
|
# regular expression. Here we make WikiWords significant to the parser,
|
2008-01-13 22:34:05 -05:00
|
|
|
# and also make the sequences {word} and \<no>text...</no> signify
|
|
|
|
|
# strike-through text. When then subclass the HTML output class to deal
|
|
|
|
|
# with these:
|
|
|
|
|
#
|
|
|
|
|
# require 'rdoc/markup'
|
|
|
|
|
# require 'rdoc/markup/to_html'
|
2010-04-02 00:40:47 -04:00
|
|
|
#
|
2008-01-13 22:34:05 -05:00
|
|
|
# class WikiHtml < RDoc::Markup::ToHtml
|
|
|
|
|
# def handle_special_WIKIWORD(special)
|
|
|
|
|
# "<font color=red>" + special.text + "</font>"
|
|
|
|
|
# end
|
|
|
|
|
# end
|
2010-04-02 00:40:47 -04:00
|
|
|
#
|
2008-02-09 22:59:08 -05:00
|
|
|
# m = RDoc::Markup.new
|
|
|
|
|
# m.add_word_pair("{", "}", :STRIKE)
|
|
|
|
|
# m.add_html("no", :STRIKE)
|
2010-04-02 00:40:47 -04:00
|
|
|
#
|
2008-02-09 22:59:08 -05:00
|
|
|
# m.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
|
2010-04-02 00:40:47 -04:00
|
|
|
#
|
2008-04-26 12:14:19 -04:00
|
|
|
# wh = WikiHtml.new
|
|
|
|
|
# wh.add_tag(:STRIKE, "<strike>", "</strike>")
|
2010-04-02 00:40:47 -04:00
|
|
|
#
|
2008-04-26 12:14:19 -04:00
|
|
|
# puts "<body>#{wh.convert ARGF.read}</body>"
|
2008-01-13 22:34:05 -05:00
|
|
|
#
|
|
|
|
|
#--
|
|
|
|
|
# Author:: Dave Thomas, dave@pragmaticprogrammer.com
|
|
|
|
|
# License:: Ruby license
|
|
|
|
|
|
|
|
|
|
class RDoc::Markup
|
|
|
|
|
|
2010-04-01 03:45:16 -04:00
|
|
|
attr_reader :attribute_manager
|
2008-01-13 22:34:05 -05:00
|
|
|
|
|
|
|
|
##
|
|
|
|
|
# Take a block of text and use various heuristics to determine it's
|
|
|
|
|
# structure (paragraphs, lists, and so on). Invoke an event handler as we
|
|
|
|
|
# identify significant chunks.
|
|
|
|
|
|
|
|
|
|
def initialize
|
2010-04-01 03:45:16 -04:00
|
|
|
@attribute_manager = RDoc::Markup::AttributeManager.new
|
2008-01-13 22:34:05 -05:00
|
|
|
@output = nil
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
##
|
|
|
|
|
# Add to the sequences used to add formatting to an individual word (such
|
2008-06-04 05:37:38 -04:00
|
|
|
# as *bold*). Matching entries will generate attributes that the output
|
2008-01-13 22:34:05 -05:00
|
|
|
# formatters can recognize by their +name+.
|
|
|
|
|
|
|
|
|
|
def add_word_pair(start, stop, name)
|
2010-04-01 03:45:16 -04:00
|
|
|
@attribute_manager.add_word_pair(start, stop, name)
|
2008-01-13 22:34:05 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
##
|
|
|
|
|
# Add to the sequences recognized as general markup.
|
|
|
|
|
|
|
|
|
|
def add_html(tag, name)
|
2010-04-01 03:45:16 -04:00
|
|
|
@attribute_manager.add_html(tag, name)
|
2008-01-13 22:34:05 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
##
|
|
|
|
|
# Add to other inline sequences. For example, we could add WikiWords using
|
|
|
|
|
# something like:
|
|
|
|
|
#
|
|
|
|
|
# parser.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
|
|
|
|
|
#
|
|
|
|
|
# Each wiki word will be presented to the output formatter via the
|
|
|
|
|
# accept_special method.
|
|
|
|
|
|
|
|
|
|
def add_special(pattern, name)
|
2010-04-01 03:45:16 -04:00
|
|
|
@attribute_manager.add_special(pattern, name)
|
2008-01-13 22:34:05 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
##
|
|
|
|
|
# We take a string, split it into lines, work out the type of each line,
|
|
|
|
|
# and from there deduce groups of lines (for example all lines in a
|
|
|
|
|
# paragraph). We then invoke the output formatter using a Visitor to
|
|
|
|
|
# display the result.
|
|
|
|
|
|
|
|
|
|
def convert(str, op)
|
2010-04-01 03:45:16 -04:00
|
|
|
document = RDoc::Markup::Parser.parse str
|
2008-01-13 22:34:05 -05:00
|
|
|
|
2010-04-01 03:45:16 -04:00
|
|
|
document.accept op
|
2008-01-13 22:34:05 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
end
|
|
|
|
|
|
2010-04-01 03:45:16 -04:00
|
|
|
require 'rdoc/markup/parser'
|
|
|
|
|
require 'rdoc/markup/attribute_manager'
|
2008-02-09 22:59:08 -05:00
|
|
|
require 'rdoc/markup/inline'
|
2010-04-01 03:45:16 -04:00
|
|
|
|
