使用するツールについて
現代焚書第5号は、以下のツールを使って作成されています。
また、以下のツールを使うことをおすすめします。
Re:VIEWは特別な記法で書かれるテキストデータを使う書籍作成ツールです。このツールを使うと印刷用PDFと電子書籍用EPUBを作成できます。このツールに必要なのはテキストデータなので、Visual Studio CodeやVim、GNU Emacsなどのテキストエディタで編集してください。Microsoft Wordや一太郎などのワープロソフトは使えませんが、Re:VIEW記法がわからないという方はワープロソフトで文章をお送りください。こちらでRe:VIEW記法に転記いたします。なお、その場合は原稿は横組みで作成してください。
GitHubは、Gitと呼ばれるバージョン管理ツールを使ったソースコード管理サービスです。現在は米Microsoft傘下のGitHub, Inc.によって運営されています。
画面はすべて英語表示ですが、使っている人が多いので使い方は省略します。さまざまな本が出ていますが、詳しくは、Windowsの方は以下の本を読むとよいでしょう。
- すばら3『字書きのためのWindows環境構築』
Macの方は……後日紹介します。
Linuxの方は……GitHubを使いこなすのはおそらく朝飯前かと思われるので何も言いません。
他にも、「世の中の小説作家と編集者は今すぐ Word や G Suite を窓から投げ捨てて Git と GitHub の使い方を覚えるべきだ」（Qiita）の著者がGitとGitHubの使い方に関する連載記事を書いています。
一応、何かわからなくなったら公式マニュアルを読んでください。ただし、一応日本語は用意されていますが、機械翻訳を使っていていろいろと残念な翻訳になっているところがあったり、まだ翻訳がなされていなかったりします。
GitHub上のファイルを読み書きするにはGitと呼ばれるバージョン管理ツールが必要です……が、このGitというツールはコマンドラインで操作するツールです。なので、コマンドラインとかShellとか聞いてナニコレと思った人はGitHub Desktopを使うとよいと思います。
GitHubのもとになっているGitにはブランチと呼ばれる、変更を分岐させて記録できる機能があります。基本的には main というブランチが現時点での正式版になります。ただし、直接 main ブランチに変更は反映できません。 main ブランチに成果を反映したい場合はプルリクエストを作成してください。査読の上で反映いたします。
GitHubにはIssuesと呼ばれる修正を議論する場があります。何か問題があれば、ここに書き込んでください。誤字脱字レベルから記事の方向性に関することまでなんでもお寄せください。さらに、GitHubにはDiscussionsと呼ばれる掲示板もあります。なお、基本的に主筆からのお知らせはこのDiscussionsで告知されます。プロジェクト管理ツールとしてタスクかんばんというツールがありますが、GitHubにも Projects というタスクかんばんがあります。このタスクかんばんは状態を確認するのに使います。使い方はあとで書きます。
最後に、GitHubにはActionsという、自動でさまざまなタスクを行なう機能があります。このプロジェクトでは後述するtextlintでの校正とRe:VIEWによるPDFおよびEPUBに変換しています。
textlintはオープンソースの校正支援ツールです。すべての校正ができるわけではありませんが、校正ルールを設定しておくとルールから外れた書き方で書いた場合に警告やエラーを出してくれます。現状textlintでエラーがない場合のみPDFやEPUBへの変換が行われるしくみになっています。引っかかったエラーがある場合はGitHub Actionsの結果に表示されます。校正ルールは株式会社SmartHR提供のものを使用しています。
エラーはVisual Studio Codeでは赤い波線で表示されます。これが残ったままPDFとEPUBの生成が行われないので、このエラーはGitHubに送信する前に直しておく必要があります。
警告はVisual Studio Codeでは黄色い波線で表示されます。警告は修正が望ましいのですが、修正しなくてもチェックは通ります。
Visual Studio CodeはMicrosoftが開発しているプログラミング向けのテキストエディターです。
なお、このページで「.」キーを押すとGitHub.devというWeb上で使えるVisual Studio Code環境があります……が期待しないでください。正直使えない機能が多くて苦労します。とりわけ、Re:VIEW向けの設定が全く効きません。
この書籍は著作権法上認められる引用の範囲内において引用した資料を除き、 クリエイティブ・コモンズ 表示 4.0 国際 ライセンス の下に提供されています。引用した資料のライセンスについてはオリジナルのライセンスに従います。
なお、ライセンス条項の日本語訳やその要約も目を通して置いてください。
This book is provided under a CC-BY-4.0 License, except for material quoted within the scope of quotations permitted under copyright law. The licensing of the quoted material is subject to the original license.