niszetの日記

アナログCMOS系雑用エンジニアが頑張る備忘録系日記

Pandocの情報収集、どうする?

遅刻です。

この記事はPandoc Advent Calendar 2020の19日目の記事です。

adventar.org

今回はPandocの情報収集、どうやっていく?というお話です。あんまりまとまりのない記事になりますが…。

マニュアル類

まずは基本から。他のソフトウェアと同様に、まずはマニュアルを熟読するところから始めましょう。と言っても、自分が使うファイル形式だけ押さえておけば良いと思いますが。

pandoc.org

有志による日本語訳も(翻訳途中だけど)ありますので、英語が苦手な人はこちらを。

pandoc-doc-ja.readthedocs.io

あと、sky_y氏の記事を追いかけるのがまとまっていて良いでしょう。初心者に優しい記事が多いです。

qiita.com

公式のマニュアルも結構更新が入っていきますので、GitHub上でcommit毎の差分を確認すると良いでしょう。更新が多いので翻訳が追いつけないですねぇ…。

github.com

Slack

日本Pandocユーザ会のSlackがあります。何か質問があればここに。あまり質問を受けるような運用になってないのが寂しい(Pandocについて質問をする、という状況があまり発生しないというのはある)

docs.google.com

この中で、news-and-feedチャンネルはマークダウンという文字列に反応して関係ない情報も拾ってきますが、いろんなブログ等の投稿を見つけられるので(私は)便利です。Pandocはどのくらい理解されているんだろうか?みたいな確認に使ってます。

Twitter

今回の記事はこのアカウントの紹介が本題です。Twitterではniszetが日本語でPandocのtipsを呟くというアカウントを作成してたのですが、

twitter.com

本家?pandoc_tipsがこの度、活動を開始しました。

twitter.com

このアカウントはPandocのLuaフィルタ回りや各種フォーマットの対応をしているtarleb氏と私niszetで運用をすることとなりました。tarleb氏からやらない?って誘われたので、是非是非!と応えたらこのようになりました。まさかの展開である。Jaの方は本家を日本語で補足説明するという運用にしようと思ったんですが、pandoc_tipsの方でも日本語で呟いてもいいよ!と言われまして。あと、他にも誘っていいよ!とも言われましたので、興味ある方はどうでしょうか…?

これらのアカウントは不定期でつぶやくことになると思いますので、速報性はあまり期待せずに。おそらくはPandocのオプションを気ままに紹介という運用になるかな、と。

MailingList

こちらは英語ですが、pandoc-discussのやり取りを追うのはPandocの開発の方向性やFAQ的にどういう質問が来ているのだろうか?という情報収集に便利です。そのままIssueやPRになるものもあるので、参加しておくと良いかもです。たまにniszetも回答しますがあんまり役にたってない気もする。

groups.google.com

Pandocの質問ガイドとしても、Issueでは質問せず、こちらで質問をしてほしいこと、そしてIssue建てるにしても過去のIssueやこのdiscussで議論されていないか?を確認したうえで、discussに投稿してからIssueにすることが推奨されます。なので、Pandocにコントリビュートしたいな~という方もやはりこのメーリングリストを常に見ていくべき、ということですね。

GitHub

Issuesを追うのもアリですが、解決するものはすぐ解決、解決しないものはずっと残りがちなので、なかなか良いIssueを見るのが難しい気もします。いずれにしてもdiscussに比べると重い話が多いので、discussでは飽き足らない人向けですね。

github.com

おまけ:いち早くPandocのリリース情報を察知しよう

さて、Pandocのリリース通知が来るたびにほぼリアルタイムでツイートしている私ですが、いつ頃来そうか、一応目安にしているものがあります。commitログをみていると、バージョンを上げるcommit、"Bump to ..." というのが見つかります。まずこれが出ないとバージョンが上がらないので、これを見つけます。

次に、リリースが近い場合は機能追加は減り、ドキュメントやテストの整備などのcommitが増えます。AUTHORS、changelogあたりの修正をしている場合はリリース直前ですね。

github.com

リリースするタイミングでおそらくjgm氏が確認してると思われるので、大体の時間の見当がつきます。日本時間の13-15時(14時が多い)か2-4時くらいが多いです。たまに全然違う時間ですが。過去の通知を拾ってきて可視化すると面白いかもしれませんね?

RSSフィードで拾ってくればえぇんちゃう?ってK4氏に言われましたがそれはそれ…。

おわりに

ということで、Pandocの情報収集方法についてさらっと書いてみましたが、あまり有用な記事にはならなかった気がします。

もう少し使用例などを交えた日本語の記事が増えたほうが、「困ったらこれを読め!」みたいになって良いのかもしれませんね…。ツールの動作の原理みたいな話よりも、何が出来るのか、これを作るのにはどうすればよいのか?という記事の方が好まれますよねぇ(そういう意味でPandocで~という記事はやりにくさはありますよね)

やはり、sky_y氏

qiita.com

や、atusy氏、

blog.atusy.net

の記事を追っていくのがやはり良さそうだな、ということで、〆ておこうと思います。

来年は私ももっとPandocのことを情報発信できるよう頑張ります。少し早いですが良いお年を~