scholarmarkdown 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13c63067f767278858bd96977033c58fdcec1716c344431d1ab3e3beeab1f5a3
-  data.tar.gz: b499d465bea603e7f6c53235b9ed18399a0cc2fd7d09d89f4168b21db5a6ba86
+  metadata.gz: 91f2c165820d1506fffbd6efce12046cad1bfccb257377c925508a40096d985f
+  data.tar.gz: c97b69b7409f6bb3a22af5f93fbf141188e7d3a088a48877d6081ed743be0af7
 SHA512:
-  metadata.gz: 4037a1e02bf6e3bceb50a09f09b297d5140d7245b1f8e75080b4b4e7e6ab27af5698a968a622c11b24b88745676c0f3600693a661c37855db9e795835a074114
-  data.tar.gz: 29ac8776f5ecb0230313e9c5f7b97b92dddd0d6917889cd193b4b34be4d58e9ee6f268039c249cbba0aa73dc1b71c194d4c9671bf76118713f5fd352a035725e
+  metadata.gz: 58e04398a9606724c7402017ae51257aee8b161cccb7a1342ebc6e802cea9397a19413354a6e68939425717e6ec7bb18f1b16d325aa4ba6e9fabd87df1c385f8
+  data.tar.gz: 3bbe1081caeebf61a7f96bb529ccd54dcac0d8f5e06afa08bcb97399fee82188d21a728577c85ca68fee5da64a60a4aac3b8c26286b818ef5d82f72139c083a4

data/VERSION

@@ -1 +1 @@
-2.4.0
+2.5.0

data/bin/template/content/styles/print.scss

@@ -7,3 +7,21 @@ header {
     display: none;
   }
 }
+
+// Table of contents
+ol.index-entries {
+  margin-bottom: 0;
+}
+
+ol.index-entries[depth="0"] {
+  li {
+    font-weight: bold;
+  }
+}
+
+ol.index-entries[depth="1"] {
+  margin-bottom: 1em;
+  li {
+    font-weight: normal;
+  }
+}

data/bin/template/content/styles/screen.scss

@@ -398,5 +398,10 @@ tbody th {
   text-align:left;
 }
 
+// Hide table of contents in screen-mode
+ol.index-entries {
+  display: none;
+}
+
 @import "shared.scss";
 @import "shared_override.scss";

data/bin/template/content/styles/shared.scss

@@ -76,3 +76,23 @@ dl {
 var {
   font-style: italic;
 }
+
+main {
+  h1.no-label-increment,
+  h2.no-label-increment,
+  h3.no-label-increment,
+  h4.no-label-increment,
+  h5.no-label-increment {
+    &::before {
+      content: "";
+    }
+  }
+}
+
+ol.index-entries {
+  list-style-type: decimal;
+
+  li {
+    margin-left: 1em;
+  }
+}

data/lib/scholarmarkdown/filter/acronym.rb

@@ -3,11 +3,31 @@ require 'csv'
 # A filter for displaying full names of acronyms
 Nanoc::Filter.define(:scholar_acronym) do |content, params|
   acronyms = CSV.parse(params[:acronyms].raw_content, :headers => true)
+  
+  # Annotate all occurrences with their full name
   transformed = content.dup
   acronyms.each do |row|
-    transformed.gsub! %r{(?<=[^a-zA-Z0-9])#{row['abbreviation']}(?=[^a-zA-Z0-9])} do |match|
+    transformed.gsub! %r{(?<=[\s\.,!?])#{row['abbreviation']}(?=[\s\.,!?])} do |match|
       %{<abbr title='#{row['full']}'>#{row['abbreviation']}</abbr>}
     end
   end
+  
+  # Inject acronyms list
+  transformed = transformed.gsub! %r{<div id="scholarmarkdown-acronyms-list"></div>} do |match|
+    serialize_acronyms acronyms
+  end
+  
   transformed
 end
+
+# Serialize the list of acronyms to a table
+def serialize_acronyms acronyms
+  table = "<table class=\"acronyms\">"
+  
+  acronyms.each do |row|
+    table += "<tr><th>#{row['abbreviation']}</th><td>#{row['full']}</td></tr>"
+  end
+  
+  table += "</table>"
+  table
+end

data/lib/scholarmarkdown/filter/labelify.rb

@@ -1,40 +1,61 @@
 # Add labels to elements such as figures and sections, and make them referencable.
-Nanoc::Filter.define(:scholar_labelify) do |content|
+
+DOCUMENT_SECTIONS = [
+  'Chapter',
+  'Section',
+  'Subsection',
+  'Subsubsection'
+]
+
+Nanoc::Filter.define(:scholar_labelify) do |content, params|
+  if params[:chapters]
+    document_sections = DOCUMENT_SECTIONS
+  else
+    document_sections = DOCUMENT_SECTIONS[1, DOCUMENT_SECTIONS.length]
+  end
+
   content = content.dup
-  
-  labels = create_labels content
+  sections_index = []
+
+  labels = create_labels document_sections, sections_index, content
   add_labels_to_figures content, labels
   set_reference_labels content, labels
   
+  serialize_sections_index sections_index, params[:sections_index_depth] || 3, content
+
   content
 end
 
 # Creates labels for referenceable elements
-def create_labels content
+def create_labels document_sections, sections_index, content
   @reference_counts = {}
   main = content[%r{<main>.*</main>}m]
   appendix = content[%r{<div id="appendix"[^>]*>.*</div>}m] || ""
-  labels = (main + appendix).scan(/<(\w+)([^>]*\s+id="([^"]+)"[^>]*)>/)
-               .map do |tag, attribute_list, id|
-    type = label_type_for tag.downcase.to_sym, attribute_list
-    number = number_for type
+  labels = (main + appendix).scan(/<(\w+)([^>]*\s+id="([^"]+)"[^>]*)>([^<]*)(?=<)/)
+               .map do |tag, attribute_list, id, name|
+    attributes = parse_attributes(attribute_list)
+    type = label_type_for document_sections, tag.downcase.to_sym, attributes
+    number = 0
+    if attributes[:class].nil? or !attributes[:class].include? 'no-label-increment'
+      number = number_for document_sections, type, name, id, sections_index
+    end
     [id, "#{type} #{number}"]
   end
   labels.to_h
 end
 
 # Determines the label type of a given element
-def label_type_for tag, attribute_list
+def label_type_for document_sections, tag, attributes
   case tag
   when :h2
-    'Section'
+    document_sections[0]
   when :h3
-    'Subsection'
+    document_sections[1]
   when :h4
-    'Subsubsection'
+    document_sections[2]
   when :figure
-    unless parse_attributes(attribute_list)[:class].nil?
-      for clazz in parse_attributes(attribute_list)[:class].split(' ') do
+    unless attributes[:class].nil?
+      for clazz in attributes[:class].split(' ') do
         case clazz
         when 'algorithm'
           return 'Algorithm'
@@ -44,6 +65,8 @@ def label_type_for tag, attribute_list
           return 'Table'
         when 'equation'
           return 'Equation'
+        when 'subfigure'
+          return 'Subfig.'
         end
       end
     end
@@ -53,27 +76,46 @@ def label_type_for tag, attribute_list
   end
 end
 
-def number_for type
+def number_for document_sections, type, name, id, sections_index
   # Determine number of elements
   @reference_counts[type] ||= 0
   number = @reference_counts[type] += 1
 
   # Perform hierarchical numbering when needed
   case type
-  when 'Section'
-    @reference_counts['Subsection'] = 0
-    @reference_counts['Subsubsection'] = 0
-  when 'Subsection'
-    @reference_counts['Subsubsection'] = 0
-    number = "#{reference_counts['Section']}.#{number}"
-  when 'Subsubsection'
-    number = "#{reference_counts['Section']}.#{reference_counts['Subsection']}.#{number}"
+  when document_sections[0]
+    @reference_counts[document_sections[1]] = 0
+    @reference_counts[document_sections[2]] = 0
+    sections_index[@reference_counts[document_sections[0]] - 1] = { :name => name, :id => id, :children => [] }
+  when document_sections[1]
+    @reference_counts[document_sections[2]] = 0
+    number = "#{reference_counts[document_sections[0]]}.#{number}"
+    sections_index[@reference_counts[document_sections[0]] - 1][:children][@reference_counts[document_sections[1]] - 1] = { :name => name, :id => id, :children => [] }
+  when document_sections[2]
+    number = "#{reference_counts[document_sections[0]]}.#{reference_counts[document_sections[1]]}.#{number}"
+    sections_index[@reference_counts[document_sections[0]] - 1][:children][@reference_counts[document_sections[1]] - 1][:children][@reference_counts[document_sections[2]] - 1] = { :name => name, :id => id, :children => [] }
+  when 'Fig.'
+    @reference_counts['Subfig.'] = 0
+  when 'Subfig.'
+    number = "#{reference_counts['Fig.']}.#{number}"
   end
   number
 end
 
 # Adds labels to referenceable figures
 def add_labels_to_figures content, labels
+  # Subfigures
+  content.gsub! %r{<figure[^>]*\s+id="([^"]+)"\s+class="[^"]*subfigure[^"]*".*?<figcaption>(?:\s*<p>)?}m do |match|
+    id=$1
+    match = match.sub! '<figcaption>', '<figcaption class="for-subfigure">'
+    if labels.key? id
+      %{#{match}<span class="label">#{h labels[id]}:</span> }
+    else
+      match
+    end
+  end
+
+  # Main figures
   content.gsub! %r{<figure[^>]*\s+id="([^"]+)".*?<figcaption>(?:\s*<p>)?}m do |match|
     if labels.key? $1
       %{#{match}<span class="label">#{h labels[$1]}:</span> }
@@ -100,3 +142,25 @@ def parse_attributes attribute_list
                 .map { |k,v| [k.downcase.to_sym, v] }
                 .to_h
 end
+
+# Replace '<div id="toc-index"></div>' with the sections index
+def serialize_sections_index sections_index, max_depth, content
+  content.gsub! %r{<div id="scholarmarkdown-toc-index"></div>} do |match|
+    serialize_sections_index_row sections_index, max_depth, 0, true
+  end
+end
+
+# Serialize a single row of index entries, and recursively create the index for sub-entries
+def serialize_sections_index_row sections_index, max_depth, depth, root
+  if max_depth == 0
+    return ""
+  end
+
+  table = "<ol class=\"#{root ? "index-entries index-entries-root" : "index-entries"}\" depth=\"#{depth}\">"
+  sections_index.each do |section|
+    index_sub = serialize_sections_index_row section[:children], max_depth - 1, depth + 1, false
+    table += "<li><a href=\"##{section[:id]}\" class=\"index-entry-name\">#{section[:name]}</a>#{index_sub}</li>"
+  end
+  table += "</ol>"
+  table
+end

data/lib/scholarmarkdown/snippets.rb

@@ -4,13 +4,17 @@ require 'erb'
 include ERB::Util
 
 # Create a section block with the given file contents
-def section id
+def section id, classes = nil
+  section_suffix=''
+  if classes
+    section_suffix=" class=\"" + classes + "\""
+  end
   item = @items["/#{id.to_s}.*"]
   if not item
     raise "Could not find the file '" + id.to_s + "'"
   end
   <<-HTML
-<section markdown="block">
+<section markdown="block"#{section_suffix}>
 #{item.raw_content}
 </section>
   HTML

data/scholarmarkdown.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: scholarmarkdown 2.4.0 ruby lib
+# stub: scholarmarkdown 2.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "scholarmarkdown".freeze
-  s.version = "2.4.0"
+  s.version = "2.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Ruben Taelman".freeze]
-  s.date = "2019-07-01"
+  s.date = "2019-07-22"
   s.email = "rubensworks@gmail.com".freeze
   s.executables = ["generate-scholarmarkdown".freeze]
   s.extra_rdoc_files = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scholarmarkdown
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Ruben Taelman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n