hikiutils 0.2.3.4 → 0.2.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/exe/hiki +1 -3
- data/exe/hiki_thor +0 -3
- data/exe/hiki_thor~ +8 -0
- data/exe/hiki~ +8 -0
- data/hikiutils.gemspec +1 -0
- data/hikiutils_bob/Rakefile +10 -27
- data/hikiutils_bob/figs/hikiutils_bob.004.jpeg +0 -0
- data/hikiutils_bob/{private_dir.graffle → hikiutils_bob.graffle} +1 -1
- data/hikiutils_bob/hikiutils_bob.key +0 -0
- data/hikiutils_bob/hikiutils_bob/hikiutils_bob.004.jpeg +0 -0
- data/hikiutils_bob/latex_all.hiki +7 -3
- data/hikiutils_bob/latex_dir/hikiutils_bob.log +99 -84
- data/hikiutils_bob/latex_dir/hikiutils_bob.pdf +0 -0
- data/hikiutils_bob/latex_dir/hikiutils_bob.synctex.gz +0 -0
- data/hikiutils_bob/latex_dir/hikiutils_bob.toc +14 -10
- data/hikiutils_bob/latex_dir/latex_all.aux +10 -10
- data/hikiutils_bob/latex_dir/latex_all.tex +14 -5
- data/hikiutils_bob/latex_dir/sync.aux +14 -8
- data/hikiutils_bob/latex_dir/sync.tex +70 -17
- data/hikiutils_bob/sync.hiki +44 -7
- data/hikiutils_yamane/Rakefile +32 -31
- data/hikiutils_yamane/abstract.hiki +1 -0
- data/hikiutils_yamane/backup/hikiutils%28optparse%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%29 +309 -0
- data/hikiutils_yamane/backup/hikiutils%28thor%E3%83%90%E3%83%BC%E3%82%B8%E3%83%A7%E3%83%B3%29 +1 -0
- data/hikiutils_yamane/backup/hikiutils_yamane +703 -0
- data/hikiutils_yamane/backup/hikiutils_yamane.hiki +0 -0
- data/hikiutils_yamane/backup/hikiutils_yamane_#hikiutils_yamane +1 -0
- data/hikiutils_yamane/backup/hikiutils_yamane_command_table +19 -0
- data/hikiutils_yamane/backup/hikiutils_yamane_introduction +7 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.001.jpeg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.001.jpg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.002.jpeg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.002.jpg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.003.jpeg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.003.jpg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.004.jpeg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.004.jpg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.005.jpeg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.005.jpg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.006.jpeg +0 -0
- data/hikiutils_yamane/figs/hikiutils_yamane.007.jpeg +0 -0
- data/hikiutils_yamane/hikiutils_yamane.hiki +37 -1
- data/hikiutils_yamane/hikiutils_yamane.key +0 -0
- data/hikiutils_yamane/hikiutils_yamane.key~11b9dba1272d2104b420497d11c6eda206ace6c2 +0 -0
- data/hikiutils_yamane/introduction.hiki +27 -0
- data/hikiutils_yamane/latex_dir/abstract.aux +22 -0
- data/hikiutils_yamane/latex_dir/abstract.tex +1 -0
- data/hikiutils_yamane/latex_dir/command_table.tex +1 -1
- data/hikiutils_yamane/latex_dir/head.tex +2 -2
- data/hikiutils_yamane/latex_dir/hikiutils_yamane.aux +3 -0
- data/hikiutils_yamane/latex_dir/hikiutils_yamane.log +224 -84
- data/hikiutils_yamane/latex_dir/hikiutils_yamane.pdf +0 -0
- data/hikiutils_yamane/latex_dir/hikiutils_yamane.synctex.gz +0 -0
- data/hikiutils_yamane/latex_dir/hikiutils_yamane.tex +16 -2
- data/hikiutils_yamane/latex_dir/hikiutils_yamane.toc +20 -0
- data/hikiutils_yamane/latex_dir/introduction.aux +26 -0
- data/hikiutils_yamane/latex_dir/introduction.tex +33 -0
- data/hikiutils_yamane/latex_dir/results.aux +45 -0
- data/hikiutils_yamane/latex_dir/results.tex +342 -0
- data/hikiutils_yamane/latex_dir/system.tex +23 -0
- data/hikiutils_yamane/results.hiki +376 -0
- data/hikiutils_yamane/system.hiki +18 -0
- data/lib/hikiutils.rb +7 -3
- data/lib/hikiutils.rb~ +387 -0
- data/lib/hikiutils/version.rb +1 -1
- data/lib/hikiutils_thor.rb +36 -20
- data/lib/hikiutils_thor.rb~ +324 -0
- data/lib/templates/Rakefile_hiki_sync +35 -31
- metadata +57 -3
|
Binary file
|
|
Binary file
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
\contentsline {section}{\numberline {1}イントロダクション}{3}
|
|
2
|
-
\contentsline {section}{\numberline {2}hikiとの同期}{
|
|
3
|
-
\contentsline {subsection}{\numberline {2.1}hikiutilsのinstall}{
|
|
2
|
+
\contentsline {section}{\numberline {2}hikiとの同期}{3}
|
|
3
|
+
\contentsline {subsection}{\numberline {2.1}hikiutilsのinstall}{3}
|
|
4
4
|
\contentsline {subsection}{\numberline {2.2}個別ディレクトリーの構成}{4}
|
|
5
5
|
\contentsline {subsection}{\numberline {2.3}一般的な執筆手順}{5}
|
|
6
6
|
\contentsline {subsection}{\numberline {2.4}rakeが用意しているタスク}{6}
|
|
@@ -11,11 +11,15 @@
|
|
|
11
11
|
\contentsline {subsubsection}{\numberline {2.4.5}rake increment}{7}
|
|
12
12
|
\contentsline {subsubsection}{\numberline {2.4.6}rake number}{7}
|
|
13
13
|
\contentsline {subsection}{\numberline {2.5}githubによる同期}{8}
|
|
14
|
-
\contentsline {
|
|
15
|
-
\contentsline {
|
|
16
|
-
\contentsline {
|
|
17
|
-
\contentsline {subsubsection}{\numberline {
|
|
18
|
-
\contentsline {
|
|
19
|
-
\contentsline {
|
|
20
|
-
\contentsline {
|
|
21
|
-
\contentsline {
|
|
14
|
+
\contentsline {subsection}{\numberline {2.6}hikiutil関連のヘルプ}{9}
|
|
15
|
+
\contentsline {subsubsection}{\numberline {2.6.1}hikiで卒論を書くときの初期化と掟}{9}
|
|
16
|
+
\contentsline {subsubsection}{\numberline {2.6.2}error対応}{10}
|
|
17
|
+
\contentsline {subsubsection}{\numberline {2.6.3}図表:すべての図表をkeynoteにまとめる,タイトルを分かりやすく書く}{10}
|
|
18
|
+
\contentsline {section}{\numberline {3}実際の最終形態(卒論=pdf)への変換}{11}
|
|
19
|
+
\contentsline {subsection}{\numberline {3.1}install}{11}
|
|
20
|
+
\contentsline {subsection}{\numberline {3.2}rake latex手順(個別ファイルの変換)}{12}
|
|
21
|
+
\contentsline {subsubsection}{\numberline {3.2.1}注意}{12}
|
|
22
|
+
\contentsline {subsection}{\numberline {3.3}rake latex\_all手順(ディレクトリー内の一括変換)}{13}
|
|
23
|
+
\contentsline {subsubsection}{\numberline {3.3.1}下準備}{13}
|
|
24
|
+
\contentsline {paragraph}{head.tex}{14}
|
|
25
|
+
\contentsline {paragraph}{pre.tex}{14}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
\relax
|
|
2
|
-
\@writefile{toc}{\contentsline {section}{\numberline {3}実際の最終形態(卒論=pdf)への変換}{
|
|
3
|
-
\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}install}{
|
|
4
|
-
\@writefile{toc}{\contentsline {subsection}{\numberline {3.2}rake latex手順(個別ファイルの変換)}{
|
|
5
|
-
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.1}注意}{
|
|
6
|
-
\@writefile{toc}{\contentsline {subsection}{\numberline {3.3}rake latex\_all手順(ディレクトリー内の一括変換)}{
|
|
7
|
-
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.1}下準備}{
|
|
8
|
-
\@writefile{toc}{\contentsline {paragraph}{head.tex}{
|
|
9
|
-
\@writefile{toc}{\contentsline {paragraph}{pre.tex}{
|
|
2
|
+
\@writefile{toc}{\contentsline {section}{\numberline {3}実際の最終形態(卒論=pdf)への変換}{11}}
|
|
3
|
+
\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}install}{11}}
|
|
4
|
+
\@writefile{toc}{\contentsline {subsection}{\numberline {3.2}rake latex手順(個別ファイルの変換)}{12}}
|
|
5
|
+
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.1}注意}{12}}
|
|
6
|
+
\@writefile{toc}{\contentsline {subsection}{\numberline {3.3}rake latex\_all手順(ディレクトリー内の一括変換)}{13}}
|
|
7
|
+
\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.3.1}下準備}{13}}
|
|
8
|
+
\@writefile{toc}{\contentsline {paragraph}{head.tex}{14}}
|
|
9
|
+
\@writefile{toc}{\contentsline {paragraph}{pre.tex}{14}}
|
|
10
10
|
\@setckpt{latex_all}{
|
|
11
|
-
\setcounter{page}{
|
|
11
|
+
\setcounter{page}{16}
|
|
12
12
|
\setcounter{equation}{0}
|
|
13
13
|
\setcounter{enumi}{4}
|
|
14
14
|
\setcounter{enumii}{1}
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
\setcounter{subsubsection}{1}
|
|
23
23
|
\setcounter{paragraph}{0}
|
|
24
24
|
\setcounter{subparagraph}{0}
|
|
25
|
-
\setcounter{figure}{
|
|
25
|
+
\setcounter{figure}{3}
|
|
26
26
|
\setcounter{table}{1}
|
|
27
27
|
\setcounter{lstnumber}{38}
|
|
28
28
|
\setcounter{lstlisting}{0}
|
|
@@ -7,6 +7,7 @@ hiki+keynoteで卒論の内容ができたら,それを卒論の最終形態
|
|
|
7
7
|
文書として完成度を高めるには,latexで細かい設定を調整する必要がどうしても出てきます.
|
|
8
8
|
|
|
9
9
|
具体的には,
|
|
10
|
+
|
|
10
11
|
\begin{enumerate}
|
|
11
12
|
\item 図の配置を調整するwrapの数値調整
|
|
12
13
|
\item 参照文献の記述
|
|
@@ -52,6 +53,7 @@ rake latex sync.hiki
|
|
|
52
53
|
latex_dir/sync.tex
|
|
53
54
|
\end{verbatim}\end{quote}
|
|
54
55
|
にlatex変換後のファイルが生成します.これを,TeXShopでcommand\_t変換します.
|
|
56
|
+
|
|
55
57
|
\begin{itemize}
|
|
56
58
|
\item \verb|{{attach_anchor(sync.pdf,hikiutils_bob)}}|
|
|
57
59
|
\end{itemize}
|
|
@@ -79,10 +81,11 @@ hikiの初めの部分は,
|
|
|
79
81
|
\end{lstlisting}
|
|
80
82
|
と変換してくれます.
|
|
81
83
|
|
|
82
|
-
必要な図は,figs
|
|
84
|
+
必要な図は,figsから自動で取るようになっていますが,
|
|
85
|
+
サイズや解像度が問題のときは手動で調整してください.
|
|
83
86
|
|
|
84
87
|
\subsection{rake latex\_all手順(ディレクトリー内の一括変換)}
|
|
85
|
-
pwdのdirectory
|
|
88
|
+
pwdのdirectoryと同名のbasenameに.hikiの拡張子がついたファイルが用意されていて,
|
|
86
89
|
\begin{quote}\begin{verbatim}
|
|
87
90
|
rake latex_all
|
|
88
91
|
\end{verbatim}\end{quote}
|
|
@@ -99,7 +102,8 @@ bob% cat hikiutils_bob.hiki
|
|
|
99
102
|
とすると,sync.tex, latex\_all.texがlatex\_dir内に変換されます.
|
|
100
103
|
さらに,開いているhikiutils\_bob.texをTeXShopで変換してみてください.
|
|
101
104
|
|
|
102
|
-
うまくできないときは\verb|ここ(http://qiita.com/hideaki_polisci/items/3afd204449c6cdd995c9
|
|
105
|
+
うまくできないときは\verb|ここ(http://qiita.com/hideaki_polisci/items/3afd204449c6cdd995c9)|を参照して自力で入れてみてください.だめならdonkey.
|
|
106
|
+
|
|
103
107
|
\begin{itemize}
|
|
104
108
|
\item \verb|{{attach_anchor(hikiutils_bob.pdf,hikiutils_bob)}}|
|
|
105
109
|
\end{itemize}
|
|
@@ -113,7 +117,9 @@ hiki -i
|
|
|
113
117
|
とhikiutils環境を再度初期化すると,自動でインストールする設定です.
|
|
114
118
|
なかったら手動で作ってください.
|
|
115
119
|
|
|
116
|
-
\paragraph{head.tex}
|
|
120
|
+
\paragraph{head.tex}
|
|
121
|
+
題目,学生番号,氏名を変更する.年月をチェック.
|
|
122
|
+
\begin{lstlisting}[style=]
|
|
117
123
|
bob% cat head.tex
|
|
118
124
|
\title{卒業論文\\
|
|
119
125
|
\vspace{4cm} hikiutilsを用いた\\卒業論文作成}
|
|
@@ -123,7 +129,10 @@ bob% cat head.tex
|
|
|
123
129
|
\maketitle
|
|
124
130
|
|
|
125
131
|
\end{lstlisting}
|
|
126
|
-
\paragraph{pre.tex}
|
|
132
|
+
\paragraph{pre.tex}
|
|
133
|
+
あまり変更しないほうがいいが,いずれいじる.例えば,フォントポイント数を10から12ptに変える,
|
|
134
|
+
\pagestyle{empty}を外すなど.
|
|
135
|
+
\begin{lstlisting}[style=]
|
|
127
136
|
bob% cat pre.tex
|
|
128
137
|
\documentclass[10pt,a4j]{article}
|
|
129
138
|
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
\relax
|
|
2
2
|
\@writefile{toc}{\contentsline {section}{\numberline {1}イントロダクション}{3}}
|
|
3
|
-
\@writefile{
|
|
4
|
-
\
|
|
5
|
-
\@writefile{
|
|
6
|
-
|
|
3
|
+
\@writefile{toc}{\contentsline {section}{\numberline {2}hikiとの同期}{3}}
|
|
4
|
+
\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}hikiutilsのinstall}{3}}
|
|
5
|
+
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces 卒論編集システムの概要.}}{4}}
|
|
6
|
+
\newlabel{default}{{1}{4}}
|
|
7
7
|
\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}個別ディレクトリーの構成}{4}}
|
|
8
8
|
\@writefile{lof}{\contentsline {figure}{\numberline {2}{\ignorespaces hikiutils\_bobのディレクトリー構成.}}{5}}
|
|
9
9
|
\newlabel{default}{{2}{5}}
|
|
@@ -18,8 +18,14 @@
|
|
|
18
18
|
\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.4.5}rake increment}{7}}
|
|
19
19
|
\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.4.6}rake number}{7}}
|
|
20
20
|
\@writefile{toc}{\contentsline {subsection}{\numberline {2.5}githubによる同期}{8}}
|
|
21
|
+
\@writefile{lof}{\contentsline {figure}{\numberline {3}{\ignorespaces 卒論編集時のgithubによる同期のシーケンス図.}}{9}}
|
|
22
|
+
\newlabel{default}{{3}{9}}
|
|
23
|
+
\@writefile{toc}{\contentsline {subsection}{\numberline {2.6}hikiutil関連のヘルプ}{9}}
|
|
24
|
+
\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.6.1}hikiで卒論を書くときの初期化と掟}{9}}
|
|
25
|
+
\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.6.2}error対応}{10}}
|
|
26
|
+
\@writefile{toc}{\contentsline {subsubsection}{\numberline {2.6.3}図表:すべての図表をkeynoteにまとめる,タイトルを分かりやすく書く}{10}}
|
|
21
27
|
\@setckpt{sync}{
|
|
22
|
-
\setcounter{page}{
|
|
28
|
+
\setcounter{page}{11}
|
|
23
29
|
\setcounter{equation}{0}
|
|
24
30
|
\setcounter{enumi}{6}
|
|
25
31
|
\setcounter{enumii}{1}
|
|
@@ -29,11 +35,11 @@
|
|
|
29
35
|
\setcounter{mpfootnote}{0}
|
|
30
36
|
\setcounter{part}{0}
|
|
31
37
|
\setcounter{section}{2}
|
|
32
|
-
\setcounter{subsection}{
|
|
33
|
-
\setcounter{subsubsection}{
|
|
38
|
+
\setcounter{subsection}{6}
|
|
39
|
+
\setcounter{subsubsection}{3}
|
|
34
40
|
\setcounter{paragraph}{0}
|
|
35
41
|
\setcounter{subparagraph}{0}
|
|
36
|
-
\setcounter{figure}{
|
|
42
|
+
\setcounter{figure}{3}
|
|
37
43
|
\setcounter{table}{1}
|
|
38
44
|
\setcounter{lstnumber}{3}
|
|
39
45
|
\setcounter{lstlisting}{0}
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
|
|
2
2
|
\section{イントロダクション}
|
|
3
|
-
|
|
3
|
+
卒業論文は,大学で課される普通の授業のレポートに比べて多くの情報内容が要求されます.また,研究という側面から体裁や版権など多くの出版における掟を遵守しながら,高い品質を保つ必要です.そのため,指導教官との編集作業が重要となるます.編集作業の効率を高めるためには,共同作業を促進するプラットフォームが必要です.
|
|
4
4
|
|
|
5
|
-
体裁などを考えるとLatex
|
|
5
|
+
体裁などを考えるとLatexの使用が標準ですが,執筆段階での煩わしさを低減するため,Mark Up記法による文章作成が一般的です(「ドキュメント作成システム構築ガイド,GitHub, RedPen, Asciidoctor, CIによるモダンライティング」, 伊藤敬彦,吉村孝広,技術評論社).西谷研ではMark Up記法の一種であるhiki記法を用いて執筆します.hiki記法からhtmlへ変換するソフトhikidocによる容易な変換が可能なため,日記web appliのhiki diaryでも利用されている有名なソフトです.hiki記法をベースにして,wiki wiki webと同等の機能を提供するhikiシステムがgithubに公開されており,個人の手持ちのパソコンにインストールしてwikiを利用することができます.西谷研ではさらにhiki記法を拡張して,コードのカラー表示,数式のlatex記述が可能となるシステムを利用しています.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
本資料では,卒論の編集作業を効率化する図に示すようなシステムの使い方を紹介します.
|
|
8
8
|
|
|
9
9
|
\begin{figure}[htbp]\begin{center}
|
|
10
10
|
\includegraphics[width=6cm,bb=0 0 442 500]{../figs/./hikiutils_bob.002.jpeg}
|
|
11
11
|
\caption{卒論編集システムの概要.}
|
|
12
12
|
\label{default}\end{center}\end{figure}
|
|
13
|
-
例えば,卒業生をyamane
|
|
13
|
+
例えば,卒業生をyamaneとしましょう.yamaneの個人のMacの自分のdirectory(hikiutils\_yamane)に幾つかのファイルを作成して卒論を書いているとします.これを指導教官(bob)が編集するとします.この同期には,Githubにより提供される共同作業環境を使います.これだけでは編集中の文書の体裁がわかりにくいでしょう.そこで,hikiシステムにより容易にwebブラウザ上に完成形を表示しつつ執筆することが求められます.このような操作環境を提供するのが,hikiutils -iです.
|
|
14
14
|
|
|
15
15
|
\section{hikiとの同期}
|
|
16
16
|
\subsection{hikiutilsのinstall}
|
|
@@ -52,21 +52,27 @@ drwxr-xr-x 26 bob 501 884 1 20 11:00 ../
|
|
|
52
52
|
|
|
53
53
|
keynoteで図を作成して,hikiutils\_bob.hikiに文章を記述していく.
|
|
54
54
|
|
|
55
|
-
\subsection{一般的な執筆手順}
|
|
56
|
-
\
|
|
55
|
+
\subsection{一般的な執筆手順}
|
|
56
|
+
\begin{enumerate}
|
|
57
|
+
\item 書類の作成
|
|
58
|
+
\begin{enumerate}
|
|
57
59
|
\item open -a mi hikiutils\_bob.hiki
|
|
58
60
|
\end{enumerate}
|
|
59
|
-
\item keynote
|
|
61
|
+
\item keynoteを開ける
|
|
62
|
+
\begin{enumerate}
|
|
60
63
|
\item open hikiutils\_bob.key
|
|
61
64
|
\end{enumerate}
|
|
62
|
-
\item keynoteのイメージをfigs
|
|
65
|
+
\item keynoteのイメージをfigsに
|
|
66
|
+
\begin{enumerate}
|
|
63
67
|
\item keynoteでイメージへ書き出し(hikiutils\_bobを仮定)
|
|
64
68
|
\item rake convert 80 hikiutils\_bob
|
|
65
69
|
\end{enumerate}
|
|
66
|
-
\item hiki
|
|
70
|
+
\item hikiシステムとの同期
|
|
71
|
+
\begin{enumerate}
|
|
67
72
|
\item rake sync
|
|
68
73
|
\end{enumerate}
|
|
69
|
-
\item hiki
|
|
74
|
+
\item hikiシステムで表示
|
|
75
|
+
\begin{enumerate}
|
|
70
76
|
\item hiki -u hikiutils\_bob
|
|
71
77
|
\end{enumerate}
|
|
72
78
|
\end{enumerate}
|
|
@@ -143,21 +149,68 @@ cp tmp.hiki hikiutils_bob.hiki
|
|
|
143
149
|
\end{verbatim}\end{quote}
|
|
144
150
|
などと番号を3から順に振り替えてくれる.
|
|
145
151
|
|
|
146
|
-
\subsection{githubによる同期}
|
|
147
|
-
\
|
|
148
|
-
\item
|
|
152
|
+
\subsection{githubによる同期}
|
|
153
|
+
\begin{enumerate}
|
|
154
|
+
\item git init, forkが済んでいると仮定
|
|
155
|
+
\item upstream, originの確認
|
|
156
|
+
\begin{enumerate}
|
|
149
157
|
\item bob% git remote -v
|
|
150
158
|
\end{enumerate}
|
|
151
|
-
\item git push
|
|
159
|
+
\item git push作業
|
|
160
|
+
\begin{enumerate}
|
|
152
161
|
\item git add -A
|
|
153
162
|
\item git commit -m 'first commit'
|
|
154
163
|
\item git push origin master
|
|
155
164
|
\end{enumerate}
|
|
156
165
|
\item githubでbobへpull requestをかける
|
|
157
|
-
\item
|
|
158
|
-
\item git pull
|
|
159
|
-
\
|
|
166
|
+
\item bobの編集後,通知がくる.まつことなく作業してもok.
|
|
167
|
+
\item git pull作業
|
|
168
|
+
\begin{enumerate}
|
|
169
|
+
\item git pull upstream master
|
|
160
170
|
\end{enumerate}
|
|
161
171
|
\end{enumerate}
|
|
162
172
|
これがうまくいかん時は聞いてください.
|
|
163
173
|
|
|
174
|
+
\begin{figure}[htbp]\begin{center}
|
|
175
|
+
\includegraphics[width=6cm,bb=0 0 442 500]{../figs/./hikiutils_bob.004.jpeg}
|
|
176
|
+
\caption{卒論編集時のgithubによる同期のシーケンス図.}
|
|
177
|
+
\label{default}\end{center}\end{figure}
|
|
178
|
+
\subsection{hikiutil関連のヘルプ}
|
|
179
|
+
\subsubsection{hikiで卒論を書くときの初期化と掟}
|
|
180
|
+
\begin{itemize}
|
|
181
|
+
\item 開発メモ:figs,dataも作成
|
|
182
|
+
\item 目的:西谷が後で迷わないように決まったファイル構造を堅持すべし
|
|
183
|
+
\item 文書:hikiで書く.のちには,latexに変換するプログラムを提供します
|
|
184
|
+
\item 図表:すべての図表をkeynoteにまとめる,タイトルを分かりやすく書く
|
|
185
|
+
\item データ:dataディレクトリにまとめる.ファイル名をkeynoteの対応する図表中に記す
|
|
186
|
+
\item hiki --initializeで初期ファイル(Rakefile, ./.hikirc, hiki\_help.yml)がcopyされる
|
|
187
|
+
\item hiki\_help.ymlを適宜~/.my\_helpにcopyしてhiki\_helpとして利用,(my\_help参照)
|
|
188
|
+
\item Errno::EACCESやpermission errorがでたときはrake chenvを試してみる(報告して)
|
|
189
|
+
\item rake syncによってhikiディレクトリーと同期が取られる
|
|
190
|
+
\item hiki -u TARGETによってブラウザー表示される
|
|
191
|
+
\item テキストの拡張子は'.hiki'
|
|
192
|
+
\item hikiでのurlはテキスト前とディレクトリーから自動生成される
|
|
193
|
+
\item 例えば,hiki2latex\_saki/introduciton.hikiとするとhiki2latex\_saki\_introducitonと変換される
|
|
194
|
+
\end{itemize}
|
|
195
|
+
\subsubsection{error対応}
|
|
196
|
+
\begin{itemize}
|
|
197
|
+
\item Permission denied - ./data/text/boundary\_narita (Errno::EACCES)->テキストにhikiが書き込めない,chmod a+w FILE
|
|
198
|
+
\end{itemize}
|
|
199
|
+
\subsubsection{図表:すべての図表をkeynoteにまとめる,タイトルを分かりやすく書く}
|
|
200
|
+
\begin{itemize}
|
|
201
|
+
\item keynoteに書いたスライドはイメージに書き出して,rake convert 80 TARGET\_DIRでfigsに変換
|
|
202
|
+
\item rake syncでfigsにあるfilesはhiki/target\_dirにcpされる
|
|
203
|
+
\item \verb|convert #{source} -resize 20% #{target}によって,target=figs/TAERGET.pngに20%に縮小して保存される|
|
|
204
|
+
\item convert -density 300 view.svg view.pngで300dpiで変換
|
|
205
|
+
\item attach\_anchorでは
|
|
206
|
+
\end{itemize}
|
|
207
|
+
'\verb|{{attach_anchor(test.png, hiki2latex_saki)}}|'
|
|
208
|
+
と,directory指定しなければならない.
|
|
209
|
+
|
|
210
|
+
\begin{itemize}
|
|
211
|
+
\item keynoteであとで図を挿入して番号が変わった時の原稿の一括変換
|
|
212
|
+
\item rake increment 2 boundary\_bob.hiki boundary\_bob > tmp.hiki
|
|
213
|
+
\item rake convert 60 boundary\_bob
|
|
214
|
+
\item rake sync
|
|
215
|
+
\item hiki -u boundary\_bob\_tmp
|
|
216
|
+
\end{itemize}
|
data/hikiutils_bob/sync.hiki
CHANGED
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
{{toc}}
|
|
2
2
|
!イントロダクション
|
|
3
|
-
|
|
3
|
+
卒業論文は,大学で課される普通の授業のレポートに比べて多くの情報内容が要求されます.また,研究という側面から体裁や版権など多くの出版における掟を遵守しながら,高い品質を保つ必要です.そのため,指導教官との編集作業が重要となるます.編集作業の効率を高めるためには,共同作業を促進するプラットフォームが必要です.
|
|
4
4
|
|
|
5
|
-
体裁などを考えるとLatex
|
|
5
|
+
体裁などを考えるとLatexの使用が標準ですが,執筆段階での煩わしさを低減するため,Mark Up記法による文章作成が一般的です(「ドキュメント作成システム構築ガイド,GitHub, RedPen, Asciidoctor, CIによるモダンライティング」, 伊藤敬彦,吉村孝広,技術評論社).西谷研ではMark Up記法の一種であるhiki記法を用いて執筆します.hiki記法からhtmlへ変換するソフトhikidocによる容易な変換が可能なため,日記web appliのhiki diaryでも利用されている有名なソフトです.hiki記法をベースにして,wiki wiki webと同等の機能を提供するhikiシステムがgithubに公開されており,個人の手持ちのパソコンにインストールしてwikiを利用することができます.西谷研ではさらにhiki記法を拡張して,コードのカラー表示,数式のlatex記述が可能となるシステムを利用しています.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
本資料では,卒論の編集作業を効率化する図に示すようなシステムの使い方を紹介します.
|
|
8
8
|
!!!caption:卒論編集システムの概要.
|
|
9
9
|
{{attach_view(hikiutils_bob.002.jpeg,hikiutils_bob)}}
|
|
10
10
|
|
|
11
|
-
例えば,卒業生をyamane
|
|
11
|
+
例えば,卒業生をyamaneとしましょう.yamaneの個人のMacの自分のdirectory(hikiutils_yamane)に幾つかのファイルを作成して卒論を書いているとします.これを指導教官(bob)が編集するとします.この同期には,Githubにより提供される共同作業環境を使います.これだけでは編集中の文書の体裁がわかりにくいでしょう.そこで,hikiシステムにより容易にwebブラウザ上に完成形を表示しつつ執筆することが求められます.このような操作環境を提供するのが,hikiutils -iです.
|
|
12
|
+
|
|
12
13
|
!hikiとの同期
|
|
13
14
|
!! hikiutilsのinstall
|
|
14
15
|
hikiuitlsをgemからinstallしておく必要がある.コマンドは以下の通り.
|
|
@@ -122,7 +123,7 @@ cp tmp.hiki hikiutils_bob.hiki
|
|
|
122
123
|
などと番号を3から順に振り替えてくれる.
|
|
123
124
|
|
|
124
125
|
!!githubによる同期
|
|
125
|
-
# git initが済んでいると仮定
|
|
126
|
+
# git init, forkが済んでいると仮定
|
|
126
127
|
# upstream, originの確認
|
|
127
128
|
## bob% git remote -v
|
|
128
129
|
# git push作業
|
|
@@ -130,7 +131,43 @@ cp tmp.hiki hikiutils_bob.hiki
|
|
|
130
131
|
## git commit -m 'first commit'
|
|
131
132
|
## git push origin master
|
|
132
133
|
# githubでbobへpull requestをかける
|
|
133
|
-
#
|
|
134
|
+
# bobの編集後,通知がくる.まつことなく作業してもok.
|
|
134
135
|
# git pull作業
|
|
135
|
-
## git pull upstream
|
|
136
|
+
## git pull upstream master
|
|
136
137
|
これがうまくいかん時は聞いてください.
|
|
138
|
+
|
|
139
|
+
!!!caption:卒論編集時のgithubによる同期のシーケンス図.
|
|
140
|
+
{{attach_view(hikiutils_bob.004.jpeg,hikiutils_bob)}}
|
|
141
|
+
|
|
142
|
+
!!hikiutil関連のヘルプ
|
|
143
|
+
!!!hikiで卒論を書くときの初期化と掟
|
|
144
|
+
*開発メモ:figs,dataも作成
|
|
145
|
+
*目的:西谷が後で迷わないように決まったファイル構造を堅持すべし
|
|
146
|
+
*文書:hikiで書く.のちには,latexに変換するプログラムを提供します
|
|
147
|
+
*図表:すべての図表をkeynoteにまとめる,タイトルを分かりやすく書く
|
|
148
|
+
*データ:dataディレクトリにまとめる.ファイル名をkeynoteの対応する図表中に記す
|
|
149
|
+
*hiki --initializeで初期ファイル(Rakefile, ./.hikirc, hiki_help.yml)がcopyされる
|
|
150
|
+
*hiki_help.ymlを適宜~/.my_helpにcopyしてhiki_helpとして利用,(my_help参照)
|
|
151
|
+
*Errno::EACCESやpermission errorがでたときはrake chenvを試してみる(報告して)
|
|
152
|
+
*rake syncによってhikiディレクトリーと同期が取られる
|
|
153
|
+
*hiki -u TARGETによってブラウザー表示される
|
|
154
|
+
*テキストの拡張子は'.hiki'
|
|
155
|
+
*hikiでのurlはテキスト前とディレクトリーから自動生成される
|
|
156
|
+
*例えば,hiki2latex_saki/introduciton.hikiとするとhiki2latex_saki_introducitonと変換される
|
|
157
|
+
|
|
158
|
+
!!!error対応
|
|
159
|
+
*Permission denied - ./data/text/boundary_narita (Errno::EACCES)->テキストにhikiが書き込めない,chmod a+w FILE
|
|
160
|
+
|
|
161
|
+
!!!図表:すべての図表をkeynoteにまとめる,タイトルを分かりやすく書く
|
|
162
|
+
*keynoteに書いたスライドはイメージに書き出して,rake convert 80 TARGET_DIRでfigsに変換
|
|
163
|
+
*rake syncでfigsにあるfilesはhiki/target_dirにcpされる
|
|
164
|
+
*\verb|convert #{source} -resize 20% #{target}によって,target=figs/TAERGET.pngに20%に縮小して保存される|
|
|
165
|
+
*convert -density 300 view.svg view.pngで300dpiで変換
|
|
166
|
+
*attach_anchorでは
|
|
167
|
+
'{{attach_anchor(test.png, hiki2latex_saki)}}'
|
|
168
|
+
と,directory指定しなければならない.
|
|
169
|
+
*keynoteであとで図を挿入して番号が変わった時の原稿の一括変換
|
|
170
|
+
*rake increment 2 boundary_bob.hiki boundary_bob > tmp.hiki
|
|
171
|
+
*rake convert 60 boundary_bob
|
|
172
|
+
*rake sync
|
|
173
|
+
*hiki -u boundary_bob_tmp
|
data/hikiutils_yamane/Rakefile
CHANGED
|
@@ -38,14 +38,14 @@ task :latex_all do
|
|
|
38
38
|
option="--listings --head latex_dir/head.tex -p "
|
|
39
39
|
main_file=f_name
|
|
40
40
|
else
|
|
41
|
-
option="-l
|
|
41
|
+
option="-l 1 --listings -b "
|
|
42
42
|
end
|
|
43
43
|
convert_to_latex(file, option)
|
|
44
44
|
}
|
|
45
45
|
cont=""
|
|
46
46
|
File.readlines(File.join($latex_dir,"#{main_file}.tex")).each{|line|
|
|
47
|
-
if line.match(
|
|
48
|
-
if m=line.match(
|
|
47
|
+
if line.match(/section{(.+)}/)
|
|
48
|
+
if m=line.match(/section{\\verb\|(.+)\|}/)
|
|
49
49
|
p m
|
|
50
50
|
p reg_exp = Regexp.new("#{basename}_(.+)")
|
|
51
51
|
p m_t=m[1].match(reg_exp)[1]
|
|
@@ -61,33 +61,6 @@ task :latex_all do
|
|
|
61
61
|
exit
|
|
62
62
|
end
|
|
63
63
|
|
|
64
|
-
desc "change latex figures to wrap format"
|
|
65
|
-
task :change_wrap do
|
|
66
|
-
lines = File.readlines($save_name)
|
|
67
|
-
|
|
68
|
-
cont = ""
|
|
69
|
-
lines.each{|line|
|
|
70
|
-
if line.include?('\begin{figure}[htbp]\begin{center}')
|
|
71
|
-
p line
|
|
72
|
-
cont << '\begin{wrapfigure}{r}{8cm}'+"\n"
|
|
73
|
-
cont << '\vspace{-2\baselineskip}'+"\n"
|
|
74
|
-
cont << '\begin{center}'+"\n"
|
|
75
|
-
elsif line.include?('\label{default}\end{center}\end{figure}')
|
|
76
|
-
p line
|
|
77
|
-
cont << '\end{center}'+"\n"
|
|
78
|
-
cont << '\vspace{2\baselineskip}'+"\n"
|
|
79
|
-
cont << '\end{wrapfigure}'+"\n"
|
|
80
|
-
else
|
|
81
|
-
cont << line
|
|
82
|
-
end
|
|
83
|
-
}
|
|
84
|
-
File.open($save_name,'w'){|file| file.print cont }
|
|
85
|
-
|
|
86
|
-
system("open #{$save_name}")
|
|
87
|
-
exit
|
|
88
|
-
end
|
|
89
|
-
|
|
90
|
-
|
|
91
64
|
desc "latex conversion FILE1(hiki) to FILE2(latex)"
|
|
92
65
|
task :latex_base do
|
|
93
66
|
Dir.mkdir($latex_dir) unless Dir.exist?($latex_dir)
|
|
@@ -127,6 +100,33 @@ def convert_to_latex(file_name, option=nil)
|
|
|
127
100
|
File.open($save_name,'w'){|file| file.print cont }
|
|
128
101
|
end
|
|
129
102
|
|
|
103
|
+
desc "change latex figures to wrap format"
|
|
104
|
+
task :change_wrap do
|
|
105
|
+
lines = File.readlines($save_name)
|
|
106
|
+
|
|
107
|
+
cont = ""
|
|
108
|
+
lines.each{|line|
|
|
109
|
+
if line.include?('\begin{figure}[htbp]\begin{center}')
|
|
110
|
+
p line
|
|
111
|
+
cont << '\begin{wrapfigure}{r}{8cm}'+"\n"
|
|
112
|
+
cont << '\vspace{-2\baselineskip}'+"\n"
|
|
113
|
+
cont << '\begin{center}'+"\n"
|
|
114
|
+
elsif line.include?('\label{default}\end{center}\end{figure}')
|
|
115
|
+
p line
|
|
116
|
+
cont << '\end{center}'+"\n"
|
|
117
|
+
cont << '\vspace{2\baselineskip}'+"\n"
|
|
118
|
+
cont << '\end{wrapfigure}'+"\n"
|
|
119
|
+
else
|
|
120
|
+
cont << line
|
|
121
|
+
end
|
|
122
|
+
}
|
|
123
|
+
File.open($save_name,'w'){|file| file.print cont }
|
|
124
|
+
|
|
125
|
+
system("open #{$save_name}")
|
|
126
|
+
exit
|
|
127
|
+
end
|
|
128
|
+
|
|
129
|
+
|
|
130
130
|
desc "increment fig NUBERS in FILE"
|
|
131
131
|
task :increment do
|
|
132
132
|
number=ARGV[1]
|
|
@@ -202,7 +202,7 @@ task :sync0 do
|
|
|
202
202
|
}
|
|
203
203
|
p entries=Dir.entries('./figs') #cp files in figs
|
|
204
204
|
p target = File.join(target_dir,'cache','attach',basename)
|
|
205
|
-
FileUtils.
|
|
205
|
+
FileUtils.mkdir_p(target,:verbose=>true) unless File.exists?(target)
|
|
206
206
|
entries[2..-1].each{|file|
|
|
207
207
|
p source = File.join('./figs',file)
|
|
208
208
|
FileUtils.cp(source,target,:verbose=>true)
|
|
@@ -262,6 +262,7 @@ task :check_previous do
|
|
|
262
262
|
if changed.size != 0
|
|
263
263
|
print("hiki dirで変更が発生しています.\n")
|
|
264
264
|
changed.each{|line| print line+"\n"}
|
|
265
|
+
print("問題がなければrake force_syncで強制同期してください.\n")
|
|
265
266
|
exit
|
|
266
267
|
end
|
|
267
268
|
end
|