josh/rscons
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

user guide: create render_toc() and render_section() methods

Browse Source
This commit is contained in:
Josh Holtrop 2019-06-14 15:55:55 -04:00
parent 4339d358f8
commit 22b007df3a
1 changed files with 20 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
rb/gen_user_guide.rb
View File

@ -37,7 +37,7 @@ class Generator
def initialize(input, output_file, multi_file) def initialize(input, output_file, multi_file)
current_page = current_page =
if multi_file if multi_file
"index.html" nil
else else
File.basename(output_file) File.basename(output_file)
end end
@ -54,7 +54,7 @@ class Generator
new_page = !new_page_text.nil? new_page = !new_page_text.nil?
section_number = get_next_section_number(level) section_number = get_next_section_number(level)
anchor = make_anchor(section_number, title_text) anchor = make_anchor(section_number, title_text)
if new_page if new_page or current_page.nil?
current_page = anchor current_page = anchor
end end
@sections << Section.new(section_number, title_text, current_page, anchor) @sections << Section.new(section_number, title_text, current_page, anchor)
@ -66,16 +66,9 @@ class Generator
renderer = Redcarpet::Render::HTML.new renderer = Redcarpet::Render::HTML.new
@markdown_renderer = Redcarpet::Markdown.new(renderer) @markdown_renderer = Redcarpet::Markdown.new(renderer)
content = %[<h1>Table of Contents</h1>\n] content = render_toc
@sections.each do |section| @sections.each do |section|
indent = section.number.split(".").size - 1 content += render_section(section)
content += %[<span style="padding-left: #{4 * indent}ex;">]
content += %[<a href="##{section.anchor}">#{section.number} #{section.title}</a><br/>\n]
content += %[</span>]
end
@sections.each do |section|
content += %[<a name="#{section.anchor}" />]
content += @markdown_renderer.render(section.contents)
end end
changelog = @markdown_renderer.render(File.read("CHANGELOG.md")) changelog = @markdown_renderer.render(File.read("CHANGELOG.md"))
content.gsub!("${changelog}", changelog) content.gsub!("${changelog}", changelog)
@ -93,6 +86,22 @@ class Generator
end end
end end
def render_toc
toc_content = %[<h1>Table of Contents</h1>\n]
@sections.each do |section|
indent = section.number.split(".").size - 1
toc_content += %[<span style="padding-left: #{4 * indent}ex;">]
toc_content += %[<a href="##{section.anchor}">#{section.number} #{section.title}</a><br/>\n]
toc_content += %[</span>]
end
toc_content
end
def render_section(section)
content = %[<a name="#{section.anchor}" />]
content + @markdown_renderer.render(section.contents)
end
def make_anchor(section_number, section_title) def make_anchor(section_number, section_title)
"s" + ("#{section_number} #{section_title}").gsub(/[^a-zA-Z0-9]/, "_") "s" + ("#{section_number} #{section_title}").gsub(/[^a-zA-Z0-9]/, "_")
end end