scholarmarkdown 1.0.0

data/lib/scholarmarkdown/filter/citation.rb

@@ -0,0 +1,18 @@
+require 'bibmarkdown'
+require 'bibtex'
+require 'csl/styles'
+
+# Sets the default directory of citation styles.
+CSL::Style.root = File.dirname(__FILE__) + '/../citationstyles'
+
+# Define a citation filter using bibmarkdown
+Nanoc::Filter.define(:scholar_citation) do |content, params|
+  bib = params[:bibfile]
+  if not bib
+    raise "Could not find bibliography file"
+  end
+  entries = BibTeX.parse(bib.raw_content).entries
+  entries.each_value { |e| e.convert!(:latex) { |key| key != :url } }
+  params = params.merge(entries: entries)
+  BibMarkdown::Document.new(content, params).to_markdown
+end

data/lib/scholarmarkdown/filter/headerids_to_section.rb

@@ -0,0 +1,7 @@
+# Moves IDs on headings to their parent section
+Nanoc::Filter.define(:scholar_headerids_to_section) do |content|
+  content = content.dup
+  content.gsub! /<section>(\s*)(<h\d[^>]*)(\sid=[^\s>]+)/,
+                '<section\3>\1\2'
+  content
+end

data/lib/scholarmarkdown/filter/hyphenate_iri.rb

@@ -0,0 +1,18 @@
+# Define a filter for hyphenating long IRIs
+Nanoc::Filter.define(:scholar_hyphenate_iri) do |content|
+  content = content.dup
+  # Replace in-text URLs
+  content.gsub! %r{>https?://[^>]+?} do |match|
+    hyphenate(match)
+  end
+  # Replace mandatory links
+  content.gsub! %r{<a href="([^"]+)"[^>]*\s+class="mandatory"} do |match|
+    %{#{match} data-link-text="#{hyphenate $1}"}
+  end
+  content
+end
+
+# Add zero-width space after slashes and hyphens to allow hyphenation
+def hyphenate text
+  text.gsub %r{(?<=/|-)}, "\u200B"
+end

data/lib/scholarmarkdown/filter/include_code.rb

@@ -0,0 +1,10 @@
+# Includes code blocks from external files
+Nanoc::Filter.define(:scholar_include_code) do |content|
+  content = content.dup
+  content.gsub! %r{````(/[^`]+)````} do
+    code = @items[$1]
+    raise "Code block #{$1} not found." unless code
+    "<pre>" + code.raw_content.lines.map{|line| "<code>#{h line}</code>"}.join() + "</pre>"
+  end
+  content
+end

data/lib/scholarmarkdown/filter/labelify.rb

@@ -0,0 +1,94 @@
+# Add labels to elements such as figures and sections, and make them referencable.
+Nanoc::Filter.define(:scholar_labelify) do |content|
+  content = content.dup
+  
+  labels = create_labels content
+  add_labels_to_figures content, labels
+  set_reference_labels content, labels
+  
+  content
+end
+
+# Creates labels for referenceable elements
+def create_labels 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
+    [id, "#{type} #{number}"]
+  end
+  labels.to_h
+end
+
+# Determines the label type of a given element
+def label_type_for tag, attribute_list
+  case tag
+  when :h2
+    'Section'
+  when :h3
+    'Subsection'
+  when :figure
+    unless parse_attributes(attribute_list)[:class].nil?
+      for clazz in parse_attributes(attribute_list)[:class].split(' ') do
+        case clazz
+        when 'algorithm'
+          return 'Algorithm'
+        when 'listing'
+          return 'Listing'
+        when 'table'
+          return 'Table'
+        end
+      end
+    end
+    'Fig.'
+  else
+    'Unknown'
+  end
+end
+
+def number_for type
+  # 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
+  when 'Subsection'
+    number = "#{reference_counts['Section']}.#{number}"
+  end
+  number
+end
+
+# Adds labels to referenceable figures
+def add_labels_to_figures content, labels
+  content.gsub! %r{<figure[^>]*\s+id="([^"]+)".*?<figcaption>(?:\s*<p>)?}m do |match|
+    if labels.key? $1
+      %{#{match}<span class="label">#{h labels[$1]}:</span> }
+    else
+      match
+    end
+  end
+end
+
+# Sets the labels of unlabeled references in the text
+def set_reference_labels content, labels
+  content.gsub! %r{(<a href="#([^"]+)">)(</a>)} do |match|
+    if labels.key? $2
+      "#{$1}#{h labels[$2]}#{$3}"
+    else
+      match
+    end
+  end
+end
+
+# Parses a string of HTML attributes
+def parse_attributes attribute_list
+  attribute_list.scan(/\s*(\w+)\s*=\s*"([^"]+)"\s*/)
+                .map { |k,v| [k.downcase.to_sym, v] }
+                .to_h
+end

data/lib/scholarmarkdown/filter/references_to_footer.rb

@@ -0,0 +1,10 @@
+# Moves the references section into <footer>
+Nanoc::Filter.define(:scholar_references_to_footer) do |content|
+  content = content.dup
+  references = content[%r{<h2 id="references">.*?</dl>}m]
+  if references
+    content[references] = ''
+    content['</footer>'] = "<section>\n" + references + "\n</section>\n</footer>"
+  end
+  content
+end

data/lib/scholarmarkdown/snippets.rb

@@ -0,0 +1,28 @@
+require 'erb'
+
+# Proper escaping of IRIs
+include ERB::Util
+
+# Create a section block with the given file contents
+def section id
+  item = @items["/#{id.to_s}.*"]
+  if not item
+    raise "Could not find the file '" + id.to_s + "'"
+  end
+  <<-HTML
+<section markdown="block">
+#{item.raw_content}
+</section>
+  HTML
+end
+
+# Create a person block
+def person name, website, profile
+  if not website
+    h name
+  elsif not profile
+    %{<a href="#{h website}">#{h name}</a>}
+  else
+    %{<a href="#{h website}" typeof="http://xmlns.com/foaf/0.1/Person" resource="#{profile}">#{h name}</a>}
+  end
+end

data/lib/scholarmarkdown.rb

@@ -0,0 +1,2 @@
+require 'scholarmarkdown/snippets'
+require 'scholarmarkdown/filter/*'

data/scholarmarkdown.gemspec

@@ -0,0 +1,96 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: scholarmarkdown 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "scholarmarkdown"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Ruben Taelman"]
+  s.date = "2018-04-19"
+  s.email = "rubensworks@gmail.com"
+  s.executables = ["generate-scholarmarkdown"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/generate-scholarmarkdown",
+    "bin/template/.gitignore",
+    "bin/template/Gemfile",
+    "bin/template/Guardfile",
+    "bin/template/README.md",
+    "bin/template/Rules",
+    "bin/template/config.ru",
+    "bin/template/content/abstract.md",
+    "bin/template/content/index.md.erb",
+    "bin/template/content/introduction.md",
+    "bin/template/content/references.bib",
+    "bin/template/content/styles/lncs.scss",
+    "bin/template/content/styles/print.scss",
+    "bin/template/content/styles/reset.scss",
+    "bin/template/content/styles/screen.scss",
+    "bin/template/content/styles/shared.scss",
+    "bin/template/layouts/default.html.erb",
+    "bin/template/nanoc.yaml",
+    "lib/scholarmarkdown.rb",
+    "lib/scholarmarkdown/citationstyles/lncs-custom.csl",
+    "lib/scholarmarkdown/filter/acronym.rb",
+    "lib/scholarmarkdown/filter/citation.rb",
+    "lib/scholarmarkdown/filter/headerids_to_section.rb",
+    "lib/scholarmarkdown/filter/hyphenate_iri.rb",
+    "lib/scholarmarkdown/filter/include_code.rb",
+    "lib/scholarmarkdown/filter/labelify.rb",
+    "lib/scholarmarkdown/filter/references_to_footer.rb",
+    "lib/scholarmarkdown/snippets.rb",
+    "scholarmarkdown.gemspec"
+  ]
+  s.homepage = "http://github.com/rubensworks/ScholarMarkdown"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.5.1"
+  s.summary = "A framework for writing markdown-based scholarly articles."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<bibtex-ruby>, [">= 0"])
+      s.add_runtime_dependency(%q<latex-decode>, [">= 0"])
+      s.add_runtime_dependency(%q<citeproc-ruby>, [">= 1.1.6"])
+      s.add_runtime_dependency(%q<csl-styles>, [">= 0"])
+      s.add_runtime_dependency(%q<bibmarkdown>, ["~> 1.3.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<juwelier>, ["~> 2.4.7"])
+    else
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<bibtex-ruby>, [">= 0"])
+      s.add_dependency(%q<latex-decode>, [">= 0"])
+      s.add_dependency(%q<citeproc-ruby>, [">= 1.1.6"])
+      s.add_dependency(%q<csl-styles>, [">= 0"])
+      s.add_dependency(%q<bibmarkdown>, ["~> 1.3.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<juwelier>, ["~> 2.4.7"])
+    end
+  else
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<bibtex-ruby>, [">= 0"])
+    s.add_dependency(%q<latex-decode>, [">= 0"])
+    s.add_dependency(%q<citeproc-ruby>, [">= 1.1.6"])
+    s.add_dependency(%q<csl-styles>, [">= 0"])
+    s.add_dependency(%q<bibmarkdown>, ["~> 1.3.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<juwelier>, ["~> 2.4.7"])
+  end
+end
+

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: scholarmarkdown
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ruben Taelman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bibtex-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: latex-decode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: citeproc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+- !ruby/object:Gem::Dependency
+  name: csl-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bibmarkdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.7
+description: 
+email: rubensworks@gmail.com
+executables:
+- generate-scholarmarkdown
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/generate-scholarmarkdown
+- bin/template/.gitignore
+- bin/template/Gemfile
+- bin/template/Guardfile
+- bin/template/README.md
+- bin/template/Rules
+- bin/template/config.ru
+- bin/template/content/abstract.md
+- bin/template/content/index.md.erb
+- bin/template/content/introduction.md
+- bin/template/content/references.bib
+- bin/template/content/styles/lncs.scss
+- bin/template/content/styles/print.scss
+- bin/template/content/styles/reset.scss
+- bin/template/content/styles/screen.scss
+- bin/template/content/styles/shared.scss
+- bin/template/layouts/default.html.erb
+- bin/template/nanoc.yaml
+- lib/scholarmarkdown.rb
+- lib/scholarmarkdown/citationstyles/lncs-custom.csl
+- lib/scholarmarkdown/filter/acronym.rb
+- lib/scholarmarkdown/filter/citation.rb
+- lib/scholarmarkdown/filter/headerids_to_section.rb
+- lib/scholarmarkdown/filter/hyphenate_iri.rb
+- lib/scholarmarkdown/filter/include_code.rb
+- lib/scholarmarkdown/filter/labelify.rb
+- lib/scholarmarkdown/filter/references_to_footer.rb
+- lib/scholarmarkdown/snippets.rb
+- scholarmarkdown.gemspec
+homepage: http://github.com/rubensworks/ScholarMarkdown
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A framework for writing markdown-based scholarly articles.
+test_files: []