AtomとGitHubを組み合わせて論文執筆ツールとして使う

そろそろ、学部4年生やM2の学生が卒論や修論を提出する時期ですね。
グラフを貼ったWordファイルが100ページを超えてくると、私のPCではかなりWord動作が重くなりイライラします。

しかし、そのようなイライラを抱えながら、多くの人が学術論文や卒業論文をWordを使って書いていると思います。
私も基本的に文章作成といえばWordという人生を歩んできましたが、より快適な論文執筆ツールを探してみました。
※以下の記事は、Windows10の環境を想定しています。

論文執筆ツールに求められる要素

まずは、ツールを探し始める前に論文執筆ツールに求められる要素を思いつくままにリストアップしてみました。

  • クラウド同期ができて、モバイル環境で編集できる。
  • 共有してオンラインで共同作業ができる。
  • アウトラインがあつかえる。(できれば、行や段落がショートカットキーで移動できる。)
  • 画像を扱える。
  • 執筆に集中できるデザイン。
  • 語数カウントができる。
  • 動作スピードが速い。
  • 図表番号の相互参照ができる。
  • 執筆量の記録ができる。
  • 文章のメタデータ: 日付情報や状態等を管理できる。
  • バージョン管理ができる。
  • 翻訳機能がある。
  • Wordファイルの入出力ができる。
  • 学習コストが低い。
  • 価格が安い。

以上の観点を考慮して、有望なツール (群) を4つに絞り込み、それらを全て試用して比較してみました。
またここには記載していませんが、私は文章構成にはDynalistというアウトライナーを使用しています。

余談ですが、Word + メール といった運用をしているケースも非常に多いと思います。しかし、それでは共同作業なんて進みません。
出来るだけ早くWord + メールという運用は見直したほうがいいと思います。
Office 365が使えるのであれば、SharePointを導入してWordファイルのバージョン管理をSharePointで行うことを勧めます。
もしくは、シンプルにDropboxで共有しましょう。

それぞれ1週間程度いじってみた結果を下の表にまとめています。
長いので一行で説明すると、Atom + GitHubの構成がなんでもできて快適ということです。
私は、現在ではAtom + GitHubの構成で論文を執筆しています。

表: 論文執筆ツールの比較表

  Atom + GitHub Word + SharePoint Google ドキュメント Scrivener + Dropbox
クラウド同期、モバイル編集 ○ ○ ○ △
共同執筆 △1 ○ ◎ ×
アウトライン機能 ○ ○ △ ○
画像 ○ ○ ○ ○
集中執筆モード ○ △ △ ○
動作スピード ○ △ △ ○
語数カウント ○ ○ ○ ○
図表番号の相互参照 ○ ○ × ○
執筆量の記録 △ 2 △ 2 △ 2 ○
メタデータの管理 ○ × × ○
バージョン管理 ◎ ○ ○ ○
翻訳機能 ○ ○ ○ ×
Wordファイルの入出力 △ 3 ◎ ◎ ○
UIのシンプルさ ○ △ ○ △
価格 無料 有料 無料 有料
学習コスト △ 4 ○ 5 ○ ×
導入にかかる時間 約2時間 0~30分 5分 10分
楽しさ 6 ○ × × ○
1 機能的には100点だが、共著者にGitHubの操作を覚えてもらう必要があるためハードルが高い。
2 スクリプトが必要。WordやGoogle Docsは公開してくれている人がいるので拝借すれば、簡単に実装できる。
3 パッケージを使えばPandocと統合できる。
4 Atomはただのテキストエディタだし、Gitも難しくはないですが、初見だとちょっと苦労する可能性あり。
5 Wordの学習コストはGitHubやMarkdownよりよほど高いと思うが、一般的に学習済み。
6 使っているときの個人的な感想です。

Atomを論文執筆用にカスタマイズする

AtomはGitHub製のテキストエディタです。
今回やったことは大きく分けて、見た目 (テーマとフォント)の設定と必要なPackageのインストールの2つです。

テーマおよびフォントの設定

テーマの設定

まずは、テーマを設定しましょう。
Atomは基本的にプログラミングをするためのエディタですので、テーマやフォントを設定しないと文章を書く気が起こりません。

論文執筆にはPen Paper Coffee というテーマがオススメです。見た目は下のような感じです。

PenPaperCoffeeの概観
PenPaperCoffee

ちなみに、Atomを文章執筆にしか使わないのであればこのテーマを適用しておけば問題ないですが、プログラミングにも用いる場合はAtom Theme Switherというパッケージをインストールすると、F12キーを押すだけで複数のテーマを切り替えられるようになります。

フォントの設定

プログラミング言語では等幅フォントが用いられますが、文章を書く場合は等幅フォントではテンションが上がらないのでフォントを設定します。

Atomではファイルタブからスタイルシートをいじることで、拡張子ごとに使用するフォントや行間などを設定することができます。ちなみに、私は次のような設定にしています。

// language-gfm
atom-text-editor[data-grammar="source gfm"].editor {
    font-family: "Times New Roman", serif;
    font-size: 12pt;
    line-height: 1.8em;

}

// language-md
atom-text-editor[data-grammar="source md"].editor {
    font-family: "Times New Roman",serif;
    font-size: 12pt;
    line-height: 1.8em;

}

参考: Atom をMarkdownエディタとして整備

パッケージのインストール

私は論文執筆用に以下のようなパッケージをインストールしています。それぞれの紹介は後でするかもしれません。

詳細が知りたい方は、以下の2つのページがとても参考になります。(ただし、どちらも英語です。)
Using Atom for academic writing
A Plain Text Workflow for Academic Writing with Atom

Gitを使ったMarkdownファイルのバージョン管理

あとは論文執筆用に設定したAtomでバリバリ論文を書けばいいのですが、Markdownはただのテキストファイルなのでこのままではバージョン管理が大変です。
すなわち、”Manuscript1″、”Manuscript2″、”Manuscript2-2″ といったファイルがフォルダを埋め尽くすことになります。

そこで、バージョン管理にはGitを使用します。ついでに、原稿の共有にはGitHubのプライベートリポジトリを使います。
これだけであと数記事かけるので、今は解説しません。興味のある方は下のQiitaの記事が参考になります。

参考: 世の中の小説作家と編集者は今すぐ Word や G Suite を窓から投げ捨てて Git と GitHub の使い方を覚えるべきだ

課題

GitHubで共有するときのハードルが高いのが課題です。
ITが苦手な共著者にGitHubでMarkdownの原稿を共有する訳にもいかないので、結局、共有はWord + SharePointかDropboxになりそうです。
それでも、自分の執筆環境としては非常に快適なので、ひとまずよしとします。

また、Atomをカスタマイズする必要があるので導入に時間がかかります。
こだわりがない場合は、WordとSharePointやDropboxを組み合わせるのが簡単で快適かもしれません。

編集後記

ツールをいじっている時間は楽しいのですが、この時間を執筆に当てた方が良いだろうなとも思います。
ちゃんと投入コストを回収できているのかという視点は必要ですね。
かなり省略した説明になってしまったので、論文執筆ツールについてはまた書きます。

研究ツールAtom, Git, Markdown, 論文執筆

Posted by おち