wtex 0.1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Akira FUNAI <akira -at- funai -dot- com>
+
+Permission is hereby granted, free of charge, to any person obtaining a 
+copy of this software and associated documentation files (the "Software"), 
+to deal in the Software without restriction, including without limitation 
+the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+and/or sell copies of the Software, and to permit persons to whom the 
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in 
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
+DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,2 @@
+See README.ja.* :-)
+README.en is on the way.

data/README.ja.txt

@@ -0,0 +1,249 @@
+!!! このソフトについて
+
+WTeXは、WikiマークアップとTeXマークアップが混在した文書から、LaTeXでタイプセット可能なTeX文書を生成するユーティリティです。段落・見出し・強調・ルビなどのマークアップを、可読性の高いWiki形式で記述し、make一発でTeX→PDFに変換することができます。また、TeXマークアップを混在させることで、高度なレイアウトや数式も表現可能です。
+
+ソース:
+|このように、***Wiki***と{\LARGE\bf TeX}の混在した文書《ソース》から、PDFが作れます。
+
+出力:
+]このように、***Wiki***と{\LARGE\bf TeX}の混在した文書《ソース》から、PDFが作れます。
+
+※作者本人は、プレーンテキスト→縦書きPDFがやりたかっただけなので、その他の機能はオマケ気味です。それなりに御用心ください。ライセンスにもある通り、完全に無保証です。
+
+!!! インストールと実行
+
+!! 必要条件
+
+WTeXでPDFを出力するには、以下のソフトが必要です。
+
+* Ruby 1.8/1.9
+* UTF-8を扱えるLaTeX環境（TeX Live 2010、MacTeXで確認しています）
+* GNU互換make
+
+!! インストール
+
+| gem install wtex
+
+!! PDFの作成
+
+適当なディレクトリで、以下を実行します。
+
+| wikitex init my_project
+
+生成されたディレクトリ「my_project」には、以下のファイルがコピーされています。
+
+| Makefile
+| body.txt
+| head.tex
+| tmpl.tex.report
+| tmpl.tex.tbook
+| out/
+
+最初に、tmpl.tex.*のいずれかをtmpl.texとしてコピーします。tmpl.tex.reportが横書き、tmpl.tex.tbookが縦書きのサンプルです。
+
+| cp -p tmpl.tex.report tmpl.tex
+
+body.txtに、Wiki/TeXマークアップでソースを記述します。head.texには文書タイトルや著者情報が、tmpl.texにはTeX文書の外枠がありますので、これらも必要に応じて適宜編集してください。完成したら、
+
+| make
+
+で、（うまく行けば）ディレクトリ内に「body.tex」および「book.pdf」が生成されます。
+
+!! Ruby からの利用
+
+| require 'rubygems'
+| require 'wtex'
+|
+| wt  = WTeX.new
+| tex = wt.tex '***Wiki***{\LARGE\bf TeX}'
+
+!!! マークアップ
+
+!! 段落と改行
+
+段落の区切りは空行（TeXと同じです）。
+ただし、TeXと違い、段落内の改行は、そのまま反映されます。
+
+段落頭の字下げは、デフォルトでは手動です。
+
+!! Wikiマークアップ
+
+! 見出し
+
+１〜３ケの「!」を行の頭に置くと、それぞれ小節・節・章の見出しになります。また、「!」の直後に「*」を付けると、連番が出力されなくなります。
+
+ソース:
+| !!! 章
+| !! 節
+| ! 小節
+| !* 小節（番号なし）
+
+! 区切り
+
+ハイフン３つ「---」を行の頭に置くと、小節の区切り記号になります。
+
+---
+
+! 強調
+
+２〜４ヶの「*」で文章を囲むと、その範囲が***強調***（デフォルトでは太字＆大文字）されます。「*」を増やすほど、大きな文字になります。
+
+ソース:
+| これは****ひどい****。
+
+出力:
+] これは****ひどい****。
+
+! 傍点・アンダーライン
+
+２ケの「_」で文章を囲むと、その範囲に__傍点__（横書きの場合、アンダーライン）が適用されます。
+
+ソース:
+| これは__ひどい__。
+
+出力:
+] これは__ひどい__。
+
+! ルビ
+
+「\verb|ルビ《るび》|」のように記述すると、ルビ《るび》を振ることができます。ルビの適用範囲は自動的に判定されますが、複合語などの場合、「|」記号で区切ることで、部分|指定《してい》も可能です（青空文庫形式に準拠）。
+
+ソース:
+| これは酷《ひど》い三|馬鹿《ばか》ですね。
+
+出力:
+] これは酷《ひど》い三|馬鹿《ばか》ですね。
+
+! ボックス
+
+行の先頭に「]」記号、または「|」記号を置くと、その行は枠付きボックスとして表示されます。行の直前に「foo.rb:」のようにコロン「:」で終わる行を書くと、ボックスのタイトルとして扱われます。「]」で始まるブロックの内部では、WikiマークアップおよびTeXマークアップが利用可能です。「|」で始まるブロックの内部では、WikiマークアップもTeXマークアップも使用できず、ソースの文字がすべてそのまま表示されます。
+
+ソース:
+| foo_bar.tex:
+| ]foo,bar,
+| ]{\large\bf bar},**baz**
+
+\begin{WTbox}{出力（マークアップが評価される）}
+\begin{WTbox}{foo\_{}bar.tex}
+foo,bar,\\
+{\large\bf bar},{\large\bf baz}
+\end{WTbox}
+\end{WTbox}
+
+ソース:
+| foo_bar.tex:
+| |foo,bar,
+| |{\large\bf bar},**baz**
+
+\begin{WTbox}{出力（マークアップは評価されない）}
+\begin{WTcode}{foo\_{}bar.tex}
+foo,bar,
+{\large\bf bar},**baz**
+\end{WTcode}
+\end{WTbox}
+
+! 引用
+
+行の先頭に「>」記号を置くと、その行は引用として扱われます。引用の内部では、WikiマークアップおよびTeXマークアップが利用可能です。
+
+ソース:
+| >吾輩は猫である。
+| >名前は__まだ無い__。
+
+\begin{WTbox}{出力}
+\begin{quote}
+吾輩は猫である。\\
+名前は\WTunderline{まだ無い}。
+\end{quote}
+\end{WTbox}
+
+! リスト
+
+行の先頭に「*」または「+」記号を置くと、その行はリストアイテムとして扱われます。「*」は序数なし、「+」だと序数ありです。強調の「\verb|**foo**|」と区別するため、記号とアイテムの間には、必ず空白を入れてください。
+
+ソース:
+| * foo
+| * bar
+| *baz←くっつけて書くとリストにならない
+
+\begin{WTbox}{出力}
+\begin{itemize}
+\item foo
+\item bar
+\end{itemize}
+*baz←くっつけて書くとリストにならない
+\end{WTbox}
+
+リストを入れ子にすることもできます。
+
+ソース:
+| + foo
+| +* bar
+| +* baz
+| + qux
+
+\begin{WTbox}{出力}
+\begin{enumerate}
+\item foo\begin{itemize}
+\item bar
+\item baz
+\end{itemize}
+
+\item qux
+\end{enumerate}
+\end{WTbox}
+
+! テーブル・表
+
+今のところ、Wikiマークアップはありません。TeXで書きましょう。
+
+!! TeXとの混在
+
+! 特殊記号の自動エスケープ
+
+TeXの特殊記号は、自動的にエスケープされます。「#」「%」「@」などは、そのまま記述可能です。ただし、バックスラッシュ「\verb|\|」・ドル記号「\${}」・中括弧「\verb|{}|」の３種だけは、\verb|\verb|等によるエスケープが必要です。
+
+ソース:
+| #, %, &
+| \verb|\|, \${}, \verb|{}|
+
+出力:
+] #, %, &
+] \verb|\|, \${}, \verb|{}|
+
+! TeXコマンド、環境、グルーピング
+
+「\verb|\|」で始まるコマンド、「\verb|\begin{...}...\end{...}|」で指定された環境、「\verb|{...}|」内部のグルーピングは、Wikiをスルーして出力されるので、TeXマークアップをそのまま記述することが可能です。
+
+ソース:
+| \verb|***Wiki***|
+| \begin{huge}Wiki《るび》\end{huge}
+| {\large\bf Wiki$\heartsuit$}
+
+出力:
+] \verb|***Wiki***|
+] \begin{huge}Wiki《るび》\end{huge}
+] {\large\bf Wiki$\heartsuit$}
+
+! 数式モード
+
+「\verb|$|」または「\verb|$$|」で囲まれた内部は、TeXの数式モードとして扱われます。
+
+ソース:
+| これはひどい $x^2 + \sqrt{y}$ です。
+
+出力（テキスト数式モード）:
+] これはひどい $x^2 + \sqrt{y}$ です。
+
+ソース:
+| これはひどい $$x^2 + \sqrt{y}$$ です。
+
+出力（ディスプレイ数式モード）:
+] これはひどい $$x^2 + \sqrt{y}$$ です。
+
+
+
+!!! ライセンス
+
+配布条件はMITライセンスとします。
+詳細は、gem同梱のLICENSEでご確認ください。

data/bin/wikitex

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# Author::    Akira FUNAI
+# Copyright:: Copyright (c) 2011 Akira FUNAI
+
+require 'rubygems'
+require 'fileutils'
+
+$LOAD_PATH.unshift ::File.expand_path('../lib', ::File.dirname(__FILE__))
+require 'wtex'
+
+case ARGV.shift
+  when 'init'
+    work_name = ARGV.shift || 'my_work'
+    work_dir  = ::File.expand_path work_name
+
+    if ::File.exists? work_dir
+      $stderr.puts "#{work_dir} already exists."
+      exit 1
+    else
+      $stderr.puts "Setting up files in #{work_dir}..."
+      ::FileUtils.cp_r(
+        ::File.expand_path('../skel',WTeX.libdir),
+        work_name,
+        :verbose => :true
+      )
+    end
+  when 'correct'
+  when 'convert'
+    wt  = WTeX.new
+    src = nil
+    ::File.open('./body.txt', 'r') {|f|
+      f.flock ::File::LOCK_SH
+      src = f.read
+      f.flock ::File::LOCK_UN
+    }
+
+    tex = wt.tex src
+    ::File.open('./body.tex', 'a') {|f|
+      f.flock ::File::LOCK_EX
+      f.seek 0
+      f.truncate 0
+      f << tex
+      f.flock ::File::LOCK_UN
+    }
+  else
+    $stderr.puts 'Usage: wikitex {init NAME|correct|convert}'
+    exit 1
+end

data/lib/wtex.rb

@@ -0,0 +1,271 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# Author::    Akira FUNAI
+# Copyright:: Copyright (c) 2011 Akira FUNAI
+
+require 'strscan'
+
+class WTeX
+
+  module Characters
+    SPECIAL_MAP = {
+      '#' => '\\#{}',
+      '%' => '\\%{}',
+      '&' => '\\&{}',
+      '_' => '\\_{}',
+      '<' => '\\textless{}',
+      '>' => '\\textgreater{}',
+      '^' => '\\textasciitilde{}',
+      '|' => '\\textbar{}',
+      '~' => '\\textasciicircum{}',
+    }
+    SPECIAL = SPECIAL_MAP.keys.join
+    WITHOUT_RUBY = '\s|｜ぁ-んゝゞ　、。，．？！´｀／∥…‥‘’“”（）〔〕［］｛｝〈〉《》「」『』【】♪'
+  end
+
+  def self.libdir
+    ::File.dirname __FILE__
+  end
+
+  def tex(str)
+    _tex str
+  end
+
+  private
+
+  def _tex(str)
+    tex  = ''
+    body = ''
+    line = ''
+    type = :blank
+
+    markups  = []
+    rex_line = /(.*?)(\\|\$\$?|\{|\n|\z)/
+    s = StringScanner.new str
+
+    while !s.eos? && s.scan(rex_line)
+      line += s[1]
+
+      if s[2] =~ /\\|\$|\{/
+        line += skip_tex_markup(s, s[2], markups)
+        next unless s.match? /\z/
+      end
+
+      new_type = wiki_type(line, s)
+
+      if (new_type != type) || single_line?(type)
+        tex += __send__("element_#{type}", body.to_s)
+        body = ''
+      end
+
+      body << line << "\n"
+      type = new_type
+      line = ''
+    end
+
+    tex += __send__("element_#{type}", body.to_s)
+    tex.gsub(/\x00(\d+)/) { markups[$1.to_i] }
+  end
+
+  def skip_tex_markup(s, type, markups)
+    if type == '\\'
+      if s.scan /begin\{(.+?)\}/
+        markups << scan_inner_contents(s, "\\begin{#{s[1]}}", "\\end{#{s[1]}}")
+      elsif s.scan /verb/
+        markups << (s.scan(/(.).*?\1/) ? "\\verb#{s[0]}" : '$\backslash$verb')
+      elsif s.scan /.\w*/
+        markups << ('\\' + s[0]) # command or escaped character
+      end
+    elsif type == '$$'
+      markups << (s.scan(%r/.*?[^\\]\$\$|\$\$/m) ? "$$#{s[0]}" : '\\${}\\${}')
+    elsif type == '$'
+      markups << (s.scan(%r/.*?[^\\]\$|\$/m) ? "$#{s[0]}" : '\\${}')
+    elsif type == '{'
+      markups << scan_inner_contents(s, '{', '}')
+    else
+      return '???'
+    end
+    "\x00#{markups.size - 1}"
+  end
+
+  def scan_inner_contents(s, open_tag, close_tag)
+    contents = ''
+    rex = /(.*?)(\\?#{Regexp.quote(open_tag)}|\\?#{Regexp.quote(close_tag)}|\z)/m
+    gen = 1
+    until s.eos? || (gen < 1)
+      contents << s.scan(rex)
+      gen += 1 if s[2] == open_tag
+      gen -= 1 if s[2] == close_tag
+    end
+    open_tag + contents
+  end
+
+  def wiki_type(line, s)
+    case line
+      when /^!/
+        :heading
+      when /^\]/
+        :box
+      when /^\|/
+        :code
+      when /^>/
+        :quote
+      when /^\*[\*\+]*\s/
+        :itemize
+      when /^\+[\*\+]*\s/
+        :enumerate
+      when /^---+$/
+        :separator
+      when /^$/
+        :blank
+      when /:$/
+        if s.match? /^\]/
+          :box
+        elsif s.match? /^\|/
+          :code
+        else
+          :p
+        end
+      else
+        :p
+    end
+  end
+
+  def single_line?(type)
+    [:heading, :newpage].include? type
+  end
+
+  def element_heading(body)
+    body.chomp!
+    body.gsub!(/(!+)(\*?)\s*/, '')
+    case $1
+      when '!'
+        "\\subsection#{$2}{#{body}}\n"
+      when '!!'
+        "\\section#{$2}{#{body}}\n"
+      else
+        "\\chapter#{$2}{#{body}}\n"
+    end
+  end
+
+  def element_box(body)
+    _box(body, :box)
+  end
+
+  def element_code(body)
+    _box(body, :code)
+  end
+
+  def _box(body, type = :box)
+    if body.gsub!(/\A([^\]\|].*):\n/, '')
+      title = escape_specials $1
+    end
+    body.gsub!(/^(\]|\|)/m, '')
+    body = element_p(body) if type == :box
+    if title
+      <<_eos
+\\begin{WT#{type}}{#{title}}
+#{body}\\end{WT#{type}}
+_eos
+    else
+      <<_eos
+\\begin{WT#{type}-without-title}
+#{body}\\end{WT#{type}-without-title}
+_eos
+    end
+  end
+
+  def element_quote(body)
+    body.gsub!(/^>/m, '')
+    <<_eos
+\\begin{quote}
+#{element_p body}\\end{quote}
+_eos
+  end
+
+  def element_itemize(body)
+    _list(body, 'itemize')
+  end
+
+  def element_enumerate(body)
+    _list(body, 'enumerate')
+  end
+
+  def _list(body, item_enum)
+    items = []
+    lines = []
+    type  = nil
+    (body + "\n\n").each_line {|line|
+      line.sub!(/^(\*|\+)/, '')
+
+      unless line =~ /^(\*|\+)/ || lines.empty?
+        item = inline lines.shift.to_s.chomp
+        unless lines.empty?
+          lines = lines.join
+          item += (lines =~ /\A\*/) ? element_itemize(lines) : element_enumerate(lines)
+        end
+        items << "\\item#{item}\n" if item != ''
+        lines = []
+      end
+
+      lines << line
+    }
+
+    <<_eos
+\\begin{#{item_enum}}
+#{items.join}\\end{#{item_enum}}
+_eos
+  end
+
+  def element_separator(body)
+    "\\WTseparator{}\n"
+  end
+
+  def element_p(body)
+    body.gsub!(/\n*\Z/, '')
+    body.gsub!(/\n/, "\\\\\\\\\n")
+    "#{inline body}\n"
+  end
+
+  def element_blank(body)
+    body
+  end
+
+  def inline(body)
+    body = convert_ruby      body
+    body = convert_strong    body
+    body = convert_underline body
+    body = escape_specials   body
+  end
+
+  def convert_ruby(body)
+    body.gsub!(/[｜\|]?([^#{Characters::WITHOUT_RUBY}]+)《(.+?)》/u, '\\\\ruby{\\1}{\\2}')
+    body
+  end
+
+  def convert_strong(body)
+    body.gsub!(/(\*{2,})(.*?)\1/) {
+      case $1
+        when '**'
+          "{\\large\\bf #{$2}}"
+        when '***'
+          "{\\LARGE\\bf #{$2}}"
+        else
+          "{\\Huge\\bf #{$2}}"
+      end
+    }
+    body
+  end
+
+  def convert_underline(body)
+    body.gsub!(/__(.*?)__/, '\\WTunderline{\1}')
+    body
+  end
+
+  def escape_specials(body)
+    body.gsub!(/[#{Characters::SPECIAL}]/) { Characters::SPECIAL_MAP[$&] }
+    body
+  end
+
+end