diff options
author | Prem Sichanugrist <s@sikac.hu> | 2012-09-07 00:09:56 -0400 |
---|---|---|
committer | Prem Sichanugrist <s@sikac.hu> | 2012-09-17 15:55:17 -0400 |
commit | 5e2866cc3445646d8df049413aa5fbf03fa605ef (patch) | |
tree | cdb9f799120a0b7516309affa9248e6f0980fe58 /guides/rails_guides | |
parent | 7a0dad25f3be77211160560dc76a8f37963051d7 (diff) | |
download | rails-5e2866cc3445646d8df049413aa5fbf03fa605ef.tar.gz rails-5e2866cc3445646d8df049413aa5fbf03fa605ef.tar.bz2 rails-5e2866cc3445646d8df049413aa5fbf03fa605ef.zip |
No more Textile guide generation support
Diffstat (limited to 'guides/rails_guides')
-rw-r--r-- | guides/rails_guides/generator.rb | 75 | ||||
-rw-r--r-- | guides/rails_guides/textile_extensions.rb | 67 |
2 files changed, 7 insertions, 135 deletions
diff --git a/guides/rails_guides/generator.rb b/guides/rails_guides/generator.rb index f7c0ee3bd7..eda9fd03a6 100644 --- a/guides/rails_guides/generator.rb +++ b/guides/rails_guides/generator.rb @@ -15,7 +15,7 @@ # # Internal links (anchors) are checked. If a reference is broken levenshtein # distance is used to suggest an existing one. This is useful since IDs are -# generated by Textile from headers and thus edits alter them. +# generated by Markdown from headers and thus edits alter them. # # Also detects duplicated IDs. They happen if there are headers with the same # text. Please do resolve them, if any, so guides are valid XHTML. @@ -65,7 +65,7 @@ module RailsGuides class Generator attr_reader :guides_dir, :source_dir, :output_dir, :edge, :warnings, :all - GUIDES_RE = /\.(?:textile|erb|md|markdown)$/ + GUIDES_RE = /\.(?:erb|md|markdown)$/ def initialize(output=nil) set_flags_from_environment @@ -172,8 +172,8 @@ module RailsGuides end def output_file_for(guide) - if guide =~ /\.(textile|markdown|md)$/ - guide.sub(/\.(textile|markdown|md)$/, '.html') + if guide =~ /\.(markdown|md)$/ + guide.sub(/\.(markdown|md)$/, '.html') else guide.sub(/\.erb$/, '') end @@ -202,17 +202,9 @@ module RailsGuides # Generate the special pages like the home. # Passing a template handler in the template name is deprecated. So pass the file name without the extension. result = view.render(:layout => layout, :formats => [$1], :file => $`) - elsif guide =~ /\.(md|markdown)$/ - body = File.read(File.join(source_dir, guide)) - result = RailsGuides::Markdown.new(view, layout).render(body) - - warn_about_broken_links(result) if @warnings else body = File.read(File.join(source_dir, guide)) - body = set_header_section(body, view) - body = set_index(body, view) - - result = view.render(:layout => layout, :text => textile(body)) + result = RailsGuides::Markdown.new(view, layout).render(body) warn_about_broken_links(result) if @warnings end @@ -221,70 +213,17 @@ module RailsGuides end end - def set_header_section(body, view) - new_body = body.gsub(/(.*?)endprologue\./m, '').strip - header = $1 - - header =~ /h2\.(.*)/ - page_title = "Ruby on Rails Guides: #{$1.strip}" - - header = textile(header) - - view.content_for(:page_title) { page_title.html_safe } - view.content_for(:header_section) { header.html_safe } - new_body - end - - def set_index(body, view) - index = <<-INDEX - <div id="subCol"> - <h3 class="chapter"><img src="images/chapters_icon.gif" alt="" />Chapters</h3> - <ol class="chapters"> - INDEX - - i = Indexer.new(body, warnings) - i.index - - # Set index for 2 levels - i.level_hash.each do |key, value| - link = view.content_tag(:a, :href => key[:id]) { textile(key[:title], true).html_safe } - - children = value.keys.map do |k| - view.content_tag(:li, - view.content_tag(:a, :href => k[:id]) { textile(k[:title], true).html_safe }) - end - - children_ul = children.empty? ? "" : view.content_tag(:ul, children.join(" ").html_safe) - - index << view.content_tag(:li, link.html_safe + children_ul.html_safe) - end - - index << '</ol>' - index << '</div>' - - view.content_for(:index_section) { index.html_safe } - - i.result - end - - def textile(body, lite_mode=false) - t = RedCloth.new(body) - t.hard_breaks = false - t.lite_mode = lite_mode - t.to_html(:notestuff, :plusplus, :code) - end - def warn_about_broken_links(html) anchors = extract_anchors(html) check_fragment_identifiers(html, anchors) end def extract_anchors(html) - # Textile generates headers with IDs computed from titles. + # Markdown generates headers with IDs computed from titles. anchors = Set.new html.scan(/<h\d\s+id="([^"]+)/).flatten.each do |anchor| if anchors.member?(anchor) - puts "*** DUPLICATE ID: #{anchor}, please use an explicit ID, e.g. h4(#explicit-id), or consider rewording" + puts "*** DUPLICATE ID: #{anchor}, please make sure that there're no headings with the same name at the same level." else anchors << anchor end diff --git a/guides/rails_guides/textile_extensions.rb b/guides/rails_guides/textile_extensions.rb deleted file mode 100644 index 1faddd4ca0..0000000000 --- a/guides/rails_guides/textile_extensions.rb +++ /dev/null @@ -1,67 +0,0 @@ -module RedCloth::Formatters::HTML - def emdash(opts) - "--" - end -end - -module RailsGuides - module TextileExtensions - def notestuff(body) - # The following regexp detects special labels followed by a - # paragraph, perhaps at the end of the document. - # - # It is important that we do not eat more than one newline - # because formatting may be wrong otherwise. For example, - # if a bulleted list follows the first item is not rendered - # as a list item, but as a paragraph starting with a plain - # asterisk. - body.gsub!(/^(TIP|IMPORTANT|CAUTION|WARNING|NOTE|INFO)[.:](.*?)(\n(?=\n)|\Z)/m) do |m| - css_class = case $1 - when 'CAUTION', 'IMPORTANT' - 'warning' - when 'TIP' - 'info' - else - $1.downcase - end - %Q(<div class="#{css_class}"><p>#{$2.strip}</p></div>) - end - end - - def plusplus(body) - body.gsub!(/\+(.*?)\+/) do |m| - "<notextile><tt>#{$1}</tt></notextile>" - end - - # The real plus sign - body.gsub!('<plus>', '+') - end - - def brush_for(code_type) - case code_type - when 'ruby', 'sql', 'plain' - code_type - when 'erb' - 'ruby; html-script: true' - when 'html' - 'xml' # html is understood, but there are .xml rules in the CSS - else - 'plain' - end - end - - def code(body) - body.gsub!(%r{<(yaml|shell|ruby|erb|html|sql|plain)>(.*?)</\1>}m) do |m| - <<HTML -<notextile> -<div class="code_container"> -<pre class="brush: #{brush_for($1)}; gutter: false; toolbar: false"> -#{ERB::Util.h($2).strip} -</pre> -</div> -</notextile> -HTML - end - end - end -end |