overleafなどのTeX共同編集システムが一般的になってきた昨今(※2022年頃)、皆様どのように一つのTeXソースを複数の人間でレビューしているでしょうか。
コメント部分に各自決めた色で
\color{***}
hogehoge
\color{black}
などとしてもいいですが、今回はそれを補助するためのスタイルファイルである、trackchange.styを紹介したいと思います決してお金は貰っていませんよ。
http://trackchanges.sourceforge.net/
とりあえず使ってみる
trackchanges.styをサイトからダウンロードしてきてTeXソースと同じディレクトリに起き、
プリアンブル部分に
\usepackage[inline]{trackchanges}
と書きます。
これだけで、以下の5つのコマンドが使える様になります。
なお、以下のコマンドにおいては、全て[editor]
の部分は省略可能です。
省略すると、以下のコマンドによって生成された変更は、全て紫色で表示されます。
編集者によって違う色を使いたい場合は後述。
\note[editor]{The note}
文章に、補記を追記します。
1 + 1 = 3です\note{数式モード使いましょうね}
と書くと、
1 + 1 = 3です[数式モード使いましょうね]
の様に組版されます。
\annote{Text to annotate}{The note}
第一引数の文章に、題二引数の文章を補記します。
\annote{$1 + 1 = 3$}{そんなわけないだろ}
と書くと、
1 + 1 = 3[そんなわけないだろ]
の様に組版されます。
ただし、実際には第一引数の文章には編集者に応じた色で下線が引かれます。
\add{Text to add}
文章を追記します。
\add{これが追記される文章}
と書くと、編集者に応じた色で下線が装飾された文章がそこに追記されます。
\remove{Text to remove}
第一引数の文章に、打ち消し線を追記します。
\remove{決してお金は貰っていませんよ}
と書くと、
決してお金は貰っていませんよ
の様に組版されます。
\change{Text to remove}{Text to add}
第一引数の文章に、打ち消し線を追記し、その横に題二引数の文章を追記します。
\change{決してお金は貰っていませんよ}{嘘ですほしいですお金ください!}
と書くと、
決してお金は貰っていませんよ嘘ですほしいですお金ください!
と組版されます。
コメントの表示モードを変える
このままだと、単に共同編集者が個々に適当に編集するのと対して変わらない様に思えます。
が、trackchangesには、コメントの表示モードが存在し、それにより単に編集者からのコメントをその場に表示するだけではなく、コメントを適用し、古い文章は破棄して表示するモードや、逆にコメントを無視し、古い文章だけを表示するモードが存在します。
これは、プリアンブルでtrackchangesをincludeした際のオプションで指定する事ができます。
\usepackage[inline]{trackchanges}
コメントをその場で表示します。
\usepackage[finalold]{trackchanges}
コメントをすべて無視して組版します。なんのためのコメントだ
例えば、この状態で
\change{決してお金は貰っていませんよ}{嘘ですほしいですお金ください!}
と書くと、
決してお金は貰っていませんよ
だけが表示されます。
\usepackage[finalnew]{trackchanges}
古い文章をすべて破棄し、コメントを適用して組版します。
例えば、この状態で
\change{決してお金は貰っていませんよ}{嘘ですほしいですお金ください!}
と書くと、
嘘ですほしいですお金ください!
だけが表示されます。
\usepackage[margins]{trackchanges}
元の文章をその場に残し、変更やコメントを組版後のページの右側にまとめて表示します。
wordの校閲機能つかった事ある場合はあんな感じと思うとわかりやすいかも。
\usepackage[margins]{trackchanges}
元の文章をその場に残し、変更やコメントを組版後のページの下側にまとめて表示します。
編集者毎に色を変える
実際に使う際は、共同編集者は2人や3人だったりします。
その際には、\addeditor{editor_name}
コマンドを使います。
例えば、
\addeditor{Yamada}
\addeditor{Suzuki}
などです。
この後に、上記の5つの編集コマンドに対して、[editor_name]
オプションを作用させます。
例えば、
\add[Yamada]{山田の文章}
\add[Suzuki]{鈴木の文章}
などです。
これにより、山田さんのコメントと、鈴木さんのコメントが違う色で表示され、かつコメントを入れた人間の名前が出るようになるため、誰のコメントなのかがわかりやすくなります。
他発展的な使い方
他、発展的な使い方は公式サイトのドキュメントから見れます。
http://trackchanges.sourceforge.net/help_stylefile.html#advanced_usage
最後に
trackchangesを用いることで、複数人の共同編集者からコメントが入った論文のソースファイルがあった場合、
投稿者は深いこと考えずにfinalnewにして投稿すればいい事になります。
とても楽ですね本当にそんなうまくいくかなぁ…!
ただし、一部の雑誌では推奨になっていますが、すべての雑誌で使えるかどうかはよくわかりません。
例えば、AGU出版などでは推奨になっているんですが、普通にlatexdiffして変更をtrackしろ、という雑誌もまだまだあると思います。
また、悲しいかな日本語は必ずしもうまくいかないこともあります。
これらの事を見極めた上で、使うか使うまいか決めていきましょう。