![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
名前:小林 大輔
学籍番号:HT12A038
日付:2024-11-24
指導教員:兼宗 進
年度:2014
所属:総合情報学部 メディアコンピュータシステム学科
本研究では、Wikiで記述する方式の論文作成システムの提案をする。 論文執筆を行う際に使用するソフトウェアのひとつに、LaTeXがある。 これは、ユーザがTeXmakerやEmacs等のエディタに英語表記の命令や文章を記述し、コマンド実行等のコンパイル作業を行うことで出力結果を得ることができる。 しかし、初学者が複雑な命令を使用しながら、論文を執筆することは難しいと考えた。 そこで、命令を簡略化し、命令の入力量を減らすことにより、ユーザの負担を軽減できる、Wikiで記述する方式の論文作成システムを開発した。
LaTeX PukiWiki Webブラウザ 文章変換 文章作成支援
文章を作成するためのソフトウェアには「Microsoft Word」や「Open Office Writer」、「LaTeX」等がある。上記に記述したソフトウェア以外にも、様々な文章作成ソフトウェアが存在するが、論文作成には主にLaTeXを用いられることが多い。
LaTeXは、ユーザがTeXmaker?やEmacs等のエディタにLaTeXの命令や文章を記述したあと、コンパイル作業をすることで、PDFファイルといった閲覧用ファイルを取得することが可能である。数式を扱うのに長けており、複雑な数式を美しく出力することができ、理系の文章作成において用いられることが多い。命令は英語表記で記述し、その中にはわかりやすい命令もあれば、少し複雑な命令も存在する。
本学科の卒業論文作成にも、LaTeXを使用することが定められている。卒業論文を書く場合、文章の内容を考え、何十ページも記述しなければならないため、複雑な命令を何度も記述するのは負担があると考えた。 そこで本研究では、Wiki形式で記述する方式の卒業論文作成システムの提案をする。本来、WikiはWebページを作成するシステムであり、独自の記法を用いて簡易的にWebページを作成できることが知られている。今回、卒業論文作成システムの構築にあたり、Wikiには存在しない記法もあったため、記法を独自で考えた。また、標準のWikiにはPDFを生成する機能はないため、提案したシステムで記述した文章を保存すると、PDFファイルを得ることも可能にした。
本論文では次のような構成になっている。第【【chap2】】章では、様々な文章作成ソフトウェアの説明を述べる。第【【chap3】】章では、本学科での論文執筆方法と、本研究で提案する卒業論文作成システムについて述べる。第【【chap4】】章では、論文作成システムの実装について述べる。第【【chap5】】章では、本研究で提案したシステムの使用結果と考察を述べる。第【【chap6】】章では、本研究のまとめを述べる。
Microsoft社が、WindowsおよびMac OS向けに発売している文章作成ソフトウェア(図【【word】】)である。ボタンひとつで、文字を中央に寄せたり、文字のサイズや書式を変更できる。文字や図や表の配置の自由度が高い。
オープンソースで開発されたフリーの統合オフィスソフト「OpenOffice?.org」の内のひとつ(図【【writer】】)。無料で利用できる。基本的な画面や操作方法は「Word」と似ているが、サポートされていない機能もある。
記述している文章内容と、視覚的なレイアウト情報を分けて記述し、文章を作成していくソフトウェアである。例えば、\section{はじめに}と記述すると、\section{}という命令でレイアウト情報を示し、{}の中に記述した文章が、指定された形式で出力される。英語表記の命令を用いて文章を作成し、コンパイル処理を行うことで初めてDVIやPDF等の閲覧用のファイルを得ることが可能である。
Webブラウザ上で独自の記法を用いて、Webページを作成するWikiの一種である。PukiWikiでは、独自の記法であるPukiWiki記法や文章を記述することでWebページの作成、編集ができる。
先行研究として、関西学院大学の吉井了平氏が行った「Wiki2LaTeXフィルターの開発」『『yosii』』がある。この研究では、LaTeXで文章作成する際に必要な命令の一部を、PukiWikiの記法と、その他に自身で設定した記号に置き換えている。それにより、LaTeX命令の入力作業の軽減を実現している(図【【wiki2tex】】)。
PukiWiki記法をLaTeXの命令へ変換するために、既存のフィルターである「pukipa.rb」を改良している。「pukipa.rb」とは、Pukiwikiの独自文法をHTMLに変換するプログラムである。本来、HTMLに変換し出力する部分を、LaTeX命令を出力するように変更している。PukiWiki記法を用いて作成した文章を、フィルターにかけることでLaTeXの命令へ変換している。
この研究では頻出する命令のみに対応している。しかし、表や図など対応していない命令があるため、論文を作成することはできない。
本学科の卒業論文の執筆には、LaTeXを扱っている。 卒業論文には様々な指定があり、指定通りに論文を作成するには、以下の項目や命令が必要である。
以上の項目や命令に対応する必要がある。
第【【chap1】】章でも述べたが、LaTeXはTeXmaker?やEmacs等のエディタに、英語表記の命令を入力し文章を作成する。命令にはわかりやすいものもあるが、複雑なものもある。複雑な命令を何度も記述するのは、慣れていないユーザには負担がかかると考えた。先行研究では、LaTeXの命令の入力を簡略化することで、ユーザへの負担は軽減している。しかし、表や図に対応していないため、このシステムのみではLaTeXの命令を記述せずに論文を作成することはできない。
そこで、論文作成に必要な命令を独自に簡略化する。また、作成した文章を保存することで、PDFファイルを作成する。これらの機能がある論文作成システムを提案をする。例として、図の挿入時に記述する命令を、提案する命令と、LaTeXの命令の文章を比較する(図【【inc】】)。命令を簡略化することで、記述量を減少させることができ、負担を軽減できると考えられる。
本研究で提案するシステムはPukiWikiをベースに作成する。提案するシステムでの文章の記述には、PukiWiki記法と、独自に提案する記法を用いる。PukiWiki記法を用いて作成した文章をLaTeX形式へ変換するプログラムの作成をする。その後、PDFファイルを作成できるようにした。
Pukiwikiは本来、Webページの作成に用いられる。一方で、LaTeXは論文作成のために用いられる。両者の利用目的が異なるため、必ずPukiWiki記法とLaTeXの命令が一致するとは限らない。そのため、命令と記法が一致しなかった記法を独自に作成し、対応付けをした。
例えば、LaTeXには内容梗概({abstract})という命令があるが、PukiWikiにはそのような記法はない。そのため、文頭に半角スペースを入力することで内容梗概を暗示させる。LaTeXで文章作成を行う際に必要な命令と、PukiWiki記法との対照表を表【【lists】】に示す。
| Pukiwiki記法 | LaTeX命令(始まり) | LaTeX命令(終わり) | 意味 |
| *~ | \chapter | なし | 章 |
| * | \section | なし | 節(大) |
| ** | \subsection | なし | 節(中) |
| *** | \subsubsection | なし | 節(小) |
| + | \begin{enumerate} | \end{enumerate} | 番号付リスト |
| - | \begin{itemize} | \end{itemize} | 番号なしリスト |
| ｜a｜b｜ | \begin{table} | \end{table} | 表組み |
| #ref(ファイル名) | \begin{figure} | \end{figure} | 図の挿入 |
| 【 】 | \label{} | なし | ラベル |
| 【 【 】 】 | \ref{} | なし | 参照 |
| 文頭に半角スペース | \begin{abstract} | \end{abstract} | 内容梗概 |
| #contents | \maketitle | なし | 目次 |
| ---- | \appendix | なし | 付録 |
| CENTER:""タイトル"" | \title | なし | タイトル |
PukiWikiでのプレビュー時に、Webブラウザ上に表示される文章やレイアウトを見ることで、PDFファイルの出力結果をイメージできるように対応付けをした。
LaTeXには「章(\chapter)」や「節(\section)」という命令がある。しかし、PukiWiki記法には「章」はなく「節(*)」しかない。PukiWiki上では「*」を使用しなければプレビュー時に目次に表示されないため、節と章を「*」を用いた記述方法にした。しかし、PukiWiki記法では「***(LaTeXでいう\subsubsection)」までしか対応されていない。そのため、「****」とは、記述することができない。そこで、文頭に「*~」と記述すると「章」とし、「節(*)」部分と区別するようにした(図【【chapsec】】参照)。
PukiWikiには文章や画像・表などにラベルを付け、参照するという記述法はなく、それぞれにアンカーやリンクを付けるといった命令しかない。 対照できない場合は、PukiWikiのページ上や文章中に存在しても違和感がなく、かつ、文章作成中に使用しない記号を使用する必要があった。 今回は、ラベル(\label)の代わりにすみつきカッコ(【 】)と参照(\ref)の代わりに(【 【 】 】)を用いた(図【【labref】】参照)。
図を挿入する際には、一度PukiWiki上に画像ファイルをアップロードし、(#ref(画像ファイル名),図の位置)と記述するとPukiWiki上に図が表示される。PukiWikiではファイル名がその図の表示名になってしまうため、表示名を出力する命令を考え実装した(図【【ref1】】参照)。画像が表示できるのは拡張子が(*.jpg)や(*.png)のファイルで、(*.eps)についてはファイル名のみが表示され、クリックすることで表示することが可能である。
LaTeXの命令へ変換しPDFにする場合にはTeXファイル(*.tex)と同じフォルダ内に画像ファイルを挿入しておく必要がある。
図【【ref1】】中の数字の説明は、1がPukiwikiでの図を挿入する命令。2で図の下部に表示名とラベルを表示している。
表を挿入する際、PukiWikiでは非常に直感的な記述が可能である。しかし、通常の記述方法では、図と同様に、表示名やラベルを記述することが出来ないため、表示名とラベルの記述方法を考え実装した(図【【tab1】】)。 図【【tab1】】中の数字は、1がPukiwikiで表を挿入する命令。2で表の上部のタイトルとラベルを表示している。
論文には、タイトルや著者名、日付が必要である。他にも、卒業論文では、学籍番号や指導教員名、所属学科などを記述する必要がある。タイトルは最上の中央部に太字で出力し、日付はPukiWiki記法で標準で扱えるものを使用する。著者名や学籍番号等の記述方式は似せるようにした(図【【title】】)。
PukiWiki記法を、LaTeXの命令へ変換するプログラムを、Perl言語を用いて作成した。下記はPukiWiki記法で箇条書きを使用した際に、変換プログラムが行う処理である。
この処理を行った際の、変換前(PukiWiki)と変換後(LaTeX)の比較を図【【item】】に示す。
LaTeX側で複数行に渡り記述する命令については、このような処理をベースとしている。
その他、タイトル(\title)や目次(\tableofcontents)等、一行で判別が可能な命令については、文頭や文中に特定の文字や記号が存在した際に、LaTeXの命令に変換している。
LaTeXでの図の挿入時には、図を表示させる、図の場所を指定する、図のタイトルを出力する命令、場合によってラベルを付与する必要がある。 PukiWikiでの入力(図【【lab1】】)をLaTeXの命令(図【【lab2】】)へあてはめていく処理を行っている。
図【【lab1】】と図【【lab2】】中の数字は、1がファイル名、2が図を表示する位置、3が図のタイトル、4がラベルとなっている。
LaTeXで表の挿入を行う場合も、図の挿入のように複雑である。表をどの位置に出力するか、表中の要素の位置指定、表のタイトルを出力、ラベルを付与させるなどの命令が必要である。
PukiWiki記法では、各要素の位置指定を一つずつしなければならない。しかし、LaTeXの命令では列ごとに要素の位置指定が可能である。そのため、PukiWikiで表の一行目に記述した位置指定を、変換後にはそれぞれの列の位置指定としている(図【【table1】】、図【【table2】】参照)。
PukiWikiでは、ページ更新をした際に、見出し(*)を使用した文末にアンカーが付属してしまう(図【【ancer】】参照)。アンカーを放置したまま、LaTeX形式に変換しターミナルなどでコンパイルをするとエラーが出てしまうため、LaTeX形式に変換する際にそのアンカーを削除する必要があった。文章作成時にアンカーのような文章を記述してしまうと、アンカーと同様に削除してしまう恐れがあったため、文頭が「*」で文末に特定の文字列が存在した場合のみ、アンカーを削除するようにした(図【【texanc】】参照)。
LaTeXは、「プリアンブル」をテキストファイルに記述しなければコンパイル処理をすることが出来ない。そのため、今回は卒業論文で使用するプリアンブルを、変換プログラムにかけた際に、自動で付与している(図【【puri】】参照)。その際に\begin{document}も一緒に付与し、\end{document}は文章の最後に付与している。これによりコンパイル処理が可能になる。
論文を印刷した際に、表紙やページ番号がついていないと非常に見にくくなってしまう。しかし、PukiWiki記法はWebページを作成する記法であるため、表紙やページ番号を付与させるような命令はない。そのため、LaTeXの命令に変換した際に、特定の命令の前後にページ番号などの命令を付与させるようにした(図【【pagenumber】】参照)。
しかし、変換した際に決められたページ番号を出力するため、現在はページ番号の書式の設定はできない。
PukiWikiでは、文章の作成やレイアウトの確認はできるが、PDFファイルを作成することはできない。PDFファイルを作成するためには、PukiWiki記法を用いて作成した文章を、LaTeX形式に変換する、そのLaTeX形式の文章をコンパイル作業を行いPDFファイルにする。しかし、これでは手間がかかってしまう。そこで、これらの作業を自動化する。
Pukiwikiで編集している文章を保存することで、LaTeX形式の文章へ変換し、そのLaTeX形式の文章をコンパイル処理することでPDFファイルになる。そのPDFファイルを保存する。 その提案を実現するために、シェルスクリプトを用いてプログラムを作成する。
自動化を行うために、rsyncコマンドと「a」オプションを使うことにより、タイムスタンプを保持したまま、変更されたファイルのみをコピーすることができる。このコマンドを用いて、サーバ内に存在するPukiWikiのWikiディレクトリを、タイムスタンプを保持したまま、変更されたファイルのみをコピーする。タイムスタンプが更新されてしまうと、タイムスタンプの比較が正常にできなくなってしまう。
「ファイル名.txt」が「ファイル名.tex」より新しくなっていた場合は、「ファイル名.txt」を変換プログラムにかけ、LaTeX命令へ変換し、「ファイル名.tex」へ書き込む。platexでtexファイルを2回コンパイル処理し、エラーが出れば次の処理には移らず、エラーが出なければdvipdfmxでコンパイル処理を行いPDFファイルを作成する。以上の処理を30秒ごとに行う。
この処理をフローチャートに示したものが図【【flow】】である。
作成したシステムによって、本論文を作成した。LaTeXで本論文を記述した場合と、本システムで記述した場合の文字数を比較する。LaTeXでは14258文字記述し、本システムでは11467文字記述した。本システムで記述した文字数の方が2791文字少なかったため、簡略化した命令を使用することでユーザへの負担を軽減することができたといえる。今後の課題として以下の点が挙げられる。
課題に対する解決策として、1から5までは変換プログラムの改良が必要である。6から8までの課題を解決するためには、PukiWikiを改良しなければならない可能性が高いので検討する必要がある。
本研究では、Wiki形式で記述する方式の卒業論文作成システムの提案した。
本システムの構築にあたり、PukiWiki記法と独自に提案した記法を用いて作成した文章を、LaTeX形式へ変換するプログラムを作成した。
LaTeXで図の挿入した場合は約147文字の入力が必要だが、同じ内容を本システムで記述する場合は約91文字になる。箇条書きの表示をする際は、32文字減らすことができた。このように、入力する文字を減らすことができたことから、ユーザにかかる負担を軽減できるといえる。
本システムにより、本論文を作成した。論文が受理されたことから、本学科指定の卒業論文を作成することができたといえる。
今回、本論文をこのシステムで作成するにあたり、使用できない命令や、細かい指定が出来ない等の課題を発見することが出来た。
今後は、発見した課題を解決していきたい。そして、このシステムが論文作成の際にユーザにかかる負担を軽減できるのか、さらなる検証を行いたい。
本研究、本論文を終えるにあたり、多大なる御指導、御教授を頂いた兼宗進教授に深く感謝いたします。
また、学生生活における基礎的な学問、学問に取り組む姿勢をご教授頂いた、メディアコンピュータシステム学科の先生方に深く感謝致します。
また、本研究を進めるにあたり御教授いただきました、下倉雅行先生に深く感謝致します。
本研究期間中、本研究に対する貴重な御意見、御協力を頂きました島袋舞子氏に感謝致します。そして、卒業研究に共に励んだ兼宗研究室メンバー一同に感謝します。
