oo2md2tex 0.0.1

data/Format.md

@@ -0,0 +1,72 @@
+# Modified Markdown format for md2tex
+
+This document describes modified markdown format for md2tex.
+
+# Interpretation of Markdown to TeX
+
+md2tex's format a minor extension to John Gruber's [Markdown][markdown] format.
+
+[markdown]: http://daringfireball.net/projects/markdown/
+
+To avoid possible incompatibilities, tried to minimize the extension.
+Followings are the extensions implemented in md2tex.
+
+Basically, `md2tex`  can output either TeX or LaTeX text.
+
+
+## Section name interpretation
+
+Markdown's section titles are mapped directly into LaTeX's counterpart.
+
+If a section name may include `[label]` at the end of title for the label
+for the given section name. The output will be `\label{LABEL}` appended to the
+section name.
+
+LaTeX section command accepts optional _shorter_ title use for the
+table-of-contents. you can specify this by using vertical bar like
+this:
+
+    # longer_title | shorter_title [LABEL]
+
+
+## Comments
+
+Characters after `%` treated as comments and no interpretations performed,
+write to output as-is.
+
+
+## LaTeX environments' items
+
+Lines prefixed with number, dot and space like `1. ` is treated as a enumerated list item.
+
+Lines prefixed with dash and space like `- ` is treated as a itemized list. Each of them are translated into `\item ` LaTeX commands.
+
+Lines start with a text surrounded by double parenthesis like `((TEXT))` is a items with text. This text is translated into `\item[TEXT]` command.
+
+## Labels/Citations
+
+References are denoted by `[citation-key]`.
+Multiple citations are allowed inside a bracket like this: `[cite_a, cite_b, cite_c]`.
+
+Note that, writing citation with `[cite_a][cite_b]` is confusing to use with regard to Markdown syntax. Either separating these two with `[cite_a]\relax[\cite_b]` or such trick may be possible.
+
+### Label format
+
+Labels references are denoted by `[label-name]`. For labels inside the document
+(non-citations) need to have prefixes.
+
+- `sec:`
+- `subsec:`
+- `subsubsec:`
+- `fig:` or `figure:`
+- `tab:` or `table:`
+
+### Special references
+
+- `[this:sec]`
+- `[this:subsec]`
+- `[this:subsubsec]`
+- `[prev:sec]` or `[previous:sec]`
+- `[prev:subsec]` or `[prev:subsec]`
+- `[prev:subsubsec]` or `[previous:subsubsec]`
+

data/bin/md2tex

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+#
+#    Copyright (c)2012 Shigeya Suzuki
+#
+#    Permission to use, copy, modify, and/or distribute this software for any
+#    purpose with or without fee is hereby granted, provided that the above
+#    copyright notice and this permission notice appear in all copies.
+#
+#    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+#    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+#    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+#    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+#    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+#    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+#    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+if RUBY_VERSION >= "1.9"  # encoding only supported in Ruby 1.9.x
+  Encoding.default_external = "UTF-8"
+end
+
+$script_base_dir = File.dirname(__FILE__)+"/../lib"
+$:.unshift($script_base_dir)
+
+require 'redcarpet'
+require 'markdown_to_tex'
+
+processor = MarkdownToTeX::Processor.new
+
+all = ""
+ARGV.each do |f|
+  i = File.read(f) 
+  s = processor.process(i)
+  puts processor.job_signature
+  puts s
+  all += s
+end
+
+all.gsub!(/%.*/, '')
+all.gsub!(/\s+/, ' ')
+all.gsub!(/\\(begin|end){[^}]+}/, '')
+#all.gsub!(/\\(LL|REP|DEL|REPX|DELX)[^}]+/, '')
+all.gsub!(/\\([A-Za-z]+)/, '')
+#all.gsub!(/L:[A-Za-z1-9]+/, '')
+all.gsub!(/\s+/, '')
+all.gsub!(/\{|\}/, '')
+puts "% Text length: #{all.size} chars"

data/bin/oo2text

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+#
+#    Copyright (c)2012 Shigeya Suzuki
+#
+#    Permission to use, copy, modify, and/or distribute this software for any
+#    purpose with or without fee is hereby granted, provided that the above
+#    copyright notice and this permission notice appear in all copies.
+#
+#    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+#    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+#    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+#    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+#    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+#    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+#    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+require 'optparse'
+require 'nokogiri'
+require 'zlib'
+
+module OmniOutliner
+
+  class Document < Nokogiri::XML::SAX::Document
+    def initialize
+      @in_item = false
+      @in_style = false
+      @str = ""
+      super
+    end
+    
+    def characters(s)
+      @str += s if @in_item && !@in_style
+    end
+    
+    def start_element(name, attrs)
+      @in_item = true if name == "item"
+      @in_style = true if name == "style"
+    end
+  
+    def end_element(name)
+      @in_item = false if name == "item"
+      @in_style = false if name == "style"
+      if name == "values"
+        @str.gsub(/\n/, '')
+        puts @str
+        @str = ""
+      end
+    end
+  end
+  
+  class Parser < Nokogiri::XML::SAX::Parser
+    def initialize(fn)
+      @file = nil
+      if fn =~ /\.oo3$/
+        fn = "#{fn}/contents.xml"
+        @file = Zlib::GzipReader.new(File.open(fn))
+      else 
+        @file = File.open(fn, rm)
+      end
+      super(Document.new)
+    end
+    
+    def parse
+      super(@file)
+    end
+  end
+
+end
+
+ARGV.options do |o|
+  o.banner = "ruby #{$0} [options] OmniOutliner-Document-Package"
+  o.separator "Options:"
+  o.parse!
+end
+
+ARGV.each do |file|
+  parser = OmniOutliner::Parser.new(file)
+  parser.parse
+end

data/lib/markdown_to_tex.rb

@@ -0,0 +1,19 @@
+require_relative 'markdown_to_tex/renderer'
+require_relative 'markdown_to_tex/text_processor'
+require_relative 'markdown_to_tex/processor'
+
+#
+#    Copyright (c)2012 Shigeya Suzuki
+#
+#    Permission to use, copy, modify, and/or distribute this software for any
+#    purpose with or without fee is hereby granted, provided that the above
+#    copyright notice and this permission notice appear in all copies.
+#
+#    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+#    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+#    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+#    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+#    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+#    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+#    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#

data/lib/markdown_to_tex/processor.rb

@@ -0,0 +1,81 @@
+#
+#    Copyright (c)2012 Shigeya Suzuki
+#
+#    Permission to use, copy, modify, and/or distribute this software for any
+#    purpose with or without fee is hereby granted, provided that the above
+#    copyright notice and this permission notice appear in all copies.
+#
+#    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+#    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+#    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+#    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+#    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+#    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+#    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+require 'date'
+
+module MarkdownToTeX
+
+  class Processor
+  
+    attr_reader :git_branch_name, :git_wd_hash, :git_hash_wd_long,
+                :git_commit_line, :git_status, :git_status_long,
+                :git_describe,
+                :run_stamp
+
+    def initialize
+      @run_stamp = DateTime.now.to_s
+
+      IO.popen("git branch -v --no-abbrev").each do |l|
+        if l =~ /(\*|.)\s+(\S+)\s+([0-9a-f]+)\s(.*)/
+          if $1 == "*"
+            @git_branch_name = $2
+            @git_wd_hash_long = $3
+            @git_wd_hash = @git_wd_hash_long[0,6]
+            @git_commit_line = $4
+            @git_commit_line.gsub!(/\#/, '\#')
+            @git_commit_line.gsub!(/\%/, '\%')
+            @git_commit_line.gsub!(/\[ahead.*\] /, '')
+            @git_status = @git_wd_hash + ": " + @git_commit_line
+            @git_status_long = @git_commit_line + '\\\\\\\\' + @git_wd_hash_long + '\\\\\\\\' + @git_branch_name
+          end
+        end
+      end
+      
+
+      @git_describe = "(no names found for git describe)"
+      
+      IO.popen("git describe --dirty --long").each do |l|
+        if l =~ /(.*)/
+          @git_describe = $1
+        end
+      end
+
+      @macros = {
+        "__OO2_RUN_STAMP__" => @run_stamp,
+        "__OO2_GIT_DESCRIBE__" => @git_describe,
+        "__OO2_GIT_STATUS__" => @git_status,
+        "__OO2_GIT_STATUS_LONG__" => @git_status_long,
+        "__OO2_GIT_HASH_LONG__" => @git_wd_hash_long
+      }
+    end
+
+    def process(text)
+      @renderer = Redcarpet::Markdown.new(MarkdownToTeX::Renderer)
+      TextProcessor.process_final(@renderer.render(text), @macros)
+    end
+    
+    def job_signature; <<-EOS.gsub(/^\s+%/, '%')
+      % oo-tex.rb run at #{@run_stamp}
+      % description: #{@git_describe}
+      % revision: #{@git_wd_hash_long}
+      % commit log:
+      % #{@git_commit_line}
+      EOS
+    end
+
+  end
+
+end

data/lib/markdown_to_tex/renderer.rb

@@ -0,0 +1,127 @@
+#
+#    Copyright (c)2012 Shigeya Suzuki
+#
+#    Permission to use, copy, modify, and/or distribute this software for any
+#    purpose with or without fee is hereby granted, provided that the above
+#    copyright notice and this permission notice appear in all copies.
+#
+#    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+#    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+#    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+#    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+#    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+#    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+#    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+module MarkdownToTeX
+  class Renderer < Redcarpet::Render::Base
+    # Block-level calls
+    # If the return value of the method is `nil`, the block
+    # will be skipped.
+    # If the method for a document element is not implemented,
+    # the block will be skipped.
+    # 
+    # Example:
+    #
+    #   class RenderWithoutCode < Redcarpet::Render::HTML
+    #     def block_code(code, language)
+    #       nil
+    #     end
+    #   end
+    #
+    def block_code(code, language)
+      wrap_environment("verbatim", code)
+    end
+    
+    ## block_quote(quote)
+    ## block_html(raw_html)
+    def header(text, header_level)
+      TextProcessor.process_header(text, header_level)
+    end
+    
+    ## hrule()
+
+    def list(contents, list_type)
+      environment = case list_type
+                      when "ordered" then "enumerated"
+                      when "unordered" then "itemize"
+                      end
+      wrap_environment("itemize", contents)
+    end
+
+    def list_item(text, list_type)
+      "\\item #{text}\n"
+    end
+
+    def paragraph(text)
+      TextProcessor.process_paragraph(text)+"\n\n"
+    end
+    
+    ## table(header, body)
+    ## table_row(content)
+    ## table_cell(content, alignment)
+    
+    # Span-level calls
+    # A return value of `nil` will not output any data
+    # If the method for a document element is not implemented,
+    # the contents of the span will be copied verbatim
+    def autolink(link, link_type)
+      "{{autolink:<#{link}>, title:<#{title}>, content:<#{content}>}}"
+    end
+
+    def codespan(code)
+      qchar = if code =~ /\+/ then "!" else "+" end
+      "\\verb#{qchar}#{code}#{qchar}"
+    end
+    ## double_emphasis(text)
+    ## emphasis(text)
+    ## image(link, title, alt_text)
+    def linebreak()
+      "\n%\n"
+    end
+
+    def link(link, title, content)
+      "#{content}\\nobreak\\footnote{\\url{#{link}}}"
+    end
+
+    def raw_html(raw_html)
+      raw_html
+    end
+    
+    ## triple_emphasis(text)
+    ## strikethrough(text)
+    ## superscript(text)
+    
+    # Low level rendering
+    ## entity(text)
+    ## normal_text(text)
+    
+    # Header of the document
+    # Rendered before any another elements
+    def doc_header()
+      "% start-of-output\n"
+    end
+    
+    # Footer of the document
+    # Rendered after all the other elements
+    def doc_footer()
+      "\n% end-of-output"
+    end
+    
+    # Pre/post-process
+    # Special callback: preprocess or postprocess the whole
+    # document before or after the rendering process begins
+    ## preprocess(full_document)
+    ## postprocess(full_document)
+    
+    
+  private
+    def wrap_environment(environment, text)
+      "\\begin{#{environment}}\n"+
+      text +
+      "\\end{#{environment}}\n"
+    end
+
+  end
+end

data/lib/markdown_to_tex/text_processor.rb

@@ -0,0 +1,131 @@
+#
+#    Copyright (c)2012 Shigeya Suzuki
+#
+#    Permission to use, copy, modify, and/or distribute this software for any
+#    purpose with or without fee is hereby granted, provided that the above
+#    copyright notice and this permission notice appear in all copies.
+#
+#    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+#    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+#    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+#    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+#    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+#    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+#    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+module MarkdownToTeX
+  class TextProcessor
+
+    @@tag_namespace = nil
+    @@cite_map = {}
+    @@level_tag =  ["chapter", "section", "subsection", "subsubsection"]
+    @@level_shift = 0
+
+    # Process a paragraph
+    def self.process_paragraph(text)
+      text.gsub!(/\(\((.*)\)\)/, '\\ITEM{\1}') # description format
+      self.reference(text)
+    end
+
+    # Citation Handling
+
+    def self.bib_name_map(n)
+      @@cite_map.has_key?(n) ? @@cite_map[n] : n
+    end
+
+    def self.tag_name_map(n)
+      return "" if n == nil
+      if @@tag_namespace == nil or n =~ /#{@@tag_namespace}:/
+        return n
+      end
+      @@tag_namespace + ":" + n
+    end
+
+    def self.label_name_map(n)
+      if @@tag_namespace == nil
+        return bib_name_map(n)
+      end
+
+      if n =~ /(chap|part|sec|subsec|subsubsec|fig|table|eq):(.+)/
+        r = $1 + ":" + self.tag_name_map($2)
+      else
+        r = self.bib_name_map(n)
+      end
+      r
+    end
+
+    def self.ref_name_map(n)
+      self.label_name_map(n)
+    end
+
+    def self.ref_name_map_cite(k)
+      cite = "CITE"
+      text = k.split(/\s*,\s*/).each.map {|kk| self.ref_name_map(kk)}.join(",")
+      if text =~ /"(.*)"/
+        r = "[#{$1}]"
+      else
+        r = "\\#{cite}{#{text}}"
+      end
+      r
+    end
+
+    def self.reference(text)
+      text.
+           gsub(/\[(this|prev|next):(chap|part|sec|subsec|subsubsec|fig|table)\]/) { "\\#{$1}#{$2}KEY{}" }.
+           gsub(/\[((chap|part|sec|subsec|subsubsec|fig|table):[^\]]+)\]/) { "\\#{$2}REF{#{self.ref_name_map($1)}}" }.
+           gsub(/\[([^\]]+)\]/) { self.ref_name_map_cite($1);}
+    end
+
+    def self.label_split(s)
+      label = ""
+      if s.sub!(/\s*\[([^\]]+)\]/, '')
+        label = $1
+      end
+      [s, label]
+    end
+
+    def self.short_desc(s)  # map short|long
+      s_short = ""
+      if s =~ /\s*([^\|]+)\s*\|\s*(.+)\s*/
+       s_short = "[#{$1}]"
+        s = $2
+      end
+      [s, s_short]
+    end
+
+    def self.level_tag(d)
+      @@level_tag[d + @@level_shift]
+    end
+
+    # Process a header
+    def self.process_header(text, level)
+      name, label = self.label_split(text)
+      name, name_short = self.short_desc(name)
+      tag = self.level_tag(level)
+      the_label = self.label_name_map(label)
+      star = "" # star ? "*" : ""
+      s = self.comment_line(tag.upcase + ": #{name}")
+      s << "\\#{tag}#{star}#{name_short}{#{name}}"
+      s << "\\label{#{the_label}}" unless label.empty?
+      s << "\n"
+      s
+    end
+
+
+    # Process on whole output text
+
+    def self.process_final(text, macros)
+      # Macro expansions
+      macros.each {|m, v| text.gsub!(m, v) }
+      text
+    end
+
+    def self.comment_line(s)
+      px = (78 - 1 - s.length)
+      px = 1 if px < 1
+      "%" * px + " " + s + "\n"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: oo2md2tex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Shigeya Suzuki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: A barebone Markdown to TeX/LaTeX converter kit via OmniOutliner
+email: shigeya@wide.ad.jp
+executables:
+- oo2text
+- md2tex
+extensions: []
+extra_rdoc_files:
+- Format.md
+files:
+- lib/markdown_to_tex/processor.rb
+- lib/markdown_to_tex/renderer.rb
+- lib/markdown_to_tex/text_processor.rb
+- lib/markdown_to_tex.rb
+- bin/oo2text
+- bin/md2tex
+- Format.md
+homepage: http://github.com/shigeya/oo2md2tex
+licenses:
+- ISC
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: oo2text and md2tex
+test_files: []
+has_rdoc: