hiki2latex 0.9.12 → 0.9.12.1

data/hikis/hiki2latex_gemizing.hiki

@@ -0,0 +1,222 @@
+{{toc}}
+
+!【概要】
+hikiフォーマットの記述をlatexフォーマットに変換する
+!【使用法】
+gem化して配布可能とした．したがって，installがちゃんとできていれば，
+:command lineから:
+<<< tcsh
+bob% hiki2latex Shunkuntype_manual > tmp.tex
+>>>
+:libraryとして:
+<<< ruby
+require 'hiki2latex'
+
+puts HikiDoc.to_latex(File.read(ARGV[0]))
+>>>
+<<< tcsh
+bob% ruby trans.rb ./Shunkuntype_manual > tmp.tex
+>>>
+などとして利用できる．
+
+!【help】
+
+<<< tcsh
+bob% hiki2latex
+Usage: hiki2latex [options]
+    -v, --version                    show program Version.
+    -l, --level VALUE                set Level for output section.
+    -p, --plain FILE                 make Plain document.
+    -b, --bare FILE                  make Bare document.
+        --head FILE                  put headers of maketitle file.
+        --pre FILE                   put preamble file.
+        --post FILE                  put post file.
+>>>
+
+!【詳細使用例(-p)】
+以下のようなSampleDoc
+<<< hiki
+bob% cat SampleDoc 
+!title
+contents
+*list1
+*list2
+!!title2
+>>>
+を
+<<< tex
+bob% hiki2latex -p SampleDoc 
+\documentclass[12pt,a4paper]{jsarticle}
+\usepackage[dvipdfmx]{graphicx}
+\begin{document}
+\section{title}
+contents
+\begin{itemize}
+\item list1
+\item list2
+\end{itemize}
+\subsection{title2}
+\end{document}
+>>>
+となる．
+
+!【詳細使用例(-b)】
+上記
+<<< tex
+ \begin{document}
+ ...
+ \end{document}
+>>>
+の中身だけを生成．いくつものtex filesをincludeしている場合の個別ファイル作成に便利．
+
+この際，'-l 2'として付録のsectionとかを調整する．
+
+!【詳細使用例( --head,  --pre,  --post】
+formatを標準と違うものにするために，pre,head,postがある．詳しくはsampleを見よ．
+していしていく順番はないはずだけど，-p SampleDocだけは順番があるのかな．
+あと，erbみたいにして使ったほうがいいかも．
+<<< tcsh
+ bob% hiki2latex --pre preamble.tex --head head.tex --post post.tex -p SampleDoc 
+>>>
+<<< tex
+%preamble.tex
+\documentclass[12pt,a4paper]{jsarticle}
+\usepackage[dvipdfmx]{graphicx}
+\pagestyle{empty}
+>>>
+<<< tex
+ \begin{document}
+>>>
+<<< tex
+%head.tex
+\author{関西学院大学・理工学部・西谷滋人}
+\title{touch typing習得環境shunkuntype}
+\date{\today}
+\maketitle
+>>>
+<<< tex
+ \section{title}
+ contents
+ \begin{itemize}
+ \item list1
+ \item list2
+ \end{itemize}
+ \subsection{title2}
+>>>
+<<< tex
+%post.tex
+\pagebreak
+\appendix
+\section{マニュアル}
+\input{shunkuntype_manual}
+\pagebreak
+\section{gem化メモ}
+\input{shunkuntype_gemizing}
+\pagebreak
+\section{初期版のコード解説}
+\input{shunkuntype_coding}
+>>>
+<<< tex
+ \end{document}
+>>>
+!【lib/hiki2latex.rb】
+<<< ruby
+require 'optparse'
+require "hiki2latex/version"
+#require "hiki2latex/hikidoc"
+require "hiki2latex/hiki2latex"
+
+module Hiki2latex
+  class Command
+
+    def self.run(argv=[])
+      new(argv).execute
+    end
+
+    def initialize(argv=[])
+      @argv = argv
+      @pre=@head=@post=nil
+    end
+
+    def execute
+      @argv << '--help' if @argv.size==0
+      command_parser = OptionParser.new do |opt|
+        opt.on('-v', '--version','show program Version.') { |v|
+          opt.version = Hiki2latex::VERSION
+          puts opt.ver
+        }
+        opt.on('-l VALUE','--level','set Level for output section.'){|level| @level=level.to_i}
+        opt.on('-p FILE', '--plain','make Plain document.') { |file| plain_doc(file) }
+        opt.on('-b FILE', '--bare','make Bare document.') { |file| bare_doc(file) }
+        opt.on('--head FILE', 'put headers of maketitle file.') { |file| @head=file }
+        opt.on('--pre FILE', 'put preamble file.') { |file| @pre=file }
+        opt.on('--post FILE', 'put post file.') { |file| @post=file }
+        opt.on('--listings', 'use listings.sty for preformat with style.') {@listings=true }
+      end
+      command_parser.banner = "Usage: hiki2latex [options] FILE"
+      command_parser.parse!(@argv)
+      plain_doc(@argv[0]) if @argv[0]!=nil
+      exit
+    end
+
+    # pre, post, listingsなどの拡張を処理
+    def plain_doc(file)
+      if @listings==true then
+        puts listings_preamble
+      elsif @pre==nil then
+        puts "\\documentclass[12pt,a4paper]{jsarticle}"
+        puts "\\usepackage[dvipdfmx]{graphicx}"
+      else
+        puts File.read(@pre)
+      end
+      puts "\\begin{document}"
+      puts File.read(@head) if @head!=nil
+      plain_tex = HikiDoc.to_latex(File.read(file),{:listings=>@listings})
+      puts mod_abstract(plain_tex)
+      puts File.read(@post) if @post!=nil
+      puts "\\end{document}"
+    end
+
+    def bare_doc(file)
+      bare_doc = HikiDoc.to_latex(File.read(file),{:level=>@level,:listings=>@listings})
+      puts kill_head_tableofcontents(bare_doc)
+    end
+>>>
+
+!!kill_head_line
+kill_head_lineで付録(bare_text)にtocが含まれている場合は削除．
+<<< ruby
+    def kill_head_tableofcontents(text)
+      text.gsub!(/^\\tableofcontents/,'')
+    end
+>>>
+
+!!mod_abstract
+mod_abstractで\verb|\section{abstract}|で書かれた内容をabstract環境へ移行する．一行づつの処理は有限状態マシン的に処理するのがいいらしい(Ruby Best Practice, p.112)．一旦contentとabstractを分けて，その後，tableofcontentの前にabstractを挿入している．delete_at(0)は一行目に\verb|\section{【abstract】}|が存在するため．
+<<< ruby
+# convert section to abstract
+    def mod_abstract(text)
+      abstract,section = [],[]
+      content = ""
+      text.split("\n").each do |line|
+        case line
+        when /^\\section(.+)/
+          section.push $1
+        end
+
+        case section[-1]
+        when /.+abstract.+/
+          abstract << line+"\n"
+        when /.+概要.+/
+          abstract << line+"\n"
+        else
+          content << line+"\n"
+        end
+      end
+      abstract.delete_at(0)
+      content.gsub!(/\\tableofcontents/){|text|
+        tt="\n\\abstract\{\n#{abstract.join}\}\n\\tableofcontents"
+      }
+      return content
+    end
+>>>

data/hikis/hiki2latex_init.hiki

@@ -0,0 +1,95 @@
+{{toc}}
+!【変更作業の手順】
+* hikiをhtmlに変換するhikidoc.rbに加えていく形で変更
+* hikidocについて調べよ(澄田の宿題）
+
+<<< ruby
+bob% diff hikidoc.rb master-hikidoc/lib/hikidoc.rb 
+39d38
+< require './hiki2latex.rb'
+58,61d56
+<   def HikiDoc.to_latex(src, options = {})
+<     new(LatexOutput.new(""), options).compile(src)
+<   end
+< 
+916,917c911
+< #  puts HikiDoc.to_html(ARGF.read(nil))
+<   puts HikiDoc.to_latex(ARGF.read(nil))
+---
+>   puts HikiDoc.to_html(ARGF.read(nil))
+>>>
+
+* hiki2latex.rbに変更を加えていく．
+!【設計】
+!!【maketitleの挿入】
+latex formatに仕込む際にテキストの順序が前後するコマンドが幾つかある．
+\\maketitleの前に置かれた，
+* title
+* author
+である．これらはheadersとしてtext部と別に返すことも可能である．
+具体的には，
+|| to_html || *fを返す
+|| to_latex || *fと*headを返す．
+なおto_htmlとの互換性を維持するため*headを後に返すようにしている．
+
+しかし，この部分は，to_htmlとの整合性を考えるとto_latexで処理してしまった方がよい．
+そこで，
+
+<<< ruby
+def finish
+  @f.string
+end
+>>>
+となっているのを，
+
+<<< ruby
+  def finish
+    if @head != "" then
+      @head << "\\maketitle\n"
+      return @head+@f
+    else
+      return @f
+    end
+  end
+>>>
+とした．
+
+!【sample】
+*[[Jihou15]]
+
+!【pdfの貼り込み】
+pdfpagesを使おうとすると
+
+<<<
+/usr/local/texlive/2015/texmf-dist/tex/latex/pdfpages/pdfpages.sty:70: LaTeX Er
+ror: Missing \begin{document}.
+
+See the LaTeX manual or LaTeX Companion for explanation.
+Type  H <return>  for immediate help.
+ ...                                              
+                                                  
+l.70 \input{pp\AM@driver.def}
+>>>
+というエラーが出る．この解決法がわからず，incudegraphicsで対応．
+
+<<<
+¥documentclass{jsarticle}
+¥usepackage[dvipdfmx,hiresbb]{graphicx}
+¥begin{document}
+¥includegraphics[width=5cm]{sample.pdf}
+¥end{document}
+
+の4行目を
+¥includegraphics[page=3,width=5cm]{sample.pdf}
+とすれば、
+
+普通に３ページ目の画像を使うことができました。
+
+美文書5版のCD-ROMから普通にインストールした TeXShopの環境です。
+
+つまり、何も（といっても、同書 P114 にあるように、
+ --shell--escape--commands=extractbb 
+をTeXShop環境設定の「内部設定」タブ　pdfTex のLatexのオプションとして付け加えています。）特別なことをせずに、ページ指定をするだけで、できてしまいました。
+
+次の、美文書の版には、ページ設定についても解説していただくといいかも知れません。＞奥村先生お願いします。
+>>>

data/hikis/hiki2latex_listings.hiki

@@ -0,0 +1,113 @@
+!【概要】
+latexのlistingsスタイルを使って，source codeの色付き表示が可能に．
+
+!【hiki2latexの変更】
+hikidoc2texで使われているのを参照して，
+
+<<< ruby
+  def block_preformatted(str, info)
+    if (@listings==true and info!=nil) then
+      style='customRuby' if info=='ruby'
+      style='customCsh' if (info=='tcsh' or info=='csh')
+      style='customTeX' if info=='tex'
+      style='customJava' if info=='java'
+      preformatted_with_style(str,style)
+    else
+      preformatted(text(str))
+    end
+  end
+
+  def preformatted(str)
+    @f.slice!(-1)
+    @f << "\\begin{quote}\\begin{verbatim}\n"
+    @f << str+"\n"
+    @f << "\\end{verbatim}\\end{quote}\n"
+  end
+
+  def preformatted_with_style(str,style)
+    @f.slice!(-1)
+    @f << "\\begin{lstlisting}[style=#{style}]\n"
+    @f << str+"\n"
+    @f << "\\end{lstlisting}\n"
+  end
+>>>
+
+opt周りは，
+
+<<< ruby
+        opt.on('--listings', 'use listings.sty for preformat with style.') {@listings=true }
+>>>
+としている．これをHikiDocへ渡す時は，
+
+<<< ruby
+    def plain_doc(file)
+      if @listings==true then
+        puts listings_preamble
+      elsif @pre==nil then
+        puts "\\documentclass[12pt,a4paper]{jsarticle}"
+        puts "\\usepackage[dvipdfmx]{graphicx}"
+      else
+        puts File.read(@pre)
+      end
+      puts "\\begin{document}"
+      puts File.read(@head) if @head!=nil
+      puts HikiDoc.to_latex(File.read(file),{:listings=>@listings})
+      puts File.read(@post) if @post!=nil
+      puts "\\end{document}"
+    end
+>>>
+後ろのoptions={}の中にhashで登録している．texのstyleはlisting_preambleで打ち出すようにしている．
+
+listingsの設定は以下の通り．
+
+<<< tex
+\documentclass[10pt,a4paper]{jsarticle}
+\usepackage[dvipdfmx]{graphicx}
+\usepackage[dvipdfmx]{color}
+\usepackage{listings}
+% to use japanese correctly, install jlistings.
+\lstset{
+  basicstyle={\small\ttfamily},
+  identifierstyle={\small},
+  commentstyle={\small\itshape\color{red}},
+  keywordstyle={\small\bfseries\color{cyan}},
+  ndkeywordstyle={\small},
+  stringstyle={\small\color{blue}},
+  frame={tb},
+  breaklines=true,
+  numbers=left,
+  numberstyle={\scriptsize},
+  stepnumber=1,
+  numbersep=1zw,
+  xrightmargin=0zw,
+  xleftmargin=3zw,
+  lineskip=-0.5ex
+}
+\lstdefinestyle{customCsh}{
+  language={csh},
+  numbers=none,
+}
+\lstdefinestyle{customRuby}{
+  language={ruby},
+  numbers=left,
+}
+\lstdefinestyle{customTex}{
+  language={tex},
+  numbers=none,
+}
+\lstdefinestyle{customJava}{
+  language={java},
+  numbers=left,
+}
+>>>
+
+<<<
+\begin{lstlisting}[style=customRuby]
+  def block_preformatted(str, info)
+    if (@listings==true and info!=nil) then
+      style='customRuby' if info=='ruby'
+      style='customCsh' if (info=='tcsh' or info=='csh')
+      style='customTeX' if info=='tex'
+...
+\end{lstlisting}
+>>>

data/hikis/hiki2latex_manual.hiki

@@ -0,0 +1,32 @@
+{{toc}}
+!【概要】
+hikiで書いたのを中間発表の予稿集用に変換するマニュアル．
+!【下準備】
+#yahataProjectをinstall
+#rake initを実行．passwordを聞かれたときはdonkeyかnishitaniに知らせる
+#setenvでpathを設定
+!【手順】
+#hikiにGraduate_handout原稿を作成
+# 作業用のdirectoryを作成
+#そこで，hiki2abst.rb ~/Sites/hiki-1.0/data/text/Graduate_handout > Graduate_handout.tex
+# open Graduate_handout.tex
+# command-Tでpdfへ変換．
+
+!【graph作成手順】
+!!hiki
+# 適当なサイズに調整したファイルを添付ファイルとしてUpLoad
+* ImageMagickがinstallされているとして，convert A.png -scale 50% B.png
+!!latex directory
+# hikiでファイルを選択してDownLoad
+# 作業用のlatex directoryへ移す．
+# ebb B.pngでB.bbを作成．
+# TeXShopでcompileすればいけるはず．
+
+! 【TeXShopの設定】
+!!ファイルが文字化け
+* 「設定」->書類->エンコーディング　Unicode(UTF-8)
+*　同じタグの「設定プロファイル」->　pTeX(ptex2pdf)を選択
+* TeXShopを再起動
+* compileすればいけるはず．
+!!compileうまくいかないとき．
+* *.auxファイルを消去して，再compile．

data/hikis/hiki2latex_math.hiki

@@ -0,0 +1,145 @@
+{{toc}}
+!【概要】
+dmath,math環境をequationに変換
+!【入力：hiki】
+
+<<<
+mathがうまくいくかどうかの検討用サンプルです．
+{{dmath 'f_x'}}
+さらにinlineで{{math 'x_i'}}なんかもできるといいのですが．
+>>>
+
+mathがうまくいくかどうかの検討用サンプルです．
+{{dmath 'f_x'}}
+さらにinlineで{{math 'x_i'}}なんかもできるといいのですが．
+
+!【出力：latex】
+
+<<<
+\begin{document}
+mathがうまくいくかどうかの検討用サンプルです．
+\begin{equation}
+f_x
+\end{equation}
+さらにinlineで$x_i$なんかもできるといいのですが．
+>>>
+:注2016/02/20:このあたりでhiki, rubyを指定するとlistingsがうまく処理できない．preformatted\_without\_styleで対応．
+{{attach_view(Math.png)}}
+!【コード解説】
+!!evaluate_plugin_block
+すこしトリッキーだったので，メモです．
+<<< ruby
+  def evaluate_plugin_block(str, buf = nil)
+    buf ||= @output.container
+    str.split(/(\0\d+\0)/).each do |s|
+      if s[0, 1] == "\0" and s[-1, 1] == "\0"
+        buf << @output.inline_plugin(plugin_block(s[1..-2].to_i))
+      else
+        buf << @output.text(s)
+      end
+    end
+    buf
+  end
+>>>
+としてinline_pluginはblock_pluginと違った扱いになっています．bufに一度溜め込んでそれを@fに吐いているようです．
+そこで，@output.inline_pluginで行き着く先が，LatexOutputの
+<<< ruby
+  def inline_plugin(src)
+    tmp=[]
+    if ( /(\w+)\((.+)\)/ =~ src ) or ( /(\w+).\'(.+)\'/ =~src ) or (/(\w+)/ =~ src)
+      tmp = [$1,$2]
+    end
+
+    case tmp[0]
+    when 'dmath'
+      "\\begin{equation}\n#{tmp[1]}\n\\end{equation}"
+    when 'math'
+      "\$#{tmp[1]}\$"
+    else
+      %Q(<span class="plugin">{{#{src}}}</span>)
+    end
+  end
+>>>
+としてmath,dmathを処理しています．必要ならそれ以外のinlineもここに付け足すことで対応できます．
+
+!!snake_nameがlatexで引っかかる
+math環境の移し替えはうまくいったが，underscore_namesがすべて引っかかるequationとして引っかかる．
+ \usepackage{underscore}
+だけでもできるようだが，できればto_latexで対応したい．ということで，paragraphにescape_snake_namesを入れた．
+
+paragraphはpreformattedからは呼ばれない．しかし，\verb|$$|や\verb|\begin{equation}...\end{equation}|が含まれる．そこで
+一旦全置換してそこだけ戻すようにした．gsubのなかでなんどもできるか自信がなくて．二重のgsubにしているが．．．
+<<< ruby
+  def escape_snake_names(str)
+    str.gsub!(/_/,"\\_")
+    str.gsub!(/\$.+?\$/){ |text| text.gsub!(/\\_/,"_")  }
+    str.gsub!(/equation.+?equation/m){ |text| text.gsub!(/\\_/,"_") }
+  end
+
+  def paragraph(lines)
+    lines.each{|line| line = escape_snake_names(line) }
+    @f << "#{lines.join("\n")}\n\n"
+  end
+>>>
+gsub!で置換できなかったときには，nilが返るので対応．なんかえらく冗長．
+<<< ruby
+  def escape_snake_names(str)
+    str.gsub!(/_/,"\\_")
+    str.gsub!(/\$.+?\$/){ |text|
+      if text =~ /\\_/ then
+        text.gsub!(/\\_/,"_")
+        else
+        text
+      end
+    }
+    str.gsub!(/equation.+?equation/m){ |text|
+      if text =~ /\\_/ then
+        text.gsub!(/\\_/,"_")
+        else
+        text
+      end
+    }
+    str
+  end
+>>>
+
+!!escape_snake_namesを改良(2016/02/14)
+gemへの公開にあたって冗長部を簡略化．verbだけはここを切り出した検証とは違う．testにuriを埋め込んでverb変換とsnakeを検証．
+<<< ruby
+  def escape_snake_names(str)
+    str.gsub!(/_/,"\\_")
+    patterns = [/\$(.+?)\$/ , /\\verb\|(.+?)\|/, /equation(.+?)equation/m ]
+    patterns.each{|pattern|
+      str.gsub!(/\\_/,"_")    if str.match(pattern)
+    }
+    str
+  end
+>>>
+!!escape_snake_namesを再改良(2016/02/16)
+underscoreではincludeなどでsnake_named_fileも変換してしまい，だめ．hiki2latexで対応．
+
+上のやり方では，うまくいかない場合が存在．元へ戻す．
+<<< ruby
+def escape_snake_names(str)
+    str.gsub!(/_/,"\\_")
+    patterns = [/\$(.+?)\$/ , /\\verb\|(.+?)\|/, /equation(.+?)equation/m ]
+    patterns.each{|pattern|
+#      str.gsub!(/\\_/,"_")    if str.match(pattern)                                                                                   
+      str.gsub!(pattern){|text|
+        if text =~ /\\_/ then
+          text.gsub!(/\\_/,'_')
+        else
+          text
+        end
+      }
+    }
+    str
+  end
+>>>
+さらに
+tableでescape_snake_namesを通ってなかった．
+ #        buf << "#{ele} &"                                                                                                             
+        buf << escape_snake_names(ele)+" &"
+
+!【copyright】
+cc by Shigeto R. Nishitani, 2015

data/hikis/hiki2latex_table.hiki

@@ -0,0 +1,102 @@
+{{toc}}
+!【概要】
+hiki2latexのtable処理部
+
+!【仕様】
+* hiki記法の表をtabularへ変換
+* 連結作用素に対応
+* 行連結では中心に表示を移動
+* 縦罫は基本使わない
+* 横罫はheader内枠と上下外枠のみ
+
+!【hiki】
+
+<<<
+||>A11||>A12||
+||^^A21||A22||>A23||
+||A11||^A22||A12||
+||A21||A23||
+>>>
+
+||>A11||>A12||
+||^^A21||A22||>A23||
+||A11||^A22||A12||
+||A21||A23||
+
+
+!【latex】
+
+<<< latex
+¥begin{center}¥begin{table}[htbp]¥begin{tabular}{ccccc}
+¥hline
+¥multicolumn{2}{c}{A11 }  &¥multicolumn{2}{c}{A12 }  &  ¥¥ ¥hline
+ &A22  &¥multicolumn{2}{c}{A23 }  &  ¥¥
+A21  &A11  &A22  &A12  &  ¥¥
+ &A21  & &A23  &  ¥¥
+¥hline
+¥end{tabular}¥end{table}¥end{center}
+%横罫を入れる場合は， ¥hline, ¥cline{2-3}などで．
+>>>
+
+{{attach_view(table.png)}}
+
+!【コード解説】
+元のHTMLOutputではそれぞれの要素で対応していたが，LatexOutputではtable_closeにて
+<<< ruby
+    def table_close
+      @f << make_table
+    end
+>>>
+としている．make_tableは下請けにmake_matrixを読んでおり，ここでほぼ全ての作業をしている．作業内容は
+* matrixを作る
+* 縦連結を処理
+** 縦連結の数(rs)だけ下行に追加
+** 連結の中心(c_rs)に内容を表記
+* 横連結をmulticolumnで処理
+** ついでに最大列数(max_col)を記録
+
+<<< ruby
+bob% cat table.rb
+cont = File.readlines("table")
+
+cont.each{|line|
+  p tmp=line.split('||')
+}
+
+t_matrix=[]
+cont.each{|line|
+  tmp=line.split('||')
+  tmp.slice!(0)
+  tmp.slice!(-1) if tmp.slice(-1)=="\n"
+  tmp.each_with_index{|ele,i| tmp[i] = ele.match(/\s*(.+)/)[1]}
+  t_matrix << tmp
+}
+
+t_matrix.each_with_index{|line,i|
+  line.each_with_index{|ele,j|
+    if ele=~/\^+/ then
+      t_matrix[i][j]=""
+      rs=$&.size
+      c_rs=rs/2
+      rs.times{|k| t_matrix[i+k+1].insert(j,"")}
+      t_matrix[i+c_rs][j]=$'
+    end
+  }
+}
+p t_matrix
+
+max_col=0
+t_matrix.each_with_index{|line,i|
+  n_col=line.size
+  line.each_with_index{|ele,j|
+    if ele=~/>+/ then
+      cs=$&.size
+      t_matrix[i][j]= "\\multicolumn{#{cs+1}}{c}{#{$'}} "
+      n_col+=cs
+    end
+  }
+  max_col = n_col if n_col>max_col
+}
+p t_matrix
+p max_col
+>>>