hiki2latex 0.9.12 → 0.9.12.1

data/hiki2latex.wiki/hiki2latex_listings.md

@@ -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/hiki2latex.wiki/hiki2latex_manual.md

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

data/hiki2latex.wiki/hiki2latex_math.md

@@ -0,0 +1,147 @@
+# 【概要】
+dmath,math環境をequationに変換
+# 【入力：hiki】
+
+```
+mathがうまくいくかどうかの検討用サンプルです．
+さらにinlineで{{math 'x_i'}}なんかもできるといいのですが．
+```
+
+mathがうまくいくかどうかの検討用サンプルです．
+さらにinlineで{{math 'x_i'}}なんかもできるといいのですが．
+
+# 【出力：latex】
+
+```
+\begin{document}
+mathがうまくいくかどうかの検討用サンプルです．
+\begin{equation}
+f_x
+\end{equation}
+さらにinlineで$x_i$なんかもできるといいのですが．
+```
+<dl>
+<dt>注2016/02/20</dt><dd>このあたりでhiki, rubyを指定するとlistingsがうまく処理できない．preformatted\_without\_styleで対応．</dd>
+</dl>
+# 【コード解説】
+## 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/hiki2latex.wiki/hiki2latex_table.md

@@ -0,0 +1,103 @@
+# 【概要】
+hiki2latexのtable処理部
+
+# 【仕様】
+- hiki記法の表をtabularへ変換
+- 連結作用素に対応
+- 行連結では中心に表示を移動
+- 縦罫は基本使わない
+- 横罫はheader内枠と上下外枠のみ
+
+# 【hiki】
+
+```
+||>A11||>A12||
+||^^A21||A22||>A23||
+||A11||^A22||A12||
+||A21||A23||
+```
+
+
+|A11||
+|:----|:----|:----|:----|
+|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}などで．
+```
+
+
+# 【コード解説】
+元の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
+```

data/hiki2latex.wiki/readme_en.md

@@ -0,0 +1,60 @@
+# Hiki2latex
+convert hikidoc text to latex format.
+
+\![badge](https://badge.fury.io/rb/hiki2latex.png)
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'hiki2latex'
+```
+And then execute:
+```
+$ bundle
+```
+Or install it yourself as:
+```
+$ gem install hiki2latex
+```
+
+## Usage
+Use as a gem library:
+```ruby
+    require 'hiki2latex'
+    
+    puts HikiDoc.to_latex(File.read(ARGV[0]),{:level=>@level,:listings=>@listings})
+```
+
+or as a command line tool:
+
+<dl>
+<dt>Usage</dt><dd> hiki2latex [options] FILE</dd>
+</dl>
+
+```
+> hiki2latex --pre PRICM_preamble.tex --post biblio.tex -p test.hiki > test.tex
+> hiki2latex --listings --post post.tex -p ./test.hiki > test.tex
+```
+
+| option | operation|
+|:----|:----|
+|    -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.|
+|        --listings    |               use listings.sty for preformat with style.|
+
+
+## Development
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec hiki2latex` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/daddygongon/hiki2latex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/{README.ja.md → hiki2latex.wiki/readme_ja.md}

@@ -1,22 +1,42 @@
 # 【概要】
 hiki formatで書かれた文章を，latex formatに変換する
-# 【documents】
-- ![](http://rubygems.org/gems/hiki2latex)
+# 【置き場所】
+- [rubygems](http://rubygems.org/gems/hiki2latex)
+- [Github](https://github.com/daddygongon/hiki2latex)
 
 # 【使用法】
-```bash
-Usage: hiki2latex [options] FILE
-    -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.
-        --listings                   use listings.sty for preformat with style.
+Use as a gem library:
+```ruby
+    require 'hiki2latex'
+    
+    puts HikiDoc.to_latex(File.read(ARGV[0]),{:level=>@level,:listings=>@listings})
+```
+
+or as a command line tool:
+
+<dl>
+<dt>Usage</dt><dd> hiki2latex [options] FILE</dd>
+</dl>
+
 ```
-- より詳細な使用法は，![](hiki2latex_gemizing)にある．
-- 西谷研の内部で利用するときに特化したマニュアルは[こちら](hiki2latex_manual)．
+> hiki2latex --pre PRICM_preamble.tex --post biblio.tex -p test.hiki > test.tex
+> hiki2latex --listings --post post.tex -p ./test.hiki > test.tex
+```
+
+| option | operation|
+|:----|:----|
+|    -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.|
+|        --listings    |               use listings.sty for preformat with style.|
+
+
+- より詳細な使用法は，nishitani0のhiki2latex_gemizingにある．
+- 西谷研の内部で利用するときに特化したマニュアルはnishitani0のhiki2latex_manual．
 
 ## sample
 幾つかのサンプルを以下に示す．
@@ -24,10 +44,10 @@ Usage: hiki2latex [options] FILE
 
 |ソース(hiki表示)|pdf(latex変換後)|
 |:----|:----|
-|[[Shunkuntype]]|[[Shunkuntype]]のレポート|
-|[[LPSO15研究会の例|LPSO15_fall_meeting_abst]]|{{attach_anchor(LPSO_abst.pdf)}}|
-|[[中間発表hand out例|AbstSample]]|{{attach_anchor(AbstSample.pdf)}}|
-|[[使っているformat集|DocumentFormatter_format_examples]]|
+|[Shunkuntype](Shunkuntype)のレポート|
+|[LPSO15研究会の例](LPSO15_fall_meeting_abst)|{{attach_anchor(LPSO_abst.pdf)}}|
+|[中間発表hand out例](AbstSample)|{{attach_anchor(AbstSample.pdf)}}|
+|[使っているformat集](DocumentFormatter_format_examples)|
 
 
 # 【仕様】
@@ -42,7 +62,7 @@ Usage: hiki2latex [options] FILE
 1. graph, tableは[h]で提供．
 
 # 【具体的な使用例rakefile】
-具体的な使用例として![](Shunkuntype_report)を作成した時のRakefile.rbを示す．何度も書き直す時は，このようにして自動化すべき．
+具体的な使用例として[Shunkuntype_report](Shunkuntype_reportd)を作成した時のRakefile.rbを示す．何度も書き直す時は，このようにして自動化すべき．
 ```ruby
 task :shunkuntype do
   dir = '~/Sites/nishitani0/Internal/data/text/'
@@ -74,15 +94,15 @@ end
 
 |memo |date|hiki|
 |:----|:----|:----|
-|hikidoc.rbからhiki2latex.rb|15/8/4|[[hiki2latex_init]]|
+|hikidoc.rbからhiki2latex.rb|15/8/4|![](hiki2latex_init)|
 |hiki2latex.rbひな形作成|15/8/5|
 |@fをStringIOからStringへ|15/8/5|
-|graph+caption|15/8/6|[[LPSO15_fall_meeting_abst]]|
-|math|15/8/7| [[hiki2latex_math]]|
-|table| 15/8/8| [[hiki2latex_table]]|
-|under_score| 15/8/11 | [[hiki2latex_math]]|
-|gem化| 16/2/13 | [[hiki2latex_gemizing]]|
-|listings| 16/2/16 | [[hiki2latex_listings]]|
+|graph+caption|15/8/6|![](LPSO15_fall_meeting_abst)|
+|math|15/8/7| ![](hiki2latex_math)|
+|table| 15/8/8| ![](hiki2latex_table)|
+|under_score| 15/8/11 | ![](hiki2latex_math)|
+|gem化| 16/2/13 | ![](hiki2latex_gemizing)|
+|listings| 16/2/16 | ![](hiki2latex_listings)|
 
 
 # 【開発メモ】

data/{docs/readme.ja.hiki → hikis/hiki2latex.hiki}

@@ -3,9 +3,9 @@
 hiki formatで書かれた文章を，latex formatに変換する
 !【documents】
 * [[http://rubygems.org/gems/hiki2latex]]
-
 !【使用法】
-<<< bash
+
+<<< tcsh
 Usage: hiki2latex [options] FILE
     -v, --version                    show program Version.
     -l, --level VALUE                set Level for output section.
@@ -23,7 +23,7 @@ Usage: hiki2latex [options] FILE
 幾つかのサンプルを以下に示す．
 !!!caption:hiki2latexにより作成されたpdfファイトとその元ネタ．
 ||ソース(hiki表示)||pdf(latex変換後)
-||[[Shunkuntype]]||[[Shunkuntype]]のレポート
+||[[Shunkuntype|https://github.com/daddygongon/shunkuntype/wiki/Shunkuntype_report]]||[[Shunkuntypeのレポート|https://github.com/daddygongon/shunkuntype/wiki/shunkun_report.pdf]]
 ||[[LPSO15研究会の例|LPSO15_fall_meeting_abst]]||{{attach_anchor(LPSO_abst.pdf)}}
 ||[[中間発表hand out例|AbstSample]]||{{attach_anchor(AbstSample.pdf)}}
 ||[[使っているformat集|DocumentFormatter_format_examples]]||
@@ -64,8 +64,6 @@ end
 >>>
 本文(Shunkuntype_report.tex)と付録(targets.texs)がある．付録は'-l 2 -b'によってsubsectionからのtitle levelにしてbare modeで作っている．post.texにpostで付け加えるtex部を指定して，appendixをつけている．
 
-!【code documents】
-[[rdoc|http://nishitani0.kwansei.ac.jp/~bob/nishitani0/rdocs/hiki2latex/index.html]]に置いといたけど，ruby gemsやgithubに置けば不要となる．
 !【変更履歴，内容】
 変更履歴，内容を表に示す．15/8月期で基本開発．16/2月期にgem化．
 !!caption:変更履歴，内容
@@ -87,7 +85,7 @@ end
 !!【 保留項目】
 # includegraphicsの自動提供
 ## hikiに置かれているgraphは劣化版なんでそれをいじるのはあまり筋がよろしくない．
-## epsならできるかも．hikeのattach_viewでサイズをどういじっているか．．．
+## epsならできるかも．hikiのattach_viewでサイズをどういじっているか．．．
 # underbar(_)がlatexでは全て引っかかる．escapeする？-> 対応済み [[hiki2latex_math]]
 ## snake表記はrubyではfile名や変数名に頻繁に使われるので対処が必要かも．