hikiutils 0.2.1 → 0.2.2

data/abst/testhiki

@@ -0,0 +1,26 @@
+!title:hiki編集作業を容易にするツールの開発
+!author:情報科学科 西谷研究室 3554 山根 亮太
+!!1 目的
+本研究を行う目的は，hikiの編集作業をより容易にするためのツールを開発することである．それを達成するために，今回hikiのコマンド名をshell風にすることで瞬時にコマンドの機能を判断し使用することができるようにする．現在hikiでコマンドを入力する際，ユーザーは瞬間的にそのコマンドの機能や意味を判断することが難しく迷いが生じてしまうことがある．その解決策として，hikiのコマンド名をshell風に書き換えることでこの問題を解決したい．
+!!2 手法
+!!!2.1 hikiについて
+hikiとはwikiエンジンの１つとされており，Rubyを用いられることで作られたwikiクローンである．
+主なhikiの特徴として
+*オリジナルwikiに似たシンプルな書式
+*プラグインによる機能拡張
+*出力するHTMLを柔軟に変更可能
+*ページにカテゴリ付けできる
+*CSSを使ったテーマ機能
+*携帯端末可能
+*InterWikiのサポート
+*HikiFarmに対応
+*ページの追加，編集がしやすい
+　等がある．[1]
+!!!2.2 hikiutilsについて
+hikiutilsとはhikiの編集作業を行うためのものである．よって，今回の研究はhikiutilsを編集することによりコマンド名の編集を行う．hikiutilsはRubyのライブラリであるgemで提供されている．hikiutilsはCLI(Charactor Line Interface)で提供されているため，プログラミング言語Rubyでコマンドラインのオプション解析を行うoptparseが利用されている．そのため，Rubyにはいくつかのlibraryが用意されている．
+!!3 開発要件
+Todoアプリケーションの構造はlib/todo/command/options.rbにサブコマンド用の定義があり，入力されたコマンドはilb/todo/command.rbで判断されることでlib/todo/command/options.rb内で実行される．hikiutilsの構造はTodoアプリケーションの構造と同じでhikiの編集を容易にするためのツール群のため，この部分の変更を行うことでコマンド名を書き換える．
+!!4 考察
+現在はTodoアプリケーションの作成を行うことでプログラムの構造の理解をしている．しかし，まだhikiutilsのコマンド名の変更までには達していない．今後の課題としては，誰が見てもコマンドの機能が判断できるコマンド名を考え，実際にhikiutils内でそのコマンドを実装する必要がある．
+!!参考文献
+[1]hikiwiki.org/ja/about.html

data/abst/testhiki2

@@ -0,0 +1,106 @@
+\documentclass[a4j,twocolumn]{jsarticle}
+\usepackage{subfigure}
+
+\def\Vec#1{\mbox{\boldmath $#1$}}
+\usepackage[dvipdfmx]{graphicx}
+\usepackage{url}
+
+
+\setlength{\textheight}{275mm}
+\headheight 5mm
+\topmargin -30mm
+\textwidth 185mm
+\oddsidemargin -15mm
+\evensidemargin -15mm
+\pagestyle{empty}
+\begin{document}
+\title{hiki編集作業を容易にするツールの開発}
+\author{情報科学科 西谷研究室 3554 山根 亮太}
+\date{}
+\maketitle
+\section{目的}
+
+hikiはwiki cloneとして便利．
+
+hikiは，通常web上で編集しているが，なにが不便?
+
+GUIとCUIが混在してしまい，操作が不便である．
+そこで，編集操作がCUIで完結するために，hikiutilsが開発された．
+しかしそのユーザインターフェースに問題がある．
+現在hikiでコマンドを入力する際，ユーザーは瞬間的にそのコマンドの機能や意味を判断することが難しく迷いが生じてしまうことがある．
+
+具体的な作業は，hikiのコマンド名をshell風にすることで瞬時にコマンドの機能を判断し使用することができるようにすることである．
+
+しかし，この開発をすることでユーザーはコマンド入力の際にそのコマンドの機能が分からなくなって入力に迷ったり，コマンド自体を忘れたりすることがなくなりより簡単に入力ができ，時間短縮にも繋がる．そのため，hikiのコマンド名をshell風に書き換えることでこの問題を解決したい.
+
+\section{システムについて}
+\subsection{hikiについて}
+hikiとはwikiエンジンの１つとされており，プログラミング言語Rubyを用いられることで作られたwikiクローンである．
+hikiの主な特徴として
+\begin{itemize}
+\item オリジナルwikiに似たシンプルな書式
+\item プラグインによる機能拡張
+\item 出力するHTMLを柔軟に変更可能
+\item ページにカテゴリ付けできる
+\item CSSを使ったテーマ機能
+\item 携帯端末可能
+\item InterWikiのサポート
+\item HikiFarmに対応
+\item ページの追加，編集がしやすい
+\end{itemize}
+等がある\cite{hiki}．
+
+\subsection{hikiutilsについて}
+hikiutilsは，hikiの編集作業を容易に行うことができるようにするツール群である．
+よって，今回の研究はhikiutilsのプログラムを編集することで瞬時にコマンドの機能や意味を理解できるコマンド名を考え編集を行う．
+hikiutilsはプログラミング言語Rubyのライブラリであるgemによって提供されている\cite{gem}．
+hikiutilsはCLI(Command Line Interface)で提供されているため，
+プログラミング言語Ruby版のコマンドラインのオプション解析を行いコマンドを標準化にするoptparseが利用されている\cite{opt}．
+そのため，CLIのoptparseを簡単に扱うためにRubyにはいくつかのlibraryが用意されている．
+
+\section{手法}
+このようなCLIの階層的なコマンド実装を示したcodeとしてTodoというgemアプリケーションがある\cite{PerfectRuby}．
+このプログラムではlib/todo/command/options.rbにサブコマンド用の定義があり，入力されたコマンドはilb/todo/command.rbで判断されることによりlib/todo/command/options.rb内で実行される．hikiutilsのプログラムの構造はTodoアプリケーションのプログラムの構造と似たものでありhikiの編集を容易にするためのツール群のため，この部分の編集を行うことでコマンド名を書き換える．
+
+\section{考察}
+
+他の視点から言えない?　が見れない?
+
+todoのコードを追いかけて．
+
+直感的なコマンドname？　shell風，git風， help?
+
+似たようなソフトに何がある?
+
+似たようなアプリに何がある?
+
+\begin{verbatim}
+hikiutils: provide utilities for helping hiki editing.
+"open -a mi"
+Usage: hiki [options]
+    -v, --version        show program Version.
+    -s, --show           show sources
+    -a, --add            add sources info
+    -t, --target VAL     set target id
+    -e, --edit FILE      open file
+    -l, --list [FILE]    list files
+    -u, --update FILE    update file
+    -r, --rsync          rsync files
+        --database FILE  read database file
+        --display FILE   display converted hikifile
+    -c, --checkdb        check database file
+        --remove FILE    remove file
+        --move FILES     move file1,file2
+        --euc FILE       translate file to euc
+\end{verbatim}
+
+
+現在Todoアプリケーションのコードを追いかけて，プログラムの構造を理解している．しかし，hikiのコマンド名の変更や直感的なコマンド名を考えることは現在できていない．今後の課題としては，まず初めにTodoアプリケーションの構造を理解することでhikiutilsの構造を理解する．また，誰が見ても機能が判断できるコマンド名を考え，実際にhikiutils内でそのコマンドの編集を行って実装し，そのコマンドが分かりやすいものであるかどうかを試してもらう必要がある．
+
+\begin{thebibliography}{9}
+\bibitem{hiki}「hiki」,hikiwiki.org/ja/about.html,2016/9/2 アクセス.
+\bibitem{gem}「Rubygems-Wikipedia」,\url{ja.wikipedia.org/wiki/RubyGems},2016/9/2 アクセス.
+\bibitem{opt}「optparseの使い方」,\url{dharry.hatenablog.com/entry/20081008/1223490673},2016/9/2 アクセス.
+\bibitem{PerfectRuby}「パーフェクトRuby」,Rubyサポーターズ(技術評論社 2013).
+\end{thebibliography}
+\end{document}

data/abst/yamane_abst.tex

@@ -0,0 +1,59 @@
+\documentclass[a4j,twocolumn]{jsarticle}
+\usepackage{subfigure}
+
+\def\Vec#1{\mbox{\boldmath $#1$}}
+\usepackage[dvipdfmx]{graphicx}
+
+\setlength{\textheight}{275mm}
+\headheight 5mm
+\topmargin -30mm
+\textwidth 185mm
+\oddsidemargin -15mm
+\evensidemargin -15mm
+\pagestyle{empty}
+\begin{document}
+\title{hiki編集作業を容易にするツールの開発}
+\author{情報科学科 西谷研究室 3554 山根 亮太}
+\date{}
+\maketitle
+\section{目的}
+
+もう少し広い範囲の開発目標の中で，具体的な作業として，コマンドの命名規則を見直す．
+
+本研究の目的は，hikiのコマンド名をshell風にすることで瞬時にコマンドの機能を判断し使用することができるようにすることである．現在hikiでコマンドを入力する際，ユーザーは瞬間的にそのコマンドの機能や意味を判断することが難しく迷いが生じてしまうことがある．その解決策として，hikiのコマンド名をshell風に書き換えることでこの問題を解決したい．
+
+\section{手法}
+\subsection{hikiについて}
+hikiとはwikiエンジンの１つとされており，Rubyを用いられることで作られたwikiクローンである．主なhikiの特徴として
+\begin{itemize}
+\item オリジナルwikiに似たシンプルな書式
+\item プラグインによる機能拡張
+\item 出力するHTMLを柔軟に変更可能
+\item ページにカテゴリ付けできる
+\item CSSを使ったテーマ機能
+\item 携帯端末可能
+\item InterWikiのサポート
+\item HikiFarmに対応
+\item ページの追加，編集がしやすい
+\end{itemize}
+等がある\cite{hiki}．
+
+gemについて何を書く?　
+
+hikiutilsの動作内容を解説．
+hikiutilsはgemで提供されている．CLI(character line interface)で提供されているので，そのコマンドを標準化するライブラリoptparseを利用する．
+
+CLIのoptionのparseを簡単に扱うためにRubyにはいくつかのlibraryが用意されている．
+
+評価．観点．optparse
+
+\section{開発要件}
+Todoアプリケーションの構造はlib/todo/command/options.rbにサブコマンド用の定義があり，入力されたコマンドはlib/todo/command.rbで判断されることでlib/todo/command/options.rb内で実行される．hikiutilsの構造はTodoアプリケーションの構造と同じでhikiの編集を容易にするためのツール群のため，この部分の変更を行うことでコマンド名を書き換える．
+
+\section{考察}
+現在はTodoアプリケーションの作成を行うことでプログラムの構造の理解をしている．しかし，まだhikiutilsのコマンド名の変更までには達していない．今後の課題としては，誰が見てもコマンドの機能が判断できるコマンド名を考え，実際にhikiutils内でそのコマンドを実装する必要がある．
+
+\begin{thebibliography}{9}
+\bibitem{hiki}hikiサイト．
+\end{thebibliography}
+\end{document}

data/abst/yamane_powerpoint.pptx/Metadata/BuildVersionHistory.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<array>
+	<string>pptx</string>
+	<string>M6.1-1769-1</string>
+</array>
+</plist>

data/abst/yamane_powerpoint.pptx/Metadata/DocumentIdentifier

@@ -0,0 +1 @@
+120BA139-C23B-4290-8A16-71ECA44979FB

data/lib/hikiutils/version.rb

@@ -1,3 +1,3 @@
 module HikiUtils
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/hikiutils.rb

@@ -68,6 +68,7 @@ EOS
         opt.on('--remove FILE','remove file') {|file| remove_file(file)}
         opt.on('--move FILES','move file1,file2',Array) {|files| move_file(files)}
         opt.on('--euc FILE','translate file to euc') {|file| euc_file(file) }
+        opt.on('--initialize','initialize source directory') {dir_init() }
       end
       begin
         command_parser.parse!(@argv)
@@ -78,6 +79,37 @@ EOS
       exit
     end
 
+    def dir_init()
+      begin
+        p target_dir = File.readlines('./.hikirc')[0]
+      rescue
+        p target_dir=@src[:srcs][@target][:local_dir]
+        File.open('./.hikirc','w'){|file| file.print "#{target_dir}\n"}
+      end
+      cp_files=[['Rakefile_hiki_sync','Rakefile'],
+                ['hiki_help.yml','hiki_help.yml']]
+      cp_files.each{|files|
+        p source = File.join(File.expand_path('..', __FILE__),'templates',files[0])
+        p target = File.join(Dir.pwd,files[1])
+        FileUtils.cp(source,target,:verbose=>true)
+      }
+      ['figs','data'].each{|dir|
+        begin
+          Dir.mkdir(dir)
+        rescue => e
+          print e
+        end
+      }
+      begin
+        p cont=File.read('./.gitignore')
+        unless cont.include?('.hikirc')
+          File.open('./.gitignore','w'){|file| file.print(".hikirc\n")}
+        end
+      rescue
+        File.open('./.gitignore','w'){|file| file.print(".hikirc\n")}
+      end
+    end
+
     def display(file)
       body = HikiDoc.to_html(File.read(file))
       source = HTML_TEMPLATE
@@ -202,12 +234,16 @@ EOS
       file = (file0==nil) ? 'FrontPage' : file0
       #rm cache file
       t_file=File.join(@l_dir,'cache/parser',file)
-      FileUtils.rm(t_file,:verbose=>true)
-
+      begin
+        FileUtils.rm(t_file,:verbose=>true)
       #update info file
       info=InfoDB.new(@l_dir)
       info.update(file0)
 
+      rescue 
+        print "some errors on touch, but dont mind...\n"
+      end
+
       #open file on browser
       l_path = @src[:srcs][@target][:local_uri]
 #      p command="open -a #{@browser} \'#{l_path}/?c=edit;p=#{file}\'"

data/lib/templates/Rakefile_hiki_sync

@@ -0,0 +1,61 @@
+begin
+  target_dir = File.readlines('./.hikirc')[0].chomp
+rescue => e
+  puts e
+  exit
+end
+p target_dir
+
+task :default do
+  system 'rake -T'
+end
+
+desc "convert fig size"
+task :convert do
+  source = ARGV[2]
+  scale = ARGV[1]
+  target = File.join('figs',source)
+  p command = "convert #{source} -resize #{scale}\% #{target}"
+  system command
+  exit
+end
+
+desc "sync hikis and figs to hiki directory"
+task :sync do
+  p dirnames=Dir.pwd.split('/')
+  p basename = (dirnames[-1]=='hikis')? dirnames[-2] : dirnames[-1]
+  p entries=Dir.entries('.')
+  entries[2..-1].each{|source| #cp *.hiki
+    next unless source.include?('.hiki')
+    next if source.include?('.hikirc')
+    p base = source.split('.')[0]
+    name = (base==basename)? base : basename+'_'+base
+    p target = File.join(target_dir,'text',name)
+    FileUtils.cp(source,target,:verbose=>true)
+  }
+  p entries=Dir.entries('./figs') #cp files in figs
+  entries[2..-1].each{|file|
+    p source = File.join('./figs',file)
+    p target = File.join(target_dir,'cache','attach',basename)
+    FileUtils.cp(source,target,:verbose=>true)
+  }
+  exit
+end
+
+desc "For hiki Errno::ENOENT, Errno::EACCES"
+task :chenv do
+  p user = ENV['USER']
+  system("sudo chmod -R a+w #{target_dir}")
+  system("sudo chown -R #{user} #{target_dir}")
+end
+
+desc "self copy to hikiutils template directory"
+task :self_copy do
+  p cp_files=[['Rakefile','Rakefile_hiki_sync'],
+            [File.join(ENV['HOME'],'.my_help','hiki_help.yml'),'hik_help.yml']]
+  cp_files.each{|files|
+    p source = File.join(Dir.pwd,'Rakefile')
+    p target = File.join('/Users/bob/Github/hikiutils/lib/templates/',files[1])
+    FileUtils.cp(source,target,:verbose=>true)
+  }
+end

data/lib/templates/hik_help.yml

@@ -0,0 +1,61 @@
+begin
+  target_dir = File.readlines('./.hikirc')[0].chomp
+rescue => e
+  puts e
+  exit
+end
+p target_dir
+
+task :default do
+  system 'rake -T'
+end
+
+desc "convert fig size"
+task :convert do
+  source = ARGV[2]
+  scale = ARGV[1]
+  target = File.join('figs',source)
+  p command = "convert #{source} -resize #{scale}\% #{target}"
+  system command
+  exit
+end
+
+desc "sync hikis and figs to hiki directory"
+task :sync do
+  p dirnames=Dir.pwd.split('/')
+  p basename = (dirnames[-1]=='hikis')? dirnames[-2] : dirnames[-1]
+  p entries=Dir.entries('.')
+  entries[2..-1].each{|source| #cp *.hiki
+    next unless source.include?('.hiki')
+    next if source.include?('.hikirc')
+    p base = source.split('.')[0]
+    name = (base==basename)? base : basename+'_'+base
+    p target = File.join(target_dir,'text',name)
+    FileUtils.cp(source,target,:verbose=>true)
+  }
+  p entries=Dir.entries('./figs') #cp files in figs
+  entries[2..-1].each{|file|
+    p source = File.join('./figs',file)
+    p target = File.join(target_dir,'cache','attach',basename)
+    FileUtils.cp(source,target,:verbose=>true)
+  }
+  exit
+end
+
+desc "For hiki Errno::ENOENT, Errno::EACCES"
+task :chenv do
+  p user = ENV['USER']
+  system("sudo chmod -R a+w #{target_dir}")
+  system("sudo chown -R #{user} #{target_dir}")
+end
+
+desc "self copy to hikiutils template directory"
+task :self_copy do
+  p cp_files=[['Rakefile','Rakefile_hiki_sync'],
+            [File.join(ENV['HOME'],'.my_help','hiki_help.yml'),'hik_help.yml']]
+  cp_files.each{|files|
+    p source = File.join(Dir.pwd,'Rakefile')
+    p target = File.join('/Users/bob/Github/hikiutils/lib/templates/',files[1])
+    FileUtils.cp(source,target,:verbose=>true)
+  }
+end

data/lib/templates/hiki_help.yml

@@ -0,0 +1,29 @@
+---
+:head:
+- hikiutil関連のヘルプ
+:initialize:
+  :opts:
+    :short: "-i"
+    :long: "--initialize"
+    :desc: localでの同期directoryの初期化
+  :title: localでの同期directoryの初期化
+  :cont:
+  - hiki --initializeで必要なファイル(Rakefile, ./.hikirc)がcopyされる
+  - rake syncによってhikiディレクトリーと同期が取られる
+  - rake convert 20 TARGET.pngによって，figs/TAERGET.pngに20%縮小して保存される
+  - hiki -u TARGETによってブラウザー表示される
+  - テキストの拡張子は'.hiki'
+  - hikiでのurlはテキスト前とディレクトリーから自動生成される
+  - 例えば，hiki2latex_saki/introduciton.hikiとするとhiki2latex_saki_introducitonと変換される
+  - |
+    attach_anchorでは
+    '{{attach_anchor(test.png, hiki2latex_saki)}}'
+    と，directory指定しなければならない.
+:syncpwd:
+  :opts:
+    :short: "-s"
+    :long: "--syncpwd"
+    :desc: syncpwd
+  :title: syncpwd
+  :cont:
+  - syncpwd

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hikiutils
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Shigeto R. Nishitani
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,6 +167,56 @@ files:
 - README.md
 - Rakefile
 - Rakefile.orig
+- abst/#testhiki#
+- abst/.DS_Store
+- abst/out2.pdf
+- abst/out3.aux
+- abst/out3.log
+- abst/out3.pdf
+- abst/out3.synctex.gz
+- abst/out3.tex
+- abst/out4.aux
+- abst/out4.log
+- abst/out4.pdf
+- abst/out4.synctex.gz
+- abst/out4.tex
+- abst/testhiki
+- abst/testhiki2
+- abst/yamane_abst.pdf
+- abst/yamane_abst.tex
+- abst/yamane_abst_new.pdf
+- abst/yamane_powerpoint.key
+- abst/yamane_powerpoint.pptx/Data/PresetImageFill0-1.jpg
+- abst/yamane_powerpoint.pptx/Data/PresetImageFill1-2.jpg
+- abst/yamane_powerpoint.pptx/Data/PresetImageFill2-3.jpg
+- abst/yamane_powerpoint.pptx/Data/PresetImageFill3-4.jpg
+- abst/yamane_powerpoint.pptx/Data/PresetImageFill4-5.jpg
+- abst/yamane_powerpoint.pptx/Data/PresetImageFill5-6.jpg
+- abst/yamane_powerpoint.pptx/Data/image1-12.png
+- abst/yamane_powerpoint.pptx/Data/image1-9.png
+- abst/yamane_powerpoint.pptx/Data/mt0@2x-13.jpg
+- abst/yamane_powerpoint.pptx/Data/mt10@2x-22.jpg
+- abst/yamane_powerpoint.pptx/Data/mt1@2x-14.jpg
+- abst/yamane_powerpoint.pptx/Data/mt2@2x-15.jpg
+- abst/yamane_powerpoint.pptx/Data/mt3@2x-16.jpg
+- abst/yamane_powerpoint.pptx/Data/mt4@2x-17.png
+- abst/yamane_powerpoint.pptx/Data/mt5@2x-18.jpg
+- abst/yamane_powerpoint.pptx/Data/mt6@2x-19.jpg
+- abst/yamane_powerpoint.pptx/Data/mt7@2x-20.png
+- abst/yamane_powerpoint.pptx/Data/mt8@2x-21.jpg
+- abst/yamane_powerpoint.pptx/Data/st0-23.jpg
+- abst/yamane_powerpoint.pptx/Data/st1-24.jpg
+- abst/yamane_powerpoint.pptx/Data/st2-25.jpg
+- abst/yamane_powerpoint.pptx/Data/st3-26.jpg
+- abst/yamane_powerpoint.pptx/Data/st4-276.jpg
+- abst/yamane_powerpoint.pptx/Data/st5-279.jpg
+- abst/yamane_powerpoint.pptx/Index.zip
+- abst/yamane_powerpoint.pptx/Metadata/BuildVersionHistory.plist
+- abst/yamane_powerpoint.pptx/Metadata/DocumentIdentifier
+- abst/yamane_powerpoint.pptx/Metadata/Properties.plist
+- abst/yamane_powerpoint.pptx/preview-micro.jpg
+- abst/yamane_powerpoint.pptx/preview-web.jpg
+- abst/yamane_powerpoint.pptx/preview.jpg
 - bin/console
 - bin/setup
 - exe/hiki
@@ -184,6 +234,9 @@ files:
 - lib/hikiutils/infodb.rb
 - lib/hikiutils/tmarshal.rb
 - lib/hikiutils/version.rb
+- lib/templates/Rakefile_hiki_sync
+- lib/templates/hik_help.yml
+- lib/templates/hiki_help.yml
 homepage: http://github.org/daddygongon/hikiutils
 licenses:
 - MIT