hiki2latex 0.9.12 → 0.9.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12076d5d0ba9927aa5c90cf3ca76272ecc0540c9
-  data.tar.gz: e6e148da375fdc48d3a083554b07d809fd026d72
+  metadata.gz: a7f61b3eeb86e7a27f989b900398a479dc450adc
+  data.tar.gz: 3a53b98b515bdcb9065ad68b9f5b71dd2477df60
 SHA512:
-  metadata.gz: 27e6493c92a853626cc67858f3b7e70035272de05c82c3758a2c832725f82fd7a6f863376f8690e6a3b3932852afb173dd261659cfb61f0ab52d9d1349092e0a
-  data.tar.gz: ed43a50306c7a9af6fed161e5e53cd973feb8c352ebae7290b6ca40ea0bc5aae13edeb767bfe449043761395cc444b79ea1609fd8ed26d3b9d7ad3cb04d38f11
+  metadata.gz: c9c63ed2c36a0c6e85129529cc884973c88244ebe4b02a395bd54e127f7171747fe35830abd228cdc555d8d690e9730405424032912a27207f1432ae2e2cf07f
+  data.tar.gz: 8c16c4ae32dd6dd5a3e3209424c82c887f0aa40c5eca3a31052df9c6d40f702010e20cb5fef84eb175249d5048aa8c1edda3e6e7c66d71b1bb1bf1478497476b

data/.yardopts

@@ -1,4 +1,2 @@
 -
-docs/README.en.md
-docs/README.ja.md
-
+**/*.md

data/{README.en.md → README.md}

@@ -1,6 +1,8 @@
 # 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
@@ -29,6 +31,10 @@ or as a command line tool:
 <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|
 |:----|:----|
@@ -41,10 +47,6 @@ or as a command line tool:
 |        --post FILE   |               put post file.|
 |        --listings    |               use listings.sty for preformat with style.|
 
-```
-> hiki2latex --pre PRICM_preamble.tex --post biblio.tex -p test.hiki > test.tex
-> hiki2latex --listings --post post.tex -p ./test.hiki > test.tex
-```
 
 ## 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.

data/Rakefile

@@ -1,42 +1,70 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "rake/testtask"
 require 'yard'
-require 'systemu'
+require "rake/testtask"
+require 'fileutils'
+p base_path = File.expand_path('..', __FILE__)
+p basename = File.basename(base_path)
 
-#task :default => :test
 task :default do
   system 'rake -T'
 end
 
-
 desc "make documents by yard"
-task :yard do
-  system "hiki2md docs/readme.hiki > docs/README.en.md"
-  system "hiki2md docs/readme.ja.hiki > docs/README.ja.md"
+task :yard => [:hiki2md] do
   YARD::Rake::YardocTask.new
 end
 
-RSpec::Core::RakeTask.new(:spec)
+desc "transfer hikis/*.hiki to wiki"
+task :hiki2md do
+  files = Dir.entries('hikis')
+  files.each{|file|
+    name=file.split('.')
+    case name[1]
+    when 'hiki'
+      p command="hiki2md hikis/#{name[0]}.hiki > #{basename}.wiki/#{name[0]}.md"
+      system command
+    when 'gif','png','pdf'
+      FileUtils.cp("hikis/#{file}","#{basename}.wiki/#{file}",:verbose=>true)
+      FileUtils.cp("hikis/#{file}","doc/#{file}",:verbose=>true)
+    end
+  }
+  readme_en="#{basename}.wiki/README_en.md"
+  readme_ja="#{basename}.wiki/README_ja.md"
+  if File.exists?(readme_en)
+    FileUtils.cp(readme_en,"./README.md",:verbose=>true)
+  elsif File.exists?(readme_ja)
+    FileUtils.cp(readme_ja,"./README.md",:verbose=>true)
+    FileUtils.cp(readme_ja,"#{basename}.wiki/Home.md",:verbose=>true)
+  end
+end
+
+desc "Make related report."
+task :make_texes do
+p  files = Dir.entries('hikis')
+  files.each{|file|
+    next if file.include?('Readme')
+    name=file.split('.')
+    case name[1]
+    when 'hiki'
+      p command="hiki2latex -l 3 --listings -b hikis/#{name[0]}.hiki > latexes/#{name[0]}.tex"
+      system command
+    when 'gif','png','pdf'
+      FileUtils.cp("hikis/#{file}","latexes/#{file}",:verbose=>true)
+    end
+  }
+  source = File.join('hikis',basename+'.hiki')
+  target = File.join('latexes',basename+'.tex')
+  p command= "hiki2latex --listings --head latexes/head.tex --post latexes/post.tex -p #{source} > #{target}"
+  system command
 
-desc "all procedure for release."
-task :update =>[:setenv] do
-  system 'emacs ./lib/hiki2latex/version.rb'
-  system 'git add -A'
-  system 'git commit'
-  system 'git push -u origin master'
-  system 'bundle exec rake release'
+  exit
 end
 
-desc "setenv for release from Kwansei gakuin."
-task :setenv do
-#  status, stdout, stderr  = systemu "scselect \| grep \'\*\' |grep KG"
-#  puts stdout
-#  p stdout != nil
-#  if stdout != nil then
-    p command='setenv HTTP_PROXY http://proxy.ksc.kwansei.ac.jp:8080'
-    system command
-    p command='setenv HTTPS_PROXY http://proxy.ksc.kwansei.ac.jp:8080'
-    system command
-#  end
-end
+def kill_head_line(file_name)
+  cont = File.readlines(file_name)
+  unless cont[0]=~/\tableofcontents/ then
+    file = File.open(file_name,'w')
+    file.puts cont[1..-1]
+    file.close
+  end
+end

data/exe/#hiki2latex#

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "hiki2latex"
+
+Hiki2latex::Command.run(ARGV)

data/hiki2latex.gemspec

@@ -38,5 +38,8 @@ EOF
   spec.add_development_dependency "test-unit"
   spec.add_development_dependency "systemu"
   spec.add_development_dependency "hiki2md"
+  spec.add_development_dependency "mathjax-yard"
+  spec.add_development_dependency "hiki2latex"
+
   spec.add_runtime_dependency "hikidoc","~>0.1.0"
 end

data/hiki2latex.wiki/handout_sample.md

@@ -0,0 +1,73 @@
+# title:hiki2yardによる数値計算資料の作成システム
+# author:情報科学科 西谷研究室 1234 西谷滋人
+
+# 目的
+hikiフォーマット文書をlatexフォーマットに変換するhiki2latex[1]をもちいて中間発表のabstract資料を作成する手順を紹介する．
+
+# インストール
+最初に，作業を自動化するhiki2yard[2]をrubygemsからinstallする．terminal上で，
+```
+gem install hiki2yaml
+```
+によって環境を構築するCUIがinstallされる．
+```
+hiki2yard --version
+```
+によってversionが表示されれば，正常にinstallがなされていることが確認できる．
+
+# 環境構築
+terminal上で
+```
+hiki2yard --init
+```
+によって，必要となるファイルが自動的に配置される．指示に従って，hogehoge.gemspecを
+手動で修正する必要がある．さらに，
+```
+bundle update
+```
+によって，必要なgem filesがinstallされる．
+
+# directory構成と各ファイルの意味
+次にdirectory構成を示す．これはbundle gem -bによって生成される標準gem構築環境に修正を加えた構成となる．
+```
+bob% tree .
+.
+├── CODE_OF_CONDUCT.md
+├── Gemfile
+├── Gemfile.lock
+├── LICENSE.txt
+├── README.md
+├── Rakefile
+├── bin
+├── doc
+├── exe
+├── hiki2yard.gemspec
+├── hiki2yard.wiki
+├── hikis
+│   ├── README_en.hiki
+│   ├── handout_sample.hiki
+...
+├── latexes
+│   ├── handout_pre.tex
+├── lib
+├── pkg
+└── spec
+```
+hikisにtargetとなるfileをhiki構文で作る．Rakefileに必要なtaskが登録されている．latexesには現在のところ，中間発表のhandoutを生成するpre-formatのtexが置かれている．
+```
+rake latex
+```
+によって
+```
+hiki2latex --pre latexes/handout_pre.tex hikis/handout_sample.hiki > latexes/handout_sample.tex
+```
+が起動され，latexes上にtargetのtex format文書が生成される．この後，自動的に起動されるmacのapplicationであるTeXShop上でcommand-tを押下することで，latexからpdfへ変換を行い，中間発表のabstractを作成する．
+
+# 個別の準備
+- 各人は自分でhikis/hogehoge.hikiファイルを生成する
+- Rakefileの:latexタスクにあるtarget変数を変更する
+後は，マニュアルに従ってpdf文書を作成できるはずである．質問がある場合は早めにね．
+
+# 参考資料
+1. [hiki2latex](https://rubygems.org/gems/hiki2latex), 2016/08/11アクセス．
+1. [sakibts/hiki2yard](https://github.com/sakibts/hiki2yard), 2016/08/11アクセス．

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

@@ -2,9 +2,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.
@@ -24,10 +24,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](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)|
 
 
 # 【仕様】
@@ -66,23 +66,21 @@ 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:変更履歴，内容
 
 |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)|
 
 
 # 【開発メモ】
@@ -92,7 +90,7 @@ end
 ## 【 保留項目】
 1. includegraphicsの自動提供
   1. hikiに置かれているgraphは劣化版なんでそれをいじるのはあまり筋がよろしくない．
-  1. epsならできるかも．hikeのattach_viewでサイズをどういじっているか．．．
+  1. epsならできるかも．hikiのattach_viewでサイズをどういじっているか．．．
 1. underbar(_)がlatexでは全て引っかかる．escapeする？-> 対応済み ![](hiki2latex_math)
   1. snake表記はrubyではfile名や変数名に頻繁に使われるので対処が必要かも．
 

data/hiki2latex.wiki/hiki2latex_gemizing.md

@@ -0,0 +1,221 @@
+
+# 【概要】
+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/hiki2latex.wiki/hiki2latex_init.md

@@ -0,0 +1,97 @@
+# 【変更作業の手順】
+- 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のオプションとして付け加えています。）特別なことをせずに、ページ指定をするだけで、できてしまいました。
+
+次の、美文書の版には、ページ設定についても解説していただくといいかも知れません。＞奥村先生お願いします。
+```